gda_meta_struct_error_quark ()

GQuark
gda_meta_struct_error_quark (void);

GDA_META_DB_OBJECT()

#define GDA_META_DB_OBJECT(dbo) ((GdaMetaDbObject*)(dbo))

Casts dbo to a GdaMetaDbObject, no check is made on the validity of dbo

GDA_META_TABLE()

#define GDA_META_TABLE(dbobj) (&((dbobj)->extra.meta_table))

Casts dbo to a GdaMetaTable, no check is made on the validity of dbo

GDA_META_VIEW()

#define GDA_META_VIEW(dbobj) (&((dbobj)->extra.meta_view))

Casts dbo to a GdaMetaView, no check is made on the validity of dbo

GDA_META_TABLE_COLUMN()

#define GDA_META_TABLE_COLUMN(col) ((GdaMetaTableColumn*)(col))

Casts col to a GdaMetaTableColumn, no check is made

gda_meta_table_column_get_attribute ()

const GValue *
gda_meta_table_column_get_attribute (GdaMetaTableColumn *tcol,
                                     const gchar *attribute);

Get the value associated to a named attribute.

Attributes can have any name, but Libgda proposes some default names, see this section.

gda_meta_table_column_set_attribute ()

void
gda_meta_table_column_set_attribute (GdaMetaTableColumn *tcol,
                                     const gchar *attribute,
                                     const GValue *value,
                                     GDestroyNotify destroy);

Set the value associated to a named attribute.

Attributes can have any name, but Libgda proposes some default names, see this section. If there is already an attribute named attribute set, then its value is replaced with the new value , except if value is NULL, in which case the attribute is removed.

Warning: attribute is not copied, if it needs to be freed when not used anymore, then destroy should point to the functions which will free it (typically g_free()). If attribute does not need to be freed, then destroy can be NULL.

gda_meta_table_column_set_attribute_static()

#define gda_meta_table_column_set_attribute_static(column,attribute,value) gda_meta_table_column_set_attribute((column),(attribute),(value),NULL)

This function is similar to gda_meta_table_column_set_attribute() but for static strings

gda_meta_table_column_foreach_attribute ()

void
gda_meta_table_column_foreach_attribute
                               (GdaMetaTableColumn *tcol,
                                GdaAttributesManagerFunc func,
                                gpointer data);

Calls func for each attribute set to tcol

GDA_META_TABLE_FOREIGN_KEY()

#define GDA_META_TABLE_FOREIGN_KEY(fk) ((GdaMetaTableForeignKey*)(fk))

