gda-decl

gda-decl

Functions

Properties

GdaConnection * connection Read / Write / Construct Only
gchar * id Read / Write
gchar * system-filename Read / Write
gchar * user-filename Read / Write
gchar * auth-string Read / Write
gchar * cnc-string Read / Write
gchar * dsn Read / Write
gint events-history-size Read / Write
guint execution-slowdown Read / Write
gboolean execution-timer Read / Write
GdaMetaStore * meta-store Read / Write
GdaConnectionOptions options Read / Write
GdaServerProvider * provider Read / Write
gint type Read / Write
gint current-row Read / Write
GdaDataModel * data-model Read / Write / Construct
GdaDataModel * forced-model Read / Write
gboolean update-model Read / Write
gboolean cache-changes Read / Write
gboolean defer-sync Read / Write
GdaDataModel * model Read / Write / Construct
gboolean prepend-null-entry Read / Write
gint sample-size Read / Write / Construct
gchar * description Read / Write
GdaHolder * full-bind Read / Write
GType * g-type Read / Write / Construct
gchar * id Read / Write
gchar * name Read / Write
gboolean not-null Read / Write
GdaHolder * simple-bind Read / Write
gint source-column Read / Write
GdaDataModel * source-model Read / Write
gboolean validate-changes Read / Write
gchar * catalog Write / Construct Only
GdaConnection * cnc Read / Write / Construct Only
gchar * cnc-string Write / Construct Only
gchar * schema Write / Construct Only
guint features Read / Write / Construct Only
GdaMetaStore * meta-store Read / Write / Construct Only
GdaStatement * statement Read / Write / Construct Only
GdaConnection * connection Read / Write / Construct Only
gint op-type Read / Write / Construct Only
GdaServerProvider * provider Read / Write / Construct Only
gchar * spec-filename Write / Construct Only
gchar * spec-resource Write / Construct Only
gchar * description Read / Write
gpointer holders Write / Construct Only
gchar * id Read / Write
gchar * name Read / Write
gboolean validate-changes Read / Write
gint column-error Read
gint line-error Read
gint mode Read / Write
gint tokenizer-flavour Read / Write
gpointer structure Read / Write
gboolean is-list Read
gpointer func Read / Write / Construct
gboolean recursive Read / Write / Construct
gchar * name Read / Write

Signals

void changed Run First
void g-type-changed Run Last
void name-changed Run Last
void dsn-added Run First
void dsn-changed Run First
void dsn-removed Run First
void dsn-to-be-removed Run First
void closed Run Last
void dsn-changed Run Last
void error Run Last
void opened Run First
void status-changed Run Last
void transaction-status-changed Run Last
void access-changed Run Last
void changed Run Last
void reset Run Last
void row-inserted Run Last
void row-removed Run Last
void row-updated Run Last
void end-of-data Run First
void row-changed Run First
void filter-changed Run First
void row-changes-applied Run First
void row-delete-changed Run First
void sample-changed Run First
void sample-size-changed Run First
GError* validate-row-changes Run Last
void attribute-changed Run First
void changed Run First
void source-changed Run First
GError* validate-change Run Last
void meta-changed Run First
void meta-reset Run First
GError* suggest-update Run Last
void sequence-item-added Run First
void sequence-item-remove Run First
void holder-attr-changed Run First
void holder-changed Run First
void holder-type-set Run First
void public-data-changed Run First
void source-model-changed Run First
GError* validate-holder-change Run Last
GError* validate-set Run Last
void checked Run First
void reset Run First
void node-changed Run Last
void node-deleted Run Last
void node-has-child-toggled Run Last
void node-inserted Run Last
void node-changed Run Last
void node-deleted Run Last
void node-has-child-toggled Run Last
void node-inserted Run Last

Object Hierarchy

    GBoxed
    ├── GdaSetGroup
    ├── GdaSetNode
    ╰── GdaSetSource
    GInterface
    ├── GdaDataHandler
    ╰── GdaDataModel
    GObject
    ├── GdaDataProxy
    ├── GdaHolder
    ├── GdaMetaStore
    ├── GdaMetaStruct
    ├── GdaRepetitiveStatement
    ├── GdaServerOperation
    ├── GdaServerProvider
       ╰── GdaSqliteProvider
    ├── GdaSet
       ├── GdaDataModelIter
       ╰── GdaDataModelIter
    ├── GdaBatch
    ├── GdaBlobOp
    ├── GdaColumn
    ├── GdaConfig
    ├── GdaConnection
       ╰── GdaVirtualConnection
    ├── GdaConnectionEvent
    ├── GdaSqlParser
    ├── GdaStatement
    ├── GdaTree
    ├── GdaTreeManager
       ├── GdaTreeMgrColumns
       ├── GdaTreeMgrLabel
       ├── GdaTreeMgrLdap
       ├── GdaTreeMgrSchemas
       ├── GdaTreeMgrSelect
       ╰── GdaTreeMgrTables
    ╰── GdaTreeNode

Prerequisites

GdaDataHandler requires GObject.

GdaDataModel requires GObject.

Implemented Interfaces

GdaConnection implements

GdaDataProxy implements GdaDataModel.

Known Implementations

GdaDataHandler is implemented by GdaHandlerBin, GdaHandlerBoolean, GdaHandlerNumerical, GdaHandlerString, GdaHandlerTime and GdaHandlerType.

GdaDataModel is implemented by GdaDataProxy.

Description

Functions

GdaSqlReservedKeywordsFunc ()

gboolean
(*GdaSqlReservedKeywordsFunc) (const gchar *word);

strtok_r()

#define strtok_r(s,d,p) strtok(s,d)

GSEAL()

#    define GSEAL(ident)      _g_sealed__ ## ident

Types and Values

GdaBatch

typedef struct _GdaBatch GdaBatch;

GdaBatchClass

