Docs for page sql_relay.doc.php

## /sql_relay.doc.php

Description
Functions
(line 662)

Returns an array of the lengths of the fields in the specified row.

void ( $sqlrcurref, $row)

- $sqlrcurref
- $row

sqlrcon_alloc (line 13)

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 the "socket" parameter is nether NULL nor "" then an attempt will be made to connect through it before attempting to connect to "server" on "port". If it is NULL or "" then no attempt will be made to connect through the socket.

void sqlrcon_alloc ( $server, $port, $socket, $user, $password, $retrytime, $tries)

- $server
- $port
- $socket
- $user
- $password
- $retrytime
- $tries

sqlrcon_autoCommitOff (line 242)

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

void sqlrcon_autoCommitOff ( $sqlrconref)

- $sqlrconref

sqlrcon_autoCommitOn (line 238)

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

void sqlrcon_autoCommitOn ( $sqlrconref)

- $sqlrconref

sqlrcon_bindFormat (line 216)

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

void sqlrcon_bindFormat ( $sqlrconref)

- $sqlrconref

sqlrcon_clientVersion (line 211)

Returns the version of the sqlrelay client software.

void sqlrcon_clientVersion ( $sqlrconref)

- $sqlrconref

sqlrcon_commit (line 249)

Issues a commit. Returns 1 if the commit succeeded, 0 if it failed and -1 if an error occurred.

void sqlrcon_commit ( $sqlrconref)

- $sqlrconref

sqlrcon_dbHostName (line 199)

Returns the host name of the database

void sqlrcon_dbHostName ( $sqlrconref)

- $sqlrconref

sqlrcon_dbIpAddress (line 203)

Returns the ip address of the database

void sqlrcon_dbIpAddress ( $sqlrconref)

- $sqlrconref

sqlrcon_dbVersion (line 195)

Returns the version of the database

void sqlrcon_dbVersion ( $sqlrconref)

- $sqlrconref

sqlrcon_debugOff (line 280)

Turns debugging off.

void sqlrcon_debugOff ( $sqlrconref)

- $sqlrconref

sqlrcon_debugOn (line 276)

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"

void sqlrcon_debugOn ( $sqlrconref)

- $sqlrconref

sqlrcon_disableEncryption (line 152)

Disables encryption.

void sqlrcon_disableEncryption ( $sqlrconref)

- $sqlrconref

sqlrcon_enableKerberos (line 78)

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.

void sqlrcon_enableKerberos ( $sqlrconref, $service, $mech, $flags)

- $sqlrconref
- $service
- $mech
- $flags

sqlrcon_enableTls (line 149)

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.

void sqlrcon_enableTls ( $sqlrconref, $version, $cert, $password, $ciphers, $validate, $ca, $depth)

- $sqlrconref
- $version
- $cert
- $password
- $ciphers
- $validate
- $ca
- $depth

sqlrcon_endSession (line 156)

Ends the session.

void sqlrcon_endSession ( $sqlrconref)

- $sqlrconref

sqlrcon_errorMessage (line 261)

If an operation failed and generated an error, the error message is

available here. If there is no error then this method returns NULL

void sqlrcon_errorMessage ( $sqlrconref)

- $sqlrconref

sqlrcon_errorNumber (line 267)

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

void sqlrcon_errorNumber ( $sqlrconref)

- $sqlrconref

sqlrcon_free (line 17)

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

void sqlrcon_free ( $sqlrconref)

- $sqlrconref

sqlrcon_getClientInfo (line 298)

Returns the string that was set by setClientInfo().

void sqlrcon_getClientInfo ( $sqlrconref)

- $sqlrconref

sqlrcon_getConnectionPort (line 169)

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

void sqlrcon_getConnectionPort ( $sqlrconref)

- $sqlrconref

sqlrcon_getConnectionSocket (line 176)

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

void sqlrcon_getConnectionSocket ( $sqlrconref)

- $sqlrconref

sqlrcon_getCurrentDatabase (line 226)

