![]() |
![]() |
![]() |
GdaBrowser hacking manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
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); gchar ** browser_connection_get_completions (BrowserConnection *bcnc, const gchar *sql, gint start, gint end); 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_normalize_sql_statement (BrowserConnection *bcnc, GdaSqlStatement *sqlst, 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); gboolean browser_connection_set_table_column_attribute (BrowserConnection *bcnc, GdaMetaTable *table, GdaMetaTableColumn *column, const gchar *attr_name, const gchar *value, GError **error); gchar * browser_connection_get_table_column_attribute (BrowserConnection *bcnc, GdaMetaTable *table, GdaMetaTableColumn *column, const gchar *attr_name, GError **error);
"busy" : Run First "favorites-changed" : Run First "meta-changed" : Run First "table-column-pref-changed" : Run First "transaction-status-changed" : Run First
typedef struct { GdaThreadWrapper *wrapper; GSList *wrapper_jobs; guint wrapper_results_timer; GHashTable *executed_statements; /* key = guint exec ID, value = a StatementResult pointer */ gchar *name; GdaConnection *cnc; gchar *dict_file_name; GdaSqlParser *parser; GSList *variables; /* list of BrowserVariable pointer, owned here */ GdaDsnInfo dsn_info; GMutex *p_mstruct_mutex; GdaMetaStruct *p_mstruct; /* private GdaMetaStruct: while it is being created */ GdaMetaStruct *mstruct; /* public GdaMetaStruct: once it has been created and is no more modified */ BrowserFavorites *bfav; gboolean busy; gchar *busy_reason; GdaConnection *store_cnc; } BrowserConnectionPrivate;
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()
.
|
a GdaConnection |
Returns : |
a new object |
const gchar * browser_connection_get_name (BrowserConnection *bcnc);
|
a BrowserConnection |
Returns : |
bcnc 's name
|
const GdaDsnInfo * browser_connection_get_information (BrowserConnection *bcnc);
Get some information about the connection
|
a BrowserConnection |
Returns : |
a pointer to the associated GdaDsnInfo |
gboolean browser_connection_is_busy (BrowserConnection *bcnc, gchar **out_reason);
Tells if bcnc
is currently busy or not.
|
a BrowserConnection |
|
a pointer to store a copy of the reason bcnc is busy (will be set
to NULL if bcnc is not busy), or NULL
|
Returns : |
TRUE if bcnc is busy
|
void browser_connection_update_meta_data (BrowserConnection *bcnc);
Make bcnc
update its meta store in the background.
|
a BrowserConnection |
GdaMetaStruct * browser_connection_get_meta_struct (BrowserConnection *bcnc);
Get the GdaMetaStruct maintained up to date by bcnc
.
|
a BrowserConnection |
Returns : |
a GdaMetaStruct, the caller does not have any reference to it. |
GdaMetaStore * browser_connection_get_meta_store (BrowserConnection *bcnc);
|
a BrowserConnection |
Returns : |
bcnc 's GdaMetaStore, the caller does not have any reference to it.
|
const gchar * browser_connection_get_dictionary_file (BrowserConnection *bcnc);
|
a BrowserConnection |
Returns : |
the dictionary file name used by bcnc , or NULL
|
BrowserFavorites * browser_connection_get_favorites (BrowserConnection *bcnc);
Get bcnc
's favorites handler
|
a BrowserConnection |
Returns : |
the BrowserFavorites used by bcnc
|
gchar ** browser_connection_get_completions (BrowserConnection *bcnc, const gchar *sql, gint start, gint end);
|
a BrowserConnection |
|
|
|
|
|
|
Returns : |
a new array of strings, or NULL (use g_strfreev() to free the returned array)
|
GdaSqlParser * browser_connection_create_parser (BrowserConnection *bcnc);
Get a new GdaSqlParser object for bcnc
|
a BrowserConnection |
Returns : |
a new GdaSqlParser |
gchar * browser_connection_render_pretty_sql (BrowserConnection *bcnc, GdaStatement *stmt);
Renders stmt
as SQL well indented
|
a BrowserConnection |
|
a GdaStatement |
Returns : |
a new string |
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
|
a BrowserConnection |
|
a GdaStatement |
|
a GdaSet as parameters, or NULL
|
|
how the returned data model (if any) will be used |
|
TRUE if the values of the last interted row must be computed
|
|
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
|
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.
|
a BrowserConnection |
|
the ID of the excution |
|
a place to store the last inserted row, if any, or NULL
|
|
a place to store errors, or NULL
|
Returns : |
the execution result, or NULL if either an error occurred or the result is not yet ready
|
gboolean browser_connection_normalize_sql_statement (BrowserConnection *bcnc, GdaSqlStatement *sqlst, GError **error);
See gda_sql_statement_normalize()
.
|
a BrowserConnection |
|
a GdaSqlStatement |
|
a place to store errors, or NULL
|
Returns : |
TRUE if no error occurred
|
gboolean browser_connection_begin (BrowserConnection *bcnc, GError **error);
Begins a transaction
|
a BrowserConnection |
|
a place to store errors, or NULL
|
Returns : |
gboolean browser_connection_commit (BrowserConnection *bcnc, GError **error);
Commits a transaction
|
a BrowserConnection |
|
a place to store errors, or NULL
|
Returns : |
gboolean browser_connection_rollback (BrowserConnection *bcnc, GError **error);
Rolls back a transaction
|
a BrowserConnection |
|
a place to store errors, or NULL
|
Returns : |
GdaTransactionStatus * browser_connection_get_transaction_status (BrowserConnection *bcnc);
Retuns: the GdaTransactionStatus of the connection, or NULL
|
a BrowserConnection |
Returns : |
gboolean browser_connection_set_table_column_attribute (BrowserConnection *bcnc, GdaMetaTable *table, GdaMetaTableColumn *column, const gchar *attr_name, const gchar *value, GError **error);
|
|
|
|
|
|
|
attribute name, not NULL
|
|
value to set, or NULL to unset
|
|
|
Returns : |
TRUE if no error occurred
|
gchar * browser_connection_get_table_column_attribute (BrowserConnection *bcnc, GdaMetaTable *table, GdaMetaTableColumn *column, const gchar *attr_name, GError **error);
|
|
|
|
|
may be NULL
|
|
attribute name, not NULL
|
|
|
Returns : |
the requested attribute, or NULL if not set or if an error occurred
|
"gda-connection"
property"gda-connection" GdaConnection* : Read / Write / Construct Only
Connection to use.
"busy"
signalvoid user_function (BrowserConnection *browserconnection, gboolean arg1, gchar *arg2, gpointer user_data) : Run First
|
the object which received the signal. |
|
|
|
|
|
user data set when the signal handler was connected. |
"favorites-changed"
signalvoid user_function (BrowserConnection *browserconnection, gpointer user_data) : Run First
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"meta-changed"
signalvoid user_function (BrowserConnection *browserconnection, GdaMetaStruct *arg1, gpointer user_data) : Run First
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"table-column-pref-changed"
signalvoid user_function (BrowserConnection *browserconnection, gpointer arg1, gpointer arg2, gchar *arg3, gchar *arg4, gpointer user_data) : Run First
|
the object which received the signal. |
|
|
|
|
|
|
|
|
|
user data set when the signal handler was connected. |
"transaction-status-changed"
signalvoid user_function (BrowserConnection *browserconnection, gpointer user_data) : Run First
|
the object which received the signal. |
|
user data set when the signal handler was connected. |