typedef struct {
	GObjectClass     parent_class;

	/* signals */
	void   (*changed) (GdaBatch *batch, GdaStatement *changed_stmt);
} GdaBatchClass;

GdaBatchPrivate

typedef struct _GdaBatchPrivate GdaBatchPrivate;

GdaBlobOp

typedef struct _GdaBlobOp GdaBlobOp;

GdaBlobOpClass

typedef struct {
	GObjectClass parent_class;
	gpointer     functions;
} GdaBlobOpClass;

GdaColumn

typedef struct _GdaColumn GdaColumn;

GdaColumnClass

typedef struct {
	GObjectClass          parent_class;
	
	/* signals */
	void (* name_changed)   (GdaColumn *column, const gchar *old_name);
	void (* g_type_changed) (GdaColumn *column, GType old_type, GType new_type);
} GdaColumnClass;

GdaColumnPrivate

typedef struct _GdaColumnPrivate GdaColumnPrivate;

GdaConfig

typedef struct _GdaConfig GdaConfig;

GdaConfigClass

typedef struct {
	GObjectClass      object_class;

	/* signals */
	void   (*dsn_added)                 (GdaConfig *conf, GdaDsnInfo *new_dsn);
	void   (*dsn_to_be_removed)         (GdaConfig *conf, GdaDsnInfo *old_dsn);
	void   (*dsn_removed)               (GdaConfig *conf, GdaDsnInfo *old_dsn);
	void   (*dsn_changed)               (GdaConfig *conf, GdaDsnInfo *dsn);
} GdaConfigClass;

GdaConnection

typedef struct _GdaConnection GdaConnection;

GdaConnectionClass

typedef struct {
	GObjectClass          object_class;

	/* signals */
	void   (*status_changed)            (GdaConnection *obj, GdaConnectionStatus status);
	void   (*error)                     (GdaConnection *cnc, GdaConnectionEvent *error);
        void   (*opened)                    (GdaConnection *obj);
        void   (*closed)                    (GdaConnection *obj);
	void   (*dsn_changed)               (GdaConnection *obj);
	void   (*transaction_status_changed)(GdaConnection *obj);
} GdaConnectionClass;

GdaConnectionEvent

typedef struct _GdaConnectionEvent GdaConnectionEvent;

GdaConnectionEventClass

typedef struct {
	GObjectClass parent_class;
} GdaConnectionEventClass;

GdaConnectionEventPrivate

typedef struct _GdaConnectionEventPrivate GdaConnectionEventPrivate;

GdaConnectionPrivate

typedef struct _GdaConnectionPrivate GdaConnectionPrivate;

GdaDataHandler

typedef struct _GdaDataHandler GdaDataHandler;

GdaDataHandlerIface

typedef struct {
	GTypeInterface           g_iface;

	/* virtual table */
	gchar         *(* get_sql_from_value)   (GdaDataHandler *dh, const GValue *value);
	gchar         *(* get_str_from_value)   (GdaDataHandler *dh, const GValue *value);
	GValue        *(* get_value_from_sql)   (GdaDataHandler *dh, const gchar *sql, GType type);
	GValue        *(* get_value_from_str)   (GdaDataHandler *dh, const gchar *str, GType type);
	GValue        *(* get_sane_init_value)  (GdaDataHandler *dh, GType type);

	gboolean       (* accepts_g_type)       (GdaDataHandler *dh, GType type);
	const gchar   *(* get_descr)            (GdaDataHandler *dh);
} GdaDataHandlerIface;

GdaDataModel

typedef struct _GdaDataModel GdaDataModel;

GdaDataModelIface

typedef struct {
	GTypeInterface           g_iface;

	/* virtual table */
	gint                 (* i_get_n_rows)       (GdaDataModel *model);
	gint                 (* i_get_n_columns)    (GdaDataModel *model);

	GdaColumn           *(* i_describe_column)  (GdaDataModel *model, gint col);
	GdaDataModelAccessFlags (* i_get_access_flags) (GdaDataModel *model);

	const GValue        *(* i_get_value_at)     (GdaDataModel *model, gint col, gint row, GError **error);
	GdaValueAttribute    (* i_get_attributes_at)(GdaDataModel *model, gint col, gint row);
	GdaDataModelIter    *(* i_create_iter)      (GdaDataModel *model);
	gboolean             (* i_iter_at_row)      (GdaDataModel *model, GdaDataModelIter *iter, gint row);
	gboolean             (* i_iter_next)        (GdaDataModel *model, GdaDataModelIter *iter); 
	gboolean             (* i_iter_prev)        (GdaDataModel *model, GdaDataModelIter *iter);

	gboolean             (* i_set_value_at)     (GdaDataModel *model, gint col, gint row, 
						     const GValue *value, GError **error);
	gboolean             (* i_iter_set_value)   (GdaDataModel *model, GdaDataModelIter *iter, gint col,
						     const GValue *value, GError **error);
	gboolean             (* i_set_values)       (GdaDataModel *model, gint row, GList *values,
						     GError **error);
	gint                 (* i_append_values)    (GdaDataModel *model, const GList *values, GError **error);
	gint                 (* i_append_row)       (GdaDataModel *model, GError **error);
	gboolean             (* i_remove_row)       (GdaDataModel *model, gint row, GError **error);
	gint                 (* i_find_row)         (GdaDataModel *model, GSList *values, gint *cols_index);

	void                 (* i_set_notify)       (GdaDataModel *model, gboolean do_notify_changes);
	gboolean             (* i_get_notify)       (GdaDataModel *model);
	void                 (* i_send_hint)        (GdaDataModel *model, GdaDataModelHint hint, const GValue *hint_value);

	/* signals */
	void                 (* row_inserted)       (GdaDataModel *model, gint row);
	void                 (* row_updated)        (GdaDataModel *model, gint row);
	void                 (* row_removed)        (GdaDataModel *model, gint row);
	void                 (* changed)            (GdaDataModel *model);
	void                 (* reset)              (GdaDataModel *model);
	void                 (* access_changed)     (GdaDataModel *model);

	/* getting more information about a data model */
	GError             **(* i_get_exceptions)   (GdaDataModel *model);
} GdaDataModelIface;

