Products Support Documentation Download
sqlrext.h File Reference

Header for the Raima SQL API Extensions. More...

#include "sqlext.h"
#include "sqlrtypes.h"
Include dependency graph for sqlrext.h:

Go to the source code of this file.

Macros

#define RDM_DRIVER_VER   RDM_ODBC_DRIVER_VERSION
 
#define RDM_SOURCE_VER   RDM_ODBC_DRIVER_VERSION
 
#define RDM_MAX_STATEMENT_LEN   4096 /* defSqlMaxstmtlen */
 
#define RDM_MAX_USER_NAME_LEN   32
 
#define RDM_INFO_LAST   SQL_CONVERT_GUID /* sqlext.h */
 
#define RDM_XOPEN_INFO_FIRST   SQL_XOPEN_CLI_YEAR
 
#define RDM_XOPEN_INFO_LAST   SQL_MAX_ASYNC_CONCURRENT_STATEMENTS
 
#define SQL_START   2
 
#define SQL_SAVEPOINT   3
 
#define SQL_RELEASE   4
 
#define SQL_PRECOMMIT   5
 
#define SQL_TXN_INACTIVE   0
 
#define SQL_TXN_UPDATE   1
 
#define SQL_TXN_READ   2
 
#define SQL_TXN_SNAPSHOT   3
 
#define SQL_TXN_DDL   4
 
#define SQL_TFSTYPE_EMBED   ((SQLUINTEGER) TFS_TYPE_EMBED)
 
#define SQL_TFSTYPE_REMOTE   ((SQLUINTEGER) TFS_TYPE_CLIENT)
 
#define SQL_TFSTYPE_HYBRID   ((SQLUINTEGER) TFS_TYPE_HYBRID)
 
#define SQL_TFSTYPE_DEFAULT   ((SQLUINTEGER) TFS_TYPE_DEFAULT)
 
#define SQL_RDM_DEFAULT_PORT   TFS_DEFAULT_PORT
 
#define SQL_RDM_DEFAULT_STDOUT   ""
 
#define TFSTYPE_MAXSIZE   8 /* "default" + 1 */
 
#define SQL_DIAG_RDM_OPEN_DB   101
 
#define SQL_DIAG_RDM_OPEN_DBUNION   102
 
#define SQL_DIAG_RDM_CLOSE_DB   103
 
#define SQL_DIAG_RDM_SELECT   104
 
#define SQL_DIAG_RDM_START   105
 
#define SQL_DIAG_RDM_COMMIT   106
 
#define SQL_DIAG_RDM_SAVEPOINT   107
 
#define SQL_DIAG_RDM_RELEASE   108
 
#define SQL_DIAG_RDM_ROLLBACK   109
 
#define SQL_DIAG_RDM_PRECOMMIT   110
 
#define SQL_DIAG_RDM_CREATE_PROCEDURE   111
 
#define SQL_DIAG_RDM_DROP_PROCEDURE   112
 
#define SQL_DIAG_RDM_SET   113
 
#define SQL_DIAG_RDM_SET_COLUMN   114
 
#define SQL_DIAG_RDM_LOCK   115
 
#define SQL_DIAG_RDM_UNLOCK   116
 
#define SQL_DIAG_RDM_INITIALIZE_SCHEMA   117
 
#define SQL_DIAG_RDM_CREATE_CATALOG   118
 
#define SQL_DIAG_RDM_IMPORT_TABLE   119
 
#define SQL_DIAG_RDM_EXPORT_TABLE   120
 
#define SQL_DIAG_RDM_UPDATE_STATS   121
 
#define SQL_DIAG_RDM_CREATE_ENCKEY   122
 
#define SQL_DIAG_RDM_DROP_ENCKEY   123
 
#define SQL_DIAG_RDM_SET_DB_ENC   124
 
#define SQL_DIAG_RDM_DECLARE_VAR   125
 
#define SQL_DIAG_RDM_ASSIGN   126
 
#define SQL_DIAG_RDM_GOTO   127
 
#define SQL_DIAG_RDM_CREATE_TRIGGER   128
 
#define SQL_DIAG_RDM_DROP_TRIGGER   129
 
