Synopsis

struct GnomeDbTableField

struct GnomeDbTableField;

gnome_db_table_field_new ()

GObject*    gnome_db_table_field_new        (GnomeDbDict *dict,
                                             GnomeDbServerDataType *type);

Creates a new GnomeDbTableField object

gnome_db_table_field_set_length ()

void        gnome_db_table_field_set_length (GnomeDbTableField *field,
                                             gint length);

gnome_db_table_field_get_length ()

gint        gnome_db_table_field_get_length (GnomeDbTableField *field);

Get the length of a field.

gnome_db_table_field_set_scale ()

void        gnome_db_table_field_set_scale  (GnomeDbTableField *field,
                                             gint length);

gnome_db_table_field_get_scale ()

gint        gnome_db_table_field_get_scale  (GnomeDbTableField *field);

Get the scale of a field.

gnome_db_table_field_get_constraints ()

GSList*     gnome_db_table_field_get_constraints
                                            (GnomeDbTableField *field);

Get all the constraints which impact the given field. Constraints are of several type: NOT NULL, primary key, foreign key, check constrains

gnome_db_table_field_set_data_type ()

void        gnome_db_table_field_set_data_type
                                            (GnomeDbTableField *field,
                                             GnomeDbServerDataType *type);

Sets the data type of the field

gnome_db_table_field_set_default_value ()

void        gnome_db_table_field_set_default_value
                                            (GnomeDbTableField *field,
                                             const GdaValue *value);

Sets (or replace) the default value for the field. WARNING: the default value's data type can be different from the field's data type (this is the case for example if the default value is a function like Postgres's default value for the SERIAL data type).

gnome_db_table_field_get_default_value ()

const GdaValue* gnome_db_table_field_get_default_value
                                            (GnomeDbTableField *field);

Get the default value for the field if ne exists

gnome_db_table_field_is_null_allowed ()

gboolean    gnome_db_table_field_is_null_allowed
                                            (GnomeDbTableField *field);

Test if field can be NULL or not

gnome_db_table_field_is_pkey_part ()

gboolean    gnome_db_table_field_is_pkey_part
                                            (GnomeDbTableField *field);

Test if field is part of a primary key constraint

gnome_db_table_field_is_pkey_alone ()

gboolean    gnome_db_table_field_is_pkey_alone
                                            (GnomeDbTableField *field);

Test if field is alone a primary key constraint

gnome_db_table_field_is_fkey_part ()

gboolean    gnome_db_table_field_is_fkey_part
                                            (GnomeDbTableField *field);

Test if field is part of a foreign key constraint

gnome_db_table_field_is_fkey_alone ()

gboolean    gnome_db_table_field_is_fkey_alone
                                            (GnomeDbTableField *field);

Get field's extra attributes. The attributes is an OR'ed value of all the possible values in GnomeDbTableFieldAttribute.

gnome_db_table_field_set_attributes ()

void        gnome_db_table_field_set_attributes
                                            (GnomeDbTableField *field,
                                             guint attributes);

gnome_db_table_field_get_attributes ()

guint       gnome_db_table_field_get_attributes
                                            (GnomeDbTableField *field);