GdaDataModelIter

typedef struct _GdaDataModelIter GdaDataModelIter;

GdaDataModelIterClass

typedef struct {
	GdaSetClass                parent_class;

	void                    (* row_changed)      (GdaDataModelIter *iter, gint row);
	void                    (* end_of_data)      (GdaDataModelIter *iter);
} GdaDataModelIterClass;

GdaDataModelIterPrivate

typedef struct _GdaDataModelIterPrivate GdaDataModelIterPrivate;

GdaDataProxy

typedef struct _GdaDataProxy GdaDataProxy;

GdaDataProxyClass

typedef struct {
	GObjectClass            parent_class;

	void                 (* row_delete_changed)   (GdaDataProxy *proxy, gint row, gboolean to_be_deleted);

	void                 (* sample_size_changed)  (GdaDataProxy *proxy, gint sample_size);
	void                 (* sample_changed)       (GdaDataProxy *proxy, gint sample_start, gint sample_end);

	GError              *(* validate_row_changes) (GdaDataProxy *proxy, gint row, gint proxied_row);
	void                 (* row_changes_applied)  (GdaDataProxy *proxy, gint row, gint proxied_row);

	void                 (* filter_changed)       (GdaDataProxy *proxy);
} GdaDataProxyClass;

GdaDataProxyPrivate

typedef struct _GdaDataProxyPrivate GdaDataProxyPrivate;

GdaHolder

typedef struct _GdaHolder GdaHolder;

GdaHolderClass

typedef struct {
	GObjectClass               parent_class;
	void                     (*changed)          (GdaHolder *holder);
	void                     (*source_changed)   (GdaHolder *holder);
	GError                  *(*validate_change)  (GdaHolder *holder, const GValue *new_value);
	void                     (*att_changed)      (GdaHolder *holder, const gchar *att_name, const GValue *att_value);
} GdaHolderClass;

GdaHolderPrivate

typedef struct _GdaHolderPrivate GdaHolderPrivate;

GdaMetaStore

typedef struct _GdaMetaStore GdaMetaStore;

GdaMetaStoreClass

typedef struct {
	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);
} GdaMetaStoreClass;

GdaMetaStoreClassPrivate

typedef struct _GdaMetaStoreClassPrivate GdaMetaStoreClassPrivate;

GdaMetaStorePrivate

typedef struct _GdaMetaStorePrivate GdaMetaStorePrivate;

GdaMetaStruct

typedef struct _GdaMetaStruct GdaMetaStruct;

GdaMetaStructClass

typedef struct {
	GObjectClass              parent_class;
} GdaMetaStructClass;

GdaMetaStructPrivate

typedef struct _GdaMetaStructPrivate GdaMetaStructPrivate;

GdaRepetitiveStatement

typedef struct _GdaRepetitiveStatement GdaRepetitiveStatement;

GdaRepetitiveStatementClass

typedef struct {
	GObjectClass parent_class;
} GdaRepetitiveStatementClass;

GdaServerOperation

typedef struct _GdaServerOperation GdaServerOperation;

GdaServerOperationClass

typedef struct {
	GObjectClass               parent_class;

	/* signals */
	void                     (*seq_item_added) (GdaServerOperation *op, const gchar *seq_path, gint item_index);
	void                     (*seq_item_remove) (GdaServerOperation *op, const gchar *seq_path, gint item_index);
} GdaServerOperationClass;

GdaServerOperationPrivate

typedef struct _GdaServerOperationPrivate GdaServerOperationPrivate;

GdaServerProvider

typedef struct _GdaServerProvider GdaServerProvider;

GdaServerProviderClass

typedef struct {
	GObjectClass parent_class;
	gpointer     functions_sets[8];
} GdaServerProviderClass;

GdaServerProviderInfo

typedef struct _GdaServerProviderInfo GdaServerProviderInfo;

GdaServerProviderPrivate

typedef struct {
	GHashTable    *data_handlers; /* key = a GdaServerProviderHandlerInfo pointer, value = a GdaDataHandler */
	GdaSqlParser  *parser;

	GHashTable    *jobs_hash; /* key = a job ID, value = a # */
} GdaServerProviderPrivate;

GdaSet

typedef struct _GdaSet GdaSet;

GdaSetClass

typedef struct {
	GObjectClass            parent_class;

	GError               *(*validate_holder_change)(GdaSet *set, GdaHolder *holder, const GValue *new_value);
	GError               *(*validate_set)          (GdaSet *set);
	void                  (*holder_changed)        (GdaSet *set, GdaHolder *holder);
	void                  (*holder_attr_changed)   (GdaSet *set, GdaHolder *holder, 
							const gchar *attr_name, const GValue *attr_value);
	void                  (*public_data_changed)   (GdaSet *set);
	void                  (*holder_type_set)       (GdaSet *set, GdaHolder *holder);
	void                  (*source_model_changed)  (GdaSet *set, GdaSetSource *source);
} GdaSetClass;

GdaSetGroup

typedef struct _GdaSetGroup GdaSetGroup;

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_set_group_free on a struct that was created manually.

Members


GdaSetNode

typedef struct _GdaSetNode GdaSetNode;

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_set_node_free on a struct that was created manually.

Members


GdaSetPrivate

typedef struct _GdaSetPrivate GdaSetPrivate;

GdaSetSource

typedef struct _GdaSetSource GdaSetSource;

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_set_source_free on a struct that was created manually.

Members


GdaSqlParser

