SQL pass-through mode
- Last Updated: May 12, 2026
- 2 minute read
- OpenAccess SDK
- Version 8.1
- Documentation
In SQL pass-through mode, the OpenAccess SDK SQL engine handles the parsing and validation of the SQL statement against the exposed schema and makes the SQL statement available to the IP through the OpenAccess SDK SQL engine API. The IP must perform the operation requested by the SQL query using the mechanism supported by the data source. This mode is preferred when the data source supports SQL or SQL-like language that can handle joins, unions, nested query, and other SQL operations.
The following table lists the operations defined by the OpenAccess SDK IP API. These are the operations that you can implement in your IP.
Operations Supported by an IP
| Operation | Description |
| CONNECT Required | Called when a client wants to establish a connection with a data source served by the IP. Authentication information such as the user name and password are passed in. |
| DCL Optional | Called with GRANT and other Database Configuration Language (DCL) commands to configure privileges. |
| DDL Optional | Called with CREATE TABLE, DROP TABLE, CREATE INDEX, or DROP INDEX operation code to perform the requested operation (only required if you want the IP code to support DDL (Data Definition Language) operations). |
| DISCONNECT Required | Closes the connection. The IP should close any files or other connections established on behalf of this connection. |
| DYNAMIC_RESULTS Optional | Called to invoke a stored procedure that returns one or more result sets that can be defined at runtime. |
| END TRANSACTION Required | Called with operation code COMMIT or ROLLBACK or PREPARE_TO_ COMMIT. |
| EXECUTE Required | Called with INSERT, SELECT, UPDATE or DELETE operation code to perform the requested operation. |
| EXIT Required | Called when the OpenAccess SDK SQL engine is shutting down. |
| GETDSINFO Required | Gets information about driver specific settings. |
| GETINFO Required | Gets information about driver specific settings. |
| GETLONGDATA Optional | Called to invoke streaming for a particular column. |
| GETTYPESINFO Required | Gets information about driver specific settings. |
| GETSUPPORT Required | Gets information about what type of operations are supported by the driver. This information is used to determine what processing is passed down to the IP. |
| INIT Required | Called at startup of the OpenAccess SDK SQL engine to initialize the IP. |
| INIT_SCALAR Optional | Called to have the IP register custom scalar functions. |
| NATIVE Optional | Called to execute a command the OpenAccess SDK SQL engine did not recognize as a valid SQL command. |
| PRIVILEGE Optional | Called to authorize access to an object. |
| PROCEDURE Optional | Called to invoke a stored procedure (Only required if you want the IP code to support stored procedures with pre-defined result sets). |
| SCHEMA Optional | Called to retrieve the schema information of your data source (only required if the IP will handle the schema management). |
| SCHEMAEX Optional | Called to retrieve schema information for stored procedures that define result set at runtime. |
| SETINFO Required | Passes client side settings to the IP. |
| START TRANSACTION Required | Called to initiate a new transaction. The IP can use this entry point to perform transaction management for each connection. |