| Top |  |  |  |  | 
| GdaDbFkey * | gda_db_fkey_new () | 
| GdaDbFkey * | gda_db_fkey_new_from_meta () | 
| const GList * | gda_db_fkey_get_field_name () | 
| const GList * | gda_db_fkey_get_ref_field () | 
| void | gda_db_fkey_set_field () | 
| const gchar * | gda_db_fkey_get_ref_table () | 
| void | gda_db_fkey_set_ref_table () | 
| const gchar * | gda_db_fkey_get_ondelete () | 
| GdaDbFkeyReferenceAction | gda_db_fkey_get_ondelete_id () | 
| void | gda_db_fkey_set_ondelete () | 
| const gchar * | gda_db_fkey_get_onupdate () | 
| GdaDbFkeyReferenceAction | gda_db_fkey_get_onupdate_id () | 
| void | gda_db_fkey_set_onupdate () | 
| gboolean | gda_db_fkey_prepare_create () | 
For generating database from xml file or for mapping database to an xml file GdaDbFkey holds information about foregn keys with a convenient set of methods to manipulate them. GdaDbFkey implements GdaDbBuildable interface for parsing xml file. This is an example how GdaDbFkey can be used:
| 1 2 3 4 5 6 7 | GdaDbFkey *fkey = gda_db_fkey_new (); gda_db_fkey_set_ref_table (fkey, "Project"); gda_db_fkey_set_ondelete (fkey, GDA_DB_FKEY_RESTRICT); gda_db_fkey_set_onupdate (fkey, GDA_DB_FKEY_RESTRICT); gda_db_fkey_set_field (fkey, "project_id", "id"); gda_db_table_append_fkey (temployee, fkey); | 
GdaDbFkey *
gda_db_fkey_new (void);
Create a new GdaDbFkey object.
Since: 6.0
Stability Level: Stable
GdaDbFkey *
gda_db_fkey_new_from_meta (GdaMetaTableForeignKey *metafkey);
Create a new instance from the corresponding meta object. If metafkey
 is NULL,
this function is identical to gda_db_fkey_new().
Since: 6.0
Stability Level: Stable
const GList *
gda_db_fkey_get_field_name (GdaDbFkey *self);
A const GList of strings where each string
corresponds to a foreign key field or NULL. 
[element-type utf8][transfer none]
Since: 6.0
Stability Level: Stable
const GList *
gda_db_fkey_get_ref_field (GdaDbFkey *self);
A GList of strings where each string corresponds
to a foreign key reference field or NULL. 
[element-type utf8][transfer none]
Since: 6.0
Stability Level: Stable
void gda_db_fkey_set_field (GdaDbFkey *self,const gchar *field,const gchar *reffield);
All arguments should be valid strings.
| self | An object GdaDbFkey | |
| field | Field name as a string | |
| reffield | A reference field name as a string | 
Since: 6.0
Stability Level: Stable
const gchar *
gda_db_fkey_get_ref_table (GdaDbFkey *self);
Return: Returns reference table name as a string or NULL if table name
hasn't been set.
Since: 6.0
Stability Level: Stable
void gda_db_fkey_set_ref_table (GdaDbFkey *self,const gchar *rtable);
Set reference table
Since: 6.0
Stability Level: Stable
const gchar *
gda_db_fkey_get_ondelete (GdaDbFkey *self);
Return: ON DELETE action as a string. If the action is not set then the string corresponding to NO_ACTION is returned.
Since: 6.0
Stability Level: Stable
GdaDbFkeyReferenceAction
gda_db_fkey_get_ondelete_id (GdaDbFkey *self);
The default value is NO_ACTION
Return: ON DELETE action as a GdaDbFkeyReferenceAction.
Since: 6.0
Stability Level: Stable
void gda_db_fkey_set_ondelete (GdaDbFkey *self,GdaDbFkeyReferenceAction id);
Set action for ON_DELETE
Since: 6.0
Stability Level: Stable
const gchar *
gda_db_fkey_get_onupdate (GdaDbFkey *self);
Since: 6.0
Stability Level: Stable
GdaDbFkeyReferenceAction
gda_db_fkey_get_onupdate_id (GdaDbFkey *self);
Return: ON_UPDATE action as a GdaDbFkeyReferenceAction
Since: 6.0
Stability Level: Stable
void gda_db_fkey_set_onupdate (GdaDbFkey *self,GdaDbFkeyReferenceAction id);
Set action for ON_UPDATE
Since: 6.0
Stability Level: Stable
gboolean gda_db_fkey_prepare_create (GdaDbFkey *self,GdaServerOperation *op,gint i,GError **error);
Prepare op
 object for execution by populating with information stored in self
.
| self | a GdaDbFkey instance | |
| op | a GdaServerOperation to populate | |
| i | Order number | |
| error | error container | 
Since: 6.0
Stability Level: Stable