Returns the database/schema that is currently in use.

void sqlrcon_getCurrentDatabase ( $sqlrconref)

- $sqlrconref

sqlrcon_getDebug (line 284)

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

void sqlrcon_getDebug ( $sqlrconref)

- $sqlrconref

sqlrcon_getLastInsertId (line 232)

Returns the value of the autoincrement column for the last insert

void sqlrcon_getLastInsertId ( $sqlrconref)

- $sqlrconref

sqlrcon_identify (line 191)

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

void sqlrcon_identify ( $sqlrconref)

- $sqlrconref

sqlrcon_ping (line 187)

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

void sqlrcon_ping ( $sqlrconref)

- $sqlrconref

sqlrcon_resumeSession (line 181)

Resumes a session previously left open using sqlrcon_suspendSession().

Returns 1 on success and 0 on failure.

void sqlrcon_resumeSession ( $sqlrconref, $port, $socket)

- $sqlrconref
- $port
- $socket

sqlrcon_rollback (line 254)

Issues a rollback. Returns 1 if the rollback succeeded, 0 if it failed and -1 if an error occurred.

void sqlrcon_rollback ( $sqlrconref)

- $sqlrconref

sqlrcon_selectDatabase (line 222)

Sets the current database/schema to "database"

void sqlrcon_selectDatabase ( $sqlrconref, $database)

- $sqlrconref
- $database

sqlrcon_serverVersion (line 207)

Returns the version of the sqlrelay server software.

void sqlrcon_serverVersion ( $sqlrconref)

- $sqlrconref

sqlrcon_setAuthenticationTimeout (line 33)

Sets the authentication timeout in seconds and milliseconds. Setting either parameter to -1 disables the timeout. You can also set this timeout using the SQLR_CLIENT_AUTHENTICATION_TIMEOUT environment variable.

void sqlrcon_setAuthenticationTimeout ( $sqlrconref, $timeoutsec, $timeoutusec)

- $sqlrconref
- $timeoutsec
- $timeoutusec

sqlrcon_setClientInfo (line 295)

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.

void sqlrcon_setClientInfo ( $sqlrconref, $clientinfo)

- $sqlrconref
- $clientinfo

sqlrcon_setConnectTimeout (line 26)

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

void sqlrcon_setConnectTimeout ( $sqlrconref, $timeoutsec, $timeoutusec)

- $sqlrconref
- $timeoutsec
- $timeoutusec

sqlrcon_setDebugFile (line 289)

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

void sqlrcon_setDebugFile ( $sqlrconref, $filename)

- $sqlrconref
- $filename

sqlrcon_setResponseTimeout (line 41)

Sets the response timeout (for queries, commits, rollbacks,

pings, etc.) in seconds and milliseconds. Setting either parameter to -1 disables the timeout. You can also set this timeout using the SQLR_CLIENT_RESPONSE_TIMEOUT environment variable.

void sqlrcon_setResponseTimeout ( $sqlrconref, $timeoutsec, $timeoutusec)

- $sqlrconref
- $timeoutsec
- $timeoutusec

sqlrcon_suspendSession (line 162)

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

void sqlrcon_suspendSession ( $sqlrconref)

- $sqlrconref

sqlrcur_affectedRows (line 587)

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

void sqlrcur_affectedRows ( $sqlrcurref)

- $sqlrcurref

sqlrcur_alloc (line 307)

Creates a cursor to run queries and fetch

result sets using connection "sqlrconref"

void sqlrcur_alloc ( $sqlrconref)

- $sqlrconref

sqlrcur_cacheOff (line 379)

Sets query caching off.

void sqlrcur_cacheOff ( $sqlrcurref)

- $sqlrcurref

sqlrcur_cacheToFile (line 364)

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

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

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

void sqlrcur_cacheToFile ( $sqlrcurref, $filename)

- $sqlrcurref
- $filename

sqlrcur_clearBinds (line 495)

Clears all bind variables.

void sqlrcur_clearBinds ( $sqlrcurref)

- $sqlrcurref

