SQL Relay C API
Functions
sqlrclientwrapper

Functions

SQLRCLIENTWRAPPER_DLLSPEC sqlrcon sqlrcon_alloc (const char *server, uint16_t port, const char *socket, const char *user, const char *password, int32_t retrytime, int32_t tries)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcon_free (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcon_setTimeout (sqlrcon sqlrconref, int32_t timeoutsec, int32_t timeoutusec)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcon_endSession (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_suspendSession (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC uint16_t sqlrcon_getConnectionPort (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcon_getConnectionSocket (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_resumeSession (sqlrcon sqlrconref, uint16_t port, const char *socket)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_ping (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcon_identify (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcon_dbVersion (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcon_serverVersion (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcon_clientVersion (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcon_bindFormat (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_selectDatabase (sqlrcon sqlrconref, const char *database)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcon_getCurrentDatabase (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC uint64_t sqlrcon_getLastInsertId (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_autoCommitOn (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_autoCommitOff (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_begin (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_commit (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_rollback (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcon_errorMessage (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC int64_t sqlrcon_errorNumber (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcon_debugOn (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcon_debugOff (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_getDebug (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcon_debugPrintFunction (sqlrcon sqlrconref, int(*printfunction)(const char *,...))
SQLRCLIENTWRAPPER_DLLSPEC sqlrcur sqlrcur_alloc (sqlrcon sqlrconref)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_free (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_setResultSetBufferSize (sqlrcur sqlrcurref, uint64_t rows)
SQLRCLIENTWRAPPER_DLLSPEC uint64_t sqlrcur_getResultSetBufferSize (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_dontGetColumnInfo (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_getColumnInfo (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_mixedCaseColumnNames (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_upperCaseColumnNames (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_lowerCaseColumnNames (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_cacheToFile (sqlrcur sqlrcurref, const char *filename)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_setCacheTtl (sqlrcur sqlrcurref, uint32_t ttl)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcur_getCacheFileName (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_cacheOff (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getDatabaseList (sqlrcur sqlrcurref, const char *wild)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getTableList (sqlrcur sqlrcurref, const char *wild)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnList (sqlrcur sqlrcurref, const char *table, const char *wild)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_sendQuery (sqlrcur sqlrcurref, const char *query)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_sendQueryWithLength (sqlrcur sqlrcurref, const char *query, uint32_t length)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_sendFileQuery (sqlrcur sqlrcurref, const char *path, const char *filename)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_prepareQuery (sqlrcur sqlrcurref, const char *query)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_prepareQueryWithLength (sqlrcur sqlrcurref, const char *query, uint32_t length)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_prepareFileQuery (sqlrcur sqlrcurref, const char *path, const char *filename)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_subString (sqlrcur sqlrcurref, const char *variable, const char *value)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_subLong (sqlrcur sqlrcurref, const char *variable, int64_t value)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_subDouble (sqlrcur sqlrcurref, const char *variable, double value, uint32_t precision, uint32_t scale)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_subStrings (sqlrcur sqlrcurref, const char **variables, const char **values)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_subLongs (sqlrcur sqlrcurref, const char **variables, const int64_t *values)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_subDoubles (sqlrcur sqlrcurref, const char **variables, const double *values, const uint32_t *precisions, const uint32_t *scales)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindString (sqlrcur sqlrcurref, const char *variable, const char *value)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindStringWithLength (sqlrcur sqlrcurref, const char *variable, const char *value, uint32_t valuelength)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindLong (sqlrcur sqlrcurref, const char *variable, int64_t value)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindDouble (sqlrcur sqlrcurref, const char *variable, double value, uint32_t precision, uint32_t scale)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindBlob (sqlrcur sqlrcurref, const char *variable, const char *value, uint32_t size)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindClob (sqlrcur sqlrcurref, const char *variable, const char *value, uint32_t size)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindStrings (sqlrcur sqlrcurref, const char **variables, const char **values)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindLongs (sqlrcur sqlrcurref, const char **variables, const int64_t *values)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindDoubles (sqlrcur sqlrcurref, const char **variables, const double *values, const uint32_t *precisions, const uint32_t *scales)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_defineOutputBindString (sqlrcur sqlrcurref, const char *variable, uint32_t length)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_defineOutputBindInteger (sqlrcur sqlrcurref, const char *variable)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_defineOutputBindDouble (sqlrcur sqlrcurref, const char *variable)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_defineOutputBindDate (sqlrcur sqlrcurref, const char *variable)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_defineOutputBindBlob (sqlrcur sqlrcurref, const char *variable)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_defineOutputBindClob (sqlrcur sqlrcurref, const char *variable)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_defineOutputBindCursor (sqlrcur sqlrcurref, const char *variable)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_clearBinds (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC uint16_t sqlrcur_countBindVariables (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_validateBinds (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_validBind (sqlrcur sqlrcurref, const char *variable)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_executeQuery (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_fetchFromBindCursor (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcur_getOutputBindString (sqlrcur sqlrcurref, const char *variable)
SQLRCLIENTWRAPPER_DLLSPEC int64_t sqlrcur_getOutputBindInteger (sqlrcur sqlrcurref, const char *variable)
SQLRCLIENTWRAPPER_DLLSPEC double sqlrcur_getOutputBindDouble (sqlrcur sqlrcurref, const char *variable)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getOutputBindDate (sqlrcur sqlrcurref, const char *variable, int16_t *year, int16_t *month, int16_t *day, int16_t *hour, int16_t *minute, int16_t *second, const char **tz)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcur_getOutputBindBlob (sqlrcur sqlrcurref, const char *variable)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcur_getOutputBindClob (sqlrcur sqlrcurref, const char *variable)
SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getOutputBindLength (sqlrcur sqlrcurref, const char *variable)
SQLRCLIENTWRAPPER_DLLSPEC sqlrcur sqlrcur_getOutputBindCursor (sqlrcur sqlrcurref, const char *variable)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_openCachedResultSet (sqlrcur sqlrcurref, const char *filename)
SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_colCount (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC uint64_t sqlrcur_rowCount (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC uint64_t sqlrcur_totalRows (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC uint64_t sqlrcur_affectedRows (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC uint64_t sqlrcur_firstRowIndex (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_endOfResultSet (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcur_errorMessage (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC int64_t sqlrcur_errorNumber (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_getNullsAsEmptyStrings (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_getNullsAsNulls (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcur_getFieldByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcur_getFieldByName (sqlrcur sqlrcurref, uint64_t row, const char *col)
SQLRCLIENTWRAPPER_DLLSPEC int64_t sqlrcur_getFieldAsIntegerByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC int64_t sqlrcur_getFieldAsIntegerByName (sqlrcur sqlrcurref, uint64_t row, const char *col)
SQLRCLIENTWRAPPER_DLLSPEC double sqlrcur_getFieldAsDoubleByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC double sqlrcur_getFieldAsDoubleByName (sqlrcur sqlrcurref, uint64_t row, const char *col)
SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getFieldLengthByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getFieldLengthByName (sqlrcur sqlrcurref, uint64_t row, const char *col)
SQLRCLIENTWRAPPER_DLLSPEC
const char *const 
sqlrcur_getRow (sqlrcur sqlrcurref, uint64_t row)
SQLRCLIENTWRAPPER_DLLSPEC
uint32_t * 
sqlrcur_getRowLengths (sqlrcur sqlrcurref, uint64_t row)
SQLRCLIENTWRAPPER_DLLSPEC
const char *const 
sqlrcur_getColumnNames (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcur_getColumnName (sqlrcur sqlrcurref, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcur_getColumnTypeByIndex (sqlrcur sqlrcurref, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC
const char * 
sqlrcur_getColumnTypeByName (sqlrcur sqlrcurref, const char *col)
SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getColumnLengthByIndex (sqlrcur sqlrcurref, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getColumnLengthByName (sqlrcur sqlrcurref, const char *col)
SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getColumnPrecisionByIndex (sqlrcur sqlrcurref, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getColumnPrecisionByName (sqlrcur sqlrcurref, const char *col)
SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getColumnScaleByIndex (sqlrcur sqlrcurref, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getColumnScaleByName (sqlrcur sqlrcurref, const char *col)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsNullableByIndex (sqlrcur sqlrcurref, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsNullableByName (sqlrcur sqlrcurref, const char *col)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsPrimaryKeyByIndex (sqlrcur sqlrcurref, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsPrimaryKeyByName (sqlrcur sqlrcurref, const char *col)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsUniqueByIndex (sqlrcur sqlrcurref, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsUniqueByName (sqlrcur sqlrcurref, const char *col)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsPartOfKeyByIndex (sqlrcur sqlrcurref, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsPartOfKeyByName (sqlrcur sqlrcurref, const char *col)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsUnsignedByIndex (sqlrcur sqlrcurref, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsUnsignedByName (sqlrcur sqlrcurref, const char *col)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsZeroFilledByIndex (sqlrcur sqlrcurref, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsZeroFilledByName (sqlrcur sqlrcurref, const char *col)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsBinaryByIndex (sqlrcur sqlrcurref, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsBinaryByName (sqlrcur sqlrcurref, const char *col)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsAutoIncrementByIndex (sqlrcur sqlrcurref, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsAutoIncrementByName (sqlrcur sqlrcurref, const char *col)
SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getLongestByIndex (sqlrcur sqlrcurref, uint32_t col)
SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getLongestByName (sqlrcur sqlrcurref, const char *col)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_suspendResultSet (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC uint16_t sqlrcur_getResultSetId (sqlrcur sqlrcurref)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_resumeResultSet (sqlrcur sqlrcurref, uint16_t id)
SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_resumeCachedResultSet (sqlrcur sqlrcurref, uint16_t id, const char *filename)
SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_closeResultSet (sqlrcur sqlrcurref)

Function Documentation

SQLRCLIENTWRAPPER_DLLSPEC sqlrcon sqlrcon_alloc ( const char *  server,
uint16_t  port,
const char *  socket,
const char *  user,
const char *  password,
int32_t  retrytime,
int32_t  tries 
)

Initiates a connection to "server" on "port" or to the unix "socket" on the local machine and authenticates with "user" and "password". Failed connections will be retried for "tries" times on interval "retrytime". If "tries" is 0 then retries will continue forever. If "retrytime" is 0 then retries will be attempted on a default interval. If the "socket" parameter is nether NULL nor "" then an attempt will be made to connect through it before attempting to connect to "server" on "port". If it is NULL or "" then no attempt will be made to connect through the socket.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_autoCommitOff ( sqlrcon  sqlrconref)

Instructs the database to wait for the client to tell it when to commit.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_autoCommitOn ( sqlrcon  sqlrconref)

Instructs the database to perform a commit after every successful query.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_begin ( sqlrcon  sqlrconref)

Begins a transaction. Returns 1 if the begin succeeded, 0 if it failed. If the database automatically begins a new transaction when a commit or rollback is issued then this doesn't do anything unless SQL Relay is faking transaction blocks.

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcon_bindFormat ( sqlrcon  sqlrconref)

Returns a string representing the format of the bind variables used in the db.

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcon_clientVersion ( sqlrcon  sqlrconref)

Returns the version of the sqlrelay client software.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_commit ( sqlrcon  sqlrconref)

Issues a commit. Returns 1 if the commit succeeded, 0 if it failed.

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcon_dbVersion ( sqlrcon  sqlrconref)

Returns the version of the database

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcon_debugOff ( sqlrcon  sqlrconref)

Turns debugging off.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcon_debugOn ( sqlrcon  sqlrconref)

Causes verbose debugging information to be sent to standard output. Another way to do this is to start a query with "-- debug\n". Yet another way is to set the environment variable SQLRDEBUG to "ON"

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcon_debugPrintFunction ( sqlrcon  sqlrconref,
int(*)(const char *,...)  printfunction 
)

Allows you to replace the function used to print debug messages with your own function. The function is expected to take arguments like printf.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcon_endSession ( sqlrcon  sqlrconref)

Ends the session.

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcon_errorMessage ( sqlrcon  sqlrconref)

If an operation failed and generated an error, the error message is available here. If there is no error then this method returns NULL

SQLRCLIENTWRAPPER_DLLSPEC int64_t sqlrcon_errorNumber ( sqlrcon  sqlrconref)

If an operation failed and generated an error, the error number is available here. If there is no error then this method returns 0.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcon_free ( sqlrcon  sqlrconref)

Disconnects and ends the session if it hasn't been terminated already.

SQLRCLIENTWRAPPER_DLLSPEC uint16_t sqlrcon_getConnectionPort ( sqlrcon  sqlrconref)

Returns the inet port that the connection is communicating over. This parameter may be passed to another connection for use in the sqlrcon_resumeSession() command. Note: The result this function returns is only valid after a call to suspendSession().

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcon_getConnectionSocket ( sqlrcon  sqlrconref)

Returns the unix socket that the connection is communicating over. This parameter may be passed to another connection for use in the sqlrcon_resumeSession() command. Note: The result this function returns is only valid after a call to suspendSession().

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcon_getCurrentDatabase ( sqlrcon  sqlrconref)

Returns the database/schema that is currently in use.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_getDebug ( sqlrcon  sqlrconref)

Returns 0 if debugging is off and 1 if debugging is on.

SQLRCLIENTWRAPPER_DLLSPEC uint64_t sqlrcon_getLastInsertId ( sqlrcon  sqlrconref)

Returns the value of the autoincrement column for the last insert

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcon_identify ( sqlrcon  sqlrconref)

Returns the type of database: oracle8, postgresql, mysql, etc.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_ping ( sqlrcon  sqlrconref)

Returns 1 if the database is up and 0 if it's down.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_resumeSession ( sqlrcon  sqlrconref,
uint16_t  port,
const char *  socket 
)

Resumes a session previously left open using sqlrcon_suspendSession(). Returns 1 on success and 0 on failure.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_rollback ( sqlrcon  sqlrconref)

Issues a rollback. Returns 1 if the rollback succeeded, 0 if it failed.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_selectDatabase ( sqlrcon  sqlrconref,
const char *  database 
)

Sets the current database/schema to "database"

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcon_serverVersion ( sqlrcon  sqlrconref)

Returns the version of the sqlrelay server software.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcon_setTimeout ( sqlrcon  sqlrconref,
int32_t  timeoutsec,
int32_t  timeoutusec 
)

Sets the server connect timeout in seconds and milliseconds. Setting either parameter to -1 disables the timeout.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcon_suspendSession ( sqlrcon  sqlrconref)

Disconnects this connection from the current session but leaves the session open so that another connection can connect to it using sqlrcon_resumeSession().

SQLRCLIENTWRAPPER_DLLSPEC uint64_t sqlrcur_affectedRows ( sqlrcur  sqlrcurref)

Returns the number of rows that were updated, inserted or deleted by the query. Not all databases support this call. Don't use it for applications which are designed to be portable across databases. -1 is returned by databases which don't support this option.

SQLRCLIENTWRAPPER_DLLSPEC sqlrcur sqlrcur_alloc ( sqlrcon  sqlrconref)

Creates a cursor to run queries and fetch result sets using connection "sqlrconref"

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_cacheOff ( sqlrcur  sqlrcurref)

Sets query caching off.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_cacheToFile ( sqlrcur  sqlrcurref,
const char *  filename 
)

Sets query caching on. Future queries will be cached to the file "filename".

A default time-to-live of 10 minutes is also set.

Note that once sqlrcur_cacheToFile() is called, the result sets of all future queries will be cached to that file until another call to sqlrcur_cacheToFile() changes which file to cache to or a call to sqlrcur_cacheOff() turns off caching.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_clearBinds ( sqlrcur  sqlrcurref)

Clears all bind variables.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_closeResultSet ( sqlrcur  sqlrcurref)

Closes the current result set, if one is open. Data that has been fetched already is still available but no more data may be fetched. Server side resources for the result set are freed as well.

SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_colCount ( sqlrcur  sqlrcurref)

Returns the number of columns in the current result set.

SQLRCLIENTWRAPPER_DLLSPEC uint16_t sqlrcur_countBindVariables ( sqlrcur  sqlrcurref)

Parses the previously prepared query, counts the number of bind variables defined in it and returns that number.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_defineOutputBindBlob ( sqlrcur  sqlrcurref,
const char *  variable 
)

Defines a binary lob output bind variable

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_defineOutputBindClob ( sqlrcur  sqlrcurref,
const char *  variable 
)

Defines a character lob output bind variable

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_defineOutputBindCursor ( sqlrcur  sqlrcurref,
const char *  variable 
)

Defines a cursor output bind variable

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_defineOutputBindDate ( sqlrcur  sqlrcurref,
const char *  variable 
)

Defines a date output bind variable.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_defineOutputBindDouble ( sqlrcur  sqlrcurref,
const char *  variable 
)

Defines an decimal output bind variable.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_defineOutputBindInteger ( sqlrcur  sqlrcurref,
const char *  variable 
)

Defines an integer output bind variable.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_defineOutputBindString ( sqlrcur  sqlrcurref,
const char *  variable,
uint32_t  length 
)

Defines a string output bind variable. "length" bytes will be reserved to store the value.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_dontGetColumnInfo ( sqlrcur  sqlrcurref)

Tells the server not to send any column info (names, types, sizes). If you don't need that info, you should call this function to improve performance.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_endOfResultSet ( sqlrcur  sqlrcurref)

Returns 0 if part of the result set is still pending on the server and 1 if not. This function can only return 0 if setResultSetBufferSize() has been called with a parameter other than 0.

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcur_errorMessage ( sqlrcur  sqlrcurref)

If a query failed and generated an error, the error message is available here. If the query succeeded then this function returns a NULL.

SQLRCLIENTWRAPPER_DLLSPEC int64_t sqlrcur_errorNumber ( sqlrcur  sqlrcurref)

If a query failed and generated an error, the error number is available here. If there is no error then this method returns 0.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_executeQuery ( sqlrcur  sqlrcurref)

Execute the query that was previously prepared and bound.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_fetchFromBindCursor ( sqlrcur  sqlrcurref)

Fetch from a cursor that was returned as an output bind variable.

SQLRCLIENTWRAPPER_DLLSPEC uint64_t sqlrcur_firstRowIndex ( sqlrcur  sqlrcurref)

Returns the index of the first buffered row. This is useful when buffering only part of the result set at a time.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_free ( sqlrcur  sqlrcurref)

Destroys the cursor and cleans up all associated result set data.

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcur_getCacheFileName ( sqlrcur  sqlrcurref)

Returns the name of the file containing the most recently cached result set.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_getColumnInfo ( sqlrcur  sqlrcurref)

Tells the server to send column info.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsAutoIncrementByIndex ( sqlrcur  sqlrcurref,
uint32_t  col 
)

Returns 1 if the specified column auto-increments and 0 otherwise.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsAutoIncrementByName ( sqlrcur  sqlrcurref,
const char *  col 
)

Returns 1 if the specified column auto-increments and 0 otherwise.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsBinaryByIndex ( sqlrcur  sqlrcurref,
uint32_t  col 
)

Returns 1 if the specified column contains binary data and 0 otherwise.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsBinaryByName ( sqlrcur  sqlrcurref,
const char *  col 
)

Returns 1 if the specified column contains binary data and 0 otherwise.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsNullableByIndex ( sqlrcur  sqlrcurref,
uint32_t  col 
)

Returns the scale of the specified column. Scale is the total number of digits to the right of the decimal point in a number. eg: 123.45 has a scale of 2.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsNullableByName ( sqlrcur  sqlrcurref,
const char *  col 
)

Returns 1 if the specified column can contain nulls and 0 otherwise.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsPartOfKeyByIndex ( sqlrcur  sqlrcurref,
uint32_t  col 
)

Returns 1 if the specified column is part of a composite key and 0 otherwise.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsPartOfKeyByName ( sqlrcur  sqlrcurref,
const char *  col 
)

Returns 1 if the specified column is part of a composite key and 0 otherwise.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsPrimaryKeyByIndex ( sqlrcur  sqlrcurref,
uint32_t  col 
)

Returns 1 if the specified column is a primary key and 0 otherwise.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsPrimaryKeyByName ( sqlrcur  sqlrcurref,
const char *  col 
)

Returns 1 if the specified column is a primary key and 0 otherwise.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsUniqueByIndex ( sqlrcur  sqlrcurref,
uint32_t  col 
)

Returns 1 if the specified column is unique and 0 otherwise.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsUniqueByName ( sqlrcur  sqlrcurref,
const char *  col 
)

Returns 1 if the specified column is unique and 0 otherwise.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsUnsignedByIndex ( sqlrcur  sqlrcurref,
uint32_t  col 
)

Returns 1 if the specified column is an unsigned number and 0 otherwise.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsUnsignedByName ( sqlrcur  sqlrcurref,
const char *  col 
)

Returns 1 if the specified column is an unsigned number and 0 otherwise.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsZeroFilledByIndex ( sqlrcur  sqlrcurref,
uint32_t  col 
)

Returns 1 if the specified column was created with the zero-fill flag and 0 otherwise.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnIsZeroFilledByName ( sqlrcur  sqlrcurref,
const char *  col 
)

Returns 1 if the specified column was created with the zero-fill flag and 0 otherwise.

SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getColumnLengthByIndex ( sqlrcur  sqlrcurref,
uint32_t  col 
)

Returns the length of the specified column.

SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getColumnLengthByName ( sqlrcur  sqlrcurref,
const char *  col 
)

Returns the length of the specified column.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getColumnList ( sqlrcur  sqlrcurref,
const char *  table,
const char *  wild 
)

Sends a query that returns a list of columns in the table specified by the "table" parameter matching "wild". If wild is empty or NULL then a list of all columns will be returned.

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcur_getColumnName ( sqlrcur  sqlrcurref,
uint32_t  col 
)

Returns the name of the specified column.

SQLRCLIENTWRAPPER_DLLSPEC const char* const sqlrcur_getColumnNames ( sqlrcur  sqlrcurref)

Returns a null terminated array of the column names of the current result set.

SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getColumnPrecisionByIndex ( sqlrcur  sqlrcurref,
uint32_t  col 
)

Returns the precision of the specified column. Precision is the total number of digits in a number. eg: 123.45 has a precision of 5. For non-numeric types, it's the number of characters in the string.

SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getColumnPrecisionByName ( sqlrcur  sqlrcurref,
const char *  col 
)

Returns the precision of the specified column. Precision is the total number of digits in a number. eg: 123.45 has a precision of 5. For non-numeric types, it's the number of characters in the string.

SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getColumnScaleByIndex ( sqlrcur  sqlrcurref,
uint32_t  col 
)

Returns the scale of the specified column. Scale is the total number of digits to the right of the decimal point in a number. eg: 123.45 has a scale of 2.

SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getColumnScaleByName ( sqlrcur  sqlrcurref,
const char *  col 
)

Returns the scale of the specified column. Scale is the total number of digits to the right of the decimal point in a number. eg: 123.45 has a scale of 2.

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcur_getColumnTypeByIndex ( sqlrcur  sqlrcurref,
uint32_t  col 
)

Returns the type of the specified column.

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcur_getColumnTypeByName ( sqlrcur  sqlrcurref,
const char *  col 
)

Returns the type of the specified column.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getDatabaseList ( sqlrcur  sqlrcurref,
const char *  wild 
)

Sends a query that returns a list of databases/schemas matching "wild". If wild is empty or NULL then a list of all databases/schemas will be returned.

SQLRCLIENTWRAPPER_DLLSPEC double sqlrcur_getFieldAsDoubleByIndex ( sqlrcur  sqlrcurref,
uint64_t  row,
uint32_t  col 
)

Returns the specified field as an decimal.

SQLRCLIENTWRAPPER_DLLSPEC double sqlrcur_getFieldAsDoubleByName ( sqlrcur  sqlrcurref,
uint64_t  row,
const char *  col 
)

Returns the specified field as an decimal.

SQLRCLIENTWRAPPER_DLLSPEC int64_t sqlrcur_getFieldAsIntegerByIndex ( sqlrcur  sqlrcurref,
uint64_t  row,
uint32_t  col 
)

Returns the specified field as an integer.

SQLRCLIENTWRAPPER_DLLSPEC int64_t sqlrcur_getFieldAsIntegerByName ( sqlrcur  sqlrcurref,
uint64_t  row,
const char *  col 
)

Returns the specified field as an integer.

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcur_getFieldByIndex ( sqlrcur  sqlrcurref,
uint64_t  row,
uint32_t  col 
)

Returns the specified field as a string.

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcur_getFieldByName ( sqlrcur  sqlrcurref,
uint64_t  row,
const char *  col 
)

Returns the specified field as a string.

SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getFieldLengthByIndex ( sqlrcur  sqlrcurref,
uint64_t  row,
uint32_t  col 
)

Returns the length of the specified row and column.

SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getFieldLengthByName ( sqlrcur  sqlrcurref,
uint64_t  row,
const char *  col 
)

Returns the length of the specified row and column.

SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getLongestByIndex ( sqlrcur  sqlrcurref,
uint32_t  col 
)

Returns the length of the longest field in the specified column.

SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getLongestByName ( sqlrcur  sqlrcurref,
const char *  col 
)

Returns the length of the longest field in the specified column.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_getNullsAsEmptyStrings ( sqlrcur  sqlrcurref)

Tells the connection to return NULL fields and output bind variables as empty strings. This is the default.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_getNullsAsNulls ( sqlrcur  sqlrcurref)

Tells the connection to return NULL fields and output bind variables as NULL's.

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcur_getOutputBindBlob ( sqlrcur  sqlrcurref,
const char *  variable 
)

Get the value stored in a previously defined binary lob output bind variable.

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcur_getOutputBindClob ( sqlrcur  sqlrcurref,
const char *  variable 
)

Get the value stored in a previously defined character lob output bind variable.

SQLRCLIENTWRAPPER_DLLSPEC sqlrcur sqlrcur_getOutputBindCursor ( sqlrcur  sqlrcurref,
const char *  variable 
)

Get the cursor associated with a previously defined output bind variable.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getOutputBindDate ( sqlrcur  sqlrcurref,
const char *  variable,
int16_t *  year,
int16_t *  month,
int16_t *  day,
int16_t *  hour,
int16_t *  minute,
int16_t *  second,
const char **  tz 
)

Get the value stored in a previously defined date output bind variable.

SQLRCLIENTWRAPPER_DLLSPEC double sqlrcur_getOutputBindDouble ( sqlrcur  sqlrcurref,
const char *  variable 
)

Get the value stored in a previously defined decimal output bind variable.

SQLRCLIENTWRAPPER_DLLSPEC int64_t sqlrcur_getOutputBindInteger ( sqlrcur  sqlrcurref,
const char *  variable 
)

Get the value stored in a previously defined integer output bind variable.

SQLRCLIENTWRAPPER_DLLSPEC uint32_t sqlrcur_getOutputBindLength ( sqlrcur  sqlrcurref,
const char *  variable 
)

Get the length of the value stored in a previously defined output bind variable.

SQLRCLIENTWRAPPER_DLLSPEC const char* sqlrcur_getOutputBindString ( sqlrcur  sqlrcurref,
const char *  variable 
)

Get the value stored in a previously defined string output bind variable.

SQLRCLIENTWRAPPER_DLLSPEC uint64_t sqlrcur_getResultSetBufferSize ( sqlrcur  sqlrcurref)

Returns the number of result set rows that will be buffered at a time or 0 for the entire result set.

SQLRCLIENTWRAPPER_DLLSPEC uint16_t sqlrcur_getResultSetId ( sqlrcur  sqlrcurref)

Returns the internal ID of this result set. This parameter may be passed to another statement for use in the resumeResultSet() function. Note: The value this function returns is only valid after a call to suspendResultSet().

SQLRCLIENTWRAPPER_DLLSPEC const char* const sqlrcur_getRow ( sqlrcur  sqlrcurref,
uint64_t  row 
)

Returns a null terminated array of the values of the fields in the specified row.

SQLRCLIENTWRAPPER_DLLSPEC uint32_t* sqlrcur_getRowLengths ( sqlrcur  sqlrcurref,
uint64_t  row 
)

Returns a null terminated array of the lengths of the fields in the specified row.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_getTableList ( sqlrcur  sqlrcurref,
const char *  wild 
)

Sends a query that returns a list of tables matching "wild". If wild is empty or NULL then a list of all tables will be returned.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindBlob ( sqlrcur  sqlrcurref,
const char *  variable,
const char *  value,
uint32_t  size 
)

Defines a binary lob input bind variable.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindClob ( sqlrcur  sqlrcurref,
const char *  variable,
const char *  value,
uint32_t  size 
)

Defines a character lob input bind variable.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindDouble ( sqlrcur  sqlrcurref,
const char *  variable,
double  value,
uint32_t  precision,
uint32_t  scale 
)

Defines a decimal input bind variable. (If you don't have the precision and scale then set them both to 0. However in that case you may get unexpected rounding behavior if the server is faking binds.)

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindDoubles ( sqlrcur  sqlrcurref,
const char **  variables,
const double *  values,
const uint32_t *  precisions,
const uint32_t *  scales 
)

Defines an array of decimal input bind variables.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindLong ( sqlrcur  sqlrcurref,
const char *  variable,
int64_t  value 
)

Defines a integer input bind variable.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindLongs ( sqlrcur  sqlrcurref,
const char **  variables,
const int64_t *  values 
)

Defines an array of integer input bind variables.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindString ( sqlrcur  sqlrcurref,
const char *  variable,
const char *  value 
)

Defines a string input bind variable.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindStrings ( sqlrcur  sqlrcurref,
const char **  variables,
const char **  values 
)

Defines an array of string input bind variables.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_inputBindStringWithLength ( sqlrcur  sqlrcurref,
const char *  variable,
const char *  value,
uint32_t  valuelength 
)

Defines a string input bind variable.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_lowerCaseColumnNames ( sqlrcur  sqlrcurref)

Columns names are converted to lower case.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_mixedCaseColumnNames ( sqlrcur  sqlrcurref)

Columns names are returned in the same case as they are defined in the database. This is the default.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_openCachedResultSet ( sqlrcur  sqlrcurref,
const char *  filename 
)

Opens a cached result set. Returns 1 on success and 0 on failure.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_prepareFileQuery ( sqlrcur  sqlrcurref,
const char *  path,
const char *  filename 
)

Prepare to execute the contents of "path"/"filename".

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_prepareQuery ( sqlrcur  sqlrcurref,
const char *  query 
)

Prepare to execute "query".

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_prepareQueryWithLength ( sqlrcur  sqlrcurref,
const char *  query,
uint32_t  length 
)

Prepare to execute "query" with length "length". This function must be used if the query contains binary data.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_resumeCachedResultSet ( sqlrcur  sqlrcurref,
uint16_t  id,
const char *  filename 
)

Resumes a result set previously left open using suspendSession() and continues caching the result set to "filename". Returns 1 on success and 0 on failure.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_resumeResultSet ( sqlrcur  sqlrcurref,
uint16_t  id 
)

Resumes a result set previously left open using suspendSession(). Returns 1 on success and 0 on failure.

SQLRCLIENTWRAPPER_DLLSPEC uint64_t sqlrcur_rowCount ( sqlrcur  sqlrcurref)

Returns the number of rows in the current result set.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_sendFileQuery ( sqlrcur  sqlrcurref,
const char *  path,
const char *  filename 
)

Sends the query in file "path"/"filename" and gets a result set.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_sendQuery ( sqlrcur  sqlrcurref,
const char *  query 
)

Sends "query" directly and gets a result set.

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_sendQueryWithLength ( sqlrcur  sqlrcurref,
const char *  query,
uint32_t  length 
)

Sends "query" with length "length" directly and gets a result set. This function must be used if the query contains binary data.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_setCacheTtl ( sqlrcur  sqlrcurref,
uint32_t  ttl 
)

Sets the time-to-live for cached result sets. The sqlr-cachemanger will remove each cached result set "ttl" seconds after it's created, provided it's scanning the directory containing the cache files.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_setResultSetBufferSize ( sqlrcur  sqlrcurref,
uint64_t  rows 
)

Sets the number of rows of the result set to buffer at a time. 0 (the default) means buffer the entire result set.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_subDouble ( sqlrcur  sqlrcurref,
const char *  variable,
double  value,
uint32_t  precision,
uint32_t  scale 
)

Defines a decimal substitution variable.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_subDoubles ( sqlrcur  sqlrcurref,
const char **  variables,
const double *  values,
const uint32_t *  precisions,
const uint32_t *  scales 
)

Defines an array of decmial substitution variables.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_subLong ( sqlrcur  sqlrcurref,
const char *  variable,
int64_t  value 
)

Defines a integer substitution variable.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_subLongs ( sqlrcur  sqlrcurref,
const char **  variables,
const int64_t *  values 
)

Defines an array of integer substitution variables.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_subString ( sqlrcur  sqlrcurref,
const char *  variable,
const char *  value 
)

Defines a string substitution variable.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_subStrings ( sqlrcur  sqlrcurref,
const char **  variables,
const char **  values 
)

Defines an array of string substitution variables.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_suspendResultSet ( sqlrcur  sqlrcurref)

Tells the server to leave this result set open when the connection calls suspendSession() so that another connection can connect to it using resumeResultSet() after it calls resumeSession().

SQLRCLIENTWRAPPER_DLLSPEC uint64_t sqlrcur_totalRows ( sqlrcur  sqlrcurref)

Returns the total number of rows that will be returned in the result set. Not all databases support this call. Don't use it for applications which are designed to be portable across databases. -1 is returned by databases which don't support this option.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_upperCaseColumnNames ( sqlrcur  sqlrcurref)

Columns names are converted to upper case.

SQLRCLIENTWRAPPER_DLLSPEC void sqlrcur_validateBinds ( sqlrcur  sqlrcurref)

If you are binding to any variables that might not actually be in your query, call this to ensure that the database won't try to bind them unless they really are in the query. There is a performance penalty for calling this function

SQLRCLIENTWRAPPER_DLLSPEC int sqlrcur_validBind ( sqlrcur  sqlrcurref,
const char *  variable 
)

Returns true if "variable" was a valid bind variable of the query.