BrowserConnection

BrowserConnection — An opened connection

Synopsis

                    BrowserConnectionPrivate;
                    BrowserConnection;
BrowserConnection * browser_connection_new              (GdaConnection *cnc);
const gchar *       browser_connection_get_name         (BrowserConnection *bcnc);
const GdaDsnInfo *  browser_connection_get_information  (BrowserConnection *bcnc);
gboolean            browser_connection_is_busy          (BrowserConnection *bcnc,
                                                         gchar **out_reason);
void                browser_connection_update_meta_data (BrowserConnection *bcnc);
GdaMetaStruct *     browser_connection_get_meta_struct  (BrowserConnection *bcnc);
GdaMetaStore *      browser_connection_get_meta_store   (BrowserConnection *bcnc);
const gchar *       browser_connection_get_dictionary_file
                                                        (BrowserConnection *bcnc);
BrowserFavorites *  browser_connection_get_favorites    (BrowserConnection *bcnc);
GdaSqlParser *      browser_connection_create_parser    (BrowserConnection *bcnc);
gchar *             browser_connection_render_pretty_sql
                                                        (BrowserConnection *bcnc,
                                                         GdaStatement *stmt);
guint               browser_connection_execute_statement
                                                        (BrowserConnection *bcnc,
                                                         GdaStatement *stmt,
                                                         GdaSet *params,
                                                         GdaStatementModelUsage model_usage,
                                                         gboolean need_last_insert_row,
                                                         GError **error);
GObject *           browser_connection_execution_get_result
                                                        (BrowserConnection *bcnc,
                                                         guint exec_id,
                                                         GdaSet **last_insert_row,
                                                         GError **error);

gboolean            browser_connection_begin            (BrowserConnection *bcnc,
                                                         GError **error);
gboolean            browser_connection_commit           (BrowserConnection *bcnc,
                                                         GError **error);
gboolean            browser_connection_rollback         (BrowserConnection *bcnc,
                                                         GError **error);
GdaTransactionStatus * browser_connection_get_transaction_status
                                                        (BrowserConnection *bcnc);

Object Hierarchy

  GObject
   +----BrowserConnection

Signals

  "busy"                                           : Run First
  "favorites-changed"                              : Run First
  "meta-changed"                                   : Run First
  "transaction-status-changed"                     : Run First

Description

The BrowserConnection object wraps a GdaConnection with some additionnal features.

Details

BrowserConnectionPrivate

typedef struct _BrowserConnectionPrivate BrowserConnectionPrivate;


BrowserConnection

typedef struct _BrowserConnection BrowserConnection;


browser_connection_new ()

BrowserConnection * browser_connection_new              (GdaConnection *cnc);

Creates a new BrowserConnection object wrapping cnc. The browser_core_take_connection() method must be called on the new object to mahe it managed by the browser.

To close the new connection, use browser_core_close_connection().

cnc :

a GdaConnection

Returns :

a new object

browser_connection_get_name ()

const gchar *       browser_connection_get_name         (BrowserConnection *bcnc);

bcnc :

a BrowserConnection

Returns :

bcnc's name

browser_connection_get_information ()

const GdaDsnInfo *  browser_connection_get_information  (BrowserConnection *bcnc);

Get some information about the connection

bcnc :

a BrowserConnection

Returns :

a pointer to the associated GdaDsnInfo

browser_connection_is_busy ()

gboolean            browser_connection_is_busy          (BrowserConnection *bcnc,
                                                         gchar **out_reason);

Tells if bcnc is currently busy or not.

bcnc :

a BrowserConnection

out_reason :

a pointer to store a copy of the reason bcnc is busy (will be set to NULL if bcnc is not busy)

Returns :

TRUE if bcnc is busy

browser_connection_update_meta_data ()

void                browser_connection_update_meta_data (BrowserConnection *bcnc);

Make bcnc update its meta store in the background.

bcnc :

a BrowserConnection

browser_connection_get_meta_struct ()

GdaMetaStruct *     browser_connection_get_meta_struct  (BrowserConnection *bcnc);

Get the GdaMetaStruct maintained up to date by bcnc.

bcnc :

a BrowserConnection

Returns :

a GdaMetaStruct, the caller does not have any reference to it.

browser_connection_get_meta_store ()

GdaMetaStore *      browser_connection_get_meta_store   (BrowserConnection *bcnc);

bcnc :

a BrowserConnection

