GNOME Data Access 4.0 manual |
|---|
Copyright © 1999 - 2010 The GNOME Foundation
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
- II. Client API reference
- Foreword about abstraction
- 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()
- 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
- Advanced GdaDataSelect usage
- 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
- 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
- III. GDA Tools
- IV. Reports
- Introduction
- API reference
- GdaReportEngine — Low level report generator based on XML
- GdaReportDocument — Report document
- GdaReportDocbookDocument — Report document based on the DocBook dialect
- GdaReportRmlDocument — Report document based on the RML dialect
- V. XSLT extension
- VI. Gda SQL console's user manual
- VII. Databases providers for developers
- Providers' support API
- GdaServerProvider — Base class for all the DBMS providers
- Subclassing GdaDataSelect — Base class for all the data models returned by DBMS providers when a SELECT statement is executed
- GdaPStmt — Prepared statement's base class
- Quark lists — Manages lists of KEY=VALUE pairs
- SQL rendering API — Adapting the SQL to the database's own SQL dialect
- Misc API — Methods dedicated to implementing providers
- Virtual methods for providers
- Virtual methods for recordsets
- Virtual methods for Blob operations
- SQL parser
- Implementation overview
- Tips to write a custom parser
- GdaSqlStatement — Structure which decomposes an SQL statement
- Assembling all the parts
- VIII. Packaging
- IX. Appendix