Casts fk to a GdaMetaTableForeignKey (no check is actuelly being done on fk 's validity)

GDA_META_TABLE_FOREIGN_KEY_ON_UPDATE_POLICY()

#define GDA_META_TABLE_FOREIGN_KEY_ON_UPDATE_POLICY(fk) (((GdaMetaTableForeignKey*)(fk))->on_update_policy)

Tells the actual policy implemented by fk when used in the context of an UPDATE.

GDA_META_TABLE_FOREIGN_KEY_ON_DELETE_POLICY()

#define GDA_META_TABLE_FOREIGN_KEY_ON_DELETE_POLICY(fk) (((GdaMetaTableForeignKey*)(fk))->on_delete_policy)

Tells the actual policy implemented by fk when used in the context of a DELETE.

gda_meta_struct_new ()

GdaMetaStruct *
gda_meta_struct_new (GdaMetaStore *store,
                     GdaMetaStructFeature features);

Creates a new GdaMetaStruct object. The features specifies the extra features which will also be computed: the more features, the more time it takes to run. Features such as table's columns, each column's attributes, etc are not optional and will always be computed.

gda_meta_struct_load_from_xml_file ()

gboolean
gda_meta_struct_load_from_xml_file (GdaMetaStruct *mstruct,
                                    const gchar *catalog,
                                    const gchar *schema,
                                    const gchar *xml_spec_file,
                                    GError **error);

Loads an XML description into mstruct . This method is still experimental and no description the XML file structure is given, and no guarantee that it will remain as it is given.

gda_meta_struct_complement ()

GdaMetaDbObject *
gda_meta_struct_complement (GdaMetaStruct *mstruct,
                            GdaMetaDbObjectType type,
                            const GValue *catalog,
                            const GValue *schema,
                            const GValue *name,
                            GError **error);

Creates a new GdaMetaDbObject structure in mstruct to represent the database object (of type type ) which can be uniquely identified as catalog .schema .name .

If catalog is not NULL, then schema should not be NULL.

If both catalog and schema are NULL, then the database object will be the one which is "visible" by default (that is which can be accessed only by its short name name).

If catalog is NULL and schema is not NULL, then the database object will be the one which can be accessed by its schema .name name.

Important note: catalog , schema and name will be used using the following convention:

For more information, see the meta data section about SQL identifiers.

gda_meta_struct_complement_schema ()

gboolean
gda_meta_struct_complement_schema (GdaMetaStruct *mstruct,
                                   const GValue *catalog,
                                   const GValue *schema,
                                   GError **error);

This method is similar to gda_meta_struct_complement() but creates GdaMetaDbObject for all the database object which are in the schema schema (and in the catalog catalog). If catalog is NULL, then any catalog will be used, and if schema is NULL then any schema will be used (if schema is NULL then catalog must also be NULL).

Please refer to gda_meta_struct_complement() form more information.

gda_meta_struct_complement_default ()

gboolean
gda_meta_struct_complement_default (GdaMetaStruct *mstruct,
                                    GError **error);

This method is similar to gda_meta_struct_complement() and gda_meta_struct_complement_all() but creates GdaMetaDbObject for all the database object which are usable using only their short name (that is which do not need to be prefixed by the schema in which they are to be used).

Please refer to gda_meta_struct_complement() form more information.

gda_meta_struct_complement_all ()

gboolean
gda_meta_struct_complement_all (GdaMetaStruct *mstruct,
                                GError **error);

This method is similar to gda_meta_struct_complement() and gda_meta_struct_complement_default() but creates GdaMetaDbObject for all the database object.

Please refer to gda_meta_struct_complement() form more information.

gda_meta_struct_complement_depend ()

gboolean
gda_meta_struct_complement_depend (GdaMetaStruct *mstruct,
                                   GdaMetaDbObject *dbo,
                                   GError **error);

This method is similar to gda_meta_struct_complement() but creates GdaMetaDbObject for all the dependencies of dbo .

Please refer to gda_meta_struct_complement() form more information.

gda_meta_struct_sort_db_objects ()

gboolean
gda_meta_struct_sort_db_objects (GdaMetaStruct *mstruct,
                                 GdaMetaSortType sort_type,
                                 GError **error);

Reorders the list of database objects within mstruct in a way specified by sort_type .

gda_meta_struct_get_all_db_objects ()

GSList *
gda_meta_struct_get_all_db_objects (GdaMetaStruct *mstruct);

Get a list of all the GdaMetaDbObject structures representing database objects in mstruct . Note that no GdaMetaDbObject structure must not be modified.

gda_meta_struct_get_db_object ()

GdaMetaDbObject *
gda_meta_struct_get_db_object (GdaMetaStruct *mstruct,
                               const GValue *catalog,
                               const GValue *schema,
                               const GValue *name);

Tries to locate the GdaMetaDbObject structure representing the database object named after catalog , schema and name .

If one or both of catalog and schema are NULL, and more than one database object matches the name, then the return value is also NULL.

gda_meta_struct_get_table_column ()

GdaMetaTableColumn *
gda_meta_struct_get_table_column (GdaMetaStruct *mstruct,
                                  GdaMetaTable *table,
                                  const GValue *col_name);

Tries to find the GdaMetaTableColumn representing the column named col_name in table .

gda_meta_struct_dump_as_graph ()

gchar *
gda_meta_struct_dump_as_graph (GdaMetaStruct *mstruct,
                               GdaMetaGraphInfo info,
                               GError **error);

Creates a new graph (in the GraphViz syntax) representation of mstruct .

GDA_META_STRUCT_ERROR

#define GDA_META_STRUCT_ERROR gda_meta_struct_error_quark ()

enum GdaMetaStructError

enum GdaMetaDbObjectType

Type of database object which can be handled as a GdaMetaDbObject

enum GdaMetaStructFeature

Controls which features are computed about database objects.

enum GdaMetaSortType

Types of sorting

GdaMetaTable

typedef struct {
	GSList       *columns;
	
	/* PK fields index */
	gint         *pk_cols_array;
	gint          pk_cols_nb;

	/* Foreign keys */
	GSList       *reverse_fk_list; /* list of GdaMetaTableForeignKey where @depend_on == this GdaMetaDbObject */
	GSList       *fk_list; /* list of GdaMetaTableForeignKey where @meta_table == this GdaMetaDbObject */
} GdaMetaTable;

This structure specifies a GdaMetaDbObject to represent a table's specific attributes, its contents must not be modified.

Note that in some cases, the columns cannot be determined for views, and in this case the columns will be NULL (this can be the case for example with SQLite where a view uses a function which is not natively provided by SQLite.

GdaMetaView

typedef struct {
	GdaMetaTable  table;
	gchar        *view_def;
	gboolean      is_updatable;
} GdaMetaView;

This structure specifies a GdaMetaDbObject to represent a view's specific attributes, its contents must not be modified.

GdaMetaDbObject

typedef struct {
	union {
		GdaMetaTable    meta_table;
		GdaMetaView     meta_view;
	}                       extra;
	GdaMetaDbObjectType     obj_type;
	gboolean                outdated;
	gchar                  *obj_catalog;
	gchar                  *obj_schema;
	gchar                  *obj_name;
	gchar                  *obj_short_name;
	gchar                  *obj_full_name;
	gchar                  *obj_owner;

	GSList                 *depend_list;
} GdaMetaDbObject;

Struture to hold information about each database object (tables, views, ...), its contents must not be modified.

Note: obj_catalog , obj_schema , obj_name , obj_short_name and obj_full_name respect the

GdaMetaStore objects. Before using these SQL identifiers, you should check the gda_sql_identifier_quote() to know if is it is necessary to surround by double quotes before using in an SQL statement.

GdaMetaTableColumn

typedef struct {
	gchar        *column_name;
	gchar        *column_type;
	GType         gtype;
	gboolean      pkey;
	gboolean      nullok;
	gchar        *default_value;
} GdaMetaTableColumn;

This structure represents a table of view's column, its contents must not be modified.

enum GdaMetaForeignKeyPolicy

Defines the filtering policy of a foreign key when invoked on an UPDATE or DELETE operation.

GdaMetaTableForeignKey

typedef struct {
	GdaMetaDbObject  *meta_table;
	GdaMetaDbObject  *depend_on;

	gint              cols_nb;	
	gint             *fk_cols_array; /* FK fields index */
	gchar           **fk_names_array; /* FK fields names */
	gint             *ref_pk_cols_array; /* Ref PK fields index */
	gchar           **ref_pk_names_array; /* Ref PK fields names */

	gchar            *fk_name;
} GdaMetaTableForeignKey;

This structure represents a foreign key constraint, its contents must not be modified.

enum GdaMetaGraphInfo

The “features” property

  “features”                 guint

Flags: Read / Write / Construct Only

Allowed values: <= G_MAXINT

Default value: 3

The “meta-store” property

  “meta-store”               GdaMetaStore *

GdaMetaStore object to fetch information from.

Flags: Read / Write / Construct Only