typedef struct _GdaSqlParser GdaSqlParser;

GdaSqlParserClass

typedef struct {
	GObjectClass         parent_class;

	/* virtual methods and data for sub classed parsers */
	void *(*delim_alloc) (void *(*f) (size_t s));
	void (*delim_free) (void  *d, void(*f) (void *d));
	void (*delim_trace) (void *d, char *s);
	void (*delim_parse) (void *d, int i, GValue *v, GdaSqlParserIface *iface);
	gint *delim_tokens_trans;
	
	void *(*parser_alloc) (void *(*f)(size_t s));
	void (*parser_free) (void *p, void(*f)(void *p));
	void (*parser_trace) (void *p, char *s);
	void (*parser_parse) (void *p, int i, GValue *v, GdaSqlParserIface *iface);
	gint *parser_tokens_trans;
} GdaSqlParserClass;

GdaSqlParserPrivate

typedef struct {
	GRecMutex  mutex;
	gchar     *sql;
	GSList    *parsed_statements;

	/* parser */
	void     *lemon_delimiter;
	void     *lemon_parser;
	GArray   *passed_tokens; /* array of token types (gint), spaces omitted, which have been given to the parser */

	/* tokenizer contexts */
	TokenizerContext *context;
	GSList           *pushed_contexts;

        /* error reporting */
	GdaSqlParserError  error_type;
        gchar             *error_msg;
        gint               error_line; /* (starts at 1) */
        gint               error_col; /* (starts at 1) */
        gint               error_pos; /* absolute count from start of message (starts at 1) */

        /* modes */
        GdaSqlParserMode     mode;
	GdaSqlParserFlavour flavour;

	/* Padding for future expansion */
	gpointer _gda_reserved1;
	gpointer _gda_reserved2;
} GdaSqlParserPrivate;

GdaStatement

typedef struct _GdaStatement GdaStatement;

GdaStatementClass

typedef struct {
	GObjectClass         parent_class;

	/* signals */
	void   (*checked)   (GdaStatement *stmt, GdaConnection *cnc, gboolean checked);
	void   (*reset)     (GdaStatement *stmt);
} GdaStatementClass;

GdaStatementPrivate

typedef struct _GdaStatementPrivate GdaStatementPrivate;

GdaTree

typedef struct _GdaTree GdaTree;

GdaTreeClass

typedef struct {
	GObjectClass      object_class;

	/* signals */
	void         (* node_changed)           (GdaTree *tree, GdaTreeNode *node);
	void         (* node_inserted)          (GdaTree *tree, GdaTreeNode *node);
	void         (* node_has_child_toggled) (GdaTree *tree, GdaTreeNode *node);
	void         (* node_deleted)           (GdaTree *tree, const gchar *node_path);
} GdaTreeClass;

GdaTreeManager

typedef struct _GdaTreeManager GdaTreeManager;

GdaTreeManagerClass

typedef struct {
	GObjectClass       parent_class;

	/* virtual methods */
	/**
	 * GdaTreeManager::update_children:
	 *
	 * Returns: NULL if an error occurred, and @out_error is set to TRUE
	 */
	GSList *(*update_children) (GdaTreeManager *manager, GdaTreeNode *node,
				    const GSList *children_nodes,
				    gboolean *out_error, GError **error);
} GdaTreeManagerClass;

GdaTreeNode

typedef struct _GdaTreeNode GdaTreeNode;

GdaTreeNodeClass

typedef struct {
	GObjectClass        object_class;

	/* signals */
	void         (* node_changed)           (GdaTreeNode *reporting, GdaTreeNode *node);
	void         (* node_inserted)          (GdaTreeNode *reporting, GdaTreeNode *node);
	void         (* node_has_child_toggled) (GdaTreeNode *reporting, GdaTreeNode *node);
	void         (* node_deleted)           (GdaTreeNode *reporting, const gchar *relative_path);

	/* virtual methods */
	gchar              *(*dump_header) (GdaTreeNode *node);
	void                (*dump_children) (GdaTreeNode *node, const gchar *prefix, GString *in_string);
} GdaTreeNodeClass;

GdaTreeNodePrivate

typedef struct _GdaTreeNodePrivate GdaTreeNodePrivate;

GdaTreePrivate

typedef struct _GdaTreePrivate GdaTreePrivate;

Property Details

The “connection” property

  “connection”               GdaConnection *

Connection used to fetch and write data.

Flags: Read / Write / Construct Only


The “id” property

  “id”                       gchar *

Column's Id (warning: the column's ID is not guaranteed to be unique in a GdaDataModel).

Flags: Read / Write

Default value: NULL


The “system-filename” property

  “system-filename”          gchar *

File to use for system-wide DSN list. When changed, the whole list of DSN will be reloaded.

Flags: Read / Write

Default value: NULL


The “user-filename” property

  “user-filename”            gchar *

File to use for per-user DSN list. When changed, the whole list of DSN will be reloaded.

Flags: Read / Write

Default value: NULL


The “auth-string” property

  “auth-string”              gchar *

Authentication string to use.

Flags: Read / Write

Default value: NULL


The “cnc-string” property

  “cnc-string”               gchar *

Connection string to use.

Flags: Read / Write

Default value: NULL


The “dsn” property

  “dsn”                      gchar *

DSN to use.

Flags: Read / Write

Default value: NULL


The “events-history-size” property

  “events-history-size”      gint

Defines the number of GdaConnectionEvent objects kept in memory which can be fetched using gda_connection_get_events().

Flags: Read / Write

Allowed values: >= 5

Default value: 5

Since: 4.2


The “execution-slowdown” property

  “execution-slowdown”       guint

Artificially slows down the execution of queries. This property can be used to debug some problems. If non zero, this value is the number of microseconds waited before actually executing each query. NB: this parameter is ignored during the meta store update (it is set to 0 before the meta data update and restored to its state after).

