Part II. Client API reference

Table of Contents

Foreword about abstraction
SQL identifiers
Binary large objects (BLOBs)
HOWTO for common tasks
Open a connection
Define a data source (DSN)
Execute a SELECT command
Modify the result of a SELECT command
Execute an INSERT, UPDATE or DELETE command
Get the last inserted row
Execute a DDL command
Get information about a table's columns
Update the meta data about a table
Validate a DML statement
Control value's assignment to various objects
Add your own data to a GdaMetaStore
Object Hierarchy
Initialization and configuration
Libgda initialization — Library initialization
Configuration — Access/Management of libgda configuration
Configuring Libgda with environment variables
Connections & commands
Convenience functions — Do quickly some actions
GdaConnection — Management of connections to data sources
GdaSqlParser — SQL parser
GdaStatement — Single SQL statement
GdaBatch — Multiple SQL statements grouped together.
GdaHolder — Container for a single GValue
GdaSet — Container for several values
GdaConnectionEvent — Any event which has occurred on a GdaConnection
GdaTransactionStatus — Keeps track of the transactional status of a connection
GdaXaTransaction — Distributed transaction manager
Description of the data model returned by gda_connection_get_meta_store_data()
GDA_CONNECTION_META_NAMESPACES
GDA_CONNECTION_META_TYPES
GDA_CONNECTION_META_TABLES
GDA_CONNECTION_META_VIEWS
GDA_CONNECTION_META_FIELDS
Virtual connections
GdaVirtualProvider — Base class for all virtual providers
GdaVproviderDataModel — Virtual provider for connections based on a list of GdaDataModel
GdaVproviderHub — Virtual provider for connections based on other connection
GdaVirtualConnection — Base class for all virtual connection objects
GdaVconnectionDataModel — Virtual connection based on a list of GdaDataModel
GdaVconnectionHub — Virtual connection which bind together connections
Data handling
A single Value — Assorted functions for dealing with GValue values.
Custom data validation
GdaHolder controls
GdaSet controls
GdaDataProxy controls
Advanced GdaDataSelect usage
Automatic re-run of the SELECT statement
Invalid parameters
Blobs — Binary data and BLOBs handling
GdaDataModel — Basic data model class
GdaDataSelect — Data models returned by the execution of a SELECT statement
GdaDataModel columns — Management of GdaDataModel column attributes
GdaDataModelIter — Data model iterator
GdaDataModelImport — Importing data from a string or a file
GdaDataAccessWrapper — Offers a random access on top of a cursor-only access data model
GdaDataModelArray — An implementation of GdaDataModel based on a GArray.
GdaDataModelArray's rows — Row for a GdaDataModelArray object
GdaDataModelBdb — GdaDataModel to access Berkeley DB database contents
GdaDataModelDir — GdaDataModel to list files in filesystem
GdaDataProxy — Proxy to hold modifications for any GdaDataModel, and provides the GdaDataModel interface itself
GdaDataComparator — Simple data model's contents comparison
Data conversions
GdaDataHandler — Interface which provides data handling (conversions) capabilities
GdaHandlerString — Default handler for strings
GdaHandlerBoolean — Default handler for booleans
GdaHandlerTime — Default handler for time, date and timestamp
GdaHandlerNumerical — Default handler for numeric values
GdaHandlerBin — Default handler for binary values
GdaHandlerType — Default handler for GType values
Dictionary - metadata
Setup
Adding custom data
Database structure
Data types
SQL identifiers
Short and full names
Individual table description
GdaMetaStore — Dictionary object
GdaMetaStruct — In memory representation of some database objects
Data definition (DDL) queries
GdaServerOperation — Handles any DDL query in an abstract way
GdaServerOperation: individual nodes — Getting information about parts (nodes) composing a path
GdaServerOperation: sequences — Manipulating sequences
Miscellaneous
Utility functions
Logging — Log functions
GdaMutex — Recursive mutex implementation
GdaLockable — Interface for locking objects in a multi threaded environment
Attributes manager — Manager for lists of attributes

The following sections describe the API available for GDA applications.