sqlrcur_closeResultSet (line 777)

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.

void sqlrcur_closeResultSet ( $sqlrcurref)

- $sqlrcurref

sqlrcur_colCount (line 569)

Returns the number of columns in the current result set.

void sqlrcur_colCount ( $sqlrcurref)

- $sqlrcurref

sqlrcur_countBindVariables (line 500)

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

void sqlrcur_countBindVariables ( $sqlrcurref)

- $sqlrcurref

sqlrcur_defineOutputBindBlob (line 481)

Defines a binary lob output bind variable

void sqlrcur_defineOutputBindBlob ( $sqlrcurref, $variable)

- $sqlrcurref
- $variable

sqlrcur_defineOutputBindClob (line 485)

Defines a character lob output bind variable

void sqlrcur_defineOutputBindClob ( $sqlrcurref, $variable)

- $sqlrcurref
- $variable

sqlrcur_defineOutputBindCursor (line 489)

Defines a cursor output bind variable

void sqlrcur_defineOutputBindCursor ( $sqlrcurref, $variable)

- $sqlrcurref
- $variable

sqlrcur_defineOutputBindDouble (line 477)

Defines an decimal output bind variable.

void sqlrcur_defineOutputBindDouble ( $sqlrcurref, $variable)

- $sqlrcurref
- $variable

sqlrcur_defineOutputBindInteger (line 473)

Defines an integer output bind variable.

void sqlrcur_defineOutputBindInteger ( $sqlrcurref, $variable)

- $sqlrcurref
- $variable

sqlrcur_defineOutputBindString (line 469)

Defines a string output bind variable.

"length" bytes will be reserved to store the value.

void sqlrcur_defineOutputBindString ( $sqlrcurref, $variable, $length)

- $sqlrcurref
- $variable
- $length

sqlrcur_dontGetColumnInfo (line 331)

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

void sqlrcur_dontGetColumnInfo ( $sqlrcurref)

- $sqlrcurref

sqlrcur_endOfResultSet (line 598)

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

void sqlrcur_endOfResultSet ( $sqlrcurref)

- $sqlrcurref

sqlrcur_errorMessage (line 605)

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

void sqlrcur_errorMessage ( $sqlrcurref)

- $sqlrcurref

sqlrcur_errorNumber (line 611)

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

void sqlrcur_errorNumber ( $sqlrcurref)

- $sqlrcurref

sqlrcur_executeQuery (line 517)

Execute the query that was previously prepared and bound.

void sqlrcur_executeQuery ( $sqlrcurref)

- $sqlrcurref

sqlrcur_fetchFromBindCursor (line 521)

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

void sqlrcur_fetchFromBindCursor ( $sqlrcurref)

- $sqlrcurref

sqlrcur_firstRowIndex (line 592)

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

void sqlrcur_firstRowIndex ( $sqlrcurref)

- $sqlrcurref

sqlrcur_free (line 311)

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

void sqlrcur_free ( $sqlrcurref)

- $sqlrcurref

sqlrcur_getCacheFileName (line 375)

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

void sqlrcur_getCacheFileName ( $sqlrcurref)

- $sqlrcurref

sqlrcur_getColumnInfo (line 335)

Tells the server to send column info.

void sqlrcur_getColumnInfo ( $sqlrcurref)

- $sqlrcurref

sqlrcur_getColumnIsAutoIncrement (line 739)

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

"col" may be specified as the column name or number.

void sqlrcur_getColumnIsAutoIncrement ( $sqlrcurref, $col)

- $sqlrcurref
- $col

sqlrcur_getColumnIsBinary (line 734)

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

"col" may be specified as the column name or number.

void sqlrcur_getColumnIsBinary ( $sqlrcurref, $col)

- $sqlrcurref
- $col

sqlrcur_getColumnIsNullable (line 704)

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. "col" may be specified as the column name or number.

void sqlrcur_getColumnIsNullable ( $sqlrcurref, $col)

- $sqlrcurref
- $col

