| Top |
| GdaDdlFkey * | gda_ddl_fkey_new () |
| const GList * | gda_ddl_fkey_get_field_name () |
| const GList * | gda_ddl_fkey_get_ref_field () |
| void | gda_ddl_fkey_set_field () |
| const gchar * | gda_ddl_fkey_get_ref_table () |
| void | gda_ddl_fkey_set_ref_table () |
| const gchar * | gda_ddl_fkey_get_ondelete () |
| GdaDdlFkeyReferenceAction | gda_ddl_fkey_get_ondelete_id () |
| void | gda_ddl_fkey_set_ondelete () |
| const gchar * | gda_ddl_fkey_get_onupdate () |
| GdaDdlFkeyReferenceAction | gda_ddl_fkey_get_onupdate_id () |
| void | gda_ddl_fkey_set_onupdate () |
| void | gda_ddl_fkey_free () |
| gboolean | gda_ddl_fkey_prepare_create () |
| GdaDdlFkey * | gda_ddl_fkey_new_from_meta () |
| #define | GDA_TYPE_DDL_FKEY |
| struct | GdaDdlFkeyClass |
| enum | GdaDdlFkeyReferenceAction |
| GdaDdlFkey |
For generating database from xml file or for mapping database to an xml file GdaDdlFkey holds information about foregn keys with a convenient set of methods to manipulate them. GdaDdlFkey implements GdaDdlBuildable interface for parsing xml file.
GdaDdlFkey *
gda_ddl_fkey_new (void);
Create a new GdaDdlFkey object.
Since: 6.0
const GList *
gda_ddl_fkey_get_field_name (GdaDdlFkey *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
const GList *
gda_ddl_fkey_get_ref_field (GdaDdlFkey *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
void gda_ddl_fkey_set_field (GdaDdlFkey *self,const gchar *field,const gchar *reffield);
All arguments should be valid strings.
self |
An object GdaDdlFkey |
|
field |
Field name as a string |
|
reffield |
A reference field name as a string |
Since: 6.0
const gchar *
gda_ddl_fkey_get_ref_table (GdaDdlFkey *self);
Return: Returns reference table name as a string or NULL if table name
hasn't been set.
Since: 6.0
void gda_ddl_fkey_set_ref_table (GdaDdlFkey *self,const gchar *rtable);
Set reference table
Since: 6.0
const gchar *
gda_ddl_fkey_get_ondelete (GdaDdlFkey *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
GdaDdlFkeyReferenceAction
gda_ddl_fkey_get_ondelete_id (GdaDdlFkey *self);
The default value is NO_ACTION
Return: ON DELETE action as a GdaDdlFkeyReferenceAction.
Since: 6.0
void gda_ddl_fkey_set_ondelete (GdaDdlFkey *self,GdaDdlFkeyReferenceAction id);
Set action for ON_DELETE
Since: 6.0
GdaDdlFkeyReferenceAction
gda_ddl_fkey_get_onupdate_id (GdaDdlFkey *self);
Return: ON_UPDATE action as a GdaDdlFkeyReferenceAction
Since: 6.0
void gda_ddl_fkey_set_onupdate (GdaDdlFkey *self,GdaDdlFkeyReferenceAction id);
Set action for ON_UPDATE
Since: 6.0
void
gda_ddl_fkey_free (GdaDdlFkey *self);
Convenient method to free the object. It is a wrap around g_clear_object()
Since: 6.0
gboolean gda_ddl_fkey_prepare_create (GdaDdlFkey *self,GdaServerOperation *op,GError **error);
Prepare op
object for execution by populating with information stored in self
.
Since: 6.0
GdaDdlFkey *
gda_ddl_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_ddl_fkey_new()
Specify numeric value for the actions, e.g. "ON DELETE" and "ON UPDATE"
|
Action is not specified. |
||
|
Action value is set to |
||
|
Value is set to "RESTRICT" |
||
|
Value is set to default behavior |
||
|
Value is set to cascade |