SQL Relay C API
Functions
sqlrclientwrapper

Functions

SQLRCLIENT_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)
 
SQLRCLIENT_DLLSPEC void sqlrcon_free (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC void sqlrcon_setConnectTimeout (sqlrcon sqlrconref, int32_t timeoutsec, int32_t timeoutusec)
 
SQLRCLIENT_DLLSPEC void sqlrcon_getConnectTimeout (sqlrcon sqlrconref, int32_t *timeoutsec, int32_t *timeoutusec)
 
SQLRCLIENT_DLLSPEC int32_t sqlrcon_getConnectTimeoutSeconds (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int32_t sqlrcon_getConnectTimeoutMicroseconds (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC void sqlrcon_setResponseTimeout (sqlrcon sqlrconref, int32_t timeoutsec, int32_t timeoutusec)
 
SQLRCLIENT_DLLSPEC void sqlrcon_getResponseTimeout (sqlrcon sqlrconref, int32_t *timeoutsec, int32_t *timeoutusec)
 
SQLRCLIENT_DLLSPEC int32_t sqlrcon_getResponseTimeoutSeconds (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int32_t sqlrcon_getResponseTimeoutMicroseconds (sqlrcon sqlrconref)
 
void sqlrcon_setBindVariableDelimiters (sqlrcon sqlrconref, const char *delimiters)
 
int sqlrcon_getBindVariableDelimiterQuestionMarkSupported (sqlrcon sqlrconref)
 
int sqlrcon_getBindVariableDelimiterColonSupported (sqlrcon sqlrconref)
 
int sqlrcon_getBindVariableDelimiterAtSignSupported (sqlrcon sqlrconref)
 
int sqlrcon_getBindVariableDelimiterDollarSignSupported (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC void sqlrcon_enableKerberos (sqlrcon sqlrconref, const char *service, const char *mech, const char *flags)
 
SQLRCLIENT_DLLSPEC void sqlrcon_enableTls (sqlrcon sqlrconref, const char *version, const char *cert, const char *password, const char *ciphers, const char *validate, const char *ca, uint16_t depth)
 
SQLRCLIENT_DLLSPEC void sqlrcon_disableEncryption (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC void sqlrcon_endSession (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int sqlrcon_suspendSession (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC uint16_t sqlrcon_getConnectionPort (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_getConnectionSocket (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int sqlrcon_resumeSession (sqlrcon sqlrconref, uint16_t port, const char *socket)
 
SQLRCLIENT_DLLSPEC int sqlrcon_ping (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_identify (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_dbVersion (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_dbHostName (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_dbIpAddress (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_serverVersion (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_clientVersion (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_bindFormat (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_nextvalFormat (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int sqlrcon_selectDatabase (sqlrcon sqlrconref, const char *database)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_getCurrentDatabase (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int sqlrcon_getDatabaseIsSchema (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int sqlrcon_selectCatalog (sqlrcon sqlrconref, const char *catalog)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_getCurrentCatalog (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int sqlrcon_selectSchema (sqlrcon sqlrconref, const char *schema)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_getCurrentSchema (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_getCurrentUser (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC uint64_t sqlrcon_getLastInsertId (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int sqlrcon_autoCommitOn (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int sqlrcon_autoCommitOff (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int sqlrcon_getAutoCommit (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int sqlrcon_begin (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int sqlrcon_commit (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int sqlrcon_rollback (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int sqlrcon_getInTransaction (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_getDefaultTransactionModel (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int sqlrcon_setTransactionModel (sqlrcon sqlrconref, const char *txmodel)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_getTransactionModel (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_getDefaultIsolationLevel (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int sqlrcon_setIsolationLevel (sqlrcon sqlrconref, const char *isolationlevel)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_getIsolationLevel (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_getDatabaseFeature (sqlrcon sqlrconref, const char *feature)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_errorMessage (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int64_t sqlrcon_errorNumber (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC void sqlrcon_debugOn (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC void sqlrcon_debugOff (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC int sqlrcon_getDebug (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC void sqlrcon_debugPrintFunction (sqlrcon sqlrconref, int(*printfunction)(const char *,...))
 
SQLRCLIENT_DLLSPEC void sqlrcon_setDebugFile (sqlrcon sqlrconref, const char *filename)
 
SQLRCLIENT_DLLSPEC void sqlrcon_setClientInfo (sqlrcon sqlrconref, const char *clientinfo)
 
SQLRCLIENT_DLLSPEC const char * sqlrcon_getClientInfo (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC sqlrcur sqlrcur_alloc (sqlrcon sqlrconref)
 
SQLRCLIENT_DLLSPEC void sqlrcur_free (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC void sqlrcur_setResultSetBufferSize (sqlrcur sqlrcurref, uint64_t rows)
 
SQLRCLIENT_DLLSPEC uint64_t sqlrcur_getResultSetBufferSize (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC void sqlrcur_dontGetColumnInfo (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC void sqlrcur_getColumnInfo (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC void sqlrcur_mixedCaseColumnNames (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC void sqlrcur_upperCaseColumnNames (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC void sqlrcur_lowerCaseColumnNames (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC void sqlrcur_cacheToFile (sqlrcur sqlrcurref, const char *filename)
 
SQLRCLIENT_DLLSPEC void sqlrcur_setCacheTtl (sqlrcur sqlrcurref, uint32_t ttl)
 
SQLRCLIENT_DLLSPEC const char * sqlrcur_getCacheFileName (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC void sqlrcur_cacheOff (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getDatabaseList (sqlrcur sqlrcurref, const char *databases)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getCatalogList (sqlrcur sqlrcurref, const char *catalogs)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getSchemaList (sqlrcur sqlrcurref, const char *schemas)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getTableTypeList (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getTableList (sqlrcur sqlrcurref, const char *tables)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getTypeInfoList (sqlrcur sqlrcurref, const char *type)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getColumnList (sqlrcur sqlrcurref, const char *table, const char *columns)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getPrimaryKeysList (sqlrcur sqlrcurref, const char *table, const char *columns)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getKeyAndIndexList (sqlrcur sqlrcurref, const char *table, const char *qualifier)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getProcedureList (sqlrcur sqlrcurref, const char *procedures)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getProcedureParameterList (sqlrcur sqlrcurref, const char *procedure, const char *parameters)
 
SQLRCLIENT_DLLSPEC int sqlrcur_sendQuery (sqlrcur sqlrcurref, const char *query)
 
SQLRCLIENT_DLLSPEC int sqlrcur_sendQueryWithLength (sqlrcur sqlrcurref, const char *query, uint32_t length)
 
SQLRCLIENT_DLLSPEC int sqlrcur_sendFileQuery (sqlrcur sqlrcurref, const char *path, const char *filename)
 
SQLRCLIENT_DLLSPEC void sqlrcur_prepareQuery (sqlrcur sqlrcurref, const char *query)
 
SQLRCLIENT_DLLSPEC void sqlrcur_prepareQueryWithLength (sqlrcur sqlrcurref, const char *query, uint32_t length)
 
SQLRCLIENT_DLLSPEC void sqlrcur_prepareFileQuery (sqlrcur sqlrcurref, const char *path, const char *filename)
 
SQLRCLIENT_DLLSPEC void sqlrcur_subString (sqlrcur sqlrcurref, const char *variable, const char *value)
 
SQLRCLIENT_DLLSPEC void sqlrcur_subLong (sqlrcur sqlrcurref, const char *variable, int64_t value)
 
SQLRCLIENT_DLLSPEC void sqlrcur_subDouble (sqlrcur sqlrcurref, const char *variable, double value, uint32_t precision, uint32_t scale)
 
SQLRCLIENT_DLLSPEC void sqlrcur_subStrings (sqlrcur sqlrcurref, const char **variables, const char **values)
 
SQLRCLIENT_DLLSPEC void sqlrcur_subLongs (sqlrcur sqlrcurref, const char **variables, const int64_t *values)
 
SQLRCLIENT_DLLSPEC void sqlrcur_subDoubles (sqlrcur sqlrcurref, const char **variables, const double *values, const uint32_t *precisions, const uint32_t *scales)
 
SQLRCLIENT_DLLSPEC void sqlrcur_inputBindString (sqlrcur sqlrcurref, const char *variable, const char *value)
 
SQLRCLIENT_DLLSPEC void sqlrcur_inputBindStringWithLength (sqlrcur sqlrcurref, const char *variable, const char *value, uint32_t valuelength)
 
SQLRCLIENT_DLLSPEC void sqlrcur_inputBindLong (sqlrcur sqlrcurref, const char *variable, int64_t value)
 
SQLRCLIENT_DLLSPEC void sqlrcur_inputBindDouble (sqlrcur sqlrcurref, const char *variable, double value, uint32_t precision, uint32_t scale)
 
SQLRCLIENT_DLLSPEC void sqlrcur_inputBindDate (sqlrcur sqlrcurref, const char *variable, int16_t year, int16_t month, int16_t day, int16_t hour, int16_t minute, int16_t second, int32_t microsecond, const char *tz, int isnegative)
 
SQLRCLIENT_DLLSPEC void sqlrcur_inputBindBlob (sqlrcur sqlrcurref, const char *variable, const char *value, uint32_t size)
 
SQLRCLIENT_DLLSPEC void sqlrcur_inputBindClob (sqlrcur sqlrcurref, const char *variable, const char *value, uint32_t size)
 
SQLRCLIENT_DLLSPEC void sqlrcur_inputBindStrings (sqlrcur sqlrcurref, const char **variables, const char **values)
 
SQLRCLIENT_DLLSPEC void sqlrcur_inputBindLongs (sqlrcur sqlrcurref, const char **variables, const int64_t *values)
 
SQLRCLIENT_DLLSPEC void sqlrcur_inputBindDoubles (sqlrcur sqlrcurref, const char **variables, const double *values, const uint32_t *precisions, const uint32_t *scales)
 
SQLRCLIENT_DLLSPEC void sqlrcur_defineOutputBindString (sqlrcur sqlrcurref, const char *variable, uint32_t length)
 
SQLRCLIENT_DLLSPEC void sqlrcur_defineOutputBindInteger (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC void sqlrcur_defineOutputBindDouble (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC void sqlrcur_defineOutputBindDate (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC void sqlrcur_defineOutputBindBlob (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC void sqlrcur_defineOutputBindClob (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC void sqlrcur_defineOutputBindCursor (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC void sqlrcur_clearBinds (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC uint16_t sqlrcur_countBindVariables (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC void sqlrcur_validateBinds (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC int sqlrcur_validBind (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC int sqlrcur_executeQuery (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC int sqlrcur_fetchFromBindCursor (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC const char * sqlrcur_getOutputBindString (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC int64_t sqlrcur_getOutputBindInteger (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC double sqlrcur_getOutputBindDouble (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_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, int32_t *microsecond, const char **tz, int *isnegative)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getOutputBindDateYear (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getOutputBindDateMonth (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getOutputBindDateDay (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getOutputBindDateHour (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getOutputBindDateMinute (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getOutputBindDateSecond (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC int32_t sqlrcur_getOutputBindDateMicrosecond (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC const char * sqlrcur_getOutputBindDateTz (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getOutputBindDateIsNegative (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC const char * sqlrcur_getOutputBindBlob (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC const char * sqlrcur_getOutputBindClob (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC uint32_t sqlrcur_getOutputBindLength (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC sqlrcur sqlrcur_getOutputBindCursor (sqlrcur sqlrcurref, const char *variable)
 
SQLRCLIENT_DLLSPEC int sqlrcur_openCachedResultSet (sqlrcur sqlrcurref, const char *filename)
 
SQLRCLIENT_DLLSPEC uint32_t sqlrcur_colCount (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC uint64_t sqlrcur_rowCount (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC uint64_t sqlrcur_totalRows (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC uint64_t sqlrcur_affectedRows (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC uint64_t sqlrcur_firstRowIndex (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC int sqlrcur_endOfResultSet (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC int sqlrcur_nextResultSet (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC const char * sqlrcur_errorMessage (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC int64_t sqlrcur_errorNumber (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC void sqlrcur_getNullsAsEmptyStrings (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC void sqlrcur_getNullsAsNulls (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC const char * sqlrcur_getFieldByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col)
 
SQLRCLIENT_DLLSPEC const char * sqlrcur_getFieldByName (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC const char * sqlrcur_getFieldByNameIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int64_t sqlrcur_getFieldAsIntegerByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col)
 
SQLRCLIENT_DLLSPEC int64_t sqlrcur_getFieldAsIntegerByName (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int64_t sqlrcur_getFieldAsIntegerByNameIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC double sqlrcur_getFieldAsDoubleByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col)
 
SQLRCLIENT_DLLSPEC double sqlrcur_getFieldAsDoubleByName (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC double sqlrcur_getFieldAsDoubleByNameIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsBooleanByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsBooleanByName (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsBooleanByNameIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col, int16_t *year, int16_t *month, int16_t *day, int16_t *hour, int16_t *minute, int16_t *second, int32_t *microsecond, int *isnegative)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateByIndexWithDdMm (sqlrcur sqlrcurref, uint64_t row, uint32_t col, int ddmm, int yyyyddmm, const char *datedelimiters, int16_t *year, int16_t *month, int16_t *day, int16_t *hour, int16_t *minute, int16_t *second, int32_t *microsecond, int *isnegative)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateByName (sqlrcur sqlrcurref, uint64_t row, const char *col, int16_t *year, int16_t *month, int16_t *day, int16_t *hour, int16_t *minute, int16_t *second, int32_t *microsecond, int *isnegative)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateByNameIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col, int16_t *year, int16_t *month, int16_t *day, int16_t *hour, int16_t *minute, int16_t *second, int32_t *microsecond, int *isnegative)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateByNameWithDdMm (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters, int16_t *year, int16_t *month, int16_t *day, int16_t *hour, int16_t *minute, int16_t *second, int32_t *microsecond, int *isnegative)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateByNameWithDdMmIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters, int16_t *year, int16_t *month, int16_t *day, int16_t *hour, int16_t *minute, int16_t *second, int32_t *microsecond, int *isnegative)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateYearByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateYearByIndexWithDdMm (sqlrcur sqlrcurref, uint64_t row, uint32_t col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateYearByName (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateYearByNameIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateYearByNameWithDdMm (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateYearByNameWithDdMmIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMonthByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMonthByIndexWithDdMm (sqlrcur sqlrcurref, uint64_t row, uint32_t col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMonthByName (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMonthByNameIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMonthByNameWithDdMm (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMonthByNameWithDdMmIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateDayByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateDayByIndexWithDdMm (sqlrcur sqlrcurref, uint64_t row, uint32_t col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateDayByName (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateDayByNameIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateDayByNameWithDdMm (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateDayByNameWithDdMmIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateHourByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateHourByIndexWithDdMm (sqlrcur sqlrcurref, uint64_t row, uint32_t col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateHourByName (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateHourByNameIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateHourByNameWithDdMm (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateHourByNameWithDdMmIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMinuteByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMinuteByIndexWithDdMm (sqlrcur sqlrcurref, uint64_t row, uint32_t col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMinuteByName (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMinuteByNameIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMinuteByNameWithDdMm (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMinuteByNameWithDdMmIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateSecondByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateSecondByIndexWithDdMm (sqlrcur sqlrcurref, uint64_t row, uint32_t col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateSecondByName (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateSecondByNameIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateSecondByNameWithDdMm (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateSecondByNameWithDdMmIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int32_t sqlrcur_getFieldAsDateMicrosecondByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col)
 
SQLRCLIENT_DLLSPEC int32_t sqlrcur_getFieldAsDateMicrosecondByIndexWithDdMm (sqlrcur sqlrcurref, uint64_t row, uint32_t col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int32_t sqlrcur_getFieldAsDateMicrosecondByName (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int32_t sqlrcur_getFieldAsDateMicrosecondByNameIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int32_t sqlrcur_getFieldAsDateMicrosecondByNameWithDdMm (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int32_t sqlrcur_getFieldAsDateMicrosecondByNameWithDdMmIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateIsNegativeByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateIsNegativeByIndexWithDdMm (sqlrcur sqlrcurref, uint64_t row, uint32_t col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateIsNegativeByName (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateIsNegativeByNameIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateIsNegativeByNameWithDdMm (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateIsNegativeByNameWithDdMmIgnoringCase (sqlrcur sqlrcurref, uint64_t row, const char *col, int ddmm, int yyyyddmm, const char *datedelimiters)
 
SQLRCLIENT_DLLSPEC uint32_t sqlrcur_getFieldLengthByIndex (sqlrcur sqlrcurref, uint64_t row, uint32_t col)
 
SQLRCLIENT_DLLSPEC uint32_t sqlrcur_getFieldLengthByName (sqlrcur sqlrcurref, uint64_t row, const char *col)
 
SQLRCLIENT_DLLSPEC const char *const * sqlrcur_getRow (sqlrcur sqlrcurref, uint64_t row)
 
SQLRCLIENT_DLLSPEC uint32_t * sqlrcur_getRowLengths (sqlrcur sqlrcurref, uint64_t row)
 
SQLRCLIENT_DLLSPEC const char *const * sqlrcur_getColumnNames (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC const char * sqlrcur_getColumnName (sqlrcur sqlrcurref, uint32_t col)
 
SQLRCLIENT_DLLSPEC const char * sqlrcur_getColumnTypeByIndex (sqlrcur sqlrcurref, uint32_t col)
 
SQLRCLIENT_DLLSPEC const char * sqlrcur_getColumnTypeByName (sqlrcur sqlrcurref, const char *col)
 
SQLRCLIENT_DLLSPEC uint32_t sqlrcur_getColumnLengthByIndex (sqlrcur sqlrcurref, uint32_t col)
 
SQLRCLIENT_DLLSPEC uint32_t sqlrcur_getColumnLengthByName (sqlrcur sqlrcurref, const char *col)
 
SQLRCLIENT_DLLSPEC uint32_t sqlrcur_getColumnPrecisionByIndex (sqlrcur sqlrcurref, uint32_t col)
 
SQLRCLIENT_DLLSPEC uint32_t sqlrcur_getColumnPrecisionByName (sqlrcur sqlrcurref, const char *col)
 
SQLRCLIENT_DLLSPEC uint32_t sqlrcur_getColumnScaleByIndex (sqlrcur sqlrcurref, uint32_t col)
 
SQLRCLIENT_DLLSPEC uint32_t sqlrcur_getColumnScaleByName (sqlrcur sqlrcurref, const char *col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsNullableByIndex (sqlrcur sqlrcurref, uint32_t col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsNullableByName (sqlrcur sqlrcurref, const char *col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsPrimaryKeyByIndex (sqlrcur sqlrcurref, uint32_t col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsPrimaryKeyByName (sqlrcur sqlrcurref, const char *col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsUniqueByIndex (sqlrcur sqlrcurref, uint32_t col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsUniqueByName (sqlrcur sqlrcurref, const char *col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsPartOfKeyByIndex (sqlrcur sqlrcurref, uint32_t col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsPartOfKeyByName (sqlrcur sqlrcurref, const char *col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsUnsignedByIndex (sqlrcur sqlrcurref, uint32_t col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsUnsignedByName (sqlrcur sqlrcurref, const char *col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsZeroFilledByIndex (sqlrcur sqlrcurref, uint32_t col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsZeroFilledByName (sqlrcur sqlrcurref, const char *col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsBinaryByIndex (sqlrcur sqlrcurref, uint32_t col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsBinaryByName (sqlrcur sqlrcurref, const char *col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsAutoIncrementByIndex (sqlrcur sqlrcurref, uint32_t col)
 
SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsAutoIncrementByName (sqlrcur sqlrcurref, const char *col)
 
SQLRCLIENT_DLLSPEC uint32_t sqlrcur_getLongestByIndex (sqlrcur sqlrcurref, uint32_t col)
 
SQLRCLIENT_DLLSPEC uint32_t sqlrcur_getLongestByName (sqlrcur sqlrcurref, const char *col)
 
SQLRCLIENT_DLLSPEC void sqlrcur_suspendResultSet (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC uint16_t sqlrcur_getResultSetId (sqlrcur sqlrcurref)
 
SQLRCLIENT_DLLSPEC int sqlrcur_resumeResultSet (sqlrcur sqlrcurref, uint16_t id)
 
SQLRCLIENT_DLLSPEC int sqlrcur_resumeCachedResultSet (sqlrcur sqlrcurref, uint16_t id, const char *filename)
 
SQLRCLIENT_DLLSPEC void sqlrcur_closeResultSet (sqlrcur sqlrcurref)
 

Detailed Description

Function Documentation

◆ sqlrcon_alloc()

SQLRCLIENT_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 auths with "user" and "password". Failed connections will be retried for "tries" times, waiting "retrytime" seconds between each try. If "tries" is 0 then retries will continue forever. If "retrytime" is 0 then retries will be attempted on a default interval.

If "server" is a comma-separated list of hosts, then an attempt will be made to connect to each until the attempt succeeds, or there are no more hosts left to try.

If the "socket" parameter is neither 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.

◆ sqlrcon_autoCommitOff()

SQLRCLIENT_DLLSPEC int sqlrcon_autoCommitOff ( sqlrcon sqlrconref)

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

◆ sqlrcon_autoCommitOn()

SQLRCLIENT_DLLSPEC int sqlrcon_autoCommitOn ( sqlrcon sqlrconref)

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

◆ sqlrcon_begin()

SQLRCLIENT_DLLSPEC int sqlrcon_begin ( sqlrcon sqlrconref)

Begins a transaction. Returns true if the begin succeeded, false 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.

◆ sqlrcon_bindFormat()

SQLRCLIENT_DLLSPEC const char * sqlrcon_bindFormat ( sqlrcon sqlrconref)

Returns a string representing the bind variable format used by the database. For example:

? - database uses a ? to represent a bind variable @* - database uses a @ followed by any characters to represent a bind variable $1 - database uses a $ followed by a number to represent a bind variable :* - database uses a : followed by any characters to represent a bind variable

◆ sqlrcon_clientVersion()

SQLRCLIENT_DLLSPEC const char * sqlrcon_clientVersion ( sqlrcon sqlrconref)

Returns the version of the sqlrelay client software.

◆ sqlrcon_commit()

SQLRCLIENT_DLLSPEC int sqlrcon_commit ( sqlrcon sqlrconref)

Commits a transaction. Returns true if the commit succeeded, false if it failed.

◆ sqlrcon_dbHostName()

SQLRCLIENT_DLLSPEC const char * sqlrcon_dbHostName ( sqlrcon sqlrconref)

Returns the host name of the database

◆ sqlrcon_dbIpAddress()

SQLRCLIENT_DLLSPEC const char * sqlrcon_dbIpAddress ( sqlrcon sqlrconref)

Returns the ip address of the database

◆ sqlrcon_dbVersion()

SQLRCLIENT_DLLSPEC const char * sqlrcon_dbVersion ( sqlrcon sqlrconref)

Returns the version of the database

◆ sqlrcon_debugOff()

SQLRCLIENT_DLLSPEC void sqlrcon_debugOff ( sqlrcon sqlrconref)

Turns debugging off.

◆ sqlrcon_debugOn()

SQLRCLIENT_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 SQLR_CLIENT_DEBUG to "ON"

◆ sqlrcon_debugPrintFunction()

SQLRCLIENT_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().

◆ sqlrcon_disableEncryption()

SQLRCLIENT_DLLSPEC void sqlrcon_disableEncryption ( sqlrcon sqlrconref)

Disables encryption.

◆ sqlrcon_enableKerberos()

SQLRCLIENT_DLLSPEC void sqlrcon_enableKerberos ( sqlrcon sqlrconref,
const char * service,
const char * mech,
const char * flags )

Enables Kerberos authentication and encryption.

"service" indicates the Kerberos service name of the SQL Relay server. If left empty or NULL then the service name "sqlrelay" will be used. "sqlrelay" is the default service name of the SQL Relay server. Note that on Windows platforms the service name must be fully qualified, including the host and realm name. For example: "sqlrelay/sqlrserver.firstworks.com@AD.FIRSTWORKS.COM".

"mech" indicates the specific Kerberos mechanism to use. On Linux/Unix platforms, this should be a string representation of the mechnaism's OID, such as: { 1 2 840 113554 1 2 2 } On Windows platforms, this should be a string like: Kerberos If left empty or NULL then the default mechanism will be used. Only set this if you know that you have a good reason to.

"flags" indicates what Kerberos flags to use. Multiple flags may be specified, separated by commas. If left empty or NULL then a defalt set of flags will be used. Only set this if you know that you have a good reason to.

Valid flags include:

  • GSS_C_MUTUAL_FLAG
  • GSS_C_REPLAY_FLAG
  • GSS_C_SEQUENCE_FLAG
  • GSS_C_CONF_FLAG
  • GSS_C_INTEG_FLAG

For a full list of flags, consult the GSSAPI documentation, though note that only the flags listed above are supported on Windows.

◆ sqlrcon_enableTls()

SQLRCLIENT_DLLSPEC void sqlrcon_enableTls ( sqlrcon sqlrconref,
const char * version,
const char * cert,
const char * password,
const char * ciphers,
const char * validate,
const char * ca,
uint16_t depth )

Enables TLS/SSL encryption, and optionally authentication.

"version" specifies the TLS/SSL protocol version that the client will attempt to use. Valid values include SSL2, SSL3, TLS1, TLS1.1, TLS1.2 or any more recent version of TLS, as supported by and enabled in the underlying TLS/SSL library. If left blank or empty then the highest supported version will be negotiated.

"cert" is the file name of the certificate chain file to send to the SQL Relay server. This is only necessary if the SQL Relay server is configured to authenticate and authorize clients by certificate.

If "cert" contains a password-protected private key, then "password" may be supplied to access it. If the private key is not password-protected, then this argument is ignored, and may be left empty or NULL.

"ciphers" is a list of ciphers to allow. Ciphers may be separated by spaces, commas, or colons. If "ciphers" is empty or NULL then a default set is used. Only set this if you know that you have a good reason to.

For a list of valid ciphers on Linux/Unix platforms, see: man ciphers

For a list of valid ciphers on Windows platforms, see: https://msdn.microsoft.com/en-us/library/windows/desktop/aa375549%28v=vs.85%29.aspx On Windows platforms, the ciphers (alg_id's) should omit CALG_ and may be given with underscores or dashes. For example: 3DES_112

"validate" indicates whether to validate the SQL Relay's server certificate, and may be set to one of the following: "no" - Don't validate the server's certificate. "ca" - Validate that the server's certificate was signed by a trusted certificate authority. "ca+host" - Perform "ca" validation and also validate that one of the subject altenate names (or the common name if no SANs are present) in the certificate matches the host parameter. (Falls back to "ca" validation when a unix socket is used.) "ca+domain" - Perform "ca" validation and also validate that the domain name of one of the subject alternate names (or the common name if no SANs are present) in the certificate matches the domain name of the host parameter. (Falls back to "ca" validation when a unix socket is used.)

"ca" is the location of a certificate authority file to use, in addition to the system's root certificates, when validating the SQL Relay server's certificate. This is useful if the SQL Relay server's certificate is self-signed.

On Windows, "ca" must be a file name.

On non-Windows systems, "ca" can be either a file or directory name. If it is a directory name, then all certificate authority files found in that directory will be used. If it a file name, then only that file will be used.

Note that the supported "cert" and "ca" file formats may vary between platforms. A variety of file formats are generally supported on Linux/Unix platfoms (.pem, .pfx, etc.) but only the .pfx format is currently supported on Windows.

◆ sqlrcon_endSession()

SQLRCLIENT_DLLSPEC void sqlrcon_endSession ( sqlrcon sqlrconref)

Ends the session.

◆ sqlrcon_errorMessage()

SQLRCLIENT_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.

◆ sqlrcon_errorNumber()

SQLRCLIENT_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.

◆ sqlrcon_free()

SQLRCLIENT_DLLSPEC void sqlrcon_free ( sqlrcon sqlrconref)

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

◆ sqlrcon_getAutoCommit()

SQLRCLIENT_DLLSPEC int sqlrcon_getAutoCommit ( sqlrcon sqlrconref)

Returns true if auto-commit is currently on, false otherwise.

◆ sqlrcon_getBindVariableDelimiterAtSignSupported()

int sqlrcon_getBindVariableDelimiterAtSignSupported ( sqlrcon sqlrconref)

Returns true if at-signs (@) are considered to be valid bind variable delimiters.

◆ sqlrcon_getBindVariableDelimiterColonSupported()

int sqlrcon_getBindVariableDelimiterColonSupported ( sqlrcon sqlrconref)

Returns true if colons (:) are considered to be valid bind variable delimiters.

◆ sqlrcon_getBindVariableDelimiterDollarSignSupported()

int sqlrcon_getBindVariableDelimiterDollarSignSupported ( sqlrcon sqlrconref)

Returns true if dollar signs ($) are considered to be valid bind variable delimiters.

◆ sqlrcon_getBindVariableDelimiterQuestionMarkSupported()

int sqlrcon_getBindVariableDelimiterQuestionMarkSupported ( sqlrcon sqlrconref)

Returns true if question marks (?) are considered to be valid bind variable delimiters.

◆ sqlrcon_getClientInfo()

SQLRCLIENT_DLLSPEC const char * sqlrcon_getClientInfo ( sqlrcon sqlrconref)

Returns the string that was set by setClientInfo().

◆ sqlrcon_getConnectionPort()

SQLRCLIENT_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 resumeSession() method. Note: The value this method returns is only valid after a call to suspendSession().

◆ sqlrcon_getConnectionSocket()

SQLRCLIENT_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 resumeSession() method. Note: The value this method returns is only valid after a call to suspendSession().

◆ sqlrcon_getConnectTimeout()

SQLRCLIENT_DLLSPEC void sqlrcon_getConnectTimeout ( sqlrcon sqlrconref,
int32_t * timeoutsec,
int32_t * timeoutusec )

Gets the server connect timeout in seconds and microseconds.

◆ sqlrcon_getConnectTimeoutMicroseconds()

SQLRCLIENT_DLLSPEC int32_t sqlrcon_getConnectTimeoutMicroseconds ( sqlrcon sqlrconref)

Gets the server connect timeout in microseconds.

◆ sqlrcon_getConnectTimeoutSeconds()

SQLRCLIENT_DLLSPEC int32_t sqlrcon_getConnectTimeoutSeconds ( sqlrcon sqlrconref)

Gets the server connect timeout in seconds.

◆ sqlrcon_getCurrentCatalog()

SQLRCLIENT_DLLSPEC const char * sqlrcon_getCurrentCatalog ( sqlrcon sqlrconref)

Returns the catalog that is currently in use.

◆ sqlrcon_getCurrentDatabase()

SQLRCLIENT_DLLSPEC const char * sqlrcon_getCurrentDatabase ( sqlrcon sqlrconref)

Returns the database that is currently in use.

May return the current catalog or schema, depending on whether the backend database equates "database" with catalog or schema.

See getDatabaseIsSchema().

◆ sqlrcon_getCurrentSchema()

SQLRCLIENT_DLLSPEC const char * sqlrcon_getCurrentSchema ( sqlrcon sqlrconref)

Returns the schema that is currently in use.

◆ sqlrcon_getCurrentUser()

SQLRCLIENT_DLLSPEC const char * sqlrcon_getCurrentUser ( sqlrcon sqlrconref)

Returns the user that sqlrelay is currently logged in to the database as, or NULL if no user could be determined or if an error occurred.

◆ sqlrcon_getDatabaseFeature()

SQLRCLIENT_DLLSPEC const char * sqlrcon_getDatabaseFeature ( sqlrcon sqlrconref,
const char * feature )

Returns the value of the specified database "feature".

Valid features include:

  • aggregate_functions
    • list - ALL,AVG,COUNT,DISTINCT,MAX,MIN,SUM
  • all_procedures_are_callable
    • true/false
  • all_tables_are_selectable
    • true/false
  • alter_domain_clauses
    • list - ADD_DOMAIN_CONSTRAINT,ADD_DOMAIN_DEFAULT,...
  • alter_table_operations
    • list - ADD_COLUMN,DROP_COLUMN
  • ansi92_sql_levels
    • list - ENTRY_LEVEL,FULL,INTERMEDIATE
  • auto_commit_failure_closes_all_result_sets
    • true/false
  • batch_operations
    • list - SELECT_EXPLICIT,ROW_COUNT_EXPLICIT,SELECT_PROC,...
  • batch_row_counts
    • list - PROCEDURES,EXPLICIT,ROLLED_UP
  • catalog_separator
    • string
  • catalog_term
    • string
  • catalog_usage
    • list - DATA_MANIPULATION,INDEX_DEFINITIONS,...
  • collation_seq
    • string
  • create_assertion_clauses
    • list - CREATE_ASSERTION,CONSTRAINT_INITIALLY_DEFERRED,...
  • create_character_set_clauses
    • list - CREATE_CHARACTER_SET,COLLATE_CLAUSE,...
  • create_collation_clauses
    • list - CREATE_COLLATION
  • create_domain_clauses
    • list - CREATE_DOMAIN,CONSTRAINT_NAME_DEFINITION,...
  • create_schema_clauses
    • list - CREATE_SCHEMA,AUTHORIZATION,DEFAULT_CHARACTER_SET
  • create_table_clauses
    • list - CREATE_TABLE,TABLE_CONSTRAINT,...
  • create_translation_clauses
    • list - CREATE_TRANSLATION
  • create_view_clauses
    • list - CREATE_VIEW,CHECK_OPTION,CASCADED,LOCAL
  • data_definition_transaction_behavior
    • list - CAUSES_COMMIT,IGNORED_IN_TRANSACTIONS
  • ddl_index_operations
    • list - CREATE_INDEX,DROP_INDEX
    • string
  • default_result_set_holdability
    • string
  • deletes_are_detected
    • list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
  • does_max_row_size_include_blobs
    • true/false
  • drop_assertion_clauses
    • list - DROP_ASSERTION
  • drop_character_set_clauses
    • list - DROP_CHARACTER_SET
  • drop_collation_clauses
    • list - DROP_COLLATION
  • drop_domain_clauses
    • list - DROP_DOMAIN,CASCADE,RESTRICT
  • drop_schema_clauses
    • list - DROP_SCHEMA,CASCADE,RESTRICT
  • drop_table_clauses
    • list - DROP_TABLE,CASCADE,RESTRICT
  • drop_translation_clauses
    • list - DROP_TRANSLATION
  • drop_view_clauses
    • list - DROP_VIEW,CASCADE,RESTRICT
  • extra_name_characters
    • string
  • foreign_key_delete_rules
    • list - CASCADE,NO_ACTION,SET_DEFAULT,SET_NULL
  • foreign_key_update_rules
    • list - CASCADE,NO_ACTION,SET_DEFAULT,SET_NULL
  • forward_only_cursor_attributes
    • list - NEXT,ABSOLUTE,RELATIVE,BOOKMARK,...
  • generated_key_always_returned
    • true/false
  • grant_clauses
    • list - DELETE_TABLE,INSERT_COLUMN,INSERT_TABLE,...
  • group_by_clauses
    • list - BASIC,BEYOND_SELECT,UNRELATED
  • identifier_case_storage
    • list - LOWER,MIXED,SENSITIVE,UPPER
  • identifier_quote_string
    • string
  • index_keywords
    • list - ASC,DESC
  • info_schema_views
    • list - ASSERTIONS,CHARACTER_SETS,CHECK_CONSTRAINTS,...
  • insert_operations
    • list - INSERT_LITERALS,INSERT_SEARCHED,SELECT_INTO
  • inserts_are_detected
    • list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
  • is_catalog_at_start
    • true/false
  • isolation_levels
    • list - READ_UNCOMMITTED,READ_COMMITTED,...
  • local_file_usage
    • list - LOCAL_FILE_PER_TABLE,LOCAL_FILES
  • locators_update_copy
    • true/false
  • lock_types
    • list - NO_CHANGE,EXCLUSIVE,UNLOCK
  • max_binary_literal_length
    • number
  • max_catalog_name_length
    • number
  • max_char_literal_length
    • number
  • max_column_name_length
    • number
  • max_columns_in_group_by
    • number
  • max_columns_in_index
    • number
  • max_columns_in_order_by
    • number
  • max_columns_in_select
    • number
  • max_columns_in_table
    • number
  • max_connections
    • number
  • max_cursor_name_length
    • number
  • max_identifier_length
    • number
  • max_index_length
    • number
  • max_procedure_name_length
    • number
  • max_row_size
    • number
  • max_schema_name_length
    • number
  • max_statement_length
    • number
  • max_statements
    • number
  • max_table_name_length
    • number
  • max_tables_in_select
    • number
  • max_user_name_length
    • number
  • need_long_data_length
    • true/false
  • null_plus_non_null_is_null
    • true/false
  • null_sort_order
    • list - AT_END,AT_START,HIGH,LOW
  • numeric_functions
    • list - ABS,ACOS,ASIN,ATAN,ATAN2,CEILING,COS,COT,...
  • open_cursors_across
    • list - COMMIT,ROLLBACK
  • open_statements_across
    • list - COMMIT,ROLLBACK
  • others_deletes_are_visible
    • list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
  • others_inserts_are_visible
    • list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
  • others_updates_are_visible
    • list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
  • outer_joins
    • list - BASIC,FULL,LIMITED
  • own_deletes_are_visible
    • list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
  • own_inserts_are_visible
    • list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
  • own_updates_are_visible
    • list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
  • predicates
    • list - BETWEEN,COMPARISON,EXISTS,IN,ISNOTNULL,ISNULL,...
  • procedure_term
    • string
  • quoted_identifier_case_storage
    • list - LOWER,MIXED,SENSITIVE,UPPER
  • relational_join_operators
    • list - CORRESPONDING_CLAUSE,CROSS_JOIN,EXCEPT_JOIN,...
  • result_set_concurrencies
    • list - FORWARD_ONLY/READ_ONLY,FORWARD_ONLY/UPDATABLE,...
  • result_set_holdabilities
    • list - CLOSE_CURSORS_AT_COMMIT,HOLD_CURSORS_OVER_COMMIT
  • result_set_types
    • list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
  • revoke_clauses
    • list - CASCADE,DELETE_TABLE,GRANT_OPTION_FOR,...
  • row_id_lifetime
    • string
  • row_value_constructor_expressions
    • list - VALUE_EXPRESSION,NULL,DEFAULT,ROW_SUBQUERY
  • schema_term
    • string
  • schema_usage
    • list - DATA_MANIPULATION,INDEX_DEFINITIONS,...
  • scroll_concurrencies
    • list - READ_ONLY,LOCK,OPT_ROWVER,OPT_VALUES
  • search_string_escape
    • string
  • sql_grammar_levels
    • list - CORE,EXTENDED,MINIMUM
  • sql_keywords
    • list - ACCESS,ADD,ALTER,AUDIT,CLUSTER,COLUMN,COMMENT,...
  • sql_state_type
    • number
  • static_cursor_attributes
    • list - NEXT,ABSOLUTE,RELATIVE,BOOKMARK,...
  • stored_programs
    • list - FUNCTIONS,PROCEDURES
  • string_functions
    • list - CONCAT,INSERT,LEFT,LTRIM,LENGTH,LOCATE,LCASE,...
  • subquery_usage
    • list - COMPARISONS,EXISTS,INS,QUANTIFIEDS
  • supports_batch_updates
    • true/false
  • supports_column_aliasing
    • true/false
  • supports_convert
    • true/false
  • supports_correlated_subqueries
    • true/false
  • supports_describe_parameter
    • true/false
  • supports_expressions_in_order_by
    • true/false
  • supports_get_generated_keys
    • true/false
  • supports_integrity_enhancement_facility
    • true/false
  • supports_like_escape_clause
    • true/false
  • supports_multiple_result_sets
    • true/false
  • supports_multiple_transactions
    • true/false
  • supports_named_parameters
    • true/false
  • supports_non_nullable_columns
    • true/false
  • supports_order_by_unrelated
    • true/false
  • supports_savepoints
    • true/false
  • supports_select_for_update
    • true/false
  • supports_transactions
    • true/false
  • system_functions
    • list - USER,DBNAME,IFNULL
  • table_correlation_names
    • list - BASIC,DIFFERENT
  • table_term
    • string
  • time_date_add_intervals
    • list - FRAC_SECOND,SECOND,MINUTE,HOUR,DAY,WEEK,MONTH,...
  • time_date_diff_intervals
    • list - FRAC_SECOND,SECOND,MINUTE,HOUR,DAY,WEEK,MONTH,...
  • time_date_functions
    • list - NOW,CURDATE,DAYOFMONTH,DAYOFWEEK,DAYOFYEAR,...
  • time_date_literals
    • list - DATE,TIME,TIMESTAMP,INTERVAL_YEAR,...
  • transaction_ddl_dml
    • list - DDL_AND_DML,DML_ONLY
  • union_clauses
    • list - UNION,UNION_ALL
  • updates_are_detected
    • list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
  • value_expressions
    • list - CASE,CAST,COALESCE,NULLIF
  • where_current_of_operations
    • list - DELETE,UPDATE

Returns the value of the feature as a string, or NULL if an error occurred or an invalid feature was requested.

◆ sqlrcon_getDatabaseIsSchema()

SQLRCLIENT_DLLSPEC int sqlrcon_getDatabaseIsSchema ( sqlrcon sqlrconref)

Returns true if the backend database equates "database" with "schema", and false if it equates "database" with "catalog".

◆ sqlrcon_getDebug()

SQLRCLIENT_DLLSPEC int sqlrcon_getDebug ( sqlrcon sqlrconref)

Returns false if debugging is off and true if debugging is on.

◆ sqlrcon_getDefaultIsolationLevel()

SQLRCLIENT_DLLSPEC const char * sqlrcon_getDefaultIsolationLevel ( sqlrcon sqlrconref)

Returns the database-specific default isolation level, or NULL if an error occurred.

◆ sqlrcon_getDefaultTransactionModel()

SQLRCLIENT_DLLSPEC const char * sqlrcon_getDefaultTransactionModel ( sqlrcon sqlrconref)

Returns the database's native transaction model. See setTranscationModel() for a list of potential return values. Returns NULL if an error occurred.

◆ sqlrcon_getInTransaction()

SQLRCLIENT_DLLSPEC int sqlrcon_getInTransaction ( sqlrcon sqlrconref)

Returns true if the session is currently inside a transaction, false otherwise.

◆ sqlrcon_getIsolationLevel()

SQLRCLIENT_DLLSPEC const char * sqlrcon_getIsolationLevel ( sqlrcon sqlrconref)

Returns the database-specific isolation level, "unknown" if the isolation level is unknown, or NULL if an error occurred.

◆ sqlrcon_getLastInsertId()

SQLRCLIENT_DLLSPEC uint64_t sqlrcon_getLastInsertId ( sqlrcon sqlrconref)

Returns the value of the autoincrement column for the last insert

◆ sqlrcon_getResponseTimeout()

SQLRCLIENT_DLLSPEC void sqlrcon_getResponseTimeout ( sqlrcon sqlrconref,
int32_t * timeoutsec,
int32_t * timeoutusec )

Gets the response timeout in seconds and microseconds.

◆ sqlrcon_getResponseTimeoutMicroseconds()

SQLRCLIENT_DLLSPEC int32_t sqlrcon_getResponseTimeoutMicroseconds ( sqlrcon sqlrconref)

Gets the response timeout in microseconds.

◆ sqlrcon_getResponseTimeoutSeconds()

SQLRCLIENT_DLLSPEC int32_t sqlrcon_getResponseTimeoutSeconds ( sqlrcon sqlrconref)

Gets the response timeout in seconds.

◆ sqlrcon_getTransactionModel()

SQLRCLIENT_DLLSPEC const char * sqlrcon_getTransactionModel ( sqlrcon sqlrconref)

Returns the current transaction model. See setTranscationModel() for a list of potential return values. Returns NULL if an error occurred.

◆ sqlrcon_identify()

SQLRCLIENT_DLLSPEC const char * sqlrcon_identify ( sqlrcon sqlrconref)

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

◆ sqlrcon_nextvalFormat()

SQLRCLIENT_DLLSPEC const char * sqlrcon_nextvalFormat ( sqlrcon sqlrconref)

Returns a string representing the format of the sequence nextval command used in the database. The format will contain a s in place of the sequence name. For example:

(nextval for s) next value for s nextval('s') s.nextval

Returns an empty string if the database does not support sequences.

◆ sqlrcon_ping()

SQLRCLIENT_DLLSPEC int sqlrcon_ping ( sqlrcon sqlrconref)

Returns true if the database is up and false if it's down.

◆ sqlrcon_resumeSession()

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

Resumes a session previously left open using suspendSession(). Returns true on success and false on failure.

◆ sqlrcon_rollback()

SQLRCLIENT_DLLSPEC int sqlrcon_rollback ( sqlrcon sqlrconref)

Rolls back a transaction. Returns true if the rollback succeeded, false if it failed.

◆ sqlrcon_selectCatalog()

SQLRCLIENT_DLLSPEC int sqlrcon_selectCatalog ( sqlrcon sqlrconref,
const char * catalog )

Sets the current catalog to "catalog"

◆ sqlrcon_selectDatabase()

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

Sets the current database to "database".

May set the current catalog or schema, depending on whether the backend database equates "database" with catalog or schema.

See getDatabaseIsSchema().

◆ sqlrcon_selectSchema()

SQLRCLIENT_DLLSPEC int sqlrcon_selectSchema ( sqlrcon sqlrconref,
const char * schema )

Sets the current schema to "schema"

◆ sqlrcon_serverVersion()

SQLRCLIENT_DLLSPEC const char * sqlrcon_serverVersion ( sqlrcon sqlrconref)

Returns the version of the sqlrelay server software.

◆ sqlrcon_setBindVariableDelimiters()

void sqlrcon_setBindVariableDelimiters ( sqlrcon sqlrconref,
const char * delimiters )

Sets which delimiters are used to identify bind variables in countBindVariables() and validateBinds(). Valid delimiters include ?,:,@, and $. Defaults to "?:@$"

◆ sqlrcon_setClientInfo()

SQLRCLIENT_DLLSPEC void sqlrcon_setClientInfo ( sqlrcon sqlrconref,
const char * clientinfo )

Allows you to set a string that will be passed to the server and ultimately included in server-side logging along with queries that were run by this instance of the client.

◆ sqlrcon_setConnectTimeout()

SQLRCLIENT_DLLSPEC void sqlrcon_setConnectTimeout ( sqlrcon sqlrconref,
int32_t timeoutsec,
int32_t timeoutusec )

Sets the server connect timeout in seconds and microseconds. Setting either parameter to -1 disables the timeout. You can also set this timeout using the SQLR_CLIENT_CONNECT_TIMEOUT environment variable.

◆ sqlrcon_setDebugFile()

SQLRCLIENT_DLLSPEC void sqlrcon_setDebugFile ( sqlrcon sqlrconref,
const char * filename )

Allows you to specify a file to write debug to. Setting "filename" to NULL or an empty string causes debug to be written to standard output (the default).

◆ sqlrcon_setIsolationLevel()

SQLRCLIENT_DLLSPEC int sqlrcon_setIsolationLevel ( sqlrcon sqlrconref,
const char * isolationlevel )

Sets the transaction isolation level to "isolationlevel". The string is the database-specific (native) name and is matched case-insensitively.

Valid isolation levels include:

For PostgreSQL:

  • READ UNCOMMITTED
  • READ COMMITTED (default)
  • REPEATABLE READ
  • SERIALIZABLE

For MySQL/MariaDB:

  • READ-UNCOMMITTED
  • READ-COMMITTED
  • REPEATABLE-READ (default)
  • SERIALIZABLE

For Oracle:

  • READ COMMITTED (default)
  • SERIALIZABLE

For DB2:

  • UR (uncommitted read)
  • CS (cursor stability, default)
  • RS (read stability)
  • RR (repeatable read)

For MS SQL Server (via FreeTDS):

  • READ UNCOMMITTED
  • READ COMMITTED (default)
  • REPEATABLE READ
  • SERIALIZABLE
  • SNAPSHOT

For SAP ASE (Sybase):

  • 0 (read uncommitted)
  • 1 (read committed, default)
  • 2 (repeatable read)
  • 3 (serializable)

For Informix:

  • dirty read
  • committed read (default)
  • cursor stability
  • repeatable read

For Firebird:

  • read committed (default)
  • read committed no record version
  • read consistency
  • snapshot
  • snapshot table stability

For SQLite:

  • 0 (serializable, default)
  • 1 (read uncommitted)

For ODBC:

  • SQL_TXN_READ_UNCOMMITTED
  • SQL_TXN_READ_COMMITTED
  • SQL_TXN_REPEATABLE_READ
  • SQL_TXN_SERIALIZABLE

(whether a given level is actually supported depends on the underlying ODBC driver and target database). The generic ODBC backend also accepts the database-specific native names listed above for any of the other backends, as well as the JDBC TRANSACTION_* names, and maps them to the closest of the four ODBC levels above.

For other databases, the string is passed through to the backend as the argument to "set transaction isolation level".

Returns true if setting the isolation level succeeded, false if it failed.

◆ sqlrcon_setResponseTimeout()

SQLRCLIENT_DLLSPEC void sqlrcon_setResponseTimeout ( sqlrcon sqlrconref,
int32_t timeoutsec,
int32_t timeoutusec )

Sets the response timeout (for queries, commits, rollbacks, pings, etc.) in seconds and microseconds. Setting either parameter to -1 disables the timeout. You can also set this timeout using the SQLR_CLIENT_RESPONSE_TIMEOUT environment variable.

◆ sqlrcon_setTransactionModel()

SQLRCLIENT_DLLSPEC int sqlrcon_setTransactionModel ( sqlrcon sqlrconref,
const char * txmodel )

Sets the current transaction model to "txmodel" which should be one of:

  • native - the database's native transaction model
  • none - no transactions
  • "implicit"
    • in a transaction when the session begins
    • commit/rollback implicitly starts a new transcaction
    • autocommit on/off take effect immediately
  • "explicit"
    • not in a transaction when the session begins
    • begin required to start a new transaction
    • commit/rollback does not start a new transcaction
    • autocommit on/off take effect immediately
  • "explicit-deferred"
    • not in a transaction when the session begins
    • begin required to start a new transaction
    • commit/rollback does not start a new transcaction
    • while in a begin-initiated transaction, autocommit on takes effect at next commit/rollback (deferred)
    • while in an autocommit-off-initiated transaction, autocommit on takes effect immediately
  • "explicit-error"
    • not in a transaction when the session begins
    • begin required to start a new transaction
    • commit/rollback does not start a new transcaction
    • while in a transaction, autocommit on/off throw error

Returns true on success and false on failure.

◆ sqlrcon_suspendSession()

SQLRCLIENT_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 resumeSession().

◆ sqlrcur_affectedRows()

SQLRCLIENT_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. 0 is returned by databases which don't support this option.

◆ sqlrcur_alloc()

SQLRCLIENT_DLLSPEC sqlrcur sqlrcur_alloc ( sqlrcon sqlrconref)

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

◆ sqlrcur_cacheOff()

SQLRCLIENT_DLLSPEC void sqlrcur_cacheOff ( sqlrcur sqlrcurref)

Sets query caching off.

◆ sqlrcur_cacheToFile()

SQLRCLIENT_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 cacheToFile() is called, the result sets of all future queries will be cached to that file until another call to cacheToFile() changes which file to cache to or a call to cacheOff() turns off caching.

◆ sqlrcur_clearBinds()

SQLRCLIENT_DLLSPEC void sqlrcur_clearBinds ( sqlrcur sqlrcurref)

Clears all bind variables.

◆ sqlrcur_closeResultSet()

SQLRCLIENT_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.

◆ sqlrcur_colCount()

SQLRCLIENT_DLLSPEC uint32_t sqlrcur_colCount ( sqlrcur sqlrcurref)

Returns the number of columns in the current result set.

◆ sqlrcur_countBindVariables()

SQLRCLIENT_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.

◆ sqlrcur_defineOutputBindBlob()

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

Defines a binary lob output bind variable.

◆ sqlrcur_defineOutputBindClob()

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

Defines a character lob output bind variable.

◆ sqlrcur_defineOutputBindCursor()

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

Defines a cursor output bind variable.

◆ sqlrcur_defineOutputBindDate()

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

Defines a date output bind variable.

◆ sqlrcur_defineOutputBindDouble()

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

Defines a decimal output bind variable.

◆ sqlrcur_defineOutputBindInteger()

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

Defines an integer output bind variable.

◆ sqlrcur_defineOutputBindString()

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

Defines an output bind variable. "bufferlength" bytes will be reserved to store the value.

◆ sqlrcur_dontGetColumnInfo()

SQLRCLIENT_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 method to improve performance.

◆ sqlrcur_endOfResultSet()

SQLRCLIENT_DLLSPEC int sqlrcur_endOfResultSet ( sqlrcur sqlrcurref)

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

◆ sqlrcur_errorMessage()

SQLRCLIENT_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 method returns NULL.

◆ sqlrcur_errorNumber()

SQLRCLIENT_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.

◆ sqlrcur_executeQuery()

SQLRCLIENT_DLLSPEC int sqlrcur_executeQuery ( sqlrcur sqlrcurref)

Execute the query that was previously prepared and bound.

◆ sqlrcur_fetchFromBindCursor()

SQLRCLIENT_DLLSPEC int sqlrcur_fetchFromBindCursor ( sqlrcur sqlrcurref)

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

◆ sqlrcur_firstRowIndex()

SQLRCLIENT_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.

◆ sqlrcur_free()

SQLRCLIENT_DLLSPEC void sqlrcur_free ( sqlrcur sqlrcurref)

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

◆ sqlrcur_getCacheFileName()

SQLRCLIENT_DLLSPEC const char * sqlrcur_getCacheFileName ( sqlrcur sqlrcurref)

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

◆ sqlrcur_getCatalogList()

SQLRCLIENT_DLLSPEC int sqlrcur_getCatalogList ( sqlrcur sqlrcurref,
const char * catalogs )

Generates a result set containing catalogs that match the pattern "catalog".

The result set will contain the following columns:

  • Database

If "catalog" is empty or NULL then a result set containing all catalogs will be returned.

If SQL Relay doesn't support getting a list of catalogs for the current database backend (or the database doesn't) then an empty result set will be returned.

◆ sqlrcur_getColumnInfo()

SQLRCLIENT_DLLSPEC void sqlrcur_getColumnInfo ( sqlrcur sqlrcurref)

Tells the server to send column info.

◆ sqlrcur_getColumnIsAutoIncrementByIndex()

SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsAutoIncrementByIndex ( sqlrcur sqlrcurref,
uint32_t col )

Returns true if the specified column auto-increments and false otherwise.

◆ sqlrcur_getColumnIsAutoIncrementByName()

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

Returns true if the specified column auto-increments and false otherwise.

◆ sqlrcur_getColumnIsBinaryByIndex()

SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsBinaryByIndex ( sqlrcur sqlrcurref,
uint32_t col )

Returns true if the specified column contains binary data and false otherwise.

◆ sqlrcur_getColumnIsBinaryByName()

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

Returns true if the specified column contains binary data and false otherwise.

◆ sqlrcur_getColumnIsNullableByIndex()

SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsNullableByIndex ( sqlrcur sqlrcurref,
uint32_t col )

Returns true if the specified column can contain nulls and false otherwise.

◆ sqlrcur_getColumnIsNullableByName()

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

Returns true if the specified column can contain nulls and false otherwise.

◆ sqlrcur_getColumnIsPartOfKeyByIndex()

SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsPartOfKeyByIndex ( sqlrcur sqlrcurref,
uint32_t col )

Returns true if the specified column is part of a composite key and false otherwise.

◆ sqlrcur_getColumnIsPartOfKeyByName()

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

Returns true if the specified column is part of a composite key and false otherwise.

◆ sqlrcur_getColumnIsPrimaryKeyByIndex()

SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsPrimaryKeyByIndex ( sqlrcur sqlrcurref,
uint32_t col )

Returns true if the specified column is a primary key and false otherwise.

◆ sqlrcur_getColumnIsPrimaryKeyByName()

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

Returns true if the specified column is a primary key and false otherwise.

◆ sqlrcur_getColumnIsUniqueByIndex()

SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsUniqueByIndex ( sqlrcur sqlrcurref,
uint32_t col )

Returns true if the specified column is unique and false otherwise.

◆ sqlrcur_getColumnIsUniqueByName()

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

Returns true if the specified column is unique and false otherwise.

◆ sqlrcur_getColumnIsUnsignedByIndex()

SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsUnsignedByIndex ( sqlrcur sqlrcurref,
uint32_t col )

Returns true if the specified column is an unsigned number and false otherwise.

◆ sqlrcur_getColumnIsUnsignedByName()

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

Returns true if the specified column is an unsigned number and false otherwise.

◆ sqlrcur_getColumnIsZeroFilledByIndex()

SQLRCLIENT_DLLSPEC int sqlrcur_getColumnIsZeroFilledByIndex ( sqlrcur sqlrcurref,
uint32_t col )

Returns true if the specified column was created with the zero-fill flag and false otherwise.

◆ sqlrcur_getColumnIsZeroFilledByName()

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

Returns true if the specified column was created with the zero-fill flag and false otherwise.

◆ sqlrcur_getColumnLengthByIndex()

SQLRCLIENT_DLLSPEC uint32_t sqlrcur_getColumnLengthByIndex ( sqlrcur sqlrcurref,
uint32_t col )

Returns the number of bytes required on the server to store the data for the specified column

◆ sqlrcur_getColumnLengthByName()

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

Returns the number of bytes required on the server to store the data for the specified column

◆ sqlrcur_getColumnList()

SQLRCLIENT_DLLSPEC int sqlrcur_getColumnList ( sqlrcur sqlrcurref,
const char * table,
const char * columns )

Generates a result set containing the columns of "table", which match the pattern "columns".

The result set will contain the following columns:

  • column_name
  • data_type
  • character_maximum_length
  • numeric_precision
  • numeric_scale
  • is_nullable
  • column_key
  • column_default
  • extra

If "columns" is empty or NULL then a list of all columns of "table" will be returned.

If SQL Relay doesn't support getting a list of columns for the current database backend (or the database doesn't) then an empty result set will be returned.

◆ sqlrcur_getColumnName()

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

Returns the name of the specified column.

◆ sqlrcur_getColumnNames()

SQLRCLIENT_DLLSPEC const char *const * sqlrcur_getColumnNames ( sqlrcur sqlrcurref)

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

◆ sqlrcur_getColumnPrecisionByIndex()

SQLRCLIENT_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.

◆ sqlrcur_getColumnPrecisionByName()

SQLRCLIENT_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.

◆ sqlrcur_getColumnScaleByIndex()

SQLRCLIENT_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.

◆ sqlrcur_getColumnScaleByName()

SQLRCLIENT_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.

◆ sqlrcur_getColumnTypeByIndex()

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

Returns the type of the specified column.

◆ sqlrcur_getColumnTypeByName()

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

Returns the type of the specified column.

◆ sqlrcur_getDatabaseList()

SQLRCLIENT_DLLSPEC int sqlrcur_getDatabaseList ( sqlrcur sqlrcurref,
const char * databases )

Generates a result set containing databases that match the pattern "databases".

The result set will contain the following columns:

  • Database

If "databases" is empty or NULL then a result set containing all databases will be returned.

May actually return a result set of catalogs or schemas, depending on whether the backend database equates "database" with catalog or schema.

See getDatabaseIsSchema().

If SQL Relay doesn't support getting a list of databases for the current database backend (or the database doesn't) then an empty result set will be returned.

◆ sqlrcur_getFieldAsBooleanByIndex()

SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsBooleanByIndex ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col )

Returns the specified field as a boolean.

◆ sqlrcur_getFieldAsBooleanByName()

SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsBooleanByName ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Returns the specified field as a boolean.

◆ sqlrcur_getFieldAsBooleanByNameIgnoringCase()

SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsBooleanByNameIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Returns the specified field as a boolean, ignoring the case of "col".

◆ sqlrcur_getFieldAsDateByIndex()

SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateByIndex ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col,
int16_t * year,
int16_t * month,
int16_t * day,
int16_t * hour,
int16_t * minute,
int16_t * second,
int32_t * microsecond,
int * isnegative )

Interprets the specified field as a date and populates its broken-down parts.

Returns true if it was able to interpret the field as a date, and false otherwise.

◆ sqlrcur_getFieldAsDateByIndexWithDdMm()

SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateByIndexWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col,
int ddmm,
int yyyyddmm,
const char * datedelimiters,
int16_t * year,
int16_t * month,
int16_t * day,
int16_t * hour,
int16_t * minute,
int16_t * second,
int32_t * microsecond,
int * isnegative )

Interprets the specified field as a date and populates its broken-down parts.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

Returns true if it was able to interpret the field as a date, and false otherwise.

◆ sqlrcur_getFieldAsDateByName()

SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateByName ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int16_t * year,
int16_t * month,
int16_t * day,
int16_t * hour,
int16_t * minute,
int16_t * second,
int32_t * microsecond,
int * isnegative )

Interprets the specified field as a date and populates its broken-down parts.

Returns true if it was able to interpret the field as a date, and false otherwise.

◆ sqlrcur_getFieldAsDateByNameIgnoringCase()

SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateByNameIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int16_t * year,
int16_t * month,
int16_t * day,
int16_t * hour,
int16_t * minute,
int16_t * second,
int32_t * microsecond,
int * isnegative )

Interprets the specified field as a date and populates its broken-down parts, ignoring the case of "col".

Returns true if it was able to interpret the field as a date, and false otherwise.

◆ sqlrcur_getFieldAsDateByNameWithDdMm()

SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateByNameWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters,
int16_t * year,
int16_t * month,
int16_t * day,
int16_t * hour,
int16_t * minute,
int16_t * second,
int32_t * microsecond,
int * isnegative )

Interprets the specified field as a date and populates its broken-down parts.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

Returns true if it was able to interpret the field as a date, and false otherwise.

◆ sqlrcur_getFieldAsDateByNameWithDdMmIgnoringCase()

SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateByNameWithDdMmIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters,
int16_t * year,
int16_t * month,
int16_t * day,
int16_t * hour,
int16_t * minute,
int16_t * second,
int32_t * microsecond,
int * isnegative )

Interprets the specified field as a date and populates its broken-down parts, ignoring the case of "col".

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

Returns true if it was able to interpret the field as a date, and false otherwise.

◆ sqlrcur_getFieldAsDateDayByIndex()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateDayByIndex ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col )

Interprets the specified field as a date and returns the day component.

◆ sqlrcur_getFieldAsDateDayByIndexWithDdMm()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateDayByIndexWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the day component.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateDayByName()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateDayByName ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Interprets the specified field as a date and returns the day component.

◆ sqlrcur_getFieldAsDateDayByNameIgnoringCase()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateDayByNameIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Interprets the specified field as a date and returns the day component, ignoring the case of "col".

◆ sqlrcur_getFieldAsDateDayByNameWithDdMm()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateDayByNameWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the day component.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateDayByNameWithDdMmIgnoringCase()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateDayByNameWithDdMmIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the day component, ignoring the case of "col".

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateHourByIndex()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateHourByIndex ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col )

Interprets the specified field as a date and returns the hour component.

◆ sqlrcur_getFieldAsDateHourByIndexWithDdMm()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateHourByIndexWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the hour component.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateHourByName()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateHourByName ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Interprets the specified field as a date and returns the hour component.

◆ sqlrcur_getFieldAsDateHourByNameIgnoringCase()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateHourByNameIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Interprets the specified field as a date and returns the hour component, ignoring the case of "col".

◆ sqlrcur_getFieldAsDateHourByNameWithDdMm()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateHourByNameWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the hour component.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateHourByNameWithDdMmIgnoringCase()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateHourByNameWithDdMmIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the hour component, ignoring the case of "col".

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateIsNegativeByIndex()

SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateIsNegativeByIndex ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col )

Interprets the specified field as a date and returns whether the hour component is negative.

◆ sqlrcur_getFieldAsDateIsNegativeByIndexWithDdMm()

SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateIsNegativeByIndexWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns whether the hour component is negative.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateIsNegativeByName()

SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateIsNegativeByName ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Interprets the specified field as a date and returns whether the hour component is negative.

◆ sqlrcur_getFieldAsDateIsNegativeByNameIgnoringCase()

SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateIsNegativeByNameIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Interprets the specified field as a date and returns whether the hour component is negative, ignoring the case of "col".

◆ sqlrcur_getFieldAsDateIsNegativeByNameWithDdMm()

SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateIsNegativeByNameWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns whether the hour component is negative.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateIsNegativeByNameWithDdMmIgnoringCase()

SQLRCLIENT_DLLSPEC int sqlrcur_getFieldAsDateIsNegativeByNameWithDdMmIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns whether the hour component is negative, ignoring the case of "col".

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateMicrosecondByIndex()

SQLRCLIENT_DLLSPEC int32_t sqlrcur_getFieldAsDateMicrosecondByIndex ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col )

Interprets the specified field as a date and returns the microsecond component.

◆ sqlrcur_getFieldAsDateMicrosecondByIndexWithDdMm()

SQLRCLIENT_DLLSPEC int32_t sqlrcur_getFieldAsDateMicrosecondByIndexWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the microsecond component.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateMicrosecondByName()

SQLRCLIENT_DLLSPEC int32_t sqlrcur_getFieldAsDateMicrosecondByName ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Interprets the specified field as a date and returns the microsecond component.

◆ sqlrcur_getFieldAsDateMicrosecondByNameIgnoringCase()

SQLRCLIENT_DLLSPEC int32_t sqlrcur_getFieldAsDateMicrosecondByNameIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Interprets the specified field as a date and returns the microsecond component, ignoring the case of "col".

◆ sqlrcur_getFieldAsDateMicrosecondByNameWithDdMm()

SQLRCLIENT_DLLSPEC int32_t sqlrcur_getFieldAsDateMicrosecondByNameWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the microsecond component.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateMicrosecondByNameWithDdMmIgnoringCase()

SQLRCLIENT_DLLSPEC int32_t sqlrcur_getFieldAsDateMicrosecondByNameWithDdMmIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the microsecond component, ignoring the case of "col".

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateMinuteByIndex()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMinuteByIndex ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col )

Interprets the specified field as a date and returns the minute component.

◆ sqlrcur_getFieldAsDateMinuteByIndexWithDdMm()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMinuteByIndexWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the minute component.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateMinuteByName()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMinuteByName ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Interprets the specified field as a date and returns the minute component.

◆ sqlrcur_getFieldAsDateMinuteByNameIgnoringCase()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMinuteByNameIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Interprets the specified field as a date and returns the minute component, ignoring the case of "col".

◆ sqlrcur_getFieldAsDateMinuteByNameWithDdMm()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMinuteByNameWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the minute component.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateMinuteByNameWithDdMmIgnoringCase()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMinuteByNameWithDdMmIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the minute component, ignoring the case of "col".

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateMonthByIndex()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMonthByIndex ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col )

Interprets the specified field as a date and returns the month component.

◆ sqlrcur_getFieldAsDateMonthByIndexWithDdMm()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMonthByIndexWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the month component.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateMonthByName()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMonthByName ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Interprets the specified field as a date and returns the month component.

◆ sqlrcur_getFieldAsDateMonthByNameIgnoringCase()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMonthByNameIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Interprets the specified field as a date and returns the month component, ignoring the case of "col".

◆ sqlrcur_getFieldAsDateMonthByNameWithDdMm()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMonthByNameWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the month component.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateMonthByNameWithDdMmIgnoringCase()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateMonthByNameWithDdMmIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the month component, ignoring the case of "col".

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateSecondByIndex()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateSecondByIndex ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col )

Interprets the specified field as a date and returns the second component.

◆ sqlrcur_getFieldAsDateSecondByIndexWithDdMm()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateSecondByIndexWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the second component.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateSecondByName()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateSecondByName ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Interprets the specified field as a date and returns the second component.

◆ sqlrcur_getFieldAsDateSecondByNameIgnoringCase()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateSecondByNameIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Interprets the specified field as a date and returns the second component, ignoring the case of "col".

◆ sqlrcur_getFieldAsDateSecondByNameWithDdMm()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateSecondByNameWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the second component.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateSecondByNameWithDdMmIgnoringCase()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateSecondByNameWithDdMmIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the second component, ignoring the case of "col".

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateYearByIndex()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateYearByIndex ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col )

Interprets the specified field as a date and returns the year component.

◆ sqlrcur_getFieldAsDateYearByIndexWithDdMm()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateYearByIndexWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
uint32_t col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the year component.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateYearByName()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateYearByName ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Interprets the specified field as a date and returns the year component.

◆ sqlrcur_getFieldAsDateYearByNameIgnoringCase()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateYearByNameIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Interprets the specified field as a date and returns the year component, ignoring the case of "col".

◆ sqlrcur_getFieldAsDateYearByNameWithDdMm()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateYearByNameWithDdMm ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the year component.

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDateYearByNameWithDdMmIgnoringCase()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getFieldAsDateYearByNameWithDdMmIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col,
int ddmm,
int yyyyddmm,
const char * datedelimiters )

Interprets the specified field as a date and returns the year component, ignoring the case of "col".

If "ddmm" is set true then the date format is assumed to be dd/mm/yyyy rather than mm/dd/yyyy when a date with a trailing year is encountered.

If "yyyyddmm" is set true then the date format is assumed to be yyyy/dd/mm rather than yyyy/mm/dd when a date with a leading year is encountered.

"datedelimiters" may be set to a set of valid date delimiters and may contain any combination of '/', '-', '.', and ':'. Eg. "/-" would mean that only '/' and '-' are valid date delimiters. If left NULL then it defaults to "/-.:".

◆ sqlrcur_getFieldAsDoubleByIndex()

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

Returns the specified field as an decimal.

◆ sqlrcur_getFieldAsDoubleByName()

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

Returns the specified field as an decimal.

◆ sqlrcur_getFieldAsDoubleByNameIgnoringCase()

SQLRCLIENT_DLLSPEC double sqlrcur_getFieldAsDoubleByNameIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Returns the specified field as a decimal, ignoring the case of "col".

◆ sqlrcur_getFieldAsIntegerByIndex()

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

Returns the specified field as an integer.

◆ sqlrcur_getFieldAsIntegerByName()

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

Returns the specified field as an integer.

◆ sqlrcur_getFieldAsIntegerByNameIgnoringCase()

SQLRCLIENT_DLLSPEC int64_t sqlrcur_getFieldAsIntegerByNameIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Returns the specified field as an integer, ignoring the case of "col".

◆ sqlrcur_getFieldByIndex()

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

Returns the specified field as a string.

◆ sqlrcur_getFieldByName()

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

Returns the specified field as a string.

◆ sqlrcur_getFieldByNameIgnoringCase()

SQLRCLIENT_DLLSPEC const char * sqlrcur_getFieldByNameIgnoringCase ( sqlrcur sqlrcurref,
uint64_t row,
const char * col )

Returns the specified field as a string, ignoring the case of "col".

◆ sqlrcur_getFieldLengthByIndex()

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

Returns the length of the specified field.

◆ sqlrcur_getFieldLengthByName()

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

Returns the length of the specified field.

◆ sqlrcur_getKeyAndIndexList()

SQLRCLIENT_DLLSPEC int sqlrcur_getKeyAndIndexList ( sqlrcur sqlrcurref,
const char * table,
const char * qualifier )

Generates a result set containing the keys and indexes of "table", which match the pattern "qualifier".

The result set will contain the following columns:

  • table
  • non_unique
  • key_name
  • seq_in_index
  • column_name
  • collation
  • cardinality
  • sub_part
  • packed
  • null
  • index_type
  • comment
  • index_comment

If "qualifier" is empty or NULL then a result set containing all keys and indexes of "table" will be returned.

If SQL Relay doesn't support getting a list of keys and indexes for the current database backend (or the database doesn't) then an empty result set will be returned.

◆ sqlrcur_getLongestByIndex()

SQLRCLIENT_DLLSPEC uint32_t sqlrcur_getLongestByIndex ( sqlrcur sqlrcurref,
uint32_t col )

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

◆ sqlrcur_getLongestByName()

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

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

◆ sqlrcur_getNullsAsEmptyStrings()

SQLRCLIENT_DLLSPEC void sqlrcur_getNullsAsEmptyStrings ( sqlrcur sqlrcurref)

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

◆ sqlrcur_getNullsAsNulls()

SQLRCLIENT_DLLSPEC void sqlrcur_getNullsAsNulls ( sqlrcur sqlrcurref)

Tells the connection to return NULL fields and output bind variables as NULL's rather than as empty strings.

◆ sqlrcur_getOutputBindBlob()

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

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

◆ sqlrcur_getOutputBindClob()

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

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

◆ sqlrcur_getOutputBindCursor()

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

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

◆ sqlrcur_getOutputBindDate()

SQLRCLIENT_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,
int32_t * microsecond,
const char ** tz,
int * isnegative )

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

◆ sqlrcur_getOutputBindDateDay()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getOutputBindDateDay ( sqlrcur sqlrcurref,
const char * variable )

Get the day from a previously defined date output bind variable.

◆ sqlrcur_getOutputBindDateHour()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getOutputBindDateHour ( sqlrcur sqlrcurref,
const char * variable )

Get the hour from a previously defined date output bind variable.

◆ sqlrcur_getOutputBindDateIsNegative()

SQLRCLIENT_DLLSPEC int sqlrcur_getOutputBindDateIsNegative ( sqlrcur sqlrcurref,
const char * variable )

Get whether the value is negative from a previously defined date output bind variable.

◆ sqlrcur_getOutputBindDateMicrosecond()

SQLRCLIENT_DLLSPEC int32_t sqlrcur_getOutputBindDateMicrosecond ( sqlrcur sqlrcurref,
const char * variable )

Get the microsecond from a previously defined date output bind variable.

◆ sqlrcur_getOutputBindDateMinute()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getOutputBindDateMinute ( sqlrcur sqlrcurref,
const char * variable )

Get the minute from a previously defined date output bind variable.

◆ sqlrcur_getOutputBindDateMonth()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getOutputBindDateMonth ( sqlrcur sqlrcurref,
const char * variable )

Get the month from a previously defined date output bind variable.

◆ sqlrcur_getOutputBindDateSecond()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getOutputBindDateSecond ( sqlrcur sqlrcurref,
const char * variable )

Get the second from a previously defined date output bind variable.

◆ sqlrcur_getOutputBindDateTz()

SQLRCLIENT_DLLSPEC const char * sqlrcur_getOutputBindDateTz ( sqlrcur sqlrcurref,
const char * variable )

Get the time zone from a previously defined date output bind variable.

◆ sqlrcur_getOutputBindDateYear()

SQLRCLIENT_DLLSPEC int16_t sqlrcur_getOutputBindDateYear ( sqlrcur sqlrcurref,
const char * variable )

Get the year from a previously defined date output bind variable.

◆ sqlrcur_getOutputBindDouble()

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

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

◆ sqlrcur_getOutputBindInteger()

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

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

◆ sqlrcur_getOutputBindLength()

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

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

◆ sqlrcur_getOutputBindString()

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

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

◆ sqlrcur_getPrimaryKeysList()

SQLRCLIENT_DLLSPEC int sqlrcur_getPrimaryKeysList ( sqlrcur sqlrcurref,
const char * table,
const char * columns )

Generates a result set containing the primary keys of "table", which match the pattern "columns".

The result set will contain the following columns:

  • table
  • non_unique
  • key_name
  • seq_in_index
  • column_name
  • collation
  • cardinality
  • sub_part
  • packed
  • null
  • index_type
  • comment
  • index_comment

If "columns" is empty or NULL then a result set containing all primary keys of "table" will be returned.

If SQL Relay doesn't support getting a list of primary keys for the current database backend (or the database doesn't) then an empty result set will be returned.

◆ sqlrcur_getProcedureList()

SQLRCLIENT_DLLSPEC int sqlrcur_getProcedureList ( sqlrcur sqlrcurref,
const char * procedures )

Generates a result set containing procedures that match the pattern "procedures".

The result set will contain the following columns:

  • routine_catalog
  • routine_schema
  • routine_name
  • data_type

If "procedures" is empty or NULL then a result set containing all procedures in the current database/schema will be returned.

If SQL Relay doesn't support getting a list of procedures for the current database backend (or the database doesn't) then an empty result set will be returned.

◆ sqlrcur_getProcedureParameterList()

SQLRCLIENT_DLLSPEC int sqlrcur_getProcedureParameterList ( sqlrcur sqlrcurref,
const char * procedure,
const char * parameters )

Generates a result set containing the parameters of "procedure", which match the pattern "parameters".

The result set will contain the following columns:

  • parameter_name
  • parameter_mode
  • data_type
  • character_maximum_length
  • ordinal_position

If "parameters" is empty or NULL then a result set containing all parameters of "procedure" will be returned.

If SQL Relay doesn't support getting a list of procedure parameters for the current database backend (or the database doesn't) then an empty result set will be returned.

◆ sqlrcur_getResultSetBufferSize()

SQLRCLIENT_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.

◆ sqlrcur_getResultSetId()

SQLRCLIENT_DLLSPEC uint16_t sqlrcur_getResultSetId ( sqlrcur sqlrcurref)

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

◆ sqlrcur_getRow()

SQLRCLIENT_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.

◆ sqlrcur_getRowLengths()

SQLRCLIENT_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.

◆ sqlrcur_getSchemaList()

SQLRCLIENT_DLLSPEC int sqlrcur_getSchemaList ( sqlrcur sqlrcurref,
const char * schemas )

Generates a result set containing schemas that match the pattern "schemas".

The result set will contain the following columns:

  • Database

(The column name is a bit of a misnomer, the results are schemas, not databases.)

If "schemas" is empty or NULL then a result set containing all schemas in the current database will be returned.

If SQL Relay doesn't support getting a list of schemas for the current database backend (or the database doesn't) then an empty result set will be returned.

◆ sqlrcur_getTableList()

SQLRCLIENT_DLLSPEC int sqlrcur_getTableList ( sqlrcur sqlrcurref,
const char * tables )

Generates a result set containing the tables in the current database and schema that match the pattern "tables".

The result set will contain the following columns:

  • Tables_in_xxx

If "tables" is empty or NULL then a result set containing all tables in the current database/schema will be returned.

If SQL Relay doesn't support getting a list of tables for the current database backend (or the database doesn't) then an empty result set will be returned.

◆ sqlrcur_getTableTypeList()

SQLRCLIENT_DLLSPEC int sqlrcur_getTableTypeList ( sqlrcur sqlrcurref)

Generates a result set containing supported table types.

The result set will contain the following columns:

  • table_type

If SQL Relay doesn't support getting a list of table types for the current database backend (or the database doesn't) then an empty result set will be returned.

◆ sqlrcur_getTypeInfoList()

SQLRCLIENT_DLLSPEC int sqlrcur_getTypeInfoList ( sqlrcur sqlrcurref,
const char * type )

Generates a result set containing data type information for "type".

The result set will contain the following columns:

  • type_name
  • data_type
  • precision
  • literal_prefix
  • literal_suffix
  • create_params
  • nullable
  • case_sensitive
  • searchable
  • unsigned_attribute
  • fixed_prec_scale
  • auto_increment
  • local_type_name
  • minumum_scale
  • maxiumm_scale
  • sql_data_type
  • sql_datetime_sub
  • num_prec_radix
  • interval_precision

If "type" is empty or NULL then a result set containing all data types in the current databas/schema will be returned.

If SQL Relay doesn't support getting type info for the current database backend (or the database doesn't) then an empty result set will be returned.

◆ sqlrcur_inputBindBlob()

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

Defines a binary lob input bind variable.

◆ sqlrcur_inputBindClob()

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

Defines a character lob input bind variable.

◆ sqlrcur_inputBindDate()

SQLRCLIENT_DLLSPEC void sqlrcur_inputBindDate ( sqlrcur sqlrcurref,
const char * variable,
int16_t year,
int16_t month,
int16_t day,
int16_t hour,
int16_t minute,
int16_t second,
int32_t microsecond,
const char * tz,
int isnegative )

Defines a date input bind variable. "day" and "month" are 1-based.

Some databases distinguish between date, time, and datetime types. For those databases...

  • The input bind variable will be interpreted as a time type if year and/or month are negative.
  • The input bind variable will be interpreted as a date type if hour, minute, second, and/or microsecond are negative.
  • The input bind variable will be interpreted as a datetime type if all parts are positive.

"tz" is the timezone abbreviation, and may be left NULL. Most databases ignore "tz".

Set "isnegative" may be set to true to represent a negative time interval. However, few databases support negative time intervals and ignore "isnegative".

◆ sqlrcur_inputBindDouble()

SQLRCLIENT_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 0. However in that case you may get unexpected rounding behavior if the server is faking binds.)

◆ sqlrcur_inputBindDoubles()

SQLRCLIENT_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.

◆ sqlrcur_inputBindLong()

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

Defines a integer input bind variable.

◆ sqlrcur_inputBindLongs()

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

Defines an array of integer input bind variables.

◆ sqlrcur_inputBindString()

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

Defines a string input bind variable.

◆ sqlrcur_inputBindStrings()

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

Defines an array of string input bind variables.

◆ sqlrcur_inputBindStringWithLength()

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

Defines a string input bind variable.

◆ sqlrcur_lowerCaseColumnNames()

SQLRCLIENT_DLLSPEC void sqlrcur_lowerCaseColumnNames ( sqlrcur sqlrcurref)

Columns names are converted to lower case.

◆ sqlrcur_mixedCaseColumnNames()

SQLRCLIENT_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.

◆ sqlrcur_nextResultSet()

SQLRCLIENT_DLLSPEC int sqlrcur_nextResultSet ( sqlrcur sqlrcurref)

Returns true and acts like executeQuery() when there is another result set available from the server.

◆ sqlrcur_openCachedResultSet()

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

Opens a cached result set. Returns true on success and false on failure.

◆ sqlrcur_prepareFileQuery()

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

Prepare to execute the contents of "path"/"filename". Returns false if the // file couldn't be opened.

◆ sqlrcur_prepareQuery()

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

Prepare to execute "query".

◆ sqlrcur_prepareQueryWithLength()

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

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

◆ sqlrcur_resumeCachedResultSet()

SQLRCLIENT_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 true on success and false on failure.

◆ sqlrcur_resumeResultSet()

SQLRCLIENT_DLLSPEC int sqlrcur_resumeResultSet ( sqlrcur sqlrcurref,
uint16_t id )

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

◆ sqlrcur_rowCount()

SQLRCLIENT_DLLSPEC uint64_t sqlrcur_rowCount ( sqlrcur sqlrcurref)

Returns the number of rows in the current result set (if the result set is being stepped through, this returns the number of rows processed so far).

◆ sqlrcur_sendFileQuery()

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

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

◆ sqlrcur_sendQuery()

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

Sends "query" directly and gets a result set.

◆ sqlrcur_sendQueryWithLength()

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

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

◆ sqlrcur_setCacheTtl()

SQLRCLIENT_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.

◆ sqlrcur_setResultSetBufferSize()

SQLRCLIENT_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.

◆ sqlrcur_subDouble()

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

Defines a decimal substitution variable.

◆ sqlrcur_subDoubles()

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

Defines an array of decimal substitution variables.

◆ sqlrcur_subLong()

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

Defines an integer substitution variable.

◆ sqlrcur_subLongs()

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

Defines an array of integer substitution variables.

◆ sqlrcur_subString()

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

Defines a string substitution variable.

◆ sqlrcur_subStrings()

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

Defines an array of string substitution variables.

◆ sqlrcur_suspendResultSet()

SQLRCLIENT_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().

◆ sqlrcur_totalRows()

SQLRCLIENT_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. 0 is returned by databases which don't support this option.

◆ sqlrcur_upperCaseColumnNames()

SQLRCLIENT_DLLSPEC void sqlrcur_upperCaseColumnNames ( sqlrcur sqlrcurref)

Columns names are converted to upper case.

◆ sqlrcur_validateBinds()

SQLRCLIENT_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 method.

◆ sqlrcur_validBind()

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

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