sqlrcur_getColumnIsPartOfKey (line 719)

Returns 1 if the specified column is part of a composite key and 0 otherwise. "col" may be specified as the column name or number.

void sqlrcur_getColumnIsPartOfKey ( $sqlrcurref, $col)

- $sqlrcurref
- $col

sqlrcur_getColumnIsPrimaryKey (line 709)

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

"col" may be specified as the column name or number.

void sqlrcur_getColumnIsPrimaryKey ( $sqlrcurref, $col)

- $sqlrcurref
- $col

sqlrcur_getColumnIsUnique (line 714)

Returns 1 if the specified column is unique and 0 otherwise. "col" may be specified as the column name or number.

void sqlrcur_getColumnIsUnique ( $sqlrcurref, $col)

- $sqlrcurref
- $col

sqlrcur_getColumnIsUnsigned (line 724)

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

"col" may be specified as the column name or number.

void sqlrcur_getColumnIsUnsigned ( $sqlrcurref, $col)

- $sqlrcurref
- $col

sqlrcur_getColumnIsZeroFilled (line 729)

Returns 1 if the specified column is zero-filled and 0 otherwise.

"col" may be specified as the with the zero-fill flag and 0 otherwise.

void sqlrcur_getColumnIsZeroFilled ( $sqlrcurref, $col)

- $sqlrcurref
- $col

sqlrcur_getColumnLength (line 685)

Returns the length of the specified column. "col" may be specified as the column name or number.

void sqlrcur_getColumnLength ( $sqlrcurref, $col)

- $sqlrcurref
- $col

sqlrcur_getColumnList (line 398)

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

void sqlrcur_getColumnList ( $sqlrcurref, $table, $wild)

- $sqlrcurref
- $table
- $wild

sqlrcur_getColumnName (line 675)

Returns the name of the specified column.

void sqlrcur_getColumnName ( $sqlrcurref, $col)

- $sqlrcurref
- $col

sqlrcur_getColumnNames (line 671)

Returns an array of the column names of the current result set.

void sqlrcur_getColumnNames ( $sqlrcurref)

- $sqlrcurref

sqlrcur_getColumnPrecision (line 692)

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. "col" may be specified as the column name or number.

void sqlrcur_getColumnPrecision ( $sqlrcurref, $col)

- $sqlrcurref
- $col

sqlrcur_getColumnScale (line 698)

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. "col" may be specified as the column name or number.

void sqlrcur_getColumnScale ( $sqlrcurref, $col)

- $sqlrcurref
- $col

sqlrcur_getColumnType (line 680)

Returns the type of the specified column. "col" may be specified as the column name or number.

void sqlrcur_getColumnType ( $sqlrcurref, $col)

- $sqlrcurref
- $col

sqlrcur_getDatabaseList (line 387)

Sends a query that returns a list of databases/schemas matching "wild".

If wild is empty or NULL then a list of all databases/schemas will be returned.

void sqlrcur_getDatabaseList ( $sqlrcurref, $wild)

- $sqlrcurref
- $wild

sqlrcur_getField (line 630)

Returns the specified field as a string. "col" may be specified as the column name or number.

void sqlrcur_getField ( $sqlrcurref, $row, $col)

- $sqlrcurref
- $row
- $col

sqlrcur_getFieldAsDouble (line 640)

Returns the specified field as an decimal. "col" may be specified as the column name or number.

void sqlrcur_getFieldAsDouble ( $sqlrcurref, $row, $col)

- $sqlrcurref
- $row
- $col

sqlrcur_getFieldAsInteger (line 635)

Returns the specified field as an integer. "col" may be specified as the column name or number.

void sqlrcur_getFieldAsInteger ( $sqlrcurref, $row, $col)

- $sqlrcurref
- $row
- $col

sqlrcur_getFieldLength (line 647)

Returns the length of the specified row and column. "col" may be specified as the column name or number.

void sqlrcur_getFieldLength ( $sqlrcurref, $row, $col)

- $sqlrcurref
- $row
- $col

