![]() | ![]() | ![]() | Libmergeant Reference Manual | ![]() |
---|
#define MG_DB_FIELD_TYPE #define MG_DB_FIELD (obj) #define IS_MG_DB_FIELD (obj) #define MG_DB_FIELD_CLASS (klass) struct MgDbField; GObject* mg_db_field_new (MgConf *conf, MgServerDataType *type); void mg_db_field_set_length (MgDbField *field, gint length); gint mg_db_field_get_length (MgDbField *field); void mg_db_field_set_scale (MgDbField *field, gint length); gint mg_db_field_get_scale (MgDbField *field); GSList* mg_db_field_get_constraints (MgDbField *field); void mg_db_field_set_data_type (MgDbField *field, MgServerDataType *type); void mg_db_field_set_default_value (MgDbField *field, const GdaValue *value); const GdaValue* mg_db_field_get_default_value (MgDbField *field); gboolean mg_db_field_is_null_allowed (MgDbField *field); gboolean mg_db_field_is_pkey_part (MgDbField *field); gboolean mg_db_field_is_pkey_alone (MgDbField *field); gboolean mg_db_field_is_fkey_part (MgDbField *field); gboolean mg_db_field_is_fkey_alone (MgDbField *field);
#define MG_DB_FIELD(obj) G_TYPE_CHECK_INSTANCE_CAST (obj, mg_db_field_get_type(), MgDbField)
obj : |
|
#define IS_MG_DB_FIELD(obj) G_TYPE_CHECK_INSTANCE_TYPE (obj, mg_db_field_get_type ())
obj : |
#define MG_DB_FIELD_CLASS(klass) G_TYPE_CHECK_CLASS_CAST (klass, mg_db_field_get_type (), MgDbFieldClass)
klass : |
|
GObject* mg_db_field_new (MgConf *conf, MgServerDataType *type);
Creates a new MgDbField object
conf : | a MgConf object |
type : | a MgServerDataType object (the field's type) |
Returns : | the new object |
void mg_db_field_set_length (MgDbField *field, gint length);
field : | |
length : |
|
gint mg_db_field_get_length (MgDbField *field);
Get the length of a field.
field : | a MgDbField object |
Returns : | the size of the corresponding data type has a fixed size, or -1 |
gint mg_db_field_get_scale (MgDbField *field);
Get the scale of a field.
field : | a MgDbField object |
Returns : | the size of the corresponding data type has a fixed size, or -1 |
GSList* mg_db_field_get_constraints (MgDbField *field);
Get all the constraints which impact the given field. Constraints are of several type: NOT NULL, primary key, foreign key, check constrains
field : | a MgDbField object |
Returns : | a new list of MgDbConstraint objects |
void mg_db_field_set_data_type (MgDbField *field, MgServerDataType *type);
Sets the data type of the field
field : | a MgDbField object |
type : | a MgServerDataType object |
void mg_db_field_set_default_value (MgDbField *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).
field : | a MgDbField object |
value : | a GdaValue value or NULL |
const GdaValue* mg_db_field_get_default_value (MgDbField *field);
Get the default value for the field if ne exists
field : | a MgDbField object |
Returns : | the default value |
gboolean mg_db_field_is_null_allowed (MgDbField *field);
field : | |
Returns : |
|
void user_function (MgDbField *mgdbfield, gpointer user_data);
mgdbfield : | the object which received the signal. |
user_data : | user data set when the signal handler was connected. |
<<< MgDbTable | MgDbConstraint >>> |