Name
GdaBatch -- Batch job execution
Description
The GdaBatch object provides a way of easily adding transactions to
your applications. It allows you to reference a set of commands as a
unique entity (a batch job).
Details
gda_batch_new ()
Creates a new GdaBatch object, which can be used in applications
to simulate a transaction, that is, a series of commands which will
be committed only if only all of them succeed. If any of the commands
return an error when executed, all the changes are rolled back (by
calling gda_connection_rollback_transaction).
Although, this behavior is configurable. You can also use it as a way
of sending several commands to the underlying database, regardless
of the errors found in the process.
gda_batch_free ()
Destroy the given batch job object
gda_batch_load_file ()
gboolean gda_batch_load_file (GdaBatch *job,
const gchar *filename,
gboolean clean); |
Load the given file as a set of commands into the given job object.
The clean parameter specifies whether to clean up the list of commands
before loading the given file or not.
gda_batch_add_command ()
void gda_batch_add_command (GdaBatch *job,
const gchar *cmd); |
Adds a command to the list of commands to be executed
gda_batch_clear ()
Clears the given GdaBatch object. This means eliminating the
list of commands
gda_batch_start ()
gboolean gda_batch_start (GdaBatch *job); |
Start the batch job execution. This function will return when
the series of commands is completed, or when an error is found
gda_batch_stop ()
Stop the execution of the given GdaBatch object. This cancels the
the transaction (discarding all changes) if the GdaBatch object
is in transaction mode
gda_batch_is_running ()
gboolean gda_batch_is_running (GdaBatch *job); |
gda_batch_get_connection ()
Return the GdaConnection object associated with the given
batch job
gda_batch_set_connection ()
Associate a GdaConnection object to the given batch job
gda_batch_get_transaction_mode ()
gboolean gda_batch_get_transaction_mode (GdaBatch *job); |
gda_batch_set_transaction_mode ()
void gda_batch_set_transaction_mode (GdaBatch *job,
gboolean mode); |
Enable/disable transaction mode for the given GdaBatch
object. Transaction mode is enabled by default
Signals
The "begin-transaction" signal
void user_function (GdaBatch *gdabatch,
gpointer user_data); |
The "commit-transaction" signal
void user_function (GdaBatch *gdabatch,
gpointer user_data); |
The "rollback-transaction" signal
void user_function (GdaBatch *gdabatch,
gpointer user_data); |
The "execute-command" signal
void user_function (GdaBatch *gdabatch,
gchar *arg1,
gpointer user_data); |