sqlrcur_getLongest (line 744)

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

"col" may be specified as the column name or number.

void sqlrcur_getLongest ( $sqlrcurref, $col)

- $sqlrcurref
- $col

sqlrcur_getNullsAsEmptyStrings (line 618)

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

void sqlrcur_getNullsAsEmptyStrings ( $sqlrcurref)

- $sqlrcurref

sqlrcur_getNullsAsNulls (line 623)

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

void sqlrcur_getNullsAsNulls ( $sqlrcurref)

- $sqlrcurref

sqlrcur_getOutputBindBlob (line 543)

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

void sqlrcur_getOutputBindBlob ( $sqlrcurref, $variable)

- $sqlrcurref
- $variable

sqlrcur_getOutputBindClob (line 548)

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

void sqlrcur_getOutputBindClob ( $sqlrcurref, $variable)

- $sqlrcurref
- $variable

sqlrcur_getOutputBindDouble (line 538)

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

void sqlrcur_getOutputBindDouble ( $sqlrcurref, $variable)

- $sqlrcurref
- $variable

sqlrcur_getOutputBindInteger (line 533)

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

void sqlrcur_getOutputBindInteger ( $sqlrcurref, $variable)

- $sqlrcurref
- $variable

sqlrcur_getOutputBindLength (line 553)

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

void sqlrcur_getOutputBindLength ( $sqlrcurref, $variable)

- $sqlrcurref
- $variable

sqlrcur_getOutputBindString (line 528)

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

void sqlrcur_getOutputBindString ( $sqlrcurref, $variable)

- $sqlrcurref
- $variable

sqlrcur_getResultSetBufferSize (line 323)

Returns the number of result set rows that will be buffered at a time or

1. for the entire result set.

void sqlrcur_getResultSetBufferSize ( $sqlrcurref)

- $sqlrcurref

sqlrcur_getResultSetId (line 759)

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

void sqlrcur_getResultSetId ( $sqlrcurref)

- $sqlrcurref

sqlrcur_getRow (line 653)

Returns an array of the values of the fields in the specified row.

void sqlrcur_getRow ( $sqlrcurref, $row)

- $sqlrcurref
- $row

sqlrcur_getRowAssoc (line 658)

Returns an associative array of the values of the fields in the specified row.

void sqlrcur_getRowAssoc ( $sqlrcurref, $row)

- $sqlrcurref
- $row

sqlrcur_getRowLenghtsAssoc (line 667)

Returns an associative array of the lengths of the fields in the specified row.

void sqlrcur_getRowLenghtsAssoc ( $sqlrcurref, $row)

- $sqlrcurref
- $row

sqlrcur_getTableList (line 392)

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

void sqlrcur_getTableList ( $sqlrcurref, $wild)

- $sqlrcurref
- $wild

sqlrcur_inputBind (line 448)

Defines an input bind variable. The value may be a string,

integer or decimal. If the value is a decimal, then precision and scale may also be specified. If you don't have the precision and scale then set them both to 0. However in that case you may get unexpected rounding behavior if the server is faking binds.

void sqlrcur_inputBind ( $sqlrcurref, $variable, $value, $precision, $scale)

- $sqlrcurref
- $variable
- $value
- $precision
- $scale

sqlrcur_inputBindBlob (line 458)

Defines a binary lob input bind variable.

void sqlrcur_inputBindBlob ( $sqlrcurref, $variable, $value, $size)

- $sqlrcurref
- $variable
- $value
- $size

sqlrcur_inputBindClob (line 462)

Defines a character lob input bind variable.

void sqlrcur_inputBindClob ( $sqlrcurref, $variable, $value, $size)

- $sqlrcurref
- $variable
- $value
- $size

sqlrcur_lowerCaseColumnNames (line 350)

Columns names are converted to lower case.

void sqlrcur_lowerCaseColumnNames ( $sqlrcurref)

- $sqlrcurref

sqlrcur_mixedCaseColumnNames (line 342)

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

