GdaXmlDatabase 3 LIBGDA-COMMON Library GdaXmlDatabaseFunctions for managing a XML database file struct GdaXmlDatabasePrivate; GdaXmlDatabase* gda_xml_database_new (void); GdaXmlDatabase* gda_xml_database_new_from_file (const gchar *filename); void gda_xml_database_free (GdaXmlDatabase *xmldb); gboolean gda_xml_database_save (GdaXmlDatabase *xmldb, const gchar *filename); void gda_xml_database_changed (GdaXmlDatabase *xmldb); typedef GdaXmlDatabaseTable; GList* gda_xml_database_get_tables (GdaXmlDatabase *xmldb); GdaXmlDatabaseTable* gda_xml_database_table_new (GdaXmlDatabase *xmldb, const gchar *name); void gda_xml_database_table_remove (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table); GdaXmlDatabaseTable* gda_xml_database_table_find (GdaXmlDatabase *xmldb, const gchar *name); const gchar* gda_xml_database_table_get_name (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table); void gda_xml_database_table_set_name (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table, const gchar *name); const gchar* gda_xml_database_table_get_owner (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table); void gda_xml_database_table_set_owner (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table, const gchar *owner); typedef GdaXmlDatabaseField; gint gda_xml_database_table_field_count (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table); GdaXmlDatabaseField* gda_xml_database_table_add_field (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table, const gchar *fname); void gda_xml_database_table_remove_field (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table, const gchar *fname); GdaXmlDatabaseField* gda_xml_database_table_get_field (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table, gint pos); GdaXmlDatabaseField* gda_xml_database_table_find_field (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table, const gchar *fname); const gchar* gda_xml_database_field_get_name (GdaXmlDatabase *xmldb, GdaXmlDatabaseField *field); void gda_xml_database_field_set_name (GdaXmlDatabase *xmldb, GdaXmlDatabaseField *field, const gchar *name); const gchar* gda_xml_database_field_get_gdatype (GdaXmlDatabase *xmldb, GdaXmlDatabaseField *field); void gda_xml_database_field_set_gdatype (GdaXmlDatabase *xmldb, GdaXmlDatabaseField *field, const gchar *type); gint gda_xml_database_field_get_size (GdaXmlDatabase *xmldb, GdaXmlDatabaseField *field); void gda_xml_database_field_set_size (GdaXmlDatabase *xmldb, GdaXmlDatabaseField *field, gint size); gint gda_xml_database_field_get_scale (GdaXmlDatabase *xmldb, GdaXmlDatabaseField *field); void gda_xml_database_field_set_scale (GdaXmlDatabase *xmldb, GdaXmlDatabaseField *field, gint scale); GtkObject +----GdaXmlDocument +----GdaXmlDatabase "changed" void user_function (GdaXmlDatabase *gdaxmldatabase, gpointer user_data); The GdaXmlDatabase object provides a convenient way of managing the contents of a XML database file, that is, the files used by libgda for importing/exporting data between GDA data sources. The format being used for this file is XML, which provides a powerful way of describing a whole database (tables, views, etc), so that we can easily copy data from one data source to another, unrelated, one. Thus, this module provides the functions you need to programatically read and write this kind of files, so that you can yourself use the import/export features of libgda. struct GdaXmlDatabasePrivate; GdaXmlDatabase* gda_xml_database_new (void); Creates a new GdaXmlDatabase object, which can be used to describe a database which will then be loaded by a provider to create its defined structure Returns : GdaXmlDatabase* gda_xml_database_new_from_file (const gchar *filename); filename : Returns : void gda_xml_database_free (GdaXmlDatabase *xmldb); Destroys the given XML database xmldb : XML database gboolean gda_xml_database_save (GdaXmlDatabase *xmldb, const gchar *filename); xmldb : filename : Returns : void gda_xml_database_changed (GdaXmlDatabase *xmldb); Emit the "changed" signal for the given XML database xmldb : XML database typedef xmlNode GdaXmlDatabaseTable; GList* gda_xml_database_get_tables (GdaXmlDatabase *xmldb); xmldb : XML database Returns :a list with the names of all the tables that are present in the given GdaXmlDatabase object GdaXmlDatabaseTable* gda_xml_database_table_new (GdaXmlDatabase *xmldb, const gchar *name); Add a new table description to the given XML database. If tname already exists, this function fails. xmldb : XML database name : Returns : void gda_xml_database_table_remove (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table); xmldb : XML database table : the table to be removed GdaXmlDatabaseTable* gda_xml_database_table_find (GdaXmlDatabase *xmldb, const gchar *name); Looks for the specified table in a XML database xmldb : XML database name : Returns : const gchar* gda_xml_database_table_get_name (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table); xmldb : XML database table : table Returns : void gda_xml_database_table_set_name (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table, const gchar *name); xmldb : XML database table : table name : const gchar* gda_xml_database_table_get_owner (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table); xmldb : table : Returns : void gda_xml_database_table_set_owner (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table, const gchar *owner); xmldb : table : owner : typedef xmlNode GdaXmlDatabaseField; gint gda_xml_database_table_field_count (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table); xmldb : table : Returns : GdaXmlDatabaseField* gda_xml_database_table_add_field (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table, const gchar *fname); Add a new field to the given table xmldb : XML database table : table fname : field name Returns : void gda_xml_database_table_remove_field (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table, const gchar *fname); xmldb : table : fname : GdaXmlDatabaseField* gda_xml_database_table_get_field (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table, gint pos); xmldb : table : pos : Returns : GdaXmlDatabaseField* gda_xml_database_table_find_field (GdaXmlDatabase *xmldb, GdaXmlDatabaseTable *table, const gchar *fname); Look for the given field in the given table xmldb : XML database table : table fname : field name Returns : const gchar* gda_xml_database_field_get_name (GdaXmlDatabase *xmldb, GdaXmlDatabaseField *field); Return the name of the given field xmldb : XML database field : XML field node Returns : void gda_xml_database_field_set_name (GdaXmlDatabase *xmldb, GdaXmlDatabaseField *field, const gchar *name); xmldb : field : name : const gchar* gda_xml_database_field_get_gdatype (GdaXmlDatabase *xmldb, GdaXmlDatabaseField *field); xmldb : field : Returns : void gda_xml_database_field_set_gdatype (GdaXmlDatabase *xmldb, GdaXmlDatabaseField *field, const gchar *type); xmldb : field : type : gint gda_xml_database_field_get_size (GdaXmlDatabase *xmldb, GdaXmlDatabaseField *field); xmldb : field : Returns : void gda_xml_database_field_set_size (GdaXmlDatabase *xmldb, GdaXmlDatabaseField *field, gint size); xmldb : field : size : gint gda_xml_database_field_get_scale (GdaXmlDatabase *xmldb, GdaXmlDatabaseField *field); xmldb : field : Returns : void gda_xml_database_field_set_scale (GdaXmlDatabase *xmldb, GdaXmlDatabaseField *field, gint scale); xmldb : field : scale : void user_function (GdaXmlDatabase *gdaxmldatabase, gpointer user_data); gdaxmldatabase : the object which received the signal. user_data : user data set when the signal handler was connected.