#define SQL_RDM_STMT_UNKNOWN   SQL_DIAG_UNKNOWN_STATEMENT
 
#define SQL_RDM_STMT_OPEN   SQL_DIAG_RDM_OPEN_DB
 
#define SQL_RDM_STMT_DBUNION   SQL_DIAG_RDM_OPEN_DBUNION
 
#define SQL_RDM_STMT_CLOSE   SQL_DIAG_RDM_CLOSE_DB
 
#define SQL_RDM_STMT_SELECT   SQL_DIAG_RDM_SELECT
 
#define SQL_RDM_STMT_INSERT   SQL_DIAG_INSERT
 
#define SQL_RDM_STMT_UPDATE   SQL_DIAG_UPDATE_WHERE
 
#define SQL_RDM_STMT_DELETE   SQL_DIAG_DELETE_WHERE
 
#define SQL_RDM_STMT_START   SQL_DIAG_RDM_START
 
#define SQL_RDM_STMT_COMMIT   SQL_DIAG_RDM_COMMIT
 
#define SQL_RDM_STMT_SAVEPOINT   SQL_DIAG_RDM_SAVEPOINT
 
#define SQL_RDM_STMT_RELEASE   SQL_DIAG_RDM_RELEASE
 
#define SQL_RDM_STMT_ROLLBACK   SQL_DIAG_RDM_ROLLBACK
 
#define SQL_RDM_STMT_CRPROC   SQL_DIAG_RDM_CREATE_PROCEDURE
 
#define SQL_RDM_STMT_DRPROC   SQL_DIAG_RDM_DROP_PROCEDURE
 
#define SQL_RDM_STMT_EXECUTE   SQL_DIAG_RDM_EXECUTE_PROCEDURE
 
#define SQL_RDM_STMT_SET   SQL_DIAG_RDM_SET
 
#define SQL_RDM_STMT_SETCOLUMN   SQL_DIAG_RDM_SET_COLUMN
 
#define SQL_RDM_STMT_LOCK   SQL_DIAG_RDM_LOCK
 
#define SQL_RDM_STMT_UNLOCK   SQL_DIAG_RDM_UNLOCK
 
#define SQL_RDM_STMT_INITDB   SQL_DIAG_RDM_INITIALIZE_SCHEMA
 
#define SQL_RDM_STMT_CRCAT   SQL_DIAG_RDM_CREATE_CATALOG
 
#define SQL_RDM_STMT_IMPORT   SQL_DIAG_RDM_IMPORT_TABLE
 
#define SQL_RDM_STMT_EXPORT   SQL_DIAG_RDM_EXPORT_TABLE
 
#define SQL_RDM_STMT_DDL   SQL_DIAG_CREATE_SCHEMA
 
#define SQLExtendedTranA   SQLExtendedTran
 
#define SQLRowIdA   SQLRowId
 

Typedefs

typedef int32_t(* ECALLBACK) (int16_t, SQLHANDLE, SQLRETURN, const void *)
 

Functions

RDBC_EXPORT SQLRETURN SQLDescribeStmt (SQLHSTMT StatementHandle, SQLUSMALLINT *pStmtType)
 Obtain the type of the latest executed statement. More...
 
RDBC_EXPORT SQLRETURN SQLExtendedTran (SQLSMALLINT HandleType, SQLHANDLE Handle, SQLSMALLINT OperationType, SQLSMALLINT TransactionType, const SQLCHAR *TransactionID, SQLSMALLINT StringLengthPtr)
 Perform an RDM specific transaction (start, mark, etc.) More...
 
RDBC_EXPORT SQLRETURN SQLExtendedTranW (SQLSMALLINT HandleType, SQLHANDLE Handle, SQLSMALLINT OperationType, SQLSMALLINT TransactionType, const SQLWCHAR *TransactionID, SQLSMALLINT StringLengthPtr)
 
RDBC_EXPORT SQLRETURN SQLGetStatementType (SQLHSTMT StatementHandle, SQLUSMALLINT *pStmtType)
 Obtain the RDM SQL statement type. More...
 
