## Full index

### Package indexes

- sql_relay

0
top

  () in sql_relay.doc.php
  Returns an array of the lengths of the fields in the specified row.

s
top

sqlrcon_alloc
  sqlrcon_alloc() in sql_relay.doc.php
  Initiates a connection to "server" on "port" or to the unix "socket" on
sqlrcon_autoCommitOff
  sqlrcon_autoCommitOff() in sql_relay.doc.php
  Instructs the database to wait for the client to tell it when to commit.
sqlrcon_autoCommitOn
  sqlrcon_autoCommitOn() in sql_relay.doc.php
  Instructs the database to perform a commit after every successful query.
sqlrcon_bindFormat
  sqlrcon_bindFormat() in sql_relay.doc.php
  Returns a string representing the format of the bind variables used in the db.
sqlrcon_clientVersion
  sqlrcon_clientVersion() in sql_relay.doc.php
  Returns the version of the sqlrelay client software.
sqlrcon_commit
  sqlrcon_commit() in sql_relay.doc.php
  Issues a commit. Returns 1 if the commit succeeded, 0 if it failed and -1 if an error occurred.
sqlrcon_dbHostName
  sqlrcon_dbHostName() in sql_relay.doc.php
  Returns the host name of the database
sqlrcon_dbIpAddress
  sqlrcon_dbIpAddress() in sql_relay.doc.php
  Returns the ip address of the database
sqlrcon_dbVersion
  sqlrcon_dbVersion() in sql_relay.doc.php
  Returns the version of the database
sqlrcon_debugOff
  sqlrcon_debugOff() in sql_relay.doc.php
  Turns debugging off.
sqlrcon_debugOn
  sqlrcon_debugOn() in sql_relay.doc.php
  Causes verbose debugging information to be sent to standard output.
sqlrcon_endSession
  sqlrcon_endSession() in sql_relay.doc.php
  Ends the session.
sqlrcon_errorMessage
  sqlrcon_errorMessage() in sql_relay.doc.php
  If an operation failed and generated an error, the error message is
sqlrcon_errorNumber
  sqlrcon_errorNumber() in sql_relay.doc.php
  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
  sqlrcon_free() in sql_relay.doc.php
  Disconnects and ends the session if it hasn't been terminated already.
sqlrcon_getClientInfo
  sqlrcon_getClientInfo() in sql_relay.doc.php
  Returns the string that was set by setClientInfo().
sqlrcon_getConnectionPort
  sqlrcon_getConnectionPort() in sql_relay.doc.php
  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().
sqlrcon_getConnectionSocket
  sqlrcon_getConnectionSocket() in sql_relay.doc.php
  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().
sqlrcon_getCurrentDatabase
  sqlrcon_getCurrentDatabase() in sql_relay.doc.php
  Returns the database/schema that is currently in use.
sqlrcon_getDebug
  sqlrcon_getDebug() in sql_relay.doc.php
  Returns 0 if debugging is off and 1 if debugging is on.
sqlrcon_getLastInsertId
  sqlrcon_getLastInsertId() in sql_relay.doc.php
  Returns the value of the autoincrement column for the last insert
sqlrcon_identify
  sqlrcon_identify() in sql_relay.doc.php
  Returns the type of database: oracle8, postgresql, mysql, etc.
sqlrcon_ping
  sqlrcon_ping() in sql_relay.doc.php
  Returns 1 if the database is up and 0 if it's down.
sqlrcon_resumeSession
  sqlrcon_resumeSession() in sql_relay.doc.php
  Resumes a session previously left open using sqlrcon_suspendSession().
sqlrcon_rollback
  sqlrcon_rollback() in sql_relay.doc.php
  Issues a rollback. Returns 1 if the rollback succeeded, 0 if it failed and -1 if an error occurred.
sqlrcon_selectDatabase
  sqlrcon_selectDatabase() in sql_relay.doc.php
  Sets the current database/schema to "database"
sqlrcon_serverVersion
  sqlrcon_serverVersion() in sql_relay.doc.php
  Returns the version of the sqlrelay server software.
sqlrcon_setAuthenticationTimeout
  sqlrcon_setAuthenticationTimeout() in sql_relay.doc.php
  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.
sqlrcon_setClientInfo
  sqlrcon_setClientInfo() in sql_relay.doc.php
  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
  sqlrcon_setConnectTimeout() in sql_relay.doc.php
  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.