Flags: Read / Write

Default value: 0

Since: 5.2.0


The “execution-timer” property

  “execution-timer”          gboolean

Computes execution times for each statement executed.

Flags: Read / Write

Default value: FALSE

Since: 4.2.9


The “meta-store” property

  “meta-store”               GdaMetaStore *

GdaMetaStore used by the connection.

Flags: Read / Write


The “options” property

  “options”                  GdaConnectionOptions

Options.

Flags: Read / Write


The “provider” property

  “provider”                 GdaServerProvider *

Provider to use.

Flags: Read / Write


The “type” property

  “type”                     gint

Connection event type.

Flags: Read / Write

Allowed values: [0,3]

Default value: 2


The “current-row” property

  “current-row”              gint

Current represented row in the data model.

Flags: Read / Write

Allowed values: >= -1

Default value: -1


The “data-model” property

  “data-model”               GdaDataModel *

Data model for which the iter is for.

Flags: Read / Write / Construct


The “forced-model” property

  “forced-model”             GdaDataModel *

Overrides the data model the iter is attached to (reserved for internal usage).

Flags: Read / Write


The “update-model” property

  “update-model”             gboolean

Flags: Read / Write

Default value: TRUE


The “cache-changes” property

  “cache-changes”            gboolean

Defines how changes kept in the data proxy are handled when the proxied data model is changed (using the "model" property). The default is to silently discard all the changes, but if this property is set to TRUE, then the changes are cached.

If set to TRUE, each cached change will be re-applied to a newly set proxied data model if the change's number of columns match the proxied data model's number of columns and based on:

  • the contents of the proxied data model's modified row for updates and deletes

  • the inserts are always kept

Flags: Read / Write

Default value: FALSE

Since: 5.2


The “defer-sync” property

  “defer-sync”               gboolean

Tells if changes to the sample of rows displayed is done in background in several steps or if it's done in one step.

Flags: Read / Write

Default value: TRUE


The “model” property

  “model”                    GdaDataModel *

Proxied data model.

Flags: Read / Write / Construct


The “prepend-null-entry” property

  “prepend-null-entry”       gboolean

Tells if a row composed of NULL values is inserted as the proxy's first row.

Flags: Read / Write

Default value: FALSE


The “sample-size” property

  “sample-size”              gint

Number of rows which the proxy will contain at any time, like a sliding window on the proxied data model.

Flags: Read / Write / Construct

Allowed values: [0,2147483646]

Default value: 300


The “description” property

  “description”              gchar *

Holder's description.

Flags: Read / Write

Default value: NULL


The “full-bind” property

  “full-bind”                GdaHolder *

Make value holder follow other GdaHolder's changes and the other way around.

Flags: Read / Write


The “g-type” property

  “g-type”                   GType *

Holder's GType.

Flags: Read / Write / Construct

Allowed values: void


The “id” property

  “id”                       gchar *

Holder's ID.

Flags: Read / Write

Default value: NULL


The “name” property

  “name”                     gchar *

Holder's name.

Flags: Read / Write

Default value: NULL


The “not-null” property

  “not-null”                 gboolean

Can the value holder be NULL?.

Flags: Read / Write

Default value: FALSE


The “simple-bind” property

  “simple-bind”              GdaHolder *

Make value holder follow other GdaHolder's changes.

Flags: Read / Write


The “source-column” property

  “source-column”            gint

Column number to use in coordination with the source-model property.

Flags: Read / Write

Allowed values: >= 0

Default value: 0


The “source-model” property

  “source-model”             GdaDataModel *

Data model among which the holder's value should be.

Flags: Read / Write


The “validate-changes” property

  “validate-changes”         gboolean

Defines if the "validate-change" signal gets emitted when the holder's value changes.

Flags: Read / Write

Default value: TRUE

Since: 5.2.0


The “catalog” property

  “catalog”                  gchar *

Catalog in which the database objects will be created.

Flags: Write / Construct Only

Default value: NULL


The “cnc” property

  “cnc”                      GdaConnection *

Connection object internally used.

Flags: Read / Write / Construct Only


The “cnc-string” property

  “cnc-string”               gchar *

Connection string for the internal connection to use.

Flags: Write / Construct Only

Default value: NULL


The “schema” property

  “schema”                   gchar *

Schema in which the database objects will be created.

Flags: Write / Construct Only

Default value: NULL


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


The “statement” property

  “statement”                GdaStatement *

Statement to Execute.

Flags: Read / Write / Construct Only


The “connection” property

  “connection”               GdaConnection *

Connection to use.

Flags: Read / Write / Construct Only


The “op-type” property

  “op-type”                  gint

Type of operation to be done.

Flags: Read / Write / Construct Only

Allowed values: [0,15]

Default value: 0


The “provider” property

  “provider”                 GdaServerProvider *

Database provider which created the object.

Flags: Read / Write / Construct Only


The “spec-filename” property

  “spec-filename”            gchar *

XML file which contains the object's data structure.

Flags: Write / Construct Only

Default value: NULL


The “spec-resource” property

  “spec-resource”            gchar *

Name of the resource which contains the XML data representing the object's data structure.

Flags: Write / Construct Only

Default value: NULL


The “description” property

  “description”              gchar *

Description.

Flags: Read / Write

Default value: NULL


The “holders” property

  “holders”                  gpointer

GdaHolder objects the set should contain.

Flags: Write / Construct Only


The “id” property

  “id”                       gchar *

Id.

Flags: Read / Write

Default value: NULL


The “name” property

  “name”                     gchar *

Name.

Flags: Read / Write

Default value: NULL


The “validate-changes” property

  “validate-changes”         gboolean

Defines if the "validate-set" signal gets emitted when any holder in the data set changes. This property also affects the GdaHolder:validate-changes property.

Flags: Read / Write