RDBC_EXPORT SQLRETURN SQLRowId (SQLHSTMT StatementHandle, const SQLCHAR *TableName, SQLROWID *pRowid)
 Retrieve the ROWID value of the current row. More...
 
RDBC_EXPORT SQLRETURN SQLRowIdW (SQLHSTMT StatementHandle, const SQLWCHAR *TableName, SQLROWID *pRowid)
 
RDBC_EXPORT SQLRETURN SQLSetError (SQLSMALLINT HandleType, SQLHANDLE Handle, SQLRETURN ErrorCode, ECALLBACK ErrorHandler)
 Set the user-defined error handling routine for the specified handle. More...
 
RDBC_EXPORT SQLRETURN SQLSetErrorEx (SQLSMALLINT HandleType, SQLHANDLE Handle, SQLRETURN ErrorCode, ECALLBACK ErrorHandler, void *pCtx)
 Set the user-defined error handling routine for the specified handle. More...
 
RDBC_EXPORT SQLRETURN SQLShowPlan (SQLHSTMT StatementHandle, SQLHSTMT QueryHandle)
 Return the command execution plan chosen by the query optimizer. More...
 
RDBC_EXPORT SQLRETURN SQLTransactStatus (SQLSMALLINT HandleType, SQLHANDLE Handle, SQLSMALLINT *pActive)
 Return the status of an ongoing transaction. More...
 

Detailed Description

Header for the Raima SQL API Extensions.

Definition in file sqlrext.h.

Macro Definition Documentation

◆ RDM_DRIVER_VER

#define RDM_DRIVER_VER   RDM_ODBC_DRIVER_VERSION

Definition at line 25 of file sqlrext.h.

◆ RDM_INFO_LAST

#define RDM_INFO_LAST   SQL_CONVERT_GUID /* sqlext.h */

Definition at line 29 of file sqlrext.h.

◆ RDM_MAX_STATEMENT_LEN

#define RDM_MAX_STATEMENT_LEN   4096 /* defSqlMaxstmtlen */

Definition at line 27 of file sqlrext.h.

◆ RDM_MAX_USER_NAME_LEN

#define RDM_MAX_USER_NAME_LEN   32

Definition at line 28 of file sqlrext.h.

◆ RDM_SOURCE_VER

#define RDM_SOURCE_VER   RDM_ODBC_DRIVER_VERSION

Definition at line 26 of file sqlrext.h.

◆ RDM_XOPEN_INFO_FIRST

#define RDM_XOPEN_INFO_FIRST   SQL_XOPEN_CLI_YEAR

Definition at line 30 of file sqlrext.h.

◆ RDM_XOPEN_INFO_LAST

#define RDM_XOPEN_INFO_LAST   SQL_MAX_ASYNC_CONCURRENT_STATEMENTS

Definition at line 34 of file sqlrext.h.

◆ SQL_DIAG_RDM_ASSIGN

#define SQL_DIAG_RDM_ASSIGN   126

Definition at line 105 of file sqlrext.h.

◆ SQL_DIAG_RDM_CLOSE_DB

#define SQL_DIAG_RDM_CLOSE_DB   103

Definition at line 82 of file sqlrext.h.

◆ SQL_DIAG_RDM_COMMIT

#define SQL_DIAG_RDM_COMMIT   106

Definition at line 85 of file sqlrext.h.

◆ SQL_DIAG_RDM_CREATE_CATALOG

#define SQL_DIAG_RDM_CREATE_CATALOG   118

Definition at line 97 of file sqlrext.h.

◆ SQL_DIAG_RDM_CREATE_ENCKEY

#define SQL_DIAG_RDM_CREATE_ENCKEY   122

Definition at line 101 of file sqlrext.h.

◆ SQL_DIAG_RDM_CREATE_PROCEDURE

#define SQL_DIAG_RDM_CREATE_PROCEDURE   111

Definition at line 90 of file sqlrext.h.

◆ SQL_DIAG_RDM_CREATE_TRIGGER

#define SQL_DIAG_RDM_CREATE_TRIGGER   128

Definition at line 107 of file sqlrext.h.

◆ SQL_DIAG_RDM_DECLARE_VAR

#define SQL_DIAG_RDM_DECLARE_VAR   125