sqlrcon_setDebugFile
  sqlrcon_setDebugFile() in sql_relay.doc.php
  Allows you to specify a file to write debug to.
sqlrcon_setResponseTimeout
  sqlrcon_setResponseTimeout() in sql_relay.doc.php
  Sets the response timeout (for queries, commits, rollbacks,
sqlrcon_suspendSession
  sqlrcon_suspendSession() in sql_relay.doc.php
  Disconnects this connection from the current session but leaves the session open so that another connection can connect to it using sqlrcon_resumeSession().
sqlrcur_affectedRows
  sqlrcur_affectedRows() in sql_relay.doc.php
  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.
sqlrcur_alloc
  sqlrcur_alloc() in sql_relay.doc.php
  Creates a cursor to run queries and fetch
sqlrcur_cacheOff
  sqlrcur_cacheOff() in sql_relay.doc.php
  Sets query caching off.
sqlrcur_cacheToFile
  sqlrcur_cacheToFile() in sql_relay.doc.php
  Sets query caching on. Future queries will be cached to the file "filename".
sqlrcur_clearBinds
  sqlrcur_clearBinds() in sql_relay.doc.php
  Clears all bind variables.
sqlrcur_closeResultSet
  sqlrcur_closeResultSet() in sql_relay.doc.php
  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
  sqlrcur_colCount() in sql_relay.doc.php
  Returns the number of columns in the current result set.
sqlrcur_countBindVariables
  sqlrcur_countBindVariables() in sql_relay.doc.php
  Parses the previously prepared query, counts the number of bind variables defined in it and returns that number.
sqlrcur_defineOutputBindBlob
  sqlrcur_defineOutputBindBlob() in sql_relay.doc.php
  Defines a binary lob output bind variable
sqlrcur_defineOutputBindClob
  sqlrcur_defineOutputBindClob() in sql_relay.doc.php
  Defines a character lob output bind variable
sqlrcur_defineOutputBindCursor
  sqlrcur_defineOutputBindCursor() in sql_relay.doc.php
  Defines a cursor output bind variable
sqlrcur_defineOutputBindDouble
  sqlrcur_defineOutputBindDouble() in sql_relay.doc.php
  Defines an decimal output bind variable.
sqlrcur_defineOutputBindInteger
  sqlrcur_defineOutputBindInteger() in sql_relay.doc.php
  Defines an integer output bind variable.
sqlrcur_defineOutputBindString
  sqlrcur_defineOutputBindString() in sql_relay.doc.php
  Defines a string output bind variable.
sqlrcur_dontGetColumnInfo
  sqlrcur_dontGetColumnInfo() in sql_relay.doc.php
  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.
sqlrcur_endOfResultSet
  sqlrcur_endOfResultSet() in sql_relay.doc.php
  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.
sqlrcur_errorMessage
  sqlrcur_errorMessage() in sql_relay.doc.php
  If a query failed and generated an error, the error message is available here. If the query succeeded then this function returns a NULL.
sqlrcur_errorNumber
  sqlrcur_errorNumber() in sql_relay.doc.php
  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
  sqlrcur_executeQuery() in sql_relay.doc.php
  Execute the query that was previously prepared and bound.
sqlrcur_fetchFromBindCursor
  sqlrcur_fetchFromBindCursor() in sql_relay.doc.php
  Fetch from a cursor that was returned as an output bind variable.
sqlrcur_firstRowIndex
  sqlrcur_firstRowIndex() in sql_relay.doc.php
  Returns the index of the first buffered row. This is useful when buffering only part of the result set at a time.
sqlrcur_free
  sqlrcur_free() in sql_relay.doc.php
  Destroys the cursor and cleans up all associated result set data.
sqlrcur_getCacheFileName
  sqlrcur_getCacheFileName() in sql_relay.doc.php
  Returns the name of the file containing the most recently cached result set.
sqlrcur_getColumnInfo
  sqlrcur_getColumnInfo() in sql_relay.doc.php
  Tells the server to send column info.
sqlrcur_getColumnIsAutoIncrement
  sqlrcur_getColumnIsAutoIncrement() in sql_relay.doc.php
  Returns 1 if the specified column auto-increments and 0 otherwise.
sqlrcur_getColumnIsBinary
  sqlrcur_getColumnIsBinary() in sql_relay.doc.php
  Returns 1 if the specified column contains binary data and 0 otherwise.
sqlrcur_getColumnIsNullable
  sqlrcur_getColumnIsNullable() in sql_relay.doc.php
  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.
sqlrcur_getColumnIsPartOfKey
  sqlrcur_getColumnIsPartOfKey() in sql_relay.doc.php
  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.
sqlrcur_getColumnIsPrimaryKey
  sqlrcur_getColumnIsPrimaryKey() in sql_relay.doc.php
  Returns 1 if the specified column is a primary key and 0 otherwise.
sqlrcur_getColumnIsUnique
  sqlrcur_getColumnIsUnique() in sql_relay.doc.php
  Returns 1 if the specified column is unique and 0 otherwise. "col" may be specified as the column name or number.
sqlrcur_getColumnIsUnsigned
  sqlrcur_getColumnIsUnsigned() in sql_relay.doc.php
  Returns 1 if the specified column is an unsigned number and 0 otherwise.
sqlrcur_getColumnIsZeroFilled
  sqlrcur_getColumnIsZeroFilled() in sql_relay.doc.php
  Returns 1 if the specified column is zero-filled and 0 otherwise.
sqlrcur_getColumnLength
  sqlrcur_getColumnLength() in sql_relay.doc.php
  Returns the length of the specified column. "col" may be specified as the column name or number.
sqlrcur_getColumnList
  sqlrcur_getColumnList() in sql_relay.doc.php
  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.
sqlrcur_getColumnName
  sqlrcur_getColumnName() in sql_relay.doc.php
  Returns the name of the specified column.
sqlrcur_getColumnNames
  sqlrcur_getColumnNames() in sql_relay.doc.php
  Returns an array of the column names of the current result set.
sqlrcur_getColumnPrecision
  sqlrcur_getColumnPrecision() in sql_relay.doc.php
  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.
sqlrcur_getColumnScale
  sqlrcur_getColumnScale() in sql_relay.doc.php
  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.
sqlrcur_getColumnType
  sqlrcur_getColumnType() in sql_relay.doc.php
  Returns the type of the specified column. "col" may be specified as the column name or number.
sqlrcur_getDatabaseList
  sqlrcur_getDatabaseList() in sql_relay.doc.php
  Sends a query that returns a list of databases/schemas matching "wild".
sqlrcur_getField
  sqlrcur_getField() in sql_relay.doc.php
  Returns the specified field as a string. "col" may be specified as the column name or number.
sqlrcur_getFieldAsDouble
  sqlrcur_getFieldAsDouble() in sql_relay.doc.php
  Returns the specified field as an decimal. "col" may be specified as the column name or number.
sqlrcur_getFieldAsInteger
  sqlrcur_getFieldAsInteger() in sql_relay.doc.php
  Returns the specified field as an integer. "col" may be specified as the column name or number.
sqlrcur_getFieldLength
  sqlrcur_getFieldLength() in sql_relay.doc.php
  Returns the length of the specified row and column. "col" may be specified as the column name or number.
sqlrcur_getLongest
  sqlrcur_getLongest() in sql_relay.doc.php
  Returns the length of the longest field in the specified column.
sqlrcur_getNullsAsEmptyStrings
  sqlrcur_getNullsAsEmptyStrings() in sql_relay.doc.php
  Tells the connection to return NULL fields and output bind variables as empty strings. This is the default.
sqlrcur_getNullsAsNulls
  sqlrcur_getNullsAsNulls() in sql_relay.doc.php
  Tells the connection to return NULL fields and output bind variables as NULL's.
sqlrcur_getOutputBindBlob
  sqlrcur_getOutputBindBlob() in sql_relay.doc.php
  Get the value stored in a previously defined binary lob output bind variable.
sqlrcur_getOutputBindClob
  sqlrcur_getOutputBindClob() in sql_relay.doc.php
  Get the value stored in a previously defined character lob output bind variable.
sqlrcur_getOutputBindDouble
  sqlrcur_getOutputBindDouble() in sql_relay.doc.php
  Get the value stored in a previously defined decimal output bind variable.
sqlrcur_getOutputBindInteger
  sqlrcur_getOutputBindInteger() in sql_relay.doc.php
  Get the value stored in a previously defined integer output bind variable.
sqlrcur_getOutputBindLength
  sqlrcur_getOutputBindLength() in sql_relay.doc.php
  Get the length of the value stored in a previously defined output bind variable.
sqlrcur_getOutputBindString
  sqlrcur_getOutputBindString() in sql_relay.doc.php
  Get the value stored in a previously defined string output bind variable.
sqlrcur_getResultSetBufferSize
  sqlrcur_getResultSetBufferSize() in sql_relay.doc.php
  Returns the number of result set rows that will be buffered at a time or
  1. for the entire result set.
sqlrcur_getResultSetId
  sqlrcur_getResultSetId() in sql_relay.doc.php
  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().
sqlrcur_getRow
  sqlrcur_getRow() in sql_relay.doc.php
  Returns an array of the values of the fields in the specified row.
sqlrcur_getRowAssoc
  sqlrcur_getRowAssoc() in sql_relay.doc.php
  Returns an associative array of the values of the fields in the specified row.
sqlrcur_getRowLenghtsAssoc
  sqlrcur_getRowLenghtsAssoc() in sql_relay.doc.php
  Returns an associative array of the lengths of the fields in the specified row.
sqlrcur_getTableList
  sqlrcur_getTableList() in sql_relay.doc.php
  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.
sqlrcur_inputBind
  sqlrcur_inputBind() in sql_relay.doc.php
  Defines an input bind variable. The value may be a string,
sqlrcur_inputBindBlob
  sqlrcur_inputBindBlob() in sql_relay.doc.php
  Defines a binary lob input bind variable.
sqlrcur_inputBindClob
  sqlrcur_inputBindClob() in sql_relay.doc.php
  Defines a character lob input bind variable.
sqlrcur_lowerCaseColumnNames
  sqlrcur_lowerCaseColumnNames() in sql_relay.doc.php
  Columns names are converted to lower case.
sqlrcur_mixedCaseColumnNames
  sqlrcur_mixedCaseColumnNames() in sql_relay.doc.php
  Columns names are returned in the same case as they are defined in the database. This is the default.
sqlrcur_openCachedResultSet
  sqlrcur_openCachedResultSet() in sql_relay.doc.php
  Opens a cached result set. Returns 1 on success and 0 on failure.
sqlrcur_prepareFileQuery
  sqlrcur_prepareFileQuery() in sql_relay.doc.php
  Prepare to execute the contents of "path"/"filename".
sqlrcur_prepareQuery
  sqlrcur_prepareQuery() in sql_relay.doc.php
  Prepare to execute "query".
sqlrcur_prepareQueryWithLength
  sqlrcur_prepareQueryWithLength() in sql_relay.doc.php
  Prepare to execute "query" with length "length". This function must be used if the query contains binary data.
sqlrcur_resumeCachedResultSet
  sqlrcur_resumeCachedResultSet() in sql_relay.doc.php
  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.
sqlrcur_resumeResultSet
  sqlrcur_resumeResultSet() in sql_relay.doc.php
  Resumes a result set previously left open using suspendSession().
sqlrcur_rowCount
  sqlrcur_rowCount() in sql_relay.doc.php
  Returns the number of rows in the current result set.
sqlrcur_sendFileQuery
  sqlrcur_sendFileQuery() in sql_relay.doc.php
  Sends the query in file "path"/"filename" and gets a result set.
sqlrcur_sendQuery
  sqlrcur_sendQuery() in sql_relay.doc.php
  Sends "query" directly and gets a result set.
sqlrcur_sendQueryWithLength
  sqlrcur_sendQueryWithLength() in sql_relay.doc.php
  Sends "query" with length "length" directly and gets a result set. This function must be used if the query contains binary data.
sqlrcur_setCacheTtl
  sqlrcur_setCacheTtl() in sql_relay.doc.php
  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
  sqlrcur_setResultSetBufferSize() in sql_relay.doc.php
  Sets the number of rows of the result set to buffer at a time.
sqlrcur_substitution
  sqlrcur_substitution() in sql_relay.doc.php
  Defines a substitution variable. The value may be a string,
sqlrcur_suspendResultSet
  sqlrcur_suspendResultSet() in sql_relay.doc.php
  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
  sqlrcur_totalRows() in sql_relay.doc.php
  Returns the total number of rows that will be returned in the result set.
sqlrcur_upperCaseColumnNames
  sqlrcur_upperCaseColumnNames() in sql_relay.doc.php
  Columns names are converted to upper case.
sqlrcur_validateBinds
  sqlrcur_validateBinds() in sql_relay.doc.php
  If you are binding to any variables that might not actually be in your
sqlrcur_validBind
  sqlrcur_validBind() in sql_relay.doc.php
  Returns true if "variable" was a valid bind variable of the query.
sql_relay.doc.php
  sql_relay.doc.php in sql_relay.doc.php