//----------------------------------------------------------------------------- // Copyright (c) 2016, 2024, Oracle and/or its affiliates. // // This software is dual-licensed to you under the Universal Permissive License // (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License // 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose // either license. // // If you elect to accept the software under the Apache License, Version 2.0, // the following applies: // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // https://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. //----------------------------------------------------------------------------- //----------------------------------------------------------------------------- // dpi.h // Include file for users of the ODPI-C library. //----------------------------------------------------------------------------- #ifndef DPI_PUBLIC #define DPI_PUBLIC // Avoid name-mangling when using C++ #ifdef __cplusplus extern "C" { #endif // define standard integer types for older versions of Microsoft Visual Studio #ifdef _MSC_VER #if _MSC_VER < 1600 #define int8_t signed __int8 #define int16_t signed __int16 #define int32_t signed __int32 #define int64_t signed __int64 #define uint8_t unsigned __int8 #define uint16_t unsigned __int16 #define uint32_t unsigned __int32 #define uint64_t unsigned __int64 #endif #endif #ifndef int8_t #include #endif // define __func__ for older versions of Microsoft Visual Studio #ifdef _MSC_VER #if _MSC_VER < 1900 #define __func__ __FUNCTION__ #endif #endif // define macro for exporting functions on Windows #if defined(_MSC_VER) && defined(DPI_EXPORTS) #define DPI_EXPORT __declspec(dllexport) #else #define DPI_EXPORT #endif // define ODPI-C version information #define DPI_MAJOR_VERSION 5 #define DPI_MINOR_VERSION 4 #define DPI_PATCH_LEVEL 0 #define DPI_VERSION_SUFFIX "b1" #define DPI_STR_HELPER(x) #x #define DPI_STR(x) DPI_STR_HELPER(x) #define DPI_VERSION_STRING \ DPI_STR(DPI_MAJOR_VERSION) "." \ DPI_STR(DPI_MINOR_VERSION) "." \ DPI_STR(DPI_PATCH_LEVEL) \ DPI_VERSION_SUFFIX #define DPI_DEFAULT_DRIVER_NAME "ODPI-C : " DPI_VERSION_STRING #define DPI_VERSION_TO_NUMBER(major, minor, patch) \ ((major * 10000) + (minor * 100) + patch) #define DPI_VERSION_NUMBER \ DPI_VERSION_TO_NUMBER(DPI_MAJOR_VERSION, DPI_MINOR_VERSION, \ DPI_PATCH_LEVEL) #define DPI_ORACLE_VERSION_TO_NUMBER(versionNum, releaseNum, updateNum, \ portReleaseNum, portUpdateNum) \ ((versionNum * 100000000) + (releaseNum * 1000000) + \ (updateNum * 10000) + (portReleaseNum * 100) + (portUpdateNum)) // define default array size to use #define DPI_DEFAULT_FETCH_ARRAY_SIZE 100 // define default number of rows to prefetch #define DPI_DEFAULT_PREFETCH_ROWS 2 // define default ping interval (in seconds) used when getting connections #define DPI_DEFAULT_PING_INTERVAL 60 // define default ping timeout (in milliseconds) used when getting connections #define DPI_DEFAULT_PING_TIMEOUT 5000 // define default statement cache size #define DPI_DEFAULT_STMT_CACHE_SIZE 20 // define constants for dequeue wait (AQ) #define DPI_DEQ_WAIT_NO_WAIT 0 #define DPI_DEQ_WAIT_FOREVER ((uint32_t) -1) // define maximum precision that can be supported by an int64_t value #define DPI_MAX_INT64_PRECISION 18 // define constants for success and failure of methods #define DPI_SUCCESS 0 #define DPI_FAILURE -1 // set debug level (DPI_DEBUG_LEVEL) as a bitmask of desired flags // reporting is to stderr // 0x0001: reports errors during free // 0x0002: reports on reference count changes // 0x0004: reports on public function calls // 0x0008: reports on all errors // 0x0010: reports on all SQL statements // 0x0020: reports on all memory allocations/frees // 0x0040: reports on all attempts to load the Oracle Client library #define DPI_DEBUG_LEVEL_UNREPORTED_ERRORS 0x0001 #define DPI_DEBUG_LEVEL_REFS 0x0002 #define DPI_DEBUG_LEVEL_FNS 0x0004 #define DPI_DEBUG_LEVEL_ERRORS 0x0008 #define DPI_DEBUG_LEVEL_SQL 0x0010 #define DPI_DEBUG_LEVEL_MEM 0x0020 #define DPI_DEBUG_LEVEL_LOAD_LIB 0x0040 //----------------------------------------------------------------------------- // Enumerations //----------------------------------------------------------------------------- // connection/pool authorization modes typedef uint32_t dpiAuthMode; #define DPI_MODE_AUTH_DEFAULT 0x00000000 #define DPI_MODE_AUTH_SYSDBA 0x00000002 #define DPI_MODE_AUTH_SYSOPER 0x00000004 #define DPI_MODE_AUTH_PRELIM 0x00000008 #define DPI_MODE_AUTH_SYSASM 0x00008000 #define DPI_MODE_AUTH_SYSBKP 0x00020000 #define DPI_MODE_AUTH_SYSDGD 0x00040000 #define DPI_MODE_AUTH_SYSKMT 0x00080000 #define DPI_MODE_AUTH_SYSRAC 0x00100000 // connection close modes typedef uint32_t dpiConnCloseMode; #define DPI_MODE_CONN_CLOSE_DEFAULT 0x0000 #define DPI_MODE_CONN_CLOSE_DROP 0x0001 #define DPI_MODE_CONN_CLOSE_RETAG 0x0002 // connection/pool creation modes typedef uint32_t dpiCreateMode; #define DPI_MODE_CREATE_DEFAULT 0x00000000 #define DPI_MODE_CREATE_THREADED 0x00000001 #define DPI_MODE_CREATE_EVENTS 0x00000004 // dequeue modes for advanced queuing typedef uint32_t dpiDeqMode; #define DPI_MODE_DEQ_BROWSE 1 #define DPI_MODE_DEQ_LOCKED 2 #define DPI_MODE_DEQ_REMOVE 3 #define DPI_MODE_DEQ_REMOVE_NO_DATA 4 // dequeue navigation flags for advanced queuing typedef uint32_t dpiDeqNavigation; #define DPI_DEQ_NAV_FIRST_MSG 1 #define DPI_DEQ_NAV_NEXT_TRANSACTION 2 #define DPI_DEQ_NAV_NEXT_MSG 3 // event types typedef uint32_t dpiEventType; #define DPI_EVENT_NONE 0 #define DPI_EVENT_STARTUP 1 #define DPI_EVENT_SHUTDOWN 2 #define DPI_EVENT_SHUTDOWN_ANY 3 #define DPI_EVENT_DEREG 5 #define DPI_EVENT_OBJCHANGE 6 #define DPI_EVENT_QUERYCHANGE 7 #define DPI_EVENT_AQ 100 // JSON conversion options #define DPI_JSON_OPT_DEFAULT 0x00 #define DPI_JSON_OPT_NUMBER_AS_STRING 0x01 #define DPI_JSON_OPT_DATE_AS_DOUBLE 0x02 // statement execution modes typedef uint32_t dpiExecMode; #define DPI_MODE_EXEC_DEFAULT 0x00000000 #define DPI_MODE_EXEC_DESCRIBE_ONLY 0x00000010 #define DPI_MODE_EXEC_COMMIT_ON_SUCCESS 0x00000020 #define DPI_MODE_EXEC_BATCH_ERRORS 0x00000080 #define DPI_MODE_EXEC_PARSE_ONLY 0x00000100 #define DPI_MODE_EXEC_ARRAY_DML_ROWCOUNTS 0x00100000 // statement fetch modes typedef uint16_t dpiFetchMode; #define DPI_MODE_FETCH_NEXT 0x0002 #define DPI_MODE_FETCH_FIRST 0x0004 #define DPI_MODE_FETCH_LAST 0x0008 #define DPI_MODE_FETCH_PRIOR 0x0010 #define DPI_MODE_FETCH_ABSOLUTE 0x0020 #define DPI_MODE_FETCH_RELATIVE 0x0040 // message delivery modes in advanced queuing typedef uint16_t dpiMessageDeliveryMode; #define DPI_MODE_MSG_PERSISTENT 1 #define DPI_MODE_MSG_BUFFERED 2 #define DPI_MODE_MSG_PERSISTENT_OR_BUFFERED 3 // message states in advanced queuing typedef uint32_t dpiMessageState; #define DPI_MSG_STATE_READY 0 #define DPI_MSG_STATE_WAITING 1 #define DPI_MSG_STATE_PROCESSED 2 #define DPI_MSG_STATE_EXPIRED 3 // native C types typedef uint32_t dpiNativeTypeNum; #define DPI_NATIVE_TYPE_INT64 3000 #define DPI_NATIVE_TYPE_UINT64 3001 #define DPI_NATIVE_TYPE_FLOAT 3002 #define DPI_NATIVE_TYPE_DOUBLE 3003 #define DPI_NATIVE_TYPE_BYTES 3004 #define DPI_NATIVE_TYPE_TIMESTAMP 3005 #define DPI_NATIVE_TYPE_INTERVAL_DS 3006 #define DPI_NATIVE_TYPE_INTERVAL_YM 3007 #define DPI_NATIVE_TYPE_LOB 3008 #define DPI_NATIVE_TYPE_OBJECT 3009 #define DPI_NATIVE_TYPE_STMT 3010 #define DPI_NATIVE_TYPE_BOOLEAN 3011 #define DPI_NATIVE_TYPE_ROWID 3012 #define DPI_NATIVE_TYPE_JSON 3013 #define DPI_NATIVE_TYPE_JSON_OBJECT 3014 #define DPI_NATIVE_TYPE_JSON_ARRAY 3015 #define DPI_NATIVE_TYPE_NULL 3016 #define DPI_NATIVE_TYPE_VECTOR 3017 // operation codes (database change and continuous query notification) typedef uint32_t dpiOpCode; #define DPI_OPCODE_ALL_OPS 0x0 #define DPI_OPCODE_ALL_ROWS 0x1 #define DPI_OPCODE_INSERT 0x2 #define DPI_OPCODE_UPDATE 0x4 #define DPI_OPCODE_DELETE 0x8 #define DPI_OPCODE_ALTER 0x10 #define DPI_OPCODE_DROP 0x20 #define DPI_OPCODE_UNKNOWN 0x40 // Oracle types typedef uint32_t dpiOracleTypeNum; #define DPI_ORACLE_TYPE_NONE 2000 #define DPI_ORACLE_TYPE_VARCHAR 2001 #define DPI_ORACLE_TYPE_NVARCHAR 2002 #define DPI_ORACLE_TYPE_CHAR 2003 #define DPI_ORACLE_TYPE_NCHAR 2004 #define DPI_ORACLE_TYPE_ROWID 2005 #define DPI_ORACLE_TYPE_RAW 2006 #define DPI_ORACLE_TYPE_NATIVE_FLOAT 2007 #define DPI_ORACLE_TYPE_NATIVE_DOUBLE 2008 #define DPI_ORACLE_TYPE_NATIVE_INT 2009 #define DPI_ORACLE_TYPE_NUMBER 2010 #define DPI_ORACLE_TYPE_DATE 2011 #define DPI_ORACLE_TYPE_TIMESTAMP 2012 #define DPI_ORACLE_TYPE_TIMESTAMP_TZ 2013 #define DPI_ORACLE_TYPE_TIMESTAMP_LTZ 2014 #define DPI_ORACLE_TYPE_INTERVAL_DS 2015 #define DPI_ORACLE_TYPE_INTERVAL_YM 2016 #define DPI_ORACLE_TYPE_CLOB 2017 #define DPI_ORACLE_TYPE_NCLOB 2018 #define DPI_ORACLE_TYPE_BLOB 2019 #define DPI_ORACLE_TYPE_BFILE 2020 #define DPI_ORACLE_TYPE_STMT 2021 #define DPI_ORACLE_TYPE_BOOLEAN 2022 #define DPI_ORACLE_TYPE_OBJECT 2023 #define DPI_ORACLE_TYPE_LONG_VARCHAR 2024 #define DPI_ORACLE_TYPE_LONG_RAW 2025 #define DPI_ORACLE_TYPE_NATIVE_UINT 2026 #define DPI_ORACLE_TYPE_JSON 2027 #define DPI_ORACLE_TYPE_JSON_OBJECT 2028 #define DPI_ORACLE_TYPE_JSON_ARRAY 2029 #define DPI_ORACLE_TYPE_UROWID 2030 #define DPI_ORACLE_TYPE_LONG_NVARCHAR 2031 #define DPI_ORACLE_TYPE_XMLTYPE 2032 #define DPI_ORACLE_TYPE_VECTOR 2033 #define DPI_ORACLE_TYPE_JSON_ID 2034 #define DPI_ORACLE_TYPE_MAX 2035 // session pool close modes typedef uint32_t dpiPoolCloseMode; #define DPI_MODE_POOL_CLOSE_DEFAULT 0x0000 #define DPI_MODE_POOL_CLOSE_FORCE 0x0001 // modes used when acquiring a connection from a session pool typedef uint8_t dpiPoolGetMode; #define DPI_MODE_POOL_GET_WAIT 0 #define DPI_MODE_POOL_GET_NOWAIT 1 #define DPI_MODE_POOL_GET_FORCEGET 2 #define DPI_MODE_POOL_GET_TIMEDWAIT 3 // purity values when acquiring a connection from a pool typedef uint32_t dpiPurity; #define DPI_PURITY_DEFAULT 0 #define DPI_PURITY_NEW 1 #define DPI_PURITY_SELF 2 // database shutdown modes typedef uint32_t dpiShutdownMode; #define DPI_MODE_SHUTDOWN_DEFAULT 0 #define DPI_MODE_SHUTDOWN_TRANSACTIONAL 1 #define DPI_MODE_SHUTDOWN_TRANSACTIONAL_LOCAL 2 #define DPI_MODE_SHUTDOWN_IMMEDIATE 3 #define DPI_MODE_SHUTDOWN_ABORT 4 #define DPI_MODE_SHUTDOWN_FINAL 5 // SODA flags #define DPI_SODA_FLAGS_DEFAULT 0x00 #define DPI_SODA_FLAGS_ATOMIC_COMMIT 0x01 #define DPI_SODA_FLAGS_CREATE_COLL_MAP 0x02 #define DPI_SODA_FLAGS_INDEX_DROP_FORCE 0x04 // database startup modes typedef uint32_t dpiStartupMode; #define DPI_MODE_STARTUP_DEFAULT 0 #define DPI_MODE_STARTUP_FORCE 1 #define DPI_MODE_STARTUP_RESTRICT 2 // server types typedef uint8_t dpiServerType; #define DPI_SERVER_TYPE_UNKNOWN 0 #define DPI_SERVER_TYPE_DEDICATED 1 #define DPI_SERVER_TYPE_SHARED 2 #define DPI_SERVER_TYPE_POOLED 4 // statement types typedef uint16_t dpiStatementType; #define DPI_STMT_TYPE_UNKNOWN 0 #define DPI_STMT_TYPE_SELECT 1 #define DPI_STMT_TYPE_UPDATE 2 #define DPI_STMT_TYPE_DELETE 3 #define DPI_STMT_TYPE_INSERT 4 #define DPI_STMT_TYPE_CREATE 5 #define DPI_STMT_TYPE_DROP 6 #define DPI_STMT_TYPE_ALTER 7 #define DPI_STMT_TYPE_BEGIN 8 #define DPI_STMT_TYPE_DECLARE 9 #define DPI_STMT_TYPE_CALL 10 #define DPI_STMT_TYPE_EXPLAIN_PLAN 15 #define DPI_STMT_TYPE_MERGE 16 #define DPI_STMT_TYPE_ROLLBACK 17 #define DPI_STMT_TYPE_COMMIT 21 // subscription grouping classes typedef uint8_t dpiSubscrGroupingClass; #define DPI_SUBSCR_GROUPING_CLASS_TIME 1 // subscription grouping types typedef uint8_t dpiSubscrGroupingType; #define DPI_SUBSCR_GROUPING_TYPE_SUMMARY 1 #define DPI_SUBSCR_GROUPING_TYPE_LAST 2 // subscription namespaces typedef uint32_t dpiSubscrNamespace; #define DPI_SUBSCR_NAMESPACE_AQ 1 #define DPI_SUBSCR_NAMESPACE_DBCHANGE 2 // subscription protocols typedef uint32_t dpiSubscrProtocol; #define DPI_SUBSCR_PROTO_CALLBACK 0 #define DPI_SUBSCR_PROTO_MAIL 1 #define DPI_SUBSCR_PROTO_PLSQL 2 #define DPI_SUBSCR_PROTO_HTTP 3 // subscription quality of service typedef uint32_t dpiSubscrQOS; #define DPI_SUBSCR_QOS_RELIABLE 0x01 #define DPI_SUBSCR_QOS_DEREG_NFY 0x02 #define DPI_SUBSCR_QOS_ROWIDS 0x04 #define DPI_SUBSCR_QOS_QUERY 0x08 #define DPI_SUBSCR_QOS_BEST_EFFORT 0x10 // two-phase commit (flags for dpiConn_tpcBegin()) typedef uint32_t dpiTpcBeginFlags; #define DPI_TPC_BEGIN_JOIN 0x00000002 #define DPI_TPC_BEGIN_NEW 0x00000001 #define DPI_TPC_BEGIN_PROMOTE 0x00000008 #define DPI_TPC_BEGIN_RESUME 0x00000004 // two-phase commit (flags for dpiConn_tpcEnd()) typedef uint32_t dpiTpcEndFlags; #define DPI_TPC_END_NORMAL 0 #define DPI_TPC_END_SUSPEND 0x00100000 // vector flags typedef uint8_t dpiVectorFlags; #define DPI_VECTOR_FLAGS_FLEXIBLE_DIM 0x01 // vector formats typedef uint8_t dpiVectorFormat; #define DPI_VECTOR_FORMAT_FLOAT32 2 #define DPI_VECTOR_FORMAT_FLOAT64 3 #define DPI_VECTOR_FORMAT_INT8 4 #define DPI_VECTOR_FORMAT_BINARY 5 // visibility of messages in advanced queuing typedef uint32_t dpiVisibility; #define DPI_VISIBILITY_IMMEDIATE 1 #define DPI_VISIBILITY_ON_COMMIT 2 //----------------------------------------------------------------------------- // Handle Types //----------------------------------------------------------------------------- typedef struct dpiConn dpiConn; typedef struct dpiContext dpiContext; typedef struct dpiDeqOptions dpiDeqOptions; typedef struct dpiEnqOptions dpiEnqOptions; typedef struct dpiJson dpiJson; typedef struct dpiLob dpiLob; typedef struct dpiMsgProps dpiMsgProps; typedef struct dpiObject dpiObject; typedef struct dpiObjectAttr dpiObjectAttr; typedef struct dpiObjectType dpiObjectType; typedef struct dpiPool dpiPool; typedef struct dpiQueue dpiQueue; typedef struct dpiRowid dpiRowid; typedef struct dpiSodaColl dpiSodaColl; typedef struct dpiSodaCollCursor dpiSodaCollCursor; typedef struct dpiSodaDb dpiSodaDb; typedef struct dpiSodaDoc dpiSodaDoc; typedef struct dpiSodaDocCursor dpiSodaDocCursor; typedef struct dpiStmt dpiStmt; typedef struct dpiSubscr dpiSubscr; typedef struct dpiVar dpiVar; typedef struct dpiVector dpiVector; //----------------------------------------------------------------------------- // Forward Declarations of Other Types //----------------------------------------------------------------------------- typedef struct dpiAccessToken dpiAccessToken; typedef struct dpiAnnotation dpiAnnotation; typedef struct dpiAppContext dpiAppContext; typedef struct dpiCommonCreateParams dpiCommonCreateParams; typedef struct dpiConnCreateParams dpiConnCreateParams; typedef struct dpiConnInfo dpiConnInfo; typedef struct dpiContextCreateParams dpiContextCreateParams; typedef struct dpiData dpiData; typedef union dpiDataBuffer dpiDataBuffer; typedef struct dpiDataTypeInfo dpiDataTypeInfo; typedef struct dpiEncodingInfo dpiEncodingInfo; typedef struct dpiErrorInfo dpiErrorInfo; typedef struct dpiJsonNode dpiJsonNode; typedef struct dpiMsgRecipient dpiMsgRecipient; typedef struct dpiObjectAttrInfo dpiObjectAttrInfo; typedef struct dpiObjectTypeInfo dpiObjectTypeInfo; typedef struct dpiPoolCreateParams dpiPoolCreateParams; typedef struct dpiQueryInfo dpiQueryInfo; typedef struct dpiShardingKeyColumn dpiShardingKeyColumn; typedef struct dpiStringList dpiSodaCollNames; typedef struct dpiSodaOperOptions dpiSodaOperOptions; typedef struct dpiStmtInfo dpiStmtInfo; typedef struct dpiStringList dpiStringList; typedef struct dpiSubscrCreateParams dpiSubscrCreateParams; typedef struct dpiSubscrMessage dpiSubscrMessage; typedef struct dpiSubscrMessageQuery dpiSubscrMessageQuery; typedef struct dpiSubscrMessageRow dpiSubscrMessageRow; typedef struct dpiSubscrMessageTable dpiSubscrMessageTable; typedef struct dpiVectorInfo dpiVectorInfo; typedef union dpiVectorDimensionBuffer dpiVectorDimensionBuffer; typedef struct dpiVersionInfo dpiVersionInfo; typedef struct dpiXid dpiXid; //----------------------------------------------------------------------------- // Declaration for function pointers //----------------------------------------------------------------------------- typedef int (*dpiAccessTokenCallback)(void *context, dpiAccessToken *accessToken); //----------------------------------------------------------------------------- // Complex Native Data Types (used for transferring data to/from ODPI-C) //----------------------------------------------------------------------------- // structure used for transferring byte strings to/from ODPI-C typedef struct { char *ptr; uint32_t length; const char *encoding; } dpiBytes; // structure used for transferring day/seconds intervals to/from ODPI-C typedef struct { int32_t days; int32_t hours; int32_t minutes; int32_t seconds; int32_t fseconds; } dpiIntervalDS; // structure used for transferring years/months intervals to/from ODPI-C typedef struct { int32_t years; int32_t months; } dpiIntervalYM; // structure used for transferring JSON nodes to/from ODPI-C struct dpiJsonNode { dpiOracleTypeNum oracleTypeNum; dpiNativeTypeNum nativeTypeNum; dpiDataBuffer *value; }; // structure used for transferring JSON object values to/from ODPI-C typedef struct { uint32_t numFields; char **fieldNames; uint32_t *fieldNameLengths; dpiJsonNode *fields; dpiDataBuffer *fieldValues; } dpiJsonObject; // structure used for transferring JSON array values to/from ODPI-C typedef struct { uint32_t numElements; dpiJsonNode *elements; dpiDataBuffer *elementValues; } dpiJsonArray; // structure used for transferring dates to/from ODPI-C typedef struct { int16_t year; uint8_t month; uint8_t day; uint8_t hour; uint8_t minute; uint8_t second; uint32_t fsecond; int8_t tzHourOffset; int8_t tzMinuteOffset; } dpiTimestamp; //----------------------------------------------------------------------------- // Other Types //----------------------------------------------------------------------------- // union used for providing a buffer of any data type union dpiDataBuffer { int asBoolean; uint8_t asUint8; uint16_t asUint16; uint32_t asUint32; int64_t asInt64; uint64_t asUint64; float asFloat; double asDouble; char *asString; void *asRaw; dpiBytes asBytes; dpiTimestamp asTimestamp; dpiIntervalDS asIntervalDS; dpiIntervalYM asIntervalYM; dpiJson *asJson; dpiJsonObject asJsonObject; dpiJsonArray asJsonArray; dpiLob *asLOB; dpiObject *asObject; dpiStmt *asStmt; dpiRowid *asRowid; dpiVector *asVector; }; // structure used for annotations struct dpiAnnotation { const char *key; uint32_t keyLength; const char *value; uint32_t valueLength; }; // structure used for application context struct dpiAppContext { const char *namespaceName; uint32_t namespaceNameLength; const char *name; uint32_t nameLength; const char *value; uint32_t valueLength; }; // structure used for common parameters used for creating standalone // connections and session pools struct dpiCommonCreateParams { dpiCreateMode createMode; const char *encoding; const char *nencoding; const char *edition; uint32_t editionLength; const char *driverName; uint32_t driverNameLength; int sodaMetadataCache; uint32_t stmtCacheSize; dpiAccessToken *accessToken; }; // structure used for creating connections struct dpiConnCreateParams { dpiAuthMode authMode; const char *connectionClass; uint32_t connectionClassLength; dpiPurity purity; const char *newPassword; uint32_t newPasswordLength; dpiAppContext *appContext; uint32_t numAppContext; int externalAuth; void *externalHandle; dpiPool *pool; const char *tag; uint32_t tagLength; int matchAnyTag; const char *outTag; uint32_t outTagLength; int outTagFound; dpiShardingKeyColumn *shardingKeyColumns; uint8_t numShardingKeyColumns; dpiShardingKeyColumn *superShardingKeyColumns; uint8_t numSuperShardingKeyColumns; int outNewSession; }; // structure used for transferring connection information from ODPI-C struct dpiConnInfo { const char *dbDomain; uint32_t dbDomainLength; const char *dbName; uint32_t dbNameLength; const char *instanceName; uint32_t instanceNameLength; const char *serviceName; uint32_t serviceNameLength; uint32_t maxIdentifierLength; uint32_t maxOpenCursors; uint8_t serverType; }; // structure used for creating a context struct dpiContextCreateParams { const char *defaultDriverName; const char *defaultEncoding; const char *loadErrorUrl; const char *oracleClientLibDir; const char *oracleClientConfigDir; int sodaUseJsonDesc; int useJsonId; }; // structure used for transferring data to/from ODPI-C struct dpiData { int isNull; dpiDataBuffer value; }; // structure used for providing metadata about data types struct dpiDataTypeInfo { dpiOracleTypeNum oracleTypeNum; dpiNativeTypeNum defaultNativeTypeNum; uint16_t ociTypeCode; uint32_t dbSizeInBytes; uint32_t clientSizeInBytes; uint32_t sizeInChars; int16_t precision; int8_t scale; uint8_t fsPrecision; dpiObjectType *objectType; int isJson; const char *domainSchema; uint32_t domainSchemaLength; const char *domainName; uint32_t domainNameLength; uint32_t numAnnotations; dpiAnnotation *annotations; int isOson; uint32_t vectorDimensions; uint8_t vectorFormat; uint8_t vectorFlags; }; // structure used for storing token authentication data struct dpiAccessToken { const char *token; uint32_t tokenLength; const char *privateKey; uint32_t privateKeyLength; }; // structure used for transferring encoding information from ODPI-C struct dpiEncodingInfo { const char *encoding; int32_t maxBytesPerCharacter; const char *nencoding; int32_t nmaxBytesPerCharacter; }; // structure used for transferring error information from ODPI-C struct dpiErrorInfo { int32_t code; uint16_t offset16; const char *message; uint32_t messageLength; const char *encoding; const char *fnName; const char *action; const char *sqlState; int isRecoverable; int isWarning; uint32_t offset; }; // structure used for transferring object attribute information from ODPI-C struct dpiObjectAttrInfo { const char *name; uint32_t nameLength; dpiDataTypeInfo typeInfo; }; // structure used for transferring object type information from ODPI-C struct dpiObjectTypeInfo { const char *schema; uint32_t schemaLength; const char *name; uint32_t nameLength; int isCollection; dpiDataTypeInfo elementTypeInfo; uint16_t numAttributes; const char *packageName; uint32_t packageNameLength; }; // structure used for creating pools struct dpiPoolCreateParams { uint32_t minSessions; uint32_t maxSessions; uint32_t sessionIncrement; int pingInterval; int pingTimeout; int homogeneous; int externalAuth; dpiPoolGetMode getMode; const char *outPoolName; uint32_t outPoolNameLength; uint32_t timeout; uint32_t waitTimeout; uint32_t maxLifetimeSession; const char *plsqlFixupCallback; uint32_t plsqlFixupCallbackLength; uint32_t maxSessionsPerShard; dpiAccessTokenCallback accessTokenCallback; void *accessTokenCallbackContext; }; // structure used for transferring query metadata from ODPI-C struct dpiQueryInfo { const char *name; uint32_t nameLength; dpiDataTypeInfo typeInfo; int nullOk; }; // structure used for recipients list struct dpiMsgRecipient { const char *name; uint32_t nameLength; }; // structure used for sharding key columns struct dpiShardingKeyColumn { dpiOracleTypeNum oracleTypeNum; dpiNativeTypeNum nativeTypeNum; dpiDataBuffer value; }; // structure used for getting an array of strings from the database; the unions // are for aliases for the names used when the structure was called // dpiSodaCollNames instead struct dpiStringList { union { uint32_t numStrings; uint32_t numNames; }; union { const char **strings; const char **names; }; union { uint32_t *stringLengths; uint32_t *nameLengths; }; }; // structure used for SODA operations (find/replace/remove) struct dpiSodaOperOptions { uint32_t numKeys; const char **keys; uint32_t *keyLengths; const char *key; uint32_t keyLength; const char *version; uint32_t versionLength; const char *filter; uint32_t filterLength; uint32_t skip; uint32_t limit; uint32_t fetchArraySize; const char *hint; uint32_t hintLength; int lock; }; // structure used for transferring statement information from ODPI-C struct dpiStmtInfo { int isQuery; int isPLSQL; int isDDL; int isDML; dpiStatementType statementType; int isReturning; }; // callback for subscriptions typedef void (*dpiSubscrCallback)(void* context, dpiSubscrMessage *message); // structure used for creating subscriptions struct dpiSubscrCreateParams { dpiSubscrNamespace subscrNamespace; dpiSubscrProtocol protocol; dpiSubscrQOS qos; dpiOpCode operations; uint32_t portNumber; uint32_t timeout; const char *name; uint32_t nameLength; dpiSubscrCallback callback; void *callbackContext; const char *recipientName; uint32_t recipientNameLength; const char *ipAddress; uint32_t ipAddressLength; uint8_t groupingClass; uint32_t groupingValue; uint8_t groupingType; uint64_t outRegId; int clientInitiated; }; // structure used for transferring messages in subscription callbacks struct dpiSubscrMessage { dpiEventType eventType; const char *dbName; uint32_t dbNameLength; dpiSubscrMessageTable *tables; uint32_t numTables; dpiSubscrMessageQuery *queries; uint32_t numQueries; dpiErrorInfo *errorInfo; const void *txId; uint32_t txIdLength; int registered; const char *queueName; uint32_t queueNameLength; const char *consumerName; uint32_t consumerNameLength; const void *aqMsgId; uint32_t aqMsgIdLength; }; // structure used for transferring query information in messages in // subscription callbacks (continuous query notification) struct dpiSubscrMessageQuery { uint64_t id; dpiOpCode operation; dpiSubscrMessageTable *tables; uint32_t numTables; }; // structure used for transferring row information in messages in // subscription callbacks struct dpiSubscrMessageRow { dpiOpCode operation; const char *rowid; uint32_t rowidLength; }; // structure used for transferring table information in messages in // subscription callbacks struct dpiSubscrMessageTable { dpiOpCode operation; const char *name; uint32_t nameLength; dpiSubscrMessageRow *rows; uint32_t numRows; }; // structure used for transferring version information struct dpiVersionInfo { int versionNum; int releaseNum; int updateNum; int portReleaseNum; int portUpdateNum; uint32_t fullVersionNum; }; // union used for providing a buffer for vector dimensions union dpiVectorDimensionBuffer { void* asPtr; int8_t* asInt8; float* asFloat; double* asDouble; }; // structure used for transferring vector information struct dpiVectorInfo { uint8_t format; uint32_t numDimensions; uint8_t dimensionSize; dpiVectorDimensionBuffer dimensions; }; // structure used for defining two-phase commit transaction ids (XIDs) struct dpiXid { long formatId; const char *globalTransactionId; uint32_t globalTransactionIdLength; const char *branchQualifier; uint32_t branchQualifierLength; }; //----------------------------------------------------------------------------- // Context Methods (dpiContext) //----------------------------------------------------------------------------- // define macro for backwards compatibility #define dpiContext_create(majorVersion, minorVersion, context, errorInfo) \ dpiContext_createWithParams(majorVersion, minorVersion, NULL, context, \ errorInfo) // create a context handle and validate the version information (with params) DPI_EXPORT int dpiContext_createWithParams(unsigned int majorVersion, unsigned int minorVersion, dpiContextCreateParams *params, dpiContext **context, dpiErrorInfo *errorInfo); // destroy context handle DPI_EXPORT int dpiContext_destroy(dpiContext *context); // free string list contents DPI_EXPORT int dpiContext_freeStringList(dpiContext *context, dpiStringList *list); // return the OCI client version in use DPI_EXPORT int dpiContext_getClientVersion(const dpiContext *context, dpiVersionInfo *versionInfo); // get error information DPI_EXPORT void dpiContext_getError(const dpiContext *context, dpiErrorInfo *errorInfo); // initialize context parameters to default values DPI_EXPORT int dpiContext_initCommonCreateParams(const dpiContext *context, dpiCommonCreateParams *params); // initialize connection create parameters to default values DPI_EXPORT int dpiContext_initConnCreateParams(const dpiContext *context, dpiConnCreateParams *params); // initialize pool create parameters to default values DPI_EXPORT int dpiContext_initPoolCreateParams(const dpiContext *context, dpiPoolCreateParams *params); // initialize SODA operation options to default values DPI_EXPORT int dpiContext_initSodaOperOptions(const dpiContext *context, dpiSodaOperOptions *options); // initialize subscription create parameters to default values DPI_EXPORT int dpiContext_initSubscrCreateParams(const dpiContext *context, dpiSubscrCreateParams *params); //----------------------------------------------------------------------------- // Connection Methods (dpiConn) //----------------------------------------------------------------------------- // add a reference to a connection DPI_EXPORT int dpiConn_addRef(dpiConn *conn); // break execution of the statement running on the connection DPI_EXPORT int dpiConn_breakExecution(dpiConn *conn); // change the password for the specified user DPI_EXPORT int dpiConn_changePassword(dpiConn *conn, const char *userName, uint32_t userNameLength, const char *oldPassword, uint32_t oldPasswordLength, const char *newPassword, uint32_t newPasswordLength); // close the connection now, not when the reference count reaches zero DPI_EXPORT int dpiConn_close(dpiConn *conn, dpiConnCloseMode mode, const char *tag, uint32_t tagLength); // commits the current active transaction DPI_EXPORT int dpiConn_commit(dpiConn *conn); // create a connection and return a reference to it DPI_EXPORT int dpiConn_create(const dpiContext *context, const char *userName, uint32_t userNameLength, const char *password, uint32_t passwordLength, const char *connectString, uint32_t connectStringLength, const dpiCommonCreateParams *commonParams, dpiConnCreateParams *createParams, dpiConn **conn); // dequeue a message from a queue DPI_EXPORT int dpiConn_deqObject(dpiConn *conn, const char *queueName, uint32_t queueNameLength, dpiDeqOptions *options, dpiMsgProps *props, dpiObject *payload, const char **msgId, uint32_t *msgIdLength); // enqueue a message to a queue DPI_EXPORT int dpiConn_enqObject(dpiConn *conn, const char *queueName, uint32_t queueNameLength, dpiEnqOptions *options, dpiMsgProps *props, dpiObject *payload, const char **msgId, uint32_t *msgIdLength); // get call timeout in place for round-trips with this connection DPI_EXPORT int dpiConn_getCallTimeout(dpiConn *conn, uint32_t *value); // get current schema associated with the connection DPI_EXPORT int dpiConn_getCurrentSchema(dpiConn *conn, const char **value, uint32_t *valueLength); // get database domain name DPI_EXPORT int dpiConn_getDbDomain(dpiConn *conn, const char **value, uint32_t *valueLength); // get database name DPI_EXPORT int dpiConn_getDbName(dpiConn *conn, const char **value, uint32_t *valueLength); // get edition associated with the connection DPI_EXPORT int dpiConn_getEdition(dpiConn *conn, const char **value, uint32_t *valueLength); // return the encoding information used by the connection DPI_EXPORT int dpiConn_getEncodingInfo(dpiConn *conn, dpiEncodingInfo *info); // get external name associated with the connection DPI_EXPORT int dpiConn_getExternalName(dpiConn *conn, const char **value, uint32_t *valueLength); // get the OCI service context handle associated with the connection DPI_EXPORT int dpiConn_getHandle(dpiConn *conn, void **handle); // return information about the connection DPI_EXPORT int dpiConn_getInfo(dpiConn *conn, dpiConnInfo *info); // get instance name associated with the connection DPI_EXPORT int dpiConn_getInstanceName(dpiConn *conn, const char **value, uint32_t *valueLength); // get internal name associated with the connection DPI_EXPORT int dpiConn_getInternalName(dpiConn *conn, const char **value, uint32_t *valueLength); // get the health of a connection DPI_EXPORT int dpiConn_getIsHealthy(dpiConn *conn, int *isHealthy); // get logical transaction id associated with the connection DPI_EXPORT int dpiConn_getLTXID(dpiConn *conn, const char **value, uint32_t *valueLength); // get the maximum number of open cursors allowed by the database DPI_EXPORT int dpiConn_getMaxOpenCursors(dpiConn *conn, uint32_t *maxOpenCursors); // create a new object type and return it for subsequent object creation DPI_EXPORT int dpiConn_getObjectType(dpiConn *conn, const char *name, uint32_t nameLength, dpiObjectType **objType); // generic method for getting an OCI connection attribute // WARNING: use only as directed by Oracle DPI_EXPORT int dpiConn_getOciAttr(dpiConn *conn, uint32_t handleType, uint32_t attribute, dpiDataBuffer *value, uint32_t *valueLength); // return information about the server version in use DPI_EXPORT int dpiConn_getServerVersion(dpiConn *conn, const char **releaseString, uint32_t *releaseStringLength, dpiVersionInfo *versionInfo); // get the service name used to connect to the database DPI_EXPORT int dpiConn_getServiceName(dpiConn *conn, const char **value, uint32_t *valueLength); // get SODA interface object DPI_EXPORT int dpiConn_getSodaDb(dpiConn *conn, dpiSodaDb **db); // return the statement cache size DPI_EXPORT int dpiConn_getStmtCacheSize(dpiConn *conn, uint32_t *cacheSize); // get whether or not a transaction is in progress DPI_EXPORT int dpiConn_getTransactionInProgress(dpiConn *conn, int *txnInProgress); // create a new dequeue options object and return it DPI_EXPORT int dpiConn_newDeqOptions(dpiConn *conn, dpiDeqOptions **options); // create a new enqueue options object and return it DPI_EXPORT int dpiConn_newEnqOptions(dpiConn *conn, dpiEnqOptions **options); // create a new, empty JSON DPI_EXPORT int dpiConn_newJson(dpiConn *conn, dpiJson **json); // create a new AQ queue with JSON payload DPI_EXPORT int dpiConn_newJsonQueue(dpiConn *conn, const char *name, uint32_t nameLength, dpiQueue **queue); // create a new message properties object and return it DPI_EXPORT int dpiConn_newMsgProps(dpiConn *conn, dpiMsgProps **props); // create a new AQ queue DPI_EXPORT int dpiConn_newQueue(dpiConn *conn, const char *name, uint32_t nameLength, dpiObjectType *payloadType, dpiQueue **queue); // create a new temporary LOB DPI_EXPORT int dpiConn_newTempLob(dpiConn *conn, dpiOracleTypeNum lobType, dpiLob **lob); // create a new variable and return it for subsequent binding/defining DPI_EXPORT int dpiConn_newVar(dpiConn *conn, dpiOracleTypeNum oracleTypeNum, dpiNativeTypeNum nativeTypeNum, uint32_t maxArraySize, uint32_t size, int sizeIsBytes, int isArray, dpiObjectType *objType, dpiVar **var, dpiData **data); // create a new vector DPI_EXPORT int dpiConn_newVector(dpiConn *conn, dpiVectorInfo *info, dpiVector **vector); // ping the connection to see if it is still alive DPI_EXPORT int dpiConn_ping(dpiConn *conn); // prepare a statement and return it for subsequent execution/fetching DPI_EXPORT int dpiConn_prepareStmt(dpiConn *conn, int scrollable, const char *sql, uint32_t sqlLength, const char *tag, uint32_t tagLength, dpiStmt **stmt); // release a reference to the connection DPI_EXPORT int dpiConn_release(dpiConn *conn); // rolls back the current active transaction DPI_EXPORT int dpiConn_rollback(dpiConn *conn); // set action associated with the connection DPI_EXPORT int dpiConn_setAction(dpiConn *conn, const char *value, uint32_t valueLength); // set call timeout for subsequent round-trips with this connection DPI_EXPORT int dpiConn_setCallTimeout(dpiConn *conn, uint32_t value); // set client identifier associated with the connection DPI_EXPORT int dpiConn_setClientIdentifier(dpiConn *conn, const char *value, uint32_t valueLength); // set client info associated with the connection DPI_EXPORT int dpiConn_setClientInfo(dpiConn *conn, const char *value, uint32_t valueLength); // set current schema associated with the connection DPI_EXPORT int dpiConn_setCurrentSchema(dpiConn *conn, const char *value, uint32_t valueLength); // set database operation associated with the connection DPI_EXPORT int dpiConn_setDbOp(dpiConn *conn, const char *value, uint32_t valueLength); // set execution context id associated with the connection DPI_EXPORT int dpiConn_setEcontextId(dpiConn *conn, const char *value, uint32_t valueLength); // set external name associated with the connection DPI_EXPORT int dpiConn_setExternalName(dpiConn *conn, const char *value, uint32_t valueLength); // set internal name associated with the connection DPI_EXPORT int dpiConn_setInternalName(dpiConn *conn, const char *value, uint32_t valueLength); // set module associated with the connection DPI_EXPORT int dpiConn_setModule(dpiConn *conn, const char *value, uint32_t valueLength); // generic method for setting an OCI connection attribute // WARNING: use only as directed by Oracle DPI_EXPORT int dpiConn_setOciAttr(dpiConn *conn, uint32_t handleType, uint32_t attribute, void *value, uint32_t valueLength); // set the statement cache size DPI_EXPORT int dpiConn_setStmtCacheSize(dpiConn *conn, uint32_t cacheSize); // shutdown the database DPI_EXPORT int dpiConn_shutdownDatabase(dpiConn *conn, dpiShutdownMode mode); // startup the database DPI_EXPORT int dpiConn_startupDatabase(dpiConn *conn, dpiStartupMode mode); // startup the database with a PFILE DPI_EXPORT int dpiConn_startupDatabaseWithPfile(dpiConn *conn, const char *pfile, uint32_t pfileLength, dpiStartupMode mode); // subscribe to events in the database DPI_EXPORT int dpiConn_subscribe(dpiConn *conn, dpiSubscrCreateParams *params, dpiSubscr **subscr); // begin a TPC (two-phase commit) transaction DPI_EXPORT int dpiConn_tpcBegin(dpiConn *conn, dpiXid *xid, uint32_t transactionTimeout, uint32_t flags); // commit a TPC (two-phase commit) transaction DPI_EXPORT int dpiConn_tpcCommit(dpiConn *conn, dpiXid *xid, int onePhase); // end (detach from) a TPC (two-phase commit) transaction DPI_EXPORT int dpiConn_tpcEnd(dpiConn *conn, dpiXid *xid, uint32_t flags); // forget a TPC (two-phase commit) transaction DPI_EXPORT int dpiConn_tpcForget(dpiConn *conn, dpiXid *xid); // prepare a TPC (two-phase commit) transaction for commit DPI_EXPORT int dpiConn_tpcPrepare(dpiConn *conn, dpiXid *xid, int *commitNeeded); // rollback a TPC (two-phase commit) transaction DPI_EXPORT int dpiConn_tpcRollback(dpiConn *conn, dpiXid *xid); // unsubscribe from events in the database DPI_EXPORT int dpiConn_unsubscribe(dpiConn *conn, dpiSubscr *subscr); //----------------------------------------------------------------------------- // Data Methods (dpiData) //----------------------------------------------------------------------------- // return the boolean portion of the data DPI_EXPORT int dpiData_getBool(dpiData *data); // return the bytes portion of the data DPI_EXPORT dpiBytes *dpiData_getBytes(dpiData *data); // return the double portion of the data DPI_EXPORT double dpiData_getDouble(dpiData *data); // return the float portion of the data DPI_EXPORT float dpiData_getFloat(dpiData *data); // return the integer portion of the data DPI_EXPORT int64_t dpiData_getInt64(dpiData *data); // return the interval (days/seconds) portion of the data DPI_EXPORT dpiIntervalDS *dpiData_getIntervalDS(dpiData *data); // return the interval (years/months) portion of the data DPI_EXPORT dpiIntervalYM *dpiData_getIntervalYM(dpiData *data); // return whether data value is null or not DPI_EXPORT int dpiData_getIsNull(dpiData *data); // return the JSON portion of the data DPI_EXPORT dpiJson *dpiData_getJson(dpiData *data); // return the JSON Array portion of the data DPI_EXPORT dpiJsonArray *dpiData_getJsonArray(dpiData *data); // return the JSON Object portion of the data DPI_EXPORT dpiJsonObject *dpiData_getJsonObject(dpiData *data); // return the LOB portion of the data DPI_EXPORT dpiLob *dpiData_getLOB(dpiData *data); // return the object portion of the data DPI_EXPORT dpiObject *dpiData_getObject(dpiData *data); // return the statement portion of the data DPI_EXPORT dpiStmt *dpiData_getStmt(dpiData *data); // return the timestamp portion of the data DPI_EXPORT dpiTimestamp *dpiData_getTimestamp(dpiData *data); // return the unsigned integer portion of the data DPI_EXPORT uint64_t dpiData_getUint64(dpiData *data); // set the boolean portion of the data DPI_EXPORT void dpiData_setBool(dpiData *data, int value); // set the bytes portion of the data DPI_EXPORT void dpiData_setBytes(dpiData *data, char *ptr, uint32_t length); // set the double portion of the data DPI_EXPORT void dpiData_setDouble(dpiData *data, double value); // set the float portion of the data DPI_EXPORT void dpiData_setFloat(dpiData *data, float value); // set the integer portion of the data DPI_EXPORT void dpiData_setInt64(dpiData *data, int64_t value); // set the interval (days/seconds) portion of the data DPI_EXPORT void dpiData_setIntervalDS(dpiData *data, int32_t days, int32_t hours, int32_t minutes, int32_t seconds, int32_t fsceconds); // set the interval (years/months) portion of the data DPI_EXPORT void dpiData_setIntervalYM(dpiData *data, int32_t years, int32_t months); // set the LOB portion of the data DPI_EXPORT void dpiData_setLOB(dpiData *data, dpiLob *lob); // set data to the null value DPI_EXPORT void dpiData_setNull(dpiData *data); // set the object portion of the data DPI_EXPORT void dpiData_setObject(dpiData *data, dpiObject *obj); // set the statement portion of the data DPI_EXPORT void dpiData_setStmt(dpiData *data, dpiStmt *stmt); // set the timestamp portion of the data DPI_EXPORT void dpiData_setTimestamp(dpiData *data, int16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second, uint32_t fsecond, int8_t tzHourOffset, int8_t tzMinuteOffset); // set the unsigned integer portion of the data DPI_EXPORT void dpiData_setUint64(dpiData *data, uint64_t value); //----------------------------------------------------------------------------- // Dequeue Option Methods (dpiDeqOptions) //----------------------------------------------------------------------------- // add a reference to dequeue options DPI_EXPORT int dpiDeqOptions_addRef(dpiDeqOptions *options); // return condition associated with dequeue options DPI_EXPORT int dpiDeqOptions_getCondition(dpiDeqOptions *options, const char **value, uint32_t *valueLength); // return consumer name associated with dequeue options DPI_EXPORT int dpiDeqOptions_getConsumerName(dpiDeqOptions *options, const char **value, uint32_t *valueLength); // return correlation associated with dequeue options DPI_EXPORT int dpiDeqOptions_getCorrelation(dpiDeqOptions *options, const char **value, uint32_t *valueLength); // return mode associated with dequeue options DPI_EXPORT int dpiDeqOptions_getMode(dpiDeqOptions *options, dpiDeqMode *value); // return message id associated with dequeue options DPI_EXPORT int dpiDeqOptions_getMsgId(dpiDeqOptions *options, const char **value, uint32_t *valueLength); // return navigation associated with dequeue options DPI_EXPORT int dpiDeqOptions_getNavigation(dpiDeqOptions *options, dpiDeqNavigation *value); // return transformation associated with dequeue options DPI_EXPORT int dpiDeqOptions_getTransformation(dpiDeqOptions *options, const char **value, uint32_t *valueLength); // return visibility associated with dequeue options DPI_EXPORT int dpiDeqOptions_getVisibility(dpiDeqOptions *options, dpiVisibility *value); // return wait time associated with dequeue options DPI_EXPORT int dpiDeqOptions_getWait(dpiDeqOptions *options, uint32_t *value); // release a reference from dequeue options DPI_EXPORT int dpiDeqOptions_release(dpiDeqOptions *options); // set condition associated with dequeue options DPI_EXPORT int dpiDeqOptions_setCondition(dpiDeqOptions *options, const char *value, uint32_t valueLength); // set consumer name associated with dequeue options DPI_EXPORT int dpiDeqOptions_setConsumerName(dpiDeqOptions *options, const char *value, uint32_t valueLength); // set correlation associated with dequeue options DPI_EXPORT int dpiDeqOptions_setCorrelation(dpiDeqOptions *options, const char *value, uint32_t valueLength); // set delivery mode associated with dequeue options DPI_EXPORT int dpiDeqOptions_setDeliveryMode(dpiDeqOptions *options, dpiMessageDeliveryMode value); // set mode associated with dequeue options DPI_EXPORT int dpiDeqOptions_setMode(dpiDeqOptions *options, dpiDeqMode value); // set message id associated with dequeue options DPI_EXPORT int dpiDeqOptions_setMsgId(dpiDeqOptions *options, const char *value, uint32_t valueLength); // set navigation associated with dequeue options DPI_EXPORT int dpiDeqOptions_setNavigation(dpiDeqOptions *options, dpiDeqNavigation value); // set transformation associated with dequeue options DPI_EXPORT int dpiDeqOptions_setTransformation(dpiDeqOptions *options, const char *value, uint32_t valueLength); // set visibility associated with dequeue options DPI_EXPORT int dpiDeqOptions_setVisibility(dpiDeqOptions *options, dpiVisibility value); // set wait time associated with dequeue options DPI_EXPORT int dpiDeqOptions_setWait(dpiDeqOptions *options, uint32_t value); //----------------------------------------------------------------------------- // Enqueue Option Methods (dpiEnqOptions) //----------------------------------------------------------------------------- // add a reference to enqueue options DPI_EXPORT int dpiEnqOptions_addRef(dpiEnqOptions *options); // return transformation associated with enqueue options DPI_EXPORT int dpiEnqOptions_getTransformation(dpiEnqOptions *options, const char **value, uint32_t *valueLength); // return visibility associated with enqueue options DPI_EXPORT int dpiEnqOptions_getVisibility(dpiEnqOptions *options, dpiVisibility *value); // release a reference from enqueue options DPI_EXPORT int dpiEnqOptions_release(dpiEnqOptions *options); // set delivery mode associated with enqueue options DPI_EXPORT int dpiEnqOptions_setDeliveryMode(dpiEnqOptions *options, dpiMessageDeliveryMode value); // set transformation associated with enqueue options DPI_EXPORT int dpiEnqOptions_setTransformation(dpiEnqOptions *options, const char *value, uint32_t valueLength); // set visibility associated with enqueue options DPI_EXPORT int dpiEnqOptions_setVisibility(dpiEnqOptions *options, dpiVisibility value); //----------------------------------------------------------------------------- // JSON Methods (dpiJson) //----------------------------------------------------------------------------- // add a reference to the JSON DPI_EXPORT int dpiJson_addRef(dpiJson *json); // return the value of the JSON object, as a hierarchy of nodes DPI_EXPORT int dpiJson_getValue(dpiJson *json, uint32_t options, dpiJsonNode **topNode); // release a reference to the JSON DPI_EXPORT int dpiJson_release(dpiJson *json); // parse textual JSON into JSON handle DPI_EXPORT int dpiJson_setFromText(dpiJson *json, const char *value, uint64_t valueLength, uint32_t flags); // set the value of the JSON object, given a hierarchy of nodes DPI_EXPORT int dpiJson_setValue(dpiJson *json, dpiJsonNode *topNode); //----------------------------------------------------------------------------- // LOB Methods (dpiLob) //----------------------------------------------------------------------------- // add a reference to the LOB DPI_EXPORT int dpiLob_addRef(dpiLob *lob); // close the LOB DPI_EXPORT int dpiLob_close(dpiLob *lob); // close the LOB's resources DPI_EXPORT int dpiLob_closeResource(dpiLob *lob); // create a copy of the LOB DPI_EXPORT int dpiLob_copy(dpiLob *lob, dpiLob **copiedLob); // get buffer size in bytes for a LOB DPI_EXPORT int dpiLob_getBufferSize(dpiLob *lob, uint64_t sizeInChars, uint64_t *sizeInBytes); // return the chunk size for the LOB DPI_EXPORT int dpiLob_getChunkSize(dpiLob *lob, uint32_t *size); // return the directory alias name and file name of a BFILE LOB DPI_EXPORT int dpiLob_getDirectoryAndFileName(dpiLob *lob, const char **directoryAlias, uint32_t *directoryAliasLength, const char **fileName, uint32_t *fileNameLength); // return if the file associated with a BFILE LOB exists DPI_EXPORT int dpiLob_getFileExists(dpiLob *lob, int *exists); // return if the LOB's resources are currently open DPI_EXPORT int dpiLob_getIsResourceOpen(dpiLob *lob, int *isOpen); // return the current size of the LOB DPI_EXPORT int dpiLob_getSize(dpiLob *lob, uint64_t *size); // return the type of the LOB DPI_EXPORT int dpiLob_getType(dpiLob *lob, dpiOracleTypeNum *type); // open the LOB's resources (used to improve performance of multiple // read/writes operations) DPI_EXPORT int dpiLob_openResource(dpiLob *lob); // read bytes from the LOB at the specified offset DPI_EXPORT int dpiLob_readBytes(dpiLob *lob, uint64_t offset, uint64_t amount, char *value, uint64_t *valueLength); // release a reference to the LOB DPI_EXPORT int dpiLob_release(dpiLob *lob); // set the directory name and file name of the BFILE LOB DPI_EXPORT int dpiLob_setDirectoryAndFileName(dpiLob *lob, const char *directoryAlias, uint32_t directoryAliasLength, const char *fileName, uint32_t fileNameLength); // sets the contents of a LOB from a byte string DPI_EXPORT int dpiLob_setFromBytes(dpiLob *lob, const char *value, uint64_t valueLength); // trim the LOB to the specified size DPI_EXPORT int dpiLob_trim(dpiLob *lob, uint64_t newSize); // write bytes to the LOB at the specified offset DPI_EXPORT int dpiLob_writeBytes(dpiLob *lob, uint64_t offset, const char *value, uint64_t valueLength); //----------------------------------------------------------------------------- // Message Properties Methods (dpiMsgProps) //----------------------------------------------------------------------------- // add a reference to message properties DPI_EXPORT int dpiMsgProps_addRef(dpiMsgProps *props); // return the number of attempts made to deliver the message DPI_EXPORT int dpiMsgProps_getNumAttempts(dpiMsgProps *props, int32_t *value); // return correlation associated with the message DPI_EXPORT int dpiMsgProps_getCorrelation(dpiMsgProps *props, const char **value, uint32_t *valueLength); // return the number of seconds the message was delayed DPI_EXPORT int dpiMsgProps_getDelay(dpiMsgProps *props, int32_t *value); // return the mode used for delivering the message DPI_EXPORT int dpiMsgProps_getDeliveryMode(dpiMsgProps *props, dpiMessageDeliveryMode *value); // return the time the message was enqueued DPI_EXPORT int dpiMsgProps_getEnqTime(dpiMsgProps *props, dpiTimestamp *value); // return the name of the exception queue associated with the message DPI_EXPORT int dpiMsgProps_getExceptionQ(dpiMsgProps *props, const char **value, uint32_t *valueLength); // return the number of seconds until the message expires DPI_EXPORT int dpiMsgProps_getExpiration(dpiMsgProps *props, int32_t *value); // return the message id for the message (after enqueuing or dequeuing) DPI_EXPORT int dpiMsgProps_getMsgId(dpiMsgProps *props, const char **value, uint32_t *valueLength); // return the original message id for the message DPI_EXPORT int dpiMsgProps_getOriginalMsgId(dpiMsgProps *props, const char **value, uint32_t *valueLength); // return the payload of the message (object or bytes) DPI_EXPORT int dpiMsgProps_getPayload(dpiMsgProps *props, dpiObject **obj, const char **value, uint32_t *valueLength); // return the payload of the message (JSON) DPI_EXPORT int dpiMsgProps_getPayloadJson(dpiMsgProps *props, dpiJson **json); // return the priority of the message DPI_EXPORT int dpiMsgProps_getPriority(dpiMsgProps *props, int32_t *value); // return the state of the message DPI_EXPORT int dpiMsgProps_getState(dpiMsgProps *props, dpiMessageState *value); // release a reference from message properties DPI_EXPORT int dpiMsgProps_release(dpiMsgProps *props); // set correlation associated with the message DPI_EXPORT int dpiMsgProps_setCorrelation(dpiMsgProps *props, const char *value, uint32_t valueLength); // set the number of seconds to delay the message DPI_EXPORT int dpiMsgProps_setDelay(dpiMsgProps *props, int32_t value); // set the name of the exception queue associated with the message DPI_EXPORT int dpiMsgProps_setExceptionQ(dpiMsgProps *props, const char *value, uint32_t valueLength); // set the number of seconds until the message expires DPI_EXPORT int dpiMsgProps_setExpiration(dpiMsgProps *props, int32_t value); // set the original message id for the message DPI_EXPORT int dpiMsgProps_setOriginalMsgId(dpiMsgProps *props, const char *value, uint32_t valueLength); // set the payload of the message (as a series of bytes) DPI_EXPORT int dpiMsgProps_setPayloadBytes(dpiMsgProps *props, const char *value, uint32_t valueLength); // set the payload of the message (as JSON) DPI_EXPORT int dpiMsgProps_setPayloadJson(dpiMsgProps *props, dpiJson *json); // set the payload of the message (as an object) DPI_EXPORT int dpiMsgProps_setPayloadObject(dpiMsgProps *props, dpiObject *obj); // set the priority of the message DPI_EXPORT int dpiMsgProps_setPriority(dpiMsgProps *props, int32_t value); // set recipients associated with the message DPI_EXPORT int dpiMsgProps_setRecipients(dpiMsgProps *props, dpiMsgRecipient *recipients, uint32_t numRecipients); //----------------------------------------------------------------------------- // Object Methods (dpiObject) //----------------------------------------------------------------------------- // add a reference to the object DPI_EXPORT int dpiObject_addRef(dpiObject *obj); // append an element to the collection DPI_EXPORT int dpiObject_appendElement(dpiObject *obj, dpiNativeTypeNum nativeTypeNum, dpiData *value); // copy the object and return the copied object DPI_EXPORT int dpiObject_copy(dpiObject *obj, dpiObject **copiedObj); // delete an element from the collection DPI_EXPORT int dpiObject_deleteElementByIndex(dpiObject *obj, int32_t index); // get the value of the specified attribute DPI_EXPORT int dpiObject_getAttributeValue(dpiObject *obj, dpiObjectAttr *attr, dpiNativeTypeNum nativeTypeNum, dpiData *value); // return whether an element exists in a collection at the specified index DPI_EXPORT int dpiObject_getElementExistsByIndex(dpiObject *obj, int32_t index, int *exists); // get the value of the element in a collection at the specified index DPI_EXPORT int dpiObject_getElementValueByIndex(dpiObject *obj, int32_t index, dpiNativeTypeNum nativeTypeNum, dpiData *value); // return the first index used in a collection DPI_EXPORT int dpiObject_getFirstIndex(dpiObject *obj, int32_t *index, int *exists); // return the last index used in a collection DPI_EXPORT int dpiObject_getLastIndex(dpiObject *obj, int32_t *index, int *exists); // return the next index used in a collection given an index DPI_EXPORT int dpiObject_getNextIndex(dpiObject *obj, int32_t index, int32_t *nextIndex, int *exists); // return the previous index used in a collection given an index DPI_EXPORT int dpiObject_getPrevIndex(dpiObject *obj, int32_t index, int32_t *prevIndex, int *exists); // return the number of elements in a collection DPI_EXPORT int dpiObject_getSize(dpiObject *obj, int32_t *size); // release a reference to the object DPI_EXPORT int dpiObject_release(dpiObject *obj); // set the value of the specified attribute DPI_EXPORT int dpiObject_setAttributeValue(dpiObject *obj, dpiObjectAttr *attr, dpiNativeTypeNum nativeTypeNum, dpiData *value); // set the value of the element in a collection at the specified index DPI_EXPORT int dpiObject_setElementValueByIndex(dpiObject *obj, int32_t index, dpiNativeTypeNum nativeTypeNum, dpiData *value); // trim a number of elements from the end of a collection DPI_EXPORT int dpiObject_trim(dpiObject *obj, uint32_t numToTrim); //----------------------------------------------------------------------------- // Object Type Attribute Methods (dpiObjectAttr) //----------------------------------------------------------------------------- // add a reference to the attribute DPI_EXPORT int dpiObjectAttr_addRef(dpiObjectAttr *attr); // return the name of the attribute DPI_EXPORT int dpiObjectAttr_getInfo(dpiObjectAttr *attr, dpiObjectAttrInfo *info); // release a reference to the attribute DPI_EXPORT int dpiObjectAttr_release(dpiObjectAttr *attr); //----------------------------------------------------------------------------- // Object Type Methods (dpiObjectType) //----------------------------------------------------------------------------- // add a reference to the object type DPI_EXPORT int dpiObjectType_addRef(dpiObjectType *objType); // create an object of the specified type and return it DPI_EXPORT int dpiObjectType_createObject(dpiObjectType *objType, dpiObject **obj); // return the attributes available on the object type DPI_EXPORT int dpiObjectType_getAttributes(dpiObjectType *objType, uint16_t numAttributes, dpiObjectAttr **attributes); // return information about the object type DPI_EXPORT int dpiObjectType_getInfo(dpiObjectType *objType, dpiObjectTypeInfo *info); // release a reference to the object type DPI_EXPORT int dpiObjectType_release(dpiObjectType *objType); //----------------------------------------------------------------------------- // Session Pools Methods (dpiPool) //----------------------------------------------------------------------------- // acquire a connection from the pool and return it DPI_EXPORT int dpiPool_acquireConnection(dpiPool *pool, const char *userName, uint32_t userNameLength, const char *password, uint32_t passwordLength, dpiConnCreateParams *createParams, dpiConn **conn); // add a reference to a pool DPI_EXPORT int dpiPool_addRef(dpiPool *pool); // destroy the pool now, not when its reference count reaches zero DPI_EXPORT int dpiPool_close(dpiPool *pool, dpiPoolCloseMode closeMode); // create a session pool and return it DPI_EXPORT int dpiPool_create(const dpiContext *context, const char *userName, uint32_t userNameLength, const char *password, uint32_t passwordLength, const char *connectString, uint32_t connectStringLength, const dpiCommonCreateParams *commonParams, dpiPoolCreateParams *createParams, dpiPool **pool); // get the pool's busy count DPI_EXPORT int dpiPool_getBusyCount(dpiPool *pool, uint32_t *value); // return the encoding information used by the session pool DPI_EXPORT int dpiPool_getEncodingInfo(dpiPool *pool, dpiEncodingInfo *info); // get the pool's "get" mode DPI_EXPORT int dpiPool_getGetMode(dpiPool *pool, dpiPoolGetMode *value); // get the pool's maximum lifetime session DPI_EXPORT int dpiPool_getMaxLifetimeSession(dpiPool *pool, uint32_t *value); // get the pool's maximum sessions per shard DPI_EXPORT int dpiPool_getMaxSessionsPerShard(dpiPool *pool, uint32_t *value); // get the pool's open count DPI_EXPORT int dpiPool_getOpenCount(dpiPool *pool, uint32_t *value); // return whether the SODA metadata cache is enabled or not DPI_EXPORT int dpiPool_getSodaMetadataCache(dpiPool *pool, int *enabled); // return the statement cache size DPI_EXPORT int dpiPool_getStmtCacheSize(dpiPool *pool, uint32_t *cacheSize); // get the pool's timeout value DPI_EXPORT int dpiPool_getTimeout(dpiPool *pool, uint32_t *value); // get the pool's wait timeout value DPI_EXPORT int dpiPool_getWaitTimeout(dpiPool *pool, uint32_t *value); // get the pool-ping-interval DPI_EXPORT int dpiPool_getPingInterval(dpiPool *pool, int *value); // release a reference to the pool DPI_EXPORT int dpiPool_release(dpiPool *pool); // set token parameter for token based authentication DPI_EXPORT int dpiPool_setAccessToken(dpiPool *pool, dpiAccessToken *params); // set the pool's "get" mode DPI_EXPORT int dpiPool_setGetMode(dpiPool *pool, dpiPoolGetMode value); // set the pool's maximum lifetime session DPI_EXPORT int dpiPool_setMaxLifetimeSession(dpiPool *pool, uint32_t value); // set the pool's maximum sessions per shard DPI_EXPORT int dpiPool_setMaxSessionsPerShard(dpiPool *pool, uint32_t value); // set whether the SODA metadata cache is enabled or not DPI_EXPORT int dpiPool_setSodaMetadataCache(dpiPool *pool, int enabled); // set the statement cache size DPI_EXPORT int dpiPool_setStmtCacheSize(dpiPool *pool, uint32_t cacheSize); // set the pool's timeout value DPI_EXPORT int dpiPool_setTimeout(dpiPool *pool, uint32_t value); // set the pool's wait timeout value DPI_EXPORT int dpiPool_setWaitTimeout(dpiPool *pool, uint32_t value); // set the pool-ping-interval value DPI_EXPORT int dpiPool_setPingInterval(dpiPool *pool, int value); //----------------------------------------------------------------------------- // AQ Queue Methods (dpiQueue) //----------------------------------------------------------------------------- // add a reference to the queue DPI_EXPORT int dpiQueue_addRef(dpiQueue *queue); // dequeue multiple messages from the queue DPI_EXPORT int dpiQueue_deqMany(dpiQueue *queue, uint32_t *numProps, dpiMsgProps **props); // dequeue a single message from the queue DPI_EXPORT int dpiQueue_deqOne(dpiQueue *queue, dpiMsgProps **props); // enqueue multiple message to the queue DPI_EXPORT int dpiQueue_enqMany(dpiQueue *queue, uint32_t numProps, dpiMsgProps **props); // enqueue a single message to the queue DPI_EXPORT int dpiQueue_enqOne(dpiQueue *queue, dpiMsgProps *props); // get a reference to the dequeue options associated with the queue DPI_EXPORT int dpiQueue_getDeqOptions(dpiQueue *queue, dpiDeqOptions **options); // get a reference to the enqueue options associated with the queue DPI_EXPORT int dpiQueue_getEnqOptions(dpiQueue *queue, dpiEnqOptions **options); // release a reference to the queue DPI_EXPORT int dpiQueue_release(dpiQueue *queue); // reconfigure the current pool DPI_EXPORT int dpiPool_reconfigure(dpiPool *pool, uint32_t minSessions, uint32_t maxSessions, uint32_t sessionIncrement); //----------------------------------------------------------------------------- // SODA Collection Methods (dpiSodaColl) //----------------------------------------------------------------------------- // add a reference to the SODA collection DPI_EXPORT int dpiSodaColl_addRef(dpiSodaColl *coll); // create an index on the collection DPI_EXPORT int dpiSodaColl_createIndex(dpiSodaColl *coll, const char *indexSpec, uint32_t indexSpecLength, uint32_t flags); // drop a SODA collection DPI_EXPORT int dpiSodaColl_drop(dpiSodaColl *coll, uint32_t flags, int *isDropped); // drop an index on the collection DPI_EXPORT int dpiSodaColl_dropIndex(dpiSodaColl *coll, const char *name, uint32_t nameLength, uint32_t flags, int *isDropped); // find documents in a SODA collection and return a cursor DPI_EXPORT int dpiSodaColl_find(dpiSodaColl *coll, const dpiSodaOperOptions *options, uint32_t flags, dpiSodaDocCursor **cursor); // find a single document in a SODA collection DPI_EXPORT int dpiSodaColl_findOne(dpiSodaColl *coll, const dpiSodaOperOptions *options, uint32_t flags, dpiSodaDoc **doc); // get the data guide for the collection DPI_EXPORT int dpiSodaColl_getDataGuide(dpiSodaColl *coll, uint32_t flags, dpiSodaDoc **doc); // get the count of documents that match the criteria DPI_EXPORT int dpiSodaColl_getDocCount(dpiSodaColl *coll, const dpiSodaOperOptions *options, uint32_t flags, uint64_t *count); // get the metadata of the collection DPI_EXPORT int dpiSodaColl_getMetadata(dpiSodaColl *coll, const char **value, uint32_t *valueLength); // get the name of the collection DPI_EXPORT int dpiSodaColl_getName(dpiSodaColl *coll, const char **value, uint32_t *valueLength); // insert multiple documents into the SODA collection DPI_EXPORT int dpiSodaColl_insertMany(dpiSodaColl *coll, uint32_t numDocs, dpiSodaDoc **docs, uint32_t flags, dpiSodaDoc **insertedDocs); // insert multiple documents into the SODA collection (with options) DPI_EXPORT int dpiSodaColl_insertManyWithOptions(dpiSodaColl *coll, uint32_t numDocs, dpiSodaDoc **docs, dpiSodaOperOptions *options, uint32_t flags, dpiSodaDoc **insertedDocs); // insert a document into the SODA collection DPI_EXPORT int dpiSodaColl_insertOne(dpiSodaColl *coll, dpiSodaDoc *doc, uint32_t flags, dpiSodaDoc **insertedDoc); // insert a document into the SODA collection (with options) DPI_EXPORT int dpiSodaColl_insertOneWithOptions(dpiSodaColl *coll, dpiSodaDoc *doc, dpiSodaOperOptions *options, uint32_t flags, dpiSodaDoc **insertedDoc); // get a list of indexes associated with the collection DPI_EXPORT int dpiSodaColl_listIndexes(dpiSodaColl *coll, uint32_t flags, dpiStringList *list); // release a reference to the SODA collection DPI_EXPORT int dpiSodaColl_release(dpiSodaColl *coll); // remove documents from a SODA collection (with operation options) DPI_EXPORT int dpiSodaColl_remove(dpiSodaColl *coll, const dpiSodaOperOptions *options, uint32_t flags, uint64_t *count); // replace a document in a SODA collection (with operation options) DPI_EXPORT int dpiSodaColl_replaceOne(dpiSodaColl *coll, const dpiSodaOperOptions *options, dpiSodaDoc *doc, uint32_t flags, int *replaced, dpiSodaDoc **replacedDoc); // save a document to a SODA collection DPI_EXPORT int dpiSodaColl_save(dpiSodaColl *coll, dpiSodaDoc *doc, uint32_t flags, dpiSodaDoc **savedDoc); // save a document to a SODA collection (with options) DPI_EXPORT int dpiSodaColl_saveWithOptions(dpiSodaColl *coll, dpiSodaDoc *doc, dpiSodaOperOptions *options, uint32_t flags, dpiSodaDoc **savedDoc); // remove all of the documents from a SODA collection DPI_EXPORT int dpiSodaColl_truncate(dpiSodaColl *coll); //----------------------------------------------------------------------------- // SODA Collection Cursor Methods (dpiSodaCollCursor) //----------------------------------------------------------------------------- // add a reference to the SODA collection cursor DPI_EXPORT int dpiSodaCollCursor_addRef(dpiSodaCollCursor *cursor); // close the SODA collection cursor DPI_EXPORT int dpiSodaCollCursor_close(dpiSodaCollCursor *cursor); // get the next collection from the cursor DPI_EXPORT int dpiSodaCollCursor_getNext(dpiSodaCollCursor *cursor, uint32_t flags, dpiSodaColl **coll); // release a reference to the SODA collection cursor DPI_EXPORT int dpiSodaCollCursor_release(dpiSodaCollCursor *cursor); //----------------------------------------------------------------------------- // SODA Database Methods (dpiSodaDb) //----------------------------------------------------------------------------- // add a reference to the SODA database DPI_EXPORT int dpiSodaDb_addRef(dpiSodaDb *db); // create a new SODA collection DPI_EXPORT int dpiSodaDb_createCollection(dpiSodaDb *db, const char *name, uint32_t nameLength, const char *metadata, uint32_t metadataLength, uint32_t flags, dpiSodaColl **coll); // create a new SODA document with binary or encoded text content DPI_EXPORT int dpiSodaDb_createDocument(dpiSodaDb *db, const char *key, uint32_t keyLength, const char *content, uint32_t contentLength, const char *mediaType, uint32_t mediaTypeLength, uint32_t flags, dpiSodaDoc **doc); // create a new SODA document with JSON content DPI_EXPORT int dpiSodaDb_createJsonDocument(dpiSodaDb *db, const char *key, uint32_t keyLength, const dpiJsonNode *content, uint32_t flags, dpiSodaDoc **doc); // free the memory allocated when getting an array of SODA collection names DPI_EXPORT int dpiSodaDb_freeCollectionNames(dpiSodaDb *db, dpiStringList *names); // return a cursor to iterate over SODA collections DPI_EXPORT int dpiSodaDb_getCollections(dpiSodaDb *db, const char *startName, uint32_t startNameLength, uint32_t flags, dpiSodaCollCursor **cursor); // return an array of SODA collection names DPI_EXPORT int dpiSodaDb_getCollectionNames(dpiSodaDb *db, const char *startName, uint32_t startNameLength, uint32_t limit, uint32_t flags, dpiStringList *names); // open an existing SODA collection DPI_EXPORT int dpiSodaDb_openCollection(dpiSodaDb *db, const char *name, uint32_t nameLength, uint32_t flags, dpiSodaColl **coll); // release a reference to the SODA database DPI_EXPORT int dpiSodaDb_release(dpiSodaDb *db); //----------------------------------------------------------------------------- // SODA Document Methods (dpiSodaDoc) //----------------------------------------------------------------------------- // add a reference to the SODA document DPI_EXPORT int dpiSodaDoc_addRef(dpiSodaDoc *cursor); // get the binary or encoded text content of the document DPI_EXPORT int dpiSodaDoc_getContent(dpiSodaDoc *doc, const char **value, uint32_t *valueLength, const char **encoding); // get the created timestamp associated with the document DPI_EXPORT int dpiSodaDoc_getCreatedOn(dpiSodaDoc *doc, const char **value, uint32_t *valueLength); // get whether the document contains a JSON document or not DPI_EXPORT int dpiSodaDoc_getIsJson(dpiSodaDoc *doc, int *isJson); // get the JSON content of the document DPI_EXPORT int dpiSodaDoc_getJsonContent(dpiSodaDoc *doc, dpiJson **value); // get the key associated with the document DPI_EXPORT int dpiSodaDoc_getKey(dpiSodaDoc *doc, const char **value, uint32_t *valueLength); // get the last modified timestamp associated with the document DPI_EXPORT int dpiSodaDoc_getLastModified(dpiSodaDoc *doc, const char **value, uint32_t *valueLength); // get the media type of the document DPI_EXPORT int dpiSodaDoc_getMediaType(dpiSodaDoc *doc, const char **value, uint32_t *valueLength); // get the version of the document DPI_EXPORT int dpiSodaDoc_getVersion(dpiSodaDoc *doc, const char **value, uint32_t *valueLength); // release a reference to the SODA document DPI_EXPORT int dpiSodaDoc_release(dpiSodaDoc *doc); //----------------------------------------------------------------------------- // SODA Document Cursor Methods (dpiSodaDocCursor) //----------------------------------------------------------------------------- // add a reference to the SODA document cursor DPI_EXPORT int dpiSodaDocCursor_addRef(dpiSodaDocCursor *cursor); // close the SODA document cursor DPI_EXPORT int dpiSodaDocCursor_close(dpiSodaDocCursor *cursor); // get the next document from the cursor DPI_EXPORT int dpiSodaDocCursor_getNext(dpiSodaDocCursor *cursor, uint32_t flags, dpiSodaDoc **doc); // release a reference to the SODA document cursor DPI_EXPORT int dpiSodaDocCursor_release(dpiSodaDocCursor *cursor); //----------------------------------------------------------------------------- // Statement Methods (dpiStmt) //----------------------------------------------------------------------------- // add a reference to a statement DPI_EXPORT int dpiStmt_addRef(dpiStmt *stmt); // bind a variable to the statement using the given name DPI_EXPORT int dpiStmt_bindByName(dpiStmt *stmt, const char *name, uint32_t nameLength, dpiVar *var); // bind a variable to the statement at the given position // positions are determined by the order in which names are introduced DPI_EXPORT int dpiStmt_bindByPos(dpiStmt *stmt, uint32_t pos, dpiVar *var); // bind a value to the statement using the given name // this creates the variable by looking at the type and then binds it DPI_EXPORT int dpiStmt_bindValueByName(dpiStmt *stmt, const char *name, uint32_t nameLength, dpiNativeTypeNum nativeTypeNum, dpiData *data); // bind a value to the statement at the given position // this creates the variable by looking at the type and then binds it DPI_EXPORT int dpiStmt_bindValueByPos(dpiStmt *stmt, uint32_t pos, dpiNativeTypeNum nativeTypeNum, dpiData *data); // close the statement now, not when its reference count reaches zero DPI_EXPORT int dpiStmt_close(dpiStmt *stmt, const char *tag, uint32_t tagLength); // define a variable to accept the data for the specified column (1 based) DPI_EXPORT int dpiStmt_define(dpiStmt *stmt, uint32_t pos, dpiVar *var); // define type of data to use for the specified column (1 based) DPI_EXPORT int dpiStmt_defineValue(dpiStmt *stmt, uint32_t pos, dpiOracleTypeNum oracleTypeNum, dpiNativeTypeNum nativeTypeNum, uint32_t size, int sizeIsBytes, dpiObjectType *objType); // execute the statement and return the number of query columns // zero implies the statement is not a query DPI_EXPORT int dpiStmt_execute(dpiStmt *stmt, dpiExecMode mode, uint32_t *numQueryColumns); // execute the statement multiple times (queries not supported) DPI_EXPORT int dpiStmt_executeMany(dpiStmt *stmt, dpiExecMode mode, uint32_t numIters); // fetch a single row and return the index into the defined variables // this will internally perform any execute and array fetch as needed DPI_EXPORT int dpiStmt_fetch(dpiStmt *stmt, int *found, uint32_t *bufferRowIndex); // return the number of rows that are available in the defined variables // up to the maximum specified; this will internally perform execute/array // fetch only if no rows are available in the defined variables and there are // more rows available to fetch DPI_EXPORT int dpiStmt_fetchRows(dpiStmt *stmt, uint32_t maxRows, uint32_t *bufferRowIndex, uint32_t *numRowsFetched, int *moreRows); // get the number of batch errors that took place in the previous execution DPI_EXPORT int dpiStmt_getBatchErrorCount(dpiStmt *stmt, uint32_t *count); // get the batch errors that took place in the previous execution DPI_EXPORT int dpiStmt_getBatchErrors(dpiStmt *stmt, uint32_t numErrors, dpiErrorInfo *errors); // get the number of bind variables that are in the prepared statement DPI_EXPORT int dpiStmt_getBindCount(dpiStmt *stmt, uint32_t *count); // get the names of the bind variables that are in the prepared statement DPI_EXPORT int dpiStmt_getBindNames(dpiStmt *stmt, uint32_t *numBindNames, const char **bindNames, uint32_t *bindNameLengths); // get the number of rows to (internally) fetch at one time DPI_EXPORT int dpiStmt_getFetchArraySize(dpiStmt *stmt, uint32_t *arraySize); // get next implicit result from previous execution; NULL if no more exist DPI_EXPORT int dpiStmt_getImplicitResult(dpiStmt *stmt, dpiStmt **implicitResult); // return information about the statement DPI_EXPORT int dpiStmt_getInfo(dpiStmt *stmt, dpiStmtInfo *info); // get the rowid of the last row affected by a DML statement DPI_EXPORT int dpiStmt_getLastRowid(dpiStmt *stmt, dpiRowid **rowid); // get the number of query columns (zero implies the statement is not a query) DPI_EXPORT int dpiStmt_getNumQueryColumns(dpiStmt *stmt, uint32_t *numQueryColumns); // generic method for getting an OCI statement attribute // WARNING: use only as directed by Oracle DPI_EXPORT int dpiStmt_getOciAttr(dpiStmt *stmt, uint32_t attribute, dpiDataBuffer *value, uint32_t *valueLength); // return the number of rows that are prefetched by the Oracle Client library DPI_EXPORT int dpiStmt_getPrefetchRows(dpiStmt *stmt, uint32_t *numRows); // return metadata about the column at the specified position (1 based) DPI_EXPORT int dpiStmt_getQueryInfo(dpiStmt *stmt, uint32_t pos, dpiQueryInfo *info); // get the value for the specified column of the current row fetched DPI_EXPORT int dpiStmt_getQueryValue(dpiStmt *stmt, uint32_t pos, dpiNativeTypeNum *nativeTypeNum, dpiData **data); // get the row count for the statement // for queries, this is the number of rows that have been fetched so far // for non-queries, this is the number of rows affected by the last execution DPI_EXPORT int dpiStmt_getRowCount(dpiStmt *stmt, uint64_t *count); // get the number of rows affected for each DML operation just executed // using the mode DPI_MODE_EXEC_ARRAY_DML_ROWCOUNTS DPI_EXPORT int dpiStmt_getRowCounts(dpiStmt *stmt, uint32_t *numRowCounts, uint64_t **rowCounts); // get subscription query id for continuous query notification DPI_EXPORT int dpiStmt_getSubscrQueryId(dpiStmt *stmt, uint64_t *queryId); // release a reference to the statement DPI_EXPORT int dpiStmt_release(dpiStmt *stmt); // scroll the statement to the desired row // this is only valid for scrollable statements DPI_EXPORT int dpiStmt_scroll(dpiStmt *stmt, dpiFetchMode mode, int32_t offset, int32_t rowCountOffset); // set the number of rows to (internally) fetch at one time DPI_EXPORT int dpiStmt_setFetchArraySize(dpiStmt *stmt, uint32_t arraySize); // generic method for setting an OCI statement attribute // WARNING: use only as directed by Oracle DPI_EXPORT int dpiStmt_setOciAttr(dpiStmt *stmt, uint32_t attribute, void *value, uint32_t valueLength); // set the number of rows that are prefetched by the Oracle Client library DPI_EXPORT int dpiStmt_setPrefetchRows(dpiStmt *stmt, uint32_t numRows); // set the flag to exclude the current SQL statement from the statement // cache DPI_EXPORT int dpiStmt_deleteFromCache(dpiStmt *stmt); //----------------------------------------------------------------------------- // Rowid Methods (dpiRowid) //----------------------------------------------------------------------------- // add a reference to the rowid DPI_EXPORT int dpiRowid_addRef(dpiRowid *rowid); // get string representation from rowid DPI_EXPORT int dpiRowid_getStringValue(dpiRowid *rowid, const char **value, uint32_t *valueLength); // release a reference to the rowid DPI_EXPORT int dpiRowid_release(dpiRowid *subscr); //----------------------------------------------------------------------------- // Subscription Methods (dpiSubscr) //----------------------------------------------------------------------------- // add a reference to the subscription DPI_EXPORT int dpiSubscr_addRef(dpiSubscr *subscr); // prepare statement for registration with subscription DPI_EXPORT int dpiSubscr_prepareStmt(dpiSubscr *subscr, const char *sql, uint32_t sqlLength, dpiStmt **stmt); // release a reference to the subscription DPI_EXPORT int dpiSubscr_release(dpiSubscr *subscr); //----------------------------------------------------------------------------- // Variable Methods (dpiVar) //----------------------------------------------------------------------------- // add a reference to the variable DPI_EXPORT int dpiVar_addRef(dpiVar *var); // copy the data from one variable to another variable DPI_EXPORT int dpiVar_copyData(dpiVar *var, uint32_t pos, dpiVar *sourceVar, uint32_t sourcePos); // return the number of elements in a PL/SQL index-by table DPI_EXPORT int dpiVar_getNumElementsInArray(dpiVar *var, uint32_t *numElements); // return pointer to array of dpiData structures for transferring data // this is needed for DML returning where the number of elements is modified DPI_EXPORT int dpiVar_getReturnedData(dpiVar *var, uint32_t pos, uint32_t *numElements, dpiData **data); // return the size in bytes of the buffer used for fetching/binding DPI_EXPORT int dpiVar_getSizeInBytes(dpiVar *var, uint32_t *sizeInBytes); // release a reference to the variable DPI_EXPORT int dpiVar_release(dpiVar *var); // set the value of the variable from a byte string DPI_EXPORT int dpiVar_setFromBytes(dpiVar *var, uint32_t pos, const char *value, uint32_t valueLength); // set the value of the variable from a JSON handle DPI_EXPORT int dpiVar_setFromJson(dpiVar *var, uint32_t pos, dpiJson *json); // set the value of the variable from a LOB DPI_EXPORT int dpiVar_setFromLob(dpiVar *var, uint32_t pos, dpiLob *lob); // set the value of the variable from an object DPI_EXPORT int dpiVar_setFromObject(dpiVar *var, uint32_t pos, dpiObject *obj); // set the value of the variable from a rowid DPI_EXPORT int dpiVar_setFromRowid(dpiVar *var, uint32_t pos, dpiRowid *rowid); // set the value of the variable from a statement DPI_EXPORT int dpiVar_setFromStmt(dpiVar *var, uint32_t pos, dpiStmt *stmt); // set the value of the variable from a vector DPI_EXPORT int dpiVar_setFromVector(dpiVar *var, uint32_t pos, dpiVector *vector); // set the number of elements in a PL/SQL index-by table DPI_EXPORT int dpiVar_setNumElementsInArray(dpiVar *var, uint32_t numElements); //----------------------------------------------------------------------------- // Vector Methods (dpiVector) //----------------------------------------------------------------------------- // add a reference to the vector DPI_EXPORT int dpiVector_addRef(dpiVector *vector); // get information about the vector DPI_EXPORT int dpiVector_getValue(dpiVector *vector, dpiVectorInfo *info); // release a reference to the vector DPI_EXPORT int dpiVector_release(dpiVector *vector); // set the contents of the vector DPI_EXPORT int dpiVector_setValue(dpiVector *vector, dpiVectorInfo *info); #ifdef __cplusplus } #endif #endif