The documentation for the OpenAccess SDK product is divided into various installation, configuration, and programmer’s guides. Refer to the tables below to identify the documentation that applies to your usage of the OpenAccess product.
Most likely the data source you want to implement a custom driver for is not SQL capable. Or it is SQL capable but you want all data access to be done through your API. In both of these cases you will be using the OpenAccess SQL engine and implementing what we call a non-SQL Interface Provider (IP for short). For this configuration please start with the OpenAccess SDK Programmer’s Guide.
If you want to implement a custom driver directly over your SQL engine then you will be implementing what we call a SQL Interface Provider (SQL IP for short). In this mode you can leverage the OpenAccess drivers and the client/server capability over any SQL compliant data source. For this configuration please start with the SQL IP Programmer’s Guide.
The configuration selection criteria are the language you will code the IP in and whether you are going to use the OpenAccess SQL engine or your own. Some documents apply to all configurations and these are listed in the Common Documents section. Refer to the table below that corresponds to the language and mode you will be working in for a list of documents that you should refer to.
Configurations
Developing in C/C++ and using the OpenAccess
SQL Engine
Developing in Java and using the OpenAccess SQL Engine
Developing in .NET and using the OpenAccess SQL Engine
Developing in C/C++ and using your SQL Engine
Developing in Java and using your SQL Engine
|
Document |
Purpose |
|
Read this first to understand how OpenAccess works. Provides overview of the features of OpenAccess, details the process of writing a custom driver, and provides details for implementing schema and data read/write operations. | |
|
Step by step guide for installing local or client/server version of the SDK. | |
|
OpenAccess SDK for C/C++ Programmer’s Reference
|
Details the IP API and the DAM API you will use to implement a custom interface. Provides details of setting up the development environment and language specifics. |
|
Document |
Purpose |
|
OpenAccess SDK Programmer’s Guide
|
Read this first to understand how OpenAccess works. Provides overview of the features of OpenAccess, details the process of writing a custom driver, and provides details for implementing schema and data read/write operations. |
|
OpenAccess SDK for Java Installation Guide
|
Step by step guide for installing local or client/server version of the SDK on any platform. |
|
Details the IP API and the DAM API you will use to implement a custom interface. Provides details of setting up the development environment and language specifics. |
|
Document |
Purpose |
|
Read this first to understand how OpenAccess works. Provides overview of the features of OpenAccess, details the process of writing a custom driver, and provides details for implementing schema and data read/write operations. | |
|
Step by step guide for installing local or client/server version of the SDK. | |
|
Details the IP API and the DAM API you will use to implement a custom interface. Provides details of setting up the development environment and language specifics. |
|
Document |
Purpose |
|
Read this first to understand how to use OpenAccess to implement a SQL IP. Provides overview and details of the interface the SQL IP must implement. | |
|
OpenAccess SDK for C/C++ Installation Guide
|
Step by step guide for installing local or client/server version of the SDK. |
|
Document |
Purpose |
|
OpenAccess SQL IP Programmer’s Guide
|
Read this first to understand how to use OpenAccess to implement a SQL IP. Provides overview and details of the interface the SQL IP must implement. |
|
Step by step guide for installing local or client/server version of the SDK. |
|
Document |
Purpose |
|
Describes what is new in this version and the steps to upgrade from previous version(s). It contains detailed list of enhancements and bug fixes. | |
|
This applies to client/server version where the drivers are installed separately from the server. This guide details installing the ODBC, JDBC, OLE DB, and .NET drivers. | |
|
Details the configuration settings for all the OpenAccess components. Refer to this guide for details on the openrda.ini configuration settings and the OpenAccess database administration. | |
|
Details on the capabilities of each of the driver and how to use it from applications and how to use the Interactive SQL tools. | |
|
Complete reference to the SQL syntax supported by OpenAccess SQL engine. Does not apply to SQL IP. | |
|
Details how to use the OpenAccess installer or to create your own installer for distributing the finished product. | |
|
Describes how to use the examples that are installed as part of the SDK installation. Samples that are available on the Web include the required documentation. |