Returns :

bcnc's GdaMetaStore, the caller does not have any reference to it.

browser_connection_get_dictionary_file ()

const gchar *       browser_connection_get_dictionary_file
                                                        (BrowserConnection *bcnc);

bcnc :

a BrowserConnection

Returns :

the dictionary file name used by bcnc, or NULL

browser_connection_get_favorites ()

BrowserFavorites *  browser_connection_get_favorites    (BrowserConnection *bcnc);

Get bcnc's favorites handler

bcnc :

a BrowserConnection

Returns :

the BrowserFavorites used by bcnc

browser_connection_create_parser ()

GdaSqlParser *      browser_connection_create_parser    (BrowserConnection *bcnc);

Get a new GdaSqlParser object for bcnc

bcnc :

a BrowserConnection

Returns :

a new GdaSqlParser

browser_connection_render_pretty_sql ()

gchar *             browser_connection_render_pretty_sql
                                                        (BrowserConnection *bcnc,
                                                         GdaStatement *stmt);

Renders stmt as SQL well indented

bcnc :

a BrowserConnection

stmt :

a GdaStatement

Returns :

a new string

browser_connection_execute_statement ()

guint               browser_connection_execute_statement
                                                        (BrowserConnection *bcnc,
                                                         GdaStatement *stmt,
                                                         GdaSet *params,
                                                         GdaStatementModelUsage model_usage,
                                                         gboolean need_last_insert_row,
                                                         GError **error);

Executes stmt by bcnc

bcnc :

a BrowserConnection

stmt :

a GdaStatement

params :

a GdaSet as parameters, or NULL

model_usage :

how the returned data model (if any) will be used

need_last_insert_row :

TRUE if the values of the last interted row must be computed

error :

a place to store errors, or NULL

Returns :

a job ID, to be used with browser_connection_execution_get_result(), or 0 if an error occurred

browser_connection_execution_get_result ()

GObject *           browser_connection_execution_get_result
                                                        (BrowserConnection *bcnc,
                                                         guint exec_id,
                                                         GdaSet **last_insert_row,
                                                         GError **error);

Pick up the result of the exec_id's execution.

Retunrs: see gda_connection_async_fetch_result()

bcnc :

a BrowserConnection

exec_id :

the ID of the excution

last_insert_row :

a place to store the last inserted row, if any, or NULL

error :

a place to store errors, or NULL

Returns :


browser_connection_begin ()

gboolean            browser_connection_begin            (BrowserConnection *bcnc,
                                                         GError **error);

Begins a transaction

bcnc :

a BrowserConnection

error :

a place to store errors, or NULL

Returns :


browser_connection_commit ()

gboolean            browser_connection_commit           (BrowserConnection *bcnc,
                                                         GError **error);

Commits a transaction

bcnc :

a BrowserConnection

error :

a place to store errors, or NULL

Returns :


browser_connection_rollback ()

gboolean            browser_connection_rollback         (BrowserConnection *bcnc,
                                                         GError **error);

Rolls back a transaction

bcnc :

a BrowserConnection

error :

a place to store errors, or NULL

Returns :


browser_connection_get_transaction_status ()

GdaTransactionStatus * browser_connection_get_transaction_status
                                                        (BrowserConnection *bcnc);

Retuns: the GdaTransactionStatus of the connection, or NULL

bcnc :

a BrowserConnection

Returns :

Signal Details

The "busy" signal

void                user_function                      (BrowserConnection *browserconnection,
                                                        gboolean           arg1,
                                                        gchar             *arg2,
                                                        gpointer           user_data)              : Run First

@: @: @:

browserconnection :

the object which received the signal.

arg1 :

arg2 :

user_data :

user data set when the signal handler was connected.

The "favorites-changed" signal

void                user_function                      (BrowserConnection *browserconnection,
                                                        gpointer           user_data)              : Run First

@:

browserconnection :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "meta-changed" signal

void                user_function                      (BrowserConnection *browserconnection,
                                                        GdaMetaStruct     *arg1,
                                                        gpointer           user_data)              : Run First

@: @:

browserconnection :

the object which received the signal.

arg1 :

user_data :

user data set when the signal handler was connected.

The "transaction-status-changed" signal

void                user_function                      (BrowserConnection *browserconnection,
                                                        gpointer           user_data)              : Run First

browserconnection :

the object which received the signal.

user_data :

user data set when the signal handler was connected.