Default value: TRUE

Since: 5.2.0


The “column-error” property

  “column-error”             gint

Flags: Read

Allowed values: >= 0

Default value: 0


The “line-error” property

  “line-error”               gint

Flags: Read

Allowed values: >= 0

Default value: 0


The “mode” property

  “mode”                     gint

Flags: Read / Write

Allowed values: [0,1]

Default value: 0


The “tokenizer-flavour” property

  “tokenizer-flavour”        gint

Flags: Read / Write

Allowed values: [0,4]

Default value: 0


The “structure” property

  “structure”                gpointer

Flags: Read / Write


The “is-list” property

  “is-list”                  gboolean

Tells if the GdaTree is a list or a tree.

Flags: Read

Default value: FALSE


The “func” property

  “func”                     gpointer

This property specifies the function which needs to be called when the list of GdaTreeNode nodes managed has to be updated

[type GdaTreeManagerNodesFunc]

Flags: Read / Write / Construct


The “recursive” property

  “recursive”                gboolean

This property specifies if, when initially creating nodes or updating the list of nodes, the tree manager shoud also request that each node it has created or updated also initially create or update their children.

This property can typically set to FALSE if the process of creating children nodes is lenghty and needs to be postponed while an event occurs.

Flags: Read / Write / Construct

Default value: TRUE


The “name” property

  “name”                     gchar *

Node's name attribute.

Flags: Read / Write

Default value: NULL

Signal Details

The “changed” signal

void
user_function (GdaBatch *batch,
               GObject  *changed_stmt,
               gpointer  user_data)

Gets emitted whenever a GdaStatement in the batch object changes

Parameters

batch

the GdaBatch object

 

changed_stmt

the statement which has been changed

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “g-type-changed” signal

void
user_function (GdaColumn *column,
               GType     *old_type,
               GType     *new_type,
               gpointer   user_data)

Gets emitted whenever column 's type has been changed

Parameters

column

the GdaColumn object

 

old_type

the column's previous type

 

new_type

the column's new type

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “name-changed” signal

void
user_function (GdaColumn *column,
               gchar     *old_name,
               gpointer   user_data)

Gets emitted whenever column 's name has been changed

Parameters

column

the GdaColumn object

 

old_name

the column's previous name

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “dsn-added” signal

void
user_function (GdaConfig *conf,
               gpointer   new_dsn,
               gpointer   user_data)

Gets emitted whenever a new DSN has been defined

Parameters

conf

the GdaConfig object

 

new_dsn

a GdaDsnInfo

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “dsn-changed” signal

void
user_function (GdaConfig *conf,
               gpointer   dsn,
               gpointer   user_data)

Gets emitted whenever a DSN's definition has been changed

Parameters

conf

the GdaConfig object

 

dsn

a GdaDsnInfo

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “dsn-removed” signal

void
user_function (GdaConfig *conf,
               gpointer   old_dsn,
               gpointer   user_data)

Gets emitted whenever a DSN has been removed

Parameters

conf

the GdaConfig object

 

old_dsn

a GdaDsnInfo

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “dsn-to-be-removed” signal

void
user_function (GdaConfig *conf,
               gpointer   old_dsn,
               gpointer   user_data)

Gets emitted whenever a DSN is about to be removed

Parameters

conf

the GdaConfig object

 

old_dsn

a GdaDsnInfo

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “closed” signal

void
user_function (GdaConnection *cnc,
               gpointer       user_data)

Gets emitted when the connection to the database has been closed

Parameters

cnc

the GdaConnection

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “dsn-changed” signal

void
user_function (GdaConnection *cnc,
               gpointer       user_data)

Gets emitted when the DSN used by cnc has been changed

Parameters

cnc

the GdaConnection

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “error” signal

void
user_function (GdaConnection      *cnc,
               GdaConnectionEvent *event,
               gpointer            user_data)

Gets emitted whenever a connection event occurs. Check the nature of event to see if it's an error or a simple notification

Parameters

cnc

the GdaConnection

 

event

a GdaConnectionEvent object

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “opened” signal

void
user_function (GdaConnection *cnc,
               gpointer       user_data)

Gets emitted when the connection has been opened to the database

Parameters

cnc

the GdaConnection

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “status-changed” signal

void
user_function (GdaConnection      *cnc,
               GdaConnectionStatus status,
               gpointer            user_data)

Gets emitted when the cnc 's status has changed (usually when a the connection is being used to execute a statement)

Parameters

cnc

the GdaConnection

 

status

the new connection status.

[type GdaConnectionStatus]

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 6.0


The “transaction-status-changed” signal

void
user_function (GdaConnection *cnc,
               gpointer       user_data)

Gets emitted when the transaction status of cnc has changed (a transaction has been started, rolled back, a savepoint added,...)

Parameters

cnc

the GdaConnection

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “access-changed” signal

void
user_function (GdaDataModel *model,
               gpointer      user_data)

Gets emitted when model 's access flags have changed. Use gda_data_model_get_access_flags() to get the access flags.

Parameters

model

the GdaDataModel

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “changed” signal

void
user_function (GdaDataModel *model,
               gpointer      user_data)

Gets emitted when any value in model has been changed

Parameters

model

the GdaDataModel

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “reset” signal

void
user_function (GdaDataModel *model,
               gpointer      user_data)

Gets emitted when model 's contents has been completely reset (the number and type of columns may also have changed)

Parameters

model

the GdaDataModel

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “row-inserted” signal

void
user_function (GdaDataModel *model,
               gint          row,
               gpointer      user_data)

Gets emitted when a row has been inserted in model

Parameters

model

the GdaDataModel

 

row

the row number

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “row-removed” signal

void
user_function (GdaDataModel *model,
               gint          row,
               gpointer      user_data)

Gets emitted when a row has been removed from model

Parameters

model

the GdaDataModel

 

