Michael Lausch

Rodrigo Moya

Vivien Malerba

Current maintainer  

Sean Allen

GDP compliance, FDL, added mark-up, English and syntax  

Xabier Rodriguez Calvar

How to begin and migration formulae  

Jose Dapena Paz

Some examples  

Bas Driessen

libgda, gda-postgres, gda-mysql  

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be found in the appendix.

Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear in any GNOME documentation, and those trademarks are made aware to the members of the GNOME Documentation Project, the names have been printed in caps or initial caps.

Abstract

GNOME Data Access (GDA) is an architecture whose purpose is to provide universal access to many different kinds and types of data sources. This goes from traditional relational database systems, to any imaginable kind of data source such as a mail server, a LDAP directory...

This universality is obtained through the use of an easily extensible plug-in system as the mechanism for communication between the different components in the architecture.


I. Getting started
Introduction
Features
Architecture
Installation
Getting the library
Installing from the sources
Compiling with the library
Configuring
Configuration for development
Configuration for accessing a database
Provider's specific information
Code examples
Initialising
Connecting
Executing queries
Using a GdaCommand
Using a GdaQuery
Managing data models
Example using random access
Example using an iterator
Freeing data models
Managing transactions
Managing connection's events and errors
Full example
DDL example
Other examples
Migration from older versions
GdaValue and GdaDataModel changes
GdaClient, GdaConnection and GdaError
Various API changes
Limitations
For MySQL
gda_server_provider_get_last_insert_id()
For Oracle
gda_server_provider_get_last_insert_id()
For PostgreSQL
BLOB handling
gda_server_provider_get_last_insert_id()
For SQLite
gda_server_provider_get_last_insert_id()
For Other providers
gda_server_provider_get_last_insert_id()
II. Client API Reference
Object Hierarchy
Initialization and configuration
Libgda initialization — Library initialization
Configuration — Access/Management of libgda configuration
Configuring libgda with environment variables
Connections & commands
GdaClient — Database client access
GdaConnection — Management of connections to data sources
GdaConnectionEvent — Any event which has occurred on a GdaConnection
GdaTransactionStatus — Keeps track of the transactional status of a connection
Commands — Issuing commands to the provider
Convenient functions — Do quickly some actions
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
Gda Value — Single value stored in a GdaDataModel
Blobs — Binary data and BLOBs handling
GdaParameter — Represents a GValue with various attributes
GdaParameterList — Manages a list of GdaParameter objects which contain individual values
GdaDataModel — Basic data model class
GdaDataModel columns — Management of GdaDataModel column attributes
GdaDataModelIter
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.
GdaDataModelBdb — GdaDataModel to access Berkeley DB database contents
GdaDataModelDir — GdaDataModel to list files in filesystem
GdaDataModelHash — An implementation of GdaDataModel based on a hash table
GdaDataModelQuery — An implementation of GdaDataModel based on a SELECT query
GdaDataModelFilterSQL — Filtering data from one or several GdaDataModel objects
GdaDataProxy — Proxy to hold modifications for any GdaDataModel, and provides the GdaDataModel interface itself
GdaDataModelIndex — Management of GdaDataModel indexes
GdaDataModel column indexes — Management of GdaDataModel column index attributes
Data conversions
GdaDataHandler — Interface which provides data handling 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 and related objects
GdaDict — GDA dictionary
GdaDictType — Represents a data type in the DBMS
GdaDictFunction — Represents a function in the DBMS.
GdaDictAggregate — Represents an aggregate in the DBMS (like COUNT() or AVG() for example)
GdaDictDatabase — Represents a database structure in the DBMS server
GdaDictTable — Represents a table or a view in the database
GdaDictField — Represents a field in a table or a view in the database
GdaDictConstraint — Represents a constraint within a database
GdaDictExtend — Make GdaDict manage other types of objects
Data manipulation (DML) queries
GdaQuery — Represents any kind of DML query
GdaQueryTarget — Represents a target entity within a query.
GdaQueryJoin — Represents a join between two different entities
GdaQueryFieldAll — Represents all the fields of an entity (through a GdaQueryTarget object)
GdaQueryFieldField — Represents one field of an entity (through a GdaQueryTarget object)
GdaQueryFieldFunc — Represents a function (selected by a GdaDictFunction object)
GdaQueryFieldAgg — Represents a function (selected by a GdaDictAggregate object)
GdaQueryFieldValue — Represents a single value (or a parameter)
GdaQueryCondition — Represents a condition within a query
Data definition (DDL) queries
GdaServerOperation — Handles any DDL query in an abstract way
Miscellaneous
Utility functions
Logging — Log functions
Quark lists — Quark lists (lists of KEY=VALUE's)
GdaObject — The base class for many of the library's objects
GdaObjectRef — Used to reference other objects
GdaGraphviz — Creates .dot files which can then be processed with GraphViz.
GdaDataModelRow — Base implementation for other objects to implement the GdaDataModel interface based on the usage of
GdaQueryField — Parent class for any query's field
GdaQueryObject — Parent class for any object participating in a GdaQuery query
GdaThreader
Graphs
GdaGraph — Data model to keep graphs' layout
GdaGraphQuery — A graph specialized in displaying query components
GdaGraphItem — Parts of data model used with the GdaGraph object.
List of lesser used interfaces
GdaEntity — Interface to represent a generic entity (for tables, views or queries)
GdaEntityField — Interface to represent a generic field (for tables's fields, etc).
GdaXmlStorage — Interface which provides saving and loading using XML structures
GdaRenderer — Interface to get representations of objects as SQL statements, XML nodes or human readable text
GdaReferer — Interface to know when on object is completely defined
III. GDA Tools
Introduction
gda-sql-3.0
gda-list-config-3.0
gda-test-connection-3.0
gda-author-dict-file-3.0
gda-inspect-dict-file-3.0
gda-list-server-op-3.0
IV. Reports
Introduction
API reference
GdaReportEngine — Low level report generator based on XML
GdaReportDocument
GdaReportDocbookDocument — Report document based on the DocBook dialect
GdaReportRmlDocument — Report document based on the RML dialect
V. Databases providers for developers
Introduction
Virtual methods for providers
get_version
get_server_version
get_info
supports_feature
get_data_handler
string_to_handler
get_def_dbms_type
open_connection
close_connection
get_database
change_database
supports_operation
create_operation
render_operation
perform_operation
execute_command
get_last_insert_id
begin_transaction
commit_transaction
rollback_transaction
create_blob
fetch_blob
get_schema
Virtual methods for recordsets
GdaServerProvider — Base class for all the DBMS providers
A. GNU Free Documentation License
0. PREAMBLE
1. APPLICABILITY AND DEFINITIONS
2. VERBATIM COPYING
3. COPYING IN QUANTITY
4. MODIFICATIONS
5. COMBINING DOCUMENTS
6. COLLECTIONS OF DOCUMENTS
7. AGGREGATION WITH INDEPENDENT WORKS
8. TRANSLATION
9. TERMINATION
10. FUTURE REVISIONS OF THIS LICENSE
Addendum
Index