Top | ![]() |
![]() |
![]() |
![]() |
GObject * | gda_dict_database_new () |
void | gda_dict_database_add_constraint () |
GdaDict * | gda_dict_database_get_dict () |
gboolean | gda_dict_database_update_dbms_data () |
void | gda_dict_database_stop_update_dbms_data () |
GSList * | gda_dict_database_get_tables () |
GdaDictTable * | gda_dict_database_get_table_by_name () |
GdaDictTable * | gda_dict_database_get_table_by_xml_id () |
GdaDictField * | gda_dict_database_get_field_by_name () |
GdaDictField * | gda_dict_database_get_field_by_xml_id () |
GSList * | gda_dict_database_get_all_constraints () |
GSList * | gda_dict_database_get_table_constraints () |
GSList * | gda_dict_database_get_all_fk_constraints () |
GSList * | gda_dict_database_get_tables_fk_constraints () |
void | constraint-added | Run First |
void | constraint-removed | Run First |
void | constraint-updated | Run First |
void | data-update-finished | Run First |
void | data-update-started | Run First |
void | field-added | Run First |
void | field-removed | Run First |
void | field-updated | Run First |
void | table-added | Run First |
void | table-removed | Run First |
void | table-updated | Run First |
void | 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
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).
GdaDict *
gda_dict_database_get_dict (GdaDictDatabase *db
);
Fetch the GdaDict object to which the GdaDictDatabase belongs.
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).
db |
a GdaDictDatabase object |
|
limit_to_type |
limit the DBMS update to this type, or 0 for no limit |
|
limit_obj_name |
limit the DBMS update to objects of this name, or |
|
error |
location to store error, or |
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.
GSList *
gda_dict_database_get_tables (GdaDictDatabase *db
);
Get a list of all the tables within db
GdaDictTable * gda_dict_database_get_table_by_name (GdaDictDatabase *db
,const gchar *name
);
Get a reference to a GdaDictTable using its name.
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.
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.
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
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.
GSList * gda_dict_database_get_table_constraints (GdaDictDatabase *db
,GdaDictTable *table
);
Get all the constraints applicable to table
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.
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.
db |
a GdaDictDatabase object |
|
table1 |
a GdaDictTable, or |
|
table2 |
a GdaDictTable, or |
|
table1_has_fk |
TRUE if the returned constraints are the one for which |
“constraint-added”
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictConstraint *arg1, gpointer user_data)
dbdatabase |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
“constraint-removed”
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictConstraint *arg1, gpointer user_data)
dbdatabase |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
“constraint-updated”
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictConstraint *arg1, gpointer user_data)
dbdatabase |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
“data-update-finished”
signalvoid user_function (GdaDictDatabase *gdadictdatabase, gpointer user_data)
dbdatabase |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
“data-update-started”
signalvoid user_function (GdaDictDatabase *gdadictdatabase, gpointer user_data)
dbdatabase |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
“field-added”
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictField *arg1, gpointer user_data)
dbdatabase |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
“field-removed”
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictField *arg1, gpointer user_data)
dbdatabase |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
“field-updated”
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictField *arg1, gpointer user_data)
dbdatabase |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
“table-added”
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictTable *arg1, gpointer user_data)
dbdatabase |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
“table-removed”
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictTable *arg1, gpointer user_data)
dbdatabase |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
“table-updated”
signalvoid user_function (GdaDictDatabase *gdadictdatabase, GdaDictTable *arg1, gpointer user_data)
dbdatabase |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
“update-progress”
signalvoid user_function (GdaDictDatabase *gdadictdatabase, gchar *arg1, guint arg2, guint arg3, gpointer user_data)
dbdatabase |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First