row

the row number

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “row-updated” signal

void
user_function (GdaDataModel *model,
               gint          row,
               gpointer      user_data)

Gets emitted when a row has been modified in model

Parameters

model

the GdaDataModel

 

row

the row number

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “end-of-data” signal

void
user_function (GdaDataModelIter *iter,
               gpointer          user_data)

Gets emitted when iter has reached the end of available data (which means the previous row it was on was the last one).

Parameters

iter

the GdaDataModelIter

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “row-changed” signal

void
user_function (GdaDataModelIter *iter,
               gint              row,
               gpointer          user_data)

Gets emitted when the row iter is currently pointing has changed

Parameters

iter

the GdaDataModelIter

 

row

the new iter's row

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “filter-changed” signal

void
user_function (GdaDataProxy *proxy,
               gpointer      user_data)

Gets emitted when proxy 's filter has been changed

Parameters

proxy

the GdaDataProxy

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “row-changes-applied” signal

void
user_function (GdaDataProxy *proxy,
               gint          row,
               gint          proxied_row,
               gpointer      user_data)

Gets emitted when proxy has committed a row change to the proxied data model.

Parameters

proxy

the GdaDataProxy

 

row

the proxy's row

 

proxied_row

the proxied data model's row

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “row-delete-changed” signal

void
user_function (GdaDataProxy *proxy,
               gint          row,
               gboolean      to_be_deleted,
               gpointer      user_data)

Gets emitted whenever a row has been marked to be deleted, or has been unmarked to be deleted

Parameters

proxy

the GdaDataProxy

 

row

the concerned proxy 's row

 

to_be_deleted

tells if the row is marked to be deleted

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “sample-changed” signal

void
user_function (GdaDataProxy *proxy,
               gint          sample_start,
               gint          sample_end,
               gpointer      user_data)

Gets emitted whenever proxy 's sample size has been changed. sample_start and sample_end are in reference to the proxied data model.

Parameters

proxy

the GdaDataProxy

 

sample_start

the first row of the sample

 

sample_end

the last row of the sample

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “sample-size-changed” signal

void
user_function (GdaDataProxy *proxy,
               gint          sample_size,
               gpointer      user_data)

Gets emitted whenever proxy 's sample size has been changed

Parameters

proxy

the GdaDataProxy

 

sample_size

the new sample size

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “validate-row-changes” signal

GError*
user_function (GdaDataProxy *proxy,
               gint          row,
               gint          proxied_row,
               gpointer      user_data)

Gets emitted when proxy is about to commit a row change to the proxied data model. If any callback returns a non NULL value, then the change commit fails with the returned GError

Parameters

proxy

the GdaDataProxy

 

row

the proxy's row

 

proxied_row

the proxied data model's row

 

user_data

user data set when the signal handler was connected.

 

Returns

a new GError if validation failed, or NULL

Flags: Run Last


The “attribute-changed” signal

void
user_function (GdaHolder *holder,
               gchar     *att_name,
               GValue    *att_value,
               gpointer   user_data)

Gets emitted when any holder 's attribute has changed

Parameters

holder

the GdaHolder

 

att_name

attribute's name

 

att_value

attribute's value

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “changed” signal

void
user_function (GdaHolder *holder,
               gpointer   user_data)

Gets emitted when holder 's value has changed

Parameters

holder

the GdaHolder

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “source-changed” signal

void
user_function (GdaHolder *holder,
               gpointer   user_data)

Gets emitted when the data model in which holder 's values should be has changed

Parameters

holder

the GdaHolder

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “validate-change” signal

GError*
user_function (GdaHolder *holder,
               GValue    *new_value,
               gpointer   user_data)

Gets emitted when holder is going to change its value. One can connect to this signal to control which values holder can have (for example to implement some business rules)

Parameters

holder

the object which received the signal

 

new_value

the proposed new value for holder

 

user_data

user data set when the signal handler was connected.

 

Returns

NULL if holder is allowed to change its value to new_value , or a GError otherwise.

Flags: Run Last


The “meta-changed” signal

void
user_function (GdaMetaStore *store,
               gpointer      changes,
               gpointer      user_data)

This signal is emitted when the store 's contents have changed (the changes are in the changes list)

Parameters

store

the GdaMetaStore instance that emitted the signal

 

changes

a list of changes made, as a GSList of pointers to GdaMetaStoreChange (which must not be modified).

[type GLib.SList][element-type Gda.MetaStoreChange]

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “meta-reset” signal

void
user_function (GdaMetaStore *store,
               gpointer      user_data)

This signal is emitted when the store 's contents have been reset completely and when no detailed changes are available

Parameters

store

the GdaMetaStore instance that emitted the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “suggest-update” signal

GError*
user_function (GdaMetaStore *store,
               gpointer      suggest,
               gpointer      user_data)

This signal is emitted when the contents of a table should be updated (data to update or insert only; deleting data is done automatically). This signal is used for internal purposes by the GdaConnection object.

Parameters

store

the GdaMetaStore instance that emitted the signal

 

suggest

the suggested update, as a GdaMetaContext structure.

[type Gda.MetaContext]

user_data

user data set when the signal handler was connected.

 

Returns

a new GError error structure if there was an error when processing the signal, or NULL if signal propagation should continue

Flags: Run Last


The “sequence-item-added” signal

void
user_function (GdaServerOperation *op,
               gchar              *seq_path,
               gint                item_index,
               gpointer            user_data)

Gets emitted whenever a new sequence item (from a sequence template) has been added

[virtual seq_item_added]

Parameters

op

the GdaServerOperation

 

seq_path

the path to the new sequence item

 

item_index

the index (starting from 0) of the new sequence item in the sequence

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “sequence-item-remove” signal

void
user_function (GdaServerOperation *op,
               gchar              *seq_path,
               gint                item_index,
               gpointer            user_data)

