GdaDdlFkey

GdaDdlFkey — Object to hold information for foregn key.

Stability Level

Stable, unless otherwise indicated

Types and Values

Object Hierarchy

    GObject
    ╰── GdaDdlFkey

Implemented Interfaces

GdaDdlFkey implements GdaDdlBuildable.

Includes

#include <libgda/libgda.h>

Description

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.

Functions

gda_ddl_fkey_new ()

GdaDdlFkey *
gda_ddl_fkey_new (void);

Create a new GdaDdlFkey object.

Since: 6.0


gda_ddl_fkey_get_field_name ()

const GList *
gda_ddl_fkey_get_field_name (GdaDdlFkey *self);

Parameters

self

a GdaDdlFkey object

 

Returns

A const GList of strings where each string corresponds to a foreign key field or NULL.

[element-type utf8][transfer none]

Since: 6.0


gda_ddl_fkey_get_ref_field ()

const GList *
gda_ddl_fkey_get_ref_field (GdaDdlFkey *self);

Parameters

self

a GdaDdlFkey object

 

Returns

A GList of strings where each string corresponds to a foreign key reference field or NULL.

[element-type utf8][transfer none]

Since: 6.0


gda_ddl_fkey_set_field ()

void
gda_ddl_fkey_set_field (GdaDdlFkey *self,
                        const gchar *field,
                        const gchar *reffield);

All arguments should be valid strings.

Parameters

self

An object GdaDdlFkey

 

field

Field name as a string

 

reffield

A reference field name as a string

 

Since: 6.0


gda_ddl_fkey_get_ref_table ()

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.

Parameters

self

a GdaDdlFkey object

 

Since: 6.0


gda_ddl_fkey_set_ref_table ()

void
gda_ddl_fkey_set_ref_table (GdaDdlFkey *self,
                            const gchar *rtable);

Set reference table

Parameters

self

GdaDdlFkey object

 

rtable

reference table name

 

Since: 6.0


gda_ddl_fkey_get_ondelete ()

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.

Parameters

self

An object GdaDdlFkey

 

Since: 6.0


gda_ddl_fkey_get_ondelete_id ()

GdaDdlFkeyReferenceAction
gda_ddl_fkey_get_ondelete_id (GdaDdlFkey *self);

The default value is NO_ACTION

Return: ON DELETE action as a GdaDdlFkeyReferenceAction.

Parameters

self

a GdaDdlFkey object

 

Since: 6.0


gda_ddl_fkey_set_ondelete ()

void
gda_ddl_fkey_set_ondelete (GdaDdlFkey *self,
                           GdaDdlFkeyReferenceAction id);

Set action for ON_DELETE

Parameters

self

An object GdaDdlFkey

 

id

GdaDdlFkeyReferenceAction action to set

 

Since: 6.0


gda_ddl_fkey_get_onupdate ()

const gchar *
gda_ddl_fkey_get_onupdate (GdaDdlFkey *self);

Parameters

self

a GdaDdlFkey instance

 

Returns

ON_UPDATE action as a string. Never NULL

Since: 6.0


gda_ddl_fkey_get_onupdate_id ()

GdaDdlFkeyReferenceAction
gda_ddl_fkey_get_onupdate_id (GdaDdlFkey *self);

Return: ON_UPDATE action as a GdaDdlFkeyReferenceAction

Parameters

self

a GdaDdlFkey instance

 

Since: 6.0


gda_ddl_fkey_set_onupdate ()

void
gda_ddl_fkey_set_onupdate (GdaDdlFkey *self,
                           GdaDdlFkeyReferenceAction id);

Set action for ON_UPDATE

Parameters

self

An object GdaDdlFkey

 

id

GdaDdlFkeyReferenceAction action to set

 

Since: 6.0


gda_ddl_fkey_free ()

void
gda_ddl_fkey_free (GdaDdlFkey *self);

Convenient method to free the object. It is a wrap around g_clear_object()

Parameters

self

a GdaDdlFkey object

 

Since: 6.0


gda_ddl_fkey_prepare_create ()

gboolean
gda_ddl_fkey_prepare_create (GdaDdlFkey *self,
                             GdaServerOperation *op,
                             GError **error);

Prepare op object for execution by populating with information stored in self .

Parameters

self

a GdaDdlFkey instance

 

op

a GdaServerOperation to populate

 

error

error container

 

Returns

TRUE if no error or FALSE otherwise.

Since: 6.0


gda_ddl_fkey_new_from_meta ()

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()

Parameters

metafkey

a GdaMetaTableForeignKey instance

 

Types and Values

GDA_TYPE_DDL_FKEY

#define GDA_TYPE_DDL_FKEY (gda_ddl_fkey_get_type())

struct GdaDdlFkeyClass

struct GdaDdlFkeyClass {
    GObjectClass parent_class;
};

enum GdaDdlFkeyReferenceAction

Specify numeric value for the actions, e.g. "ON DELETE" and "ON UPDATE"

Members

GDA_DDL_FKEY_NO_ACTION

Action is not specified.

 

GDA_DDL_FKEY_SET_NULL

Action value is set to NULL

 

GDA_DDL_FKEY_RESTRICT

Value is set to "RESTRICT"

 

GDA_DDL_FKEY_SET_DEFAULT

Value is set to default behavior

 

GDA_DDL_FKEY_CASCADE

Value is set to cascade

 

GdaDdlFkey

typedef struct _GdaDdlFkey GdaDdlFkey;