## Package org.eclipse.datatools.connectivity.oda

[Platform API] Defines the runtime API of the Open Data Access (ODA) extensions.

See:
Description

Interface Summary
IAdvancedQuery: An optional, extended query interface for more advanced query capabilities.
IBlob: An optional interface that represents a Binary Large Object (BLOB) value.
IClob: An optional interface that represents a Character Large Object (CLOB) value.
IConnection: A data source connection interface used to establish a live connection to the underlying data provider.
IDataSetMetaData: Provides comprehensive information on the driver's capabilities for a type of data set query.
IDriver: The entry point to a custom ODA run-time driver's implementation.
IParameterMetaData: An interface that represents the meta-data of input/output parameters defined in a prepared query.
IParameterRowSet: An optional interface that represents complex data type objects such as structures and tables.
IQuery: The base query interface to prepare and execute a query text to retrieve data.
IResultSet: The interface used to access a set of data rows retrieved by an IQuery object.
IResultSetMetaData: The interface that represents the meta-data of an IResultSet object.

Class Summary
LogConfiguration: Encapsulates the trace logging configuration specified for an ODA run-time driver.
SortSpec: A class that encapsulates one or more sort keys for association with an IQuery.

Exception Summary
OdaException: An exception class that provides information on an ODA runtime driver error or other data provider errors.

## Package org.eclipse.datatools.connectivity.oda Description

[Platform API] Defines the runtime API of the Open Data Access (ODA) extensions. ODA provides the capability to plug any external data source into a data consumer application that supports the ODA framework.

The ODA extension framework defines a set of ODA design-time and run-time interfaces. It adopts the Eclipse plug-in framework for one to provide a designer tool, and a runtime driver for data retrieval. This public API package specifies the Java interfaces of an ODA extension's runtime driver.
An ODA consumer application, such as the BIRT Data Engine, uses the data source connection and data set query definitions specified at design time to access an ODA runtime driver for query execution and data retrieval.

The ODA runtime interfaces are JDBC-like, but have been extended to support additional capabilities of non-RDBMS data sources. An ODA driver would implement the public runtime interfaces, which would in turn wrap data-source-specific APIs, such as web services, to retrieve a result set's data rows.

Below is a brief overview of the API's main interfaces.
The IDriver serves as the entry point to an ODA runtime driver. The driver produces a dedicated IConnection for establishing a connection to the data source provider.
An open connection in turn creates an IQuery to define the specifics of a data set query. A connection also provides meta-data information on the capabilities of the data source, and its supported data set types in IDataSetMetaData.
A query is executed to retrieve one or more IResultSet instances.
A result set is then used to fetch result data. It also provides an IResultSetMetaData for its meta-data information.

Since:
  1.0