/usr/include/libgda-5.0/libgda/gda-meta-store.h is in libgda-5.0-dev 5.2.4-9.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 | /*
* Copyright (C) 2008 Murray Cumming <murrayc@murrayc.com>
* Copyright (C) 2008 - 2012 Vivien Malerba <malerba@gnome-db.org>
* Copyright (C) 2012 Daniel Espinosa <despinosa@src.gnome.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GDA_META_STORE_H_
#define __GDA_META_STORE_H_
#include <glib-object.h>
#include <libgda/gda-enums.h>
#include <libgda/gda-data-model.h>
#include <libgda/gda-decl.h>
G_BEGIN_DECLS
#define GDA_TYPE_META_STORE (gda_meta_store_get_type())
#define GDA_META_STORE(obj) G_TYPE_CHECK_INSTANCE_CAST (obj, gda_meta_store_get_type(), GdaMetaStore)
#define GDA_META_STORE_CLASS(klass) G_TYPE_CHECK_CLASS_CAST (klass, gda_meta_store_get_type (), GdaMetaStoreClass)
#define GDA_IS_META_STORE(obj) G_TYPE_CHECK_INSTANCE_TYPE (obj, gda_meta_store_get_type ())
/* error reporting */
extern GQuark gda_meta_store_error_quark (void);
#define GDA_META_STORE_ERROR gda_meta_store_error_quark ()
typedef enum {
GDA_META_STORE_INCORRECT_SCHEMA_ERROR,
GDA_META_STORE_UNSUPPORTED_PROVIDER_ERROR,
GDA_META_STORE_INTERNAL_ERROR,
GDA_META_STORE_META_CONTEXT_ERROR,
GDA_META_STORE_MODIFY_CONTENTS_ERROR,
GDA_META_STORE_EXTRACT_SQL_ERROR,
GDA_META_STORE_ATTRIBUTE_NOT_FOUND_ERROR,
GDA_META_STORE_ATTRIBUTE_ERROR,
GDA_META_STORE_SCHEMA_OBJECT_NOT_FOUND_ERROR,
GDA_META_STORE_SCHEMA_OBJECT_CONFLICT_ERROR,
GDA_META_STORE_SCHEMA_OBJECT_DESCR_ERROR,
GDA_META_STORE_TRANSACTION_ALREADY_STARTED_ERROR
} GdaMetaStoreError;
/*
* tracking changes in the meta database
*/
typedef enum {
GDA_META_STORE_ADD,
GDA_META_STORE_REMOVE,
GDA_META_STORE_MODIFY
} GdaMetaStoreChangeType;
/**
* GdaMetaStoreChange:
* @c_type:
* @table_name:
* @keys: (element-type utf8 GObject.Value):
*/
typedef struct {
/* change general information */
GdaMetaStoreChangeType c_type;
gchar *table_name;
GHashTable *keys; /* key = ('+' or '-') and a column position in @table (string) starting at 0,
* value = a GValue pointer */
} GdaMetaStoreChange;
/* Pointer type for GdaMetaContext */
#define GDA_TYPE_META_CONTEXT (gda_meta_context_get_type())
/**
* GdaMetaContext:
* @table_name: the name of the table <emphasis>in the GdaMetaStore's internal database</emphasis>
* @size: the size of the @column_names and @column_values arrays
* @column_names: (array length=size) (transfer container): an array of column names (columns of the @table_name table)
* @column_values: (array length=size) (transfer container): an array of values, one for each column named in @column_names
* @columns: (element-type utf8 GObject.Value): A #GHashTable storing columns' name as key and #GValue as column's
* value.
*
* The <structname>GdaMetaContext</structname> represents a meta data modification
* context: the <emphasis>how</emphasis> when used with gda_meta_store_modify_with_context(),
* and the <emphasis>what</emphasis> when used with gda_connection_update_meta_store().
*
* To create a new #GdaMetaContext use #gda_meta_context_new.
*
* To add a new column/value pair use #gda_meta_context_add_column.
*
* To free a #GdaMetaContext, created by #gda_meta_context_new, use #gda_attributes_manager_free.
*
* Since 5.2, you must consider this struct as opaque. Any access to its internal must use public API.
* Don't try to use #gda_meta_context_free on a struct that was created manually.
*/
typedef struct {
gchar *table_name;
gint size;
gchar **column_names;
GValue **column_values;
GHashTable *columns;/* Added since 5.2 */
} GdaMetaContext;
/* struct for the object's data */
struct _GdaMetaStore
{
GObject object;
GdaMetaStorePrivate *priv;
};
/* struct for the object's class */
struct _GdaMetaStoreClass
{
GObjectClass parent_class;
GdaMetaStoreClassPrivate *cpriv;
/* signals the changes */
void (*meta_reset) (GdaMetaStore *store);
GError *(*suggest_update)(GdaMetaStore *store, GdaMetaContext *suggest);
void (*meta_changed) (GdaMetaStore *store, GSList *changes);
/*< private >*/
/* Padding for future expansion */
void (*_gda_reserved1) (void);
void (*_gda_reserved2) (void);
void (*_gda_reserved3) (void);
void (*_gda_reserved4) (void);
};
/**
* SECTION:gda-meta-store
* @short_description: Dictionary object
* @title: GdaMetaStore
* @stability: Stable
* @see_also: #GdaMetaStruct
*
* Previous versions of &LIBGDA; relied on an XML based file to store dictionary information, such as
* the database's schema (tables, views, etc) and various other information. The problems were that it was
* difficult for an application to integrate its own data into the dictionary and that there were some
* performances problems as the XML file needed to be parsed (and converted into its own in-memory structure)
* before any data could be read out of it.
*
* The new dictionary now relies on a database structure to store its data (see the
* <link linkend="information_schema">database schema</link> section for a detailed description). The actual database can be a
* single file (using an SQLite database), an entirely in memory database (also using an SQLite database), or
* a more conventional backend such as a PostgreSQL database for a shared dictionary on a server.
*
* The #GdaMetaStore object is thread safe.
*/
GType gda_meta_store_get_type (void) G_GNUC_CONST;
GdaMetaStore *gda_meta_store_new_with_file (const gchar *file_name);
GdaMetaStore *gda_meta_store_new (const gchar *cnc_string);
gint gda_meta_store_get_version (GdaMetaStore *store);
GdaConnection *gda_meta_store_get_internal_connection (GdaMetaStore *store);
gchar *gda_meta_store_sql_identifier_quote (const gchar *id, GdaConnection *cnc);
GdaDataModel *gda_meta_store_extract (GdaMetaStore *store, const gchar *select_sql, GError **error, ...);
GdaDataModel *gda_meta_store_extract_v (GdaMetaStore *store, const gchar *select_sql, GHashTable *vars,
GError **error);
gboolean gda_meta_store_modify (GdaMetaStore *store, const gchar *table_name,
GdaDataModel *new_data, const gchar *condition, GError **error, ...);
gboolean gda_meta_store_modify_v (GdaMetaStore *store, const gchar *table_name,
GdaDataModel *new_data, const gchar *condition,
gint nvalues, const gchar **value_names,
const GValue **values, GError **error);
gboolean gda_meta_store_modify_with_context (GdaMetaStore *store, GdaMetaContext *context,
GdaDataModel *new_data, GError **error);
GdaDataModel *gda_meta_store_create_modify_data_model (GdaMetaStore *store, const gchar *table_name);
void gda_meta_store_set_identifiers_style (GdaMetaStore *store, GdaSqlIdentifierStyle style);
void gda_meta_store_set_reserved_keywords_func(GdaMetaStore *store, GdaSqlReservedKeywordsFunc func);
gboolean gda_meta_store_get_attribute_value (GdaMetaStore *store, const gchar *att_name,
gchar **att_value, GError **error);
gboolean gda_meta_store_set_attribute_value (GdaMetaStore *store, const gchar *att_name,
const gchar *att_value, GError **error);
gboolean gda_meta_store_schema_add_custom_object (GdaMetaStore *store, const gchar *xml_description,
GError **error);
gboolean gda_meta_store_schema_remove_custom_object (GdaMetaStore *store, const gchar *obj_name, GError **error);
GSList *gda_meta_store_schema_get_all_tables (GdaMetaStore *store);
GSList *gda_meta_store_schema_get_depend_tables (GdaMetaStore *store, const gchar *table_name);
GdaMetaStruct *gda_meta_store_schema_get_structure (GdaMetaStore *store, GError **error);
gboolean gda_meta_store_declare_foreign_key (GdaMetaStore *store, GdaMetaStruct *mstruct,
const gchar *fk_name,
const gchar *catalog, const gchar *schema, const gchar *table,
const gchar *ref_catalog, const gchar *ref_schema, const gchar *ref_table,
guint nb_cols,
gchar **colnames, gchar **ref_colnames,
GError **error);
gboolean gda_meta_store_undeclare_foreign_key (GdaMetaStore *store, GdaMetaStruct *mstruct,
const gchar *fk_name,
const gchar *catalog, const gchar *schema, const gchar *table,
const gchar *ref_catalog, const gchar *ref_schema, const gchar *ref_table,
GError **error);
GType gda_meta_context_get_type (void) G_GNUC_CONST;
GdaMetaContext* gda_meta_context_new (void);
GdaMetaContext* gda_meta_context_copy (GdaMetaContext *ctx);
void gda_meta_context_set_table (GdaMetaContext *ctx, const gchar *table);
const gchar* gda_meta_context_get_table (GdaMetaContext *ctx);
void gda_meta_context_set_column (GdaMetaContext *ctx, const gchar* column,
const GValue* value, GdaConnection *cnc);
void gda_meta_context_set_columns (GdaMetaContext *ctx, GHashTable *columns,
GdaConnection *cnc);
void gda_meta_context_free (GdaMetaContext *ctx);
G_END_DECLS
#endif
|