Gets emitted whenever a sequence item is about to be removed

[virtual seq_item_remove]

Parameters

op

the GdaServerOperation

 

seq_path

the path to the sequence item to be removed

 

item_index

the index (starting from 0) of the sequence item in the sequence

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “holder-attr-changed” signal

void
user_function (GdaSet    *set,
               GdaHolder *holder,
               gchar     *attr_name,
               GValue    *attr_value,
               gpointer   user_data)

Gets emitted when an attribute for any of the GdaHolder objects managed by set has changed

Parameters

set

the GdaSet

 

holder

the GdaHolder for which an attribute changed

 

attr_name

attribute's name

 

attr_value

attribute's value

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “holder-changed” signal

void
user_function (GdaSet    *gdaset,
               GdaHolder *arg1,
               gpointer   user_data)

Flags: Run First


The “holder-type-set” signal

void
user_function (GdaSet    *set,
               GdaHolder *holder,
               gpointer   user_data)

Gets emitted when holder in set has its type finally set, in case it was GDA_TYPE_NULL

Parameters

set

the GdaSet

 

holder

the GdaHolder for which the GType has been set

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First

Since: 4.2


The “public-data-changed” signal

void
user_function (GdaSet  *set,
               gpointer user_data)

Gets emitted when set 's public data (GdaSetNode, GdaSetGroup or GdaSetSource values) have changed

Parameters

set

the GdaSet

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “source-model-changed” signal

void
user_function (GdaSet  *set,
               gpointer source,
               gpointer user_data)

Gets emitted when the data model in source has changed

Parameters

set

the GdaSet

 

source

the GdaSetSource for which the data_model attribute has changed

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First

Since: 4.2


The “validate-holder-change” signal

GError*
user_function (GdaSet    *set,
               GdaHolder *holder,
               GValue    *new_value,
               gpointer   user_data)

Gets emitted when a GdaHolder's in set is going to change its value. One can connect to this signal to control which values holder can have (for example to implement some business rules)

Parameters

set

the GdaSet

 

holder

the GdaHolder which is going to change

 

new_value

the proposed new value for holder

 

user_data

user data set when the signal handler was connected.

 

Returns

NULL if holder is allowed to change its value to new_value , or a GError otherwise.

Flags: Run Last


The “validate-set” signal

GError*
user_function (GdaSet  *set,
               gpointer user_data)

Gets emitted when gda_set_is_valid() is called, use this signal to control which combination of values set 's holder can have (for example to implement some business rules)

Parameters

set

the GdaSet

 

user_data

user data set when the signal handler was connected.

 

Returns

NULL if set 's contents has been validated, or a GError otherwise.

Flags: Run Last


The “checked” signal

void
user_function (GdaStatement  *stmt,
               GdaConnection *cnc,
               gboolean       checked,
               gpointer       user_data)

Gets emitted whenever the structure and contents of stmt have been verified (emitted after gda_statement_check_validity()).

Parameters

stmt

the GdaStatement object

 

cnc

a GdaConnection

 

checked

whether stmt have been verified

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “reset” signal

void
user_function (GdaStatement *stmt,
               gpointer      user_data)

Gets emitted whenever the stmt has changed

Parameters

stmt

the GdaStatement object

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “node-changed” signal

void
user_function (GdaTree     *tree,
               GdaTreeNode *node,
               gpointer     user_data)

Gets emitted when a node has changed in tree

Parameters

tree

the GdaTree

 

node

the GdaTreeNode which has changed

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 4.2


The “node-deleted” signal

void
user_function (GdaTree *tree,
               gchar   *node_path,
               gpointer user_data)

Gets emitted when a node has been removed from tree

Parameters

tree

the GdaTree

 

node_path

the position the node held in tree as a tree path

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 4.2


The “node-has-child-toggled” signal

void
user_function (GdaTree     *tree,
               GdaTreeNode *node,
               gpointer     user_data)

Gets emitted when a node has has a child when it did not have any or when it does not have a ny children anymore when it had some

Parameters

tree

the GdaTree

 

node

the GdaTreeNode which changed from having children to being a leaf or the other way around

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 4.2


The “node-inserted” signal

void
user_function (GdaTree     *tree,
               GdaTreeNode *node,
               gpointer     user_data)

Gets emitted when a node has been inserted in tree

Parameters

tree

the GdaTree

 

node

the GdaTreeNode which has inserted

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 4.2


The “node-changed” signal

void
user_function (GdaTreeNode *reporting,
               GdaTreeNode *node,
               gpointer     user_data)

Gets emitted when a node has changed

Parameters

reporting

the GdaTreeNode which emits the signal (may be a parent of node , or node itself)

 

node

the GdaTreeNode which has changed

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 4.2


The “node-deleted” signal

void
user_function (GdaTreeNode *reporting,
               gchar       *relative_path,
               gpointer     user_data)

Gets emitted when a node has been removed

Parameters

reporting

the GdaTreeNode which emits the signal (a parent of the removed node)

 

relative_path

the path the node held, relative to reporting

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 4.2


The “node-has-child-toggled” signal

void
user_function (GdaTreeNode *reporting,
               GdaTreeNode *node,
               gpointer     user_data)

Gets emitted when a node has has a child when it did not have any or when it does not have a ny children anymore when it had some

Parameters

reporting

the GdaTreeNode which emits the signal (may be a parent of node , or node itself)

 

node

the GdaTreeNode which changed from having children to being a leaf or the other way around

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 4.2


The “node-inserted” signal

void
user_function (GdaTreeNode *reporting,
               GdaTreeNode *node,
               gpointer     user_data)

Gets emitted when a node has been inserted

Parameters

reporting

the GdaTreeNode which emits the signal (may be a parent of node , or node itself)

 

node

the GdaTreeNode which has been inserted

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 4.2