Definition at line 104 of file sqlrext.h.

◆ SQL_DIAG_RDM_DROP_ENCKEY

#define SQL_DIAG_RDM_DROP_ENCKEY   123

Definition at line 102 of file sqlrext.h.

◆ SQL_DIAG_RDM_DROP_PROCEDURE

#define SQL_DIAG_RDM_DROP_PROCEDURE   112

Definition at line 91 of file sqlrext.h.

◆ SQL_DIAG_RDM_DROP_TRIGGER

#define SQL_DIAG_RDM_DROP_TRIGGER   129

Definition at line 108 of file sqlrext.h.

◆ SQL_DIAG_RDM_EXPORT_TABLE

#define SQL_DIAG_RDM_EXPORT_TABLE   120

Definition at line 99 of file sqlrext.h.

◆ SQL_DIAG_RDM_GOTO

#define SQL_DIAG_RDM_GOTO   127

Definition at line 106 of file sqlrext.h.

◆ SQL_DIAG_RDM_IMPORT_TABLE

#define SQL_DIAG_RDM_IMPORT_TABLE   119

Definition at line 98 of file sqlrext.h.

◆ SQL_DIAG_RDM_INITIALIZE_SCHEMA

#define SQL_DIAG_RDM_INITIALIZE_SCHEMA   117

Definition at line 96 of file sqlrext.h.

◆ SQL_DIAG_RDM_LOCK

#define SQL_DIAG_RDM_LOCK   115

Definition at line 94 of file sqlrext.h.

◆ SQL_DIAG_RDM_OPEN_DB

#define SQL_DIAG_RDM_OPEN_DB   101

Definition at line 80 of file sqlrext.h.

◆ SQL_DIAG_RDM_OPEN_DBUNION

#define SQL_DIAG_RDM_OPEN_DBUNION   102

Definition at line 81 of file sqlrext.h.

◆ SQL_DIAG_RDM_PRECOMMIT

#define SQL_DIAG_RDM_PRECOMMIT   110

Definition at line 89 of file sqlrext.h.

◆ SQL_DIAG_RDM_RELEASE

#define SQL_DIAG_RDM_RELEASE   108

Definition at line 87 of file sqlrext.h.

◆ SQL_DIAG_RDM_ROLLBACK

#define SQL_DIAG_RDM_ROLLBACK   109

Definition at line 88 of file sqlrext.h.

◆ SQL_DIAG_RDM_SAVEPOINT

#define SQL_DIAG_RDM_SAVEPOINT   107

Definition at line 86 of file sqlrext.h.

◆ SQL_DIAG_RDM_SELECT

#define SQL_DIAG_RDM_SELECT   104

Definition at line 83 of file sqlrext.h.

◆ SQL_DIAG_RDM_SET

#define SQL_DIAG_RDM_SET   113

Definition at line 92 of file sqlrext.h.

◆ SQL_DIAG_RDM_SET_COLUMN

#define SQL_DIAG_RDM_SET_COLUMN   114

Definition at line 93 of file sqlrext.h.

◆ SQL_DIAG_RDM_SET_DB_ENC

#define SQL_DIAG_RDM_SET_DB_ENC   124

Definition at line 103 of file sqlrext.h.

◆ SQL_DIAG_RDM_START

#define SQL_DIAG_RDM_START   105

Definition at line 84 of file sqlrext.h.

◆ SQL_DIAG_RDM_UNLOCK

#define SQL_DIAG_RDM_UNLOCK   116

Definition at line 95 of file sqlrext.h.

◆ SQL_DIAG_RDM_UPDATE_STATS

#define SQL_DIAG_RDM_UPDATE_STATS   121

Definition at line 100 of file sqlrext.h.

◆ SQL_PRECOMMIT

#define SQL_PRECOMMIT   5

Definition at line 43 of file sqlrext.h.

◆ SQL_RDM_DEFAULT_PORT

#define SQL_RDM_DEFAULT_PORT   TFS_DEFAULT_PORT

Definition at line 65 of file sqlrext.h.

◆ SQL_RDM_DEFAULT_STDOUT

#define SQL_RDM_DEFAULT_STDOUT   ""