void sqlrcur_mixedCaseColumnNames ( $sqlrcurref)

- $sqlrcurref

sqlrcur_openCachedResultSet (line 563)

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

void sqlrcur_openCachedResultSet ( $sqlrcurref, $filename)

- $sqlrcurref
- $filename

sqlrcur_prepareFileQuery (line 428)

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

void sqlrcur_prepareFileQuery ( $sqlrcurref, $path, $filename)

- $sqlrcurref
- $path
- $filename

sqlrcur_prepareQuery (line 419)

Prepare to execute "query".

void sqlrcur_prepareQuery ( $sqlrcurref, $query)

- $sqlrcurref
- $query

sqlrcur_prepareQueryWithLength (line 424)

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

void sqlrcur_prepareQueryWithLength ( $sqlrcurref, $query, $length)

- $sqlrcurref
- $query
- $length

sqlrcur_resumeCachedResultSet (line 770)

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

void sqlrcur_resumeCachedResultSet ( $sqlrcurref, $id, $filename)

- $sqlrcurref
- $id
- $filename

sqlrcur_resumeResultSet (line 764)

Resumes a result set previously left open using suspendSession().

Returns 1 on success and 0 on failure.

void sqlrcur_resumeResultSet ( $sqlrcurref, $id)

- $sqlrcurref
- $id

sqlrcur_rowCount (line 573)

Returns the number of rows in the current result set.

void sqlrcur_rowCount ( $sqlrcurref)

- $sqlrcurref

sqlrcur_sendFileQuery (line 413)

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

void sqlrcur_sendFileQuery ( $sqlrcurref, $path, $filename)

- $sqlrcurref
- $path
- $filename

sqlrcur_sendQuery (line 404)

Sends "query" directly and gets a result set.

void sqlrcur_sendQuery ( $sqlrcurref, $query)

- $sqlrcurref
- $query

sqlrcur_sendQueryWithLength (line 409)

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

void sqlrcur_sendQueryWithLength ( $sqlrcurref, $query, $length)

- $sqlrcurref
- $query
- $length

sqlrcur_setCacheTtl (line 370)

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.

void sqlrcur_setCacheTtl ( $sqlrcurref, $ttl)

- $sqlrcurref
- $ttl

sqlrcur_setResultSetBufferSize (line 318)

Sets the number of rows of the result set to buffer at a time.

1. (the default) means buffer the entire result set.

void sqlrcur_setResultSetBufferSize ( $sqlrcurref, $rows)

- $sqlrcurref
- $rows

sqlrcur_substitution (line 434)

Defines a substitution variable. The value may be a string,

integer or decimal. If it is a decimal, then precision and scale may also be specified

void sqlrcur_substitution ( $sqlrcurref, $variable, $value, $precision, $scale)

- $sqlrcurref
- $variable
- $value
- $precision
- $scale

sqlrcur_suspendResultSet (line 752)

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

void sqlrcur_suspendResultSet ( $sqlrcurref)

- $sqlrcurref

sqlrcur_totalRows (line 580)

Returns the total number of rows that will be returned in the result set.

Not all databases support this call. Don't use it for applications which are designed to be portable across databases. -1 is returned by databases which don't support this option.

void sqlrcur_totalRows ( $sqlrcurref)

- $sqlrcurref

sqlrcur_upperCaseColumnNames (line 346)

Columns names are converted to upper case.

void sqlrcur_upperCaseColumnNames ( $sqlrcurref)

- $sqlrcurref

sqlrcur_validateBinds (line 507)

If you are binding to any variables that might not actually be in your

query, call this to ensure that the database won't try to bind them unless they really are in the query. There is a performance penalty for calling this function

void sqlrcur_validateBinds ( $sqlrcurref)

- $sqlrcurref

sqlrcur_validBind (line 511)

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

void sqlrcur_validBind ( $sqlrcurref, $variable)

- $sqlrcurref
- $variable

Documentation generated on Tue, 15 Mar 2016 06:50:59 +0000 by phpDocumentor 1.4.4