![]() |
![]() |
![]() |
GNOME Data Access 3.0 manual | ![]() |
---|---|---|---|---|
GdaDictDatabase; GObject* gda_dict_database_new (GdaDict *dict); void gda_dict_database_add_constraint (GdaDictDatabase *db, GdaDictConstraint *cstr); GdaDict* gda_dict_database_get_dict (GdaDictDatabase *db); gboolean gda_dict_database_update_dbms_data (GdaDictDatabase *db, GType limit_to_type, const gchar *limit_obj_name, GError **error); void gda_dict_database_stop_update_dbms_data (GdaDictDatabase *db); GSList* gda_dict_database_get_tables (GdaDictDatabase *db); GdaDictTable* gda_dict_database_get_table_by_name (GdaDictDatabase *db, const gchar *name); GdaDictTable* gda_dict_database_get_table_by_xml_id (GdaDictDatabase *db, const gchar *xml_id); GdaDictField* gda_dict_database_get_field_by_name (GdaDictDatabase *db, const gchar *fullname); GdaDictField* gda_dict_database_get_field_by_xml_id (GdaDictDatabase *db, const gchar *xml_id); GSList* gda_dict_database_get_all_constraints (GdaDictDatabase *db); GSList* gda_dict_database_get_table_constraints (GdaDictDatabase *db, GdaDictTable *table); GSList* gda_dict_database_get_all_fk_constraints (GdaDictDatabase *db); GSList* gda_dict_database_get_tables_fk_constraints (GdaDictDatabase *db, GdaDictTable *table1, GdaDictTable *table2, gboolean table1_has_fk);
"constraint-added" : Run First "constraint-removed" : Run First "constraint-updated" : Run First "data-update-finished" : Run First "data-update-started" : Run First "field-added" : Run First "field-removed" : Run First "field-updated" : Run First "table-added" : Run First "table-removed" : Run First "table-updated" : Run First "update-progress" : Run First
This object manages an internal dictionary mirroring the real database structure with objects such as GdaDictTable (composed of GdaDictfield objects) and GdaDictConstraint.
GObject* gda_dict_database_new (GdaDict *dict);
Creates a new GdaDictDatabase object
|
a GdaDict object |
Returns : |
the new object |
void gda_dict_database_add_constraint (GdaDictDatabase *db, GdaDictConstraint *cstr);
Add the cstr
constraint to the database. The cstr
constraint is a user-defined constraint
(which is not part of the database structure itself).
|
a GdaDictDatabase object |
|
a GdaDictConstraint |
GdaDict* gda_dict_database_get_dict (GdaDictDatabase *db);
Fetch the GdaDict object to which the GdaDictDatabase belongs.
|
a GdaDictDatabase object |
Returns : |
the GdaDict object |
gboolean gda_dict_database_update_dbms_data (GdaDictDatabase *db, GType limit_to_type, const gchar *limit_obj_name, GError **error);
Synchronises the database representation with the database structure which is stored in the DBMS. For this operation to succeed, the connection to the DBMS server MUST be opened (using the corresponding GdaConnection object).
|
a GdaDictDatabase object |
|
limit the DBMS update to this type, or 0 for no limit |
|
limit the DBMS update to objects of this name, or NULL for no limit
|
|
location to store error, or NULL
|
Returns : |
TRUE if no error |
void gda_dict_database_stop_update_dbms_data (GdaDictDatabase *db);
When the database updates its internal lists of DBMS objects, a call to this function will stop that update process. It has no effect when the database is not updating its DBMS data.
|
a GdaDictDatabase object |
GSList* gda_dict_database_get_tables (GdaDictDatabase *db);
Get a list of all the tables within db
|
a GdaDictDatabase object |
Returns : |
a new list of all the GdaDictTable objects |
GdaDictTable* gda_dict_database_get_table_by_name (GdaDictDatabase *db, const gchar *name);
Get a reference to a GdaDictTable using its name.
|
a GdaDictDatabase object |
|
the name of the requested table |
Returns : |
The GdaDictTable pointer or NULL if the requested table does not exist. |
GdaDictTable* gda_dict_database_get_table_by_xml_id (GdaDictDatabase *db, const gchar *xml_id);
Get a reference to a GdaDictTable using its XML id.
|
a GdaDictDatabase object |
|
the XML id of the requested table |
Returns : |
The GdaDictTable pointer or NULL if the requested table does not exist. |
GdaDictField* gda_dict_database_get_field_by_name (GdaDictDatabase *db, const gchar *fullname);
Get a reference to a GdaDictField specifying the full name (table_name.field_name) of the requested field.
|
a GdaDictDatabase object |
|
the name of the requested table field |
Returns : |
The GdaDictField pointer or NULL if the requested field does not exist. |
GdaDictField* gda_dict_database_get_field_by_xml_id (GdaDictDatabase *db, const gchar *xml_id);
Get a reference to a GdaDictField specifying its XML id
|
a GdaDictDatabase object |
|
the XML id of the requested table field |
Returns : |
The GdaDictField pointer or NULL if the requested field does not exist. |
GSList* gda_dict_database_get_all_constraints (GdaDictDatabase *db);
Get a list of all the constraints applied to the database. Constraints are represented as GdaDictConstraint objects and represent any type of constraint.
|
a GdaDictDatabase object |
Returns : |
a new list of the constraints |
GSList* gda_dict_database_get_table_constraints (GdaDictDatabase *db, GdaDictTable *table);
Get all the constraints applicable to table
|
a GdaDictDatabase object |
|
a GdaDictTable, part of db
|
Returns : |
a new GSList of GdaDictConstraint objects |
GSList* gda_dict_database_get_all_fk_constraints (GdaDictDatabase *db);
Get a list of all the constraints applied to the database which represent a foreign constrains. Constraints are represented as GdaDictConstraint objects.
|
a GdaDictDatabase object |
Returns : |
a new list of the constraints |
GSList* gda_dict_database_get_tables_fk_constraints (GdaDictDatabase *db, GdaDictTable *table1, GdaDictTable *table2, gboolean table1_has_fk);
Get a list of all the constraints applied to the database which represent a foreign key constrains, between
table1
and table2
. If table1
or table2
are NULL
, then the returned foreign key constraints are the ones
between any table and table1
or table2
.
Constraints are represented as GdaDictConstraint objects.
|
a GdaDictDatabase object |
|
a GdaDictTable, or NULL
|
|
a GdaDictTable, or NULL
|
|
TRUE if the returned constraints are the one for which table1 contains the foreign key
|
Returns : |
a new list of the constraints |
"constraint-added"
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictConstraint *arg1, gpointer user_data) : Run First
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"constraint-removed"
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictConstraint *arg1, gpointer user_data) : Run First
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"constraint-updated"
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictConstraint *arg1, gpointer user_data) : Run First
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"data-update-finished"
signalvoid user_function (GdaDictDatabase *gdadictdatabase, gpointer user_data) : Run First
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"data-update-started"
signalvoid user_function (GdaDictDatabase *gdadictdatabase, gpointer user_data) : Run First
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"field-added"
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictField *arg1, gpointer user_data) : Run First
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"field-removed"
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictField *arg1, gpointer user_data) : Run First
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"field-updated"
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictField *arg1, gpointer user_data) : Run First
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"table-added"
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictTable *arg1, gpointer user_data) : Run First
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"table-removed"
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictTable *arg1, gpointer user_data) : Run First
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"table-updated"
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictTable *arg1, gpointer user_data) : Run First
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"update-progress"
signalvoid user_function (GdaDictDatabase *gdadictdatabase, gchar *arg1, guint arg2, guint arg3, gpointer user_data) : Run First
|
the object which received the signal. |
|
|
|
|
|
|
|
user data set when the signal handler was connected. |