Definition at line 70 of file sqlrext.h.

◆ SQL_RDM_STMT_CLOSE

#define SQL_RDM_STMT_CLOSE   SQL_DIAG_RDM_CLOSE_DB

Definition at line 116 of file sqlrext.h.

◆ SQL_RDM_STMT_COMMIT

#define SQL_RDM_STMT_COMMIT   SQL_DIAG_RDM_COMMIT

Definition at line 122 of file sqlrext.h.

◆ SQL_RDM_STMT_CRCAT

#define SQL_RDM_STMT_CRCAT   SQL_DIAG_RDM_CREATE_CATALOG

Definition at line 134 of file sqlrext.h.

◆ SQL_RDM_STMT_CRPROC

#define SQL_RDM_STMT_CRPROC   SQL_DIAG_RDM_CREATE_PROCEDURE

Definition at line 126 of file sqlrext.h.

◆ SQL_RDM_STMT_DBUNION

#define SQL_RDM_STMT_DBUNION   SQL_DIAG_RDM_OPEN_DBUNION

Definition at line 115 of file sqlrext.h.

◆ SQL_RDM_STMT_DDL

#define SQL_RDM_STMT_DDL   SQL_DIAG_CREATE_SCHEMA

Definition at line 137 of file sqlrext.h.

◆ SQL_RDM_STMT_DELETE

#define SQL_RDM_STMT_DELETE   SQL_DIAG_DELETE_WHERE

Definition at line 120 of file sqlrext.h.

◆ SQL_RDM_STMT_DRPROC

#define SQL_RDM_STMT_DRPROC   SQL_DIAG_RDM_DROP_PROCEDURE

Definition at line 127 of file sqlrext.h.

◆ SQL_RDM_STMT_EXECUTE

#define SQL_RDM_STMT_EXECUTE   SQL_DIAG_RDM_EXECUTE_PROCEDURE

Definition at line 128 of file sqlrext.h.

◆ SQL_RDM_STMT_EXPORT

#define SQL_RDM_STMT_EXPORT   SQL_DIAG_RDM_EXPORT_TABLE

Definition at line 136 of file sqlrext.h.

◆ SQL_RDM_STMT_IMPORT

#define SQL_RDM_STMT_IMPORT   SQL_DIAG_RDM_IMPORT_TABLE

Definition at line 135 of file sqlrext.h.

◆ SQL_RDM_STMT_INITDB

#define SQL_RDM_STMT_INITDB   SQL_DIAG_RDM_INITIALIZE_SCHEMA

Definition at line 133 of file sqlrext.h.

◆ SQL_RDM_STMT_INSERT

#define SQL_RDM_STMT_INSERT   SQL_DIAG_INSERT

Definition at line 118 of file sqlrext.h.

◆ SQL_RDM_STMT_LOCK

#define SQL_RDM_STMT_LOCK   SQL_DIAG_RDM_LOCK

Definition at line 131 of file sqlrext.h.

◆ SQL_RDM_STMT_OPEN

#define SQL_RDM_STMT_OPEN   SQL_DIAG_RDM_OPEN_DB

Definition at line 114 of file sqlrext.h.

◆ SQL_RDM_STMT_RELEASE

#define SQL_RDM_STMT_RELEASE   SQL_DIAG_RDM_RELEASE

Definition at line 124 of file sqlrext.h.

◆ SQL_RDM_STMT_ROLLBACK

#define SQL_RDM_STMT_ROLLBACK   SQL_DIAG_RDM_ROLLBACK

Definition at line 125 of file sqlrext.h.

◆ SQL_RDM_STMT_SAVEPOINT

#define SQL_RDM_STMT_SAVEPOINT   SQL_DIAG_RDM_SAVEPOINT

Definition at line 123 of file sqlrext.h.

◆ SQL_RDM_STMT_SELECT

#define SQL_RDM_STMT_SELECT   SQL_DIAG_RDM_SELECT

Definition at line 117 of file sqlrext.h.

◆ SQL_RDM_STMT_SET

#define SQL_RDM_STMT_SET   SQL_DIAG_RDM_SET

Definition at line 129 of file sqlrext.h.

◆ SQL_RDM_STMT_SETCOLUMN

#define SQL_RDM_STMT_SETCOLUMN   SQL_DIAG_RDM_SET_COLUMN

Definition at line 130 of file sqlrext.h.

◆ SQL_RDM_STMT_START

#define SQL_RDM_STMT_START   SQL_DIAG_RDM_START

Definition at line 121 of file sqlrext.h.

◆ SQL_RDM_STMT_UNKNOWN

#define SQL_RDM_STMT_UNKNOWN   SQL_DIAG_UNKNOWN_STATEMENT

Definition at line 113 of file sqlrext.h.

◆ SQL_RDM_STMT_UNLOCK

#define SQL_RDM_STMT_UNLOCK   SQL_DIAG_RDM_UNLOCK

Definition at line 132 of file sqlrext.h.

◆ SQL_RDM_STMT_UPDATE

#define SQL_RDM_STMT_UPDATE   SQL_DIAG_UPDATE_WHERE

Definition at line 119 of file sqlrext.h.

◆ SQL_RELEASE

#define SQL_RELEASE   4

Definition at line 42 of file sqlrext.h.

◆ SQL_SAVEPOINT

#define SQL_SAVEPOINT   3

Definition at line 41 of file sqlrext.h.

◆ SQL_START

#define SQL_START   2

Definition at line 40 of file sqlrext.h.

◆ SQL_TFSTYPE_DEFAULT

#define SQL_TFSTYPE_DEFAULT   ((SQLUINTEGER) TFS_TYPE_DEFAULT)

Definition at line 60 of file sqlrext.h.

◆ SQL_TFSTYPE_EMBED

#define SQL_TFSTYPE_EMBED   ((SQLUINTEGER) TFS_TYPE_EMBED)

Definition at line 57 of file sqlrext.h.

◆ SQL_TFSTYPE_HYBRID

#define SQL_TFSTYPE_HYBRID   ((SQLUINTEGER) TFS_TYPE_HYBRID)

Definition at line 59 of file sqlrext.h.

◆ SQL_TFSTYPE_REMOTE

#define SQL_TFSTYPE_REMOTE   ((SQLUINTEGER) TFS_TYPE_CLIENT)

Definition at line 58 of file sqlrext.h.

◆ SQL_TXN_DDL

#define SQL_TXN_DDL   4

Definition at line 52 of file sqlrext.h.

◆ SQL_TXN_INACTIVE

#define SQL_TXN_INACTIVE   0

Definition at line 48 of file sqlrext.h.

◆ SQL_TXN_READ

#define SQL_TXN_READ   2

Definition at line 50 of file sqlrext.h.

◆ SQL_TXN_SNAPSHOT

#define SQL_TXN_SNAPSHOT   3

Definition at line 51 of file sqlrext.h.

◆ SQL_TXN_UPDATE

#define SQL_TXN_UPDATE   1

Definition at line 49 of file sqlrext.h.

◆ SQLExtendedTranA

#define SQLExtendedTranA   SQLExtendedTran

Definition at line 247 of file sqlrext.h.

◆ SQLRowIdA

#define SQLRowIdA   SQLRowId

Definition at line 248 of file sqlrext.h.

◆ TFSTYPE_MAXSIZE

#define TFSTYPE_MAXSIZE   8 /* "default" + 1 */

Definition at line 75 of file sqlrext.h.

Typedef Documentation

◆ ECALLBACK

typedef int32_t( * ECALLBACK) (int16_t, SQLHANDLE, SQLRETURN, const void *)

Definition at line 143 of file sqlrext.h.

Function Documentation

◆ SQLExtendedTranW()

RDBC_EXPORT SQLRETURN SQLExtendedTranW ( SQLSMALLINT  HandleType,
SQLHANDLE  Handle,
SQLSMALLINT  OperationType,
SQLSMALLINT  TransactionType,
const SQLWCHAR TransactionID,
SQLSMALLINT  StringLengthPtr 
)

◆ SQLRowIdW()

RDBC_EXPORT SQLRETURN SQLRowIdW ( SQLHSTMT  StatementHandle,
const SQLWCHAR TableName,
SQLROWID pRowid 
)