Index by: file name | procedure name | procedure call | annotation

: 1 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

# Index of annotations

### A

affectedRows { } - sqlrcurCmd.tcl
  Returns the number of rows that were updated inserted or deleted by the query.
autoCommitOff { } - sqlrconCmd.tcl
  Instructs the database to wait for the client to tell it when to
autoCommitOn { } - sqlrconCmd.tcl
  Instructs the database to perform a commit after every successful

### B

begin { } - sqlrconCmd.tcl
  Begins a transaction.
bindFormat { } - sqlrconCmd.tcl
  Returns a string representing the format of the bind variables used in the

### C

cacheOff { } - sqlrcurCmd.tcl
  Sets query caching
cacheToFile { filename } - sqlrcurCmd.tcl
  Sets query caching on.
clearBinds { } - sqlrcurCmd.tcl
  Clears all bind
clientVersion { } - sqlrconCmd.tcl
  Returns the version of the sqlrelay client
closeResultSet { } - sqlrcurCmd.tcl
  Closes the current result set, if one is open.
colCount { } - sqlrcurCmd.tcl
  Returns the number of columns in the current result
commit { } - sqlrconCmd.tcl
  Issues a commit.
countBindVariables { } - sqlrcurCmd.tcl
  Parses the previously prepared query counts the number of bind variables defined in it and returns that

### D

dbHostName { } - sqlrconCmd.tcl
  Returns the host name of the
dbIpAddress { } - sqlrconCmd.tcl
  Returns the ip address of the
dbVersion { } - sqlrconCmd.tcl
  Returns the version of the
debugOff { } - sqlrconCmd.tcl
  Turns debugging
debugOn { } - sqlrconCmd.tcl
  Causes verbose debugging information to be sent to standard output.
defineOutputBindBlob { variable } - sqlrcurCmd.tcl
  Defines a binary lob output bind
defineOutputBindClob { variable } - sqlrcurCmd.tcl
  Defines a character lob output bind
defineOutputBindCursor { variable } - sqlrcurCmd.tcl
  Defines a cursor output bind
defineOutputBindDouble { variable } - sqlrcurCmd.tcl
  Defines a decimal output bind
defineOutputBindInteger { variable } - sqlrcurCmd.tcl
  Defines an integer output bind
defineOutputBindString { variable bufferlength } - sqlrcurCmd.tcl
  Defines an output bind variable.
disableEncryption { } - sqlrconCmd.tcl
  Disables
dontGetColumnInfo { } - sqlrcurCmd.tcl
  Tells the server not to send any column info {names types sizes}.

### E

enableKerberos { service mech flags } - sqlrconCmd.tcl
  Enables Kerberos authentication and encryption.
enableTls { version cert password ciphers validate ca depth } - sqlrconCmd.tcl
  Enables TLS/SSL encryption, and optionally authentication.
endOfResultSet { } - sqlrcurCmd.tcl
  Returns false if part of the result set is still pending on the server and true if not.
endSession { } - sqlrconCmd.tcl
  Ends the
errorMessage { } - sqlrconCmd.tcl
  If an operation failed and generated an error the error message is available here.
errorMessage { } - sqlrcurCmd.tcl
  If a query failed and generated an error the error message is available here.
errorNumber { } - sqlrconCmd.tcl
  If an operation failed and generated an error, the error number is available here.
errorNumber { } - sqlrcurCmd.tcl
  If a query failed and generated an error, the error number is available here.
executeQuery { } - sqlrcurCmd.tcl
  Execute the query that was previously prepared and

### F

fetchFromBindCursor { } - sqlrcurCmd.tcl
  Fetch from a cursor that was returned as an output bind
firstRowIndex { } - sqlrcurCmd.tcl
  Returns the index of the first buffered row.

### G

getCacheFileName { } - sqlrcurCmd.tcl
  Returns the name of the file containing the cached result
getClientInfo { } - sqlrconCmd.tcl
  Returns the string that was set by
getColumnInfo { } - sqlrcurCmd.tcl
  Tells the server to send column
getColumnIsAutoIncrementByIndex { col } - sqlrcurCmd.tcl
  Returns true if the specified column auto-increments and false
getColumnIsAutoIncrementByName { col } - sqlrcurCmd.tcl
  Returns true if the specified column auto-increments and false
getColumnIsBinaryByIndex { col } - sqlrcurCmd.tcl
  Returns true if the specified column contains binary data and false
getColumnIsBinaryByName { col } - sqlrcurCmd.tcl
  Returns true if the specified column contains binary data and false
getColumnIsNullableByIndex { col } - sqlrcurCmd.tcl
  Returns true if the specified column can contain nulls and false
getColumnIsNullableByName { col } - sqlrcurCmd.tcl
  Returns true if the specified column can contain nulls and false
getColumnIsPartOfKeyByIndex { col } - sqlrcurCmd.tcl
  Returns true if the specified column is part of a composite key and false
getColumnIsPartOfKeyByName { col } - sqlrcurCmd.tcl
  Returns true if the specified column is part of a composite key and false
getColumnIsPrimaryKeyByIndex { col } - sqlrcurCmd.tcl
  Returns true if the specified column is a primary key and false
getColumnIsPrimaryKeyByName { col } - sqlrcurCmd.tcl
  Returns true if the specified column is a primary key and false
getColumnIsUniqueByIndex { col } - sqlrcurCmd.tcl
  Returns true if the specified column is unique and false
getColumnIsUniqueByName { col } - sqlrcurCmd.tcl
  Returns true if the specified column is unique and false
getColumnIsUnsignedByIndex { col } - sqlrcurCmd.tcl
  Returns true if the specified column is an unsigned number and false
getColumnIsUnsignedByName { col } - sqlrcurCmd.tcl
  Returns true if the specified column is an unsigned number and false
getColumnIsZeroFilledByIndex { col } - sqlrcurCmd.tcl
  Returns true if the specified column was created with the zero-fill flag and false
getColumnIsZeroFilledByName { col } - sqlrcurCmd.tcl
  Returns true if the specified column was created with the zero-fill flag and false
getColumnLengthByIndex { col } - sqlrcurCmd.tcl
  Returns the number of bytes required on the server to store the data for the specified
getColumnLengthByName { col } - sqlrcurCmd.tcl
  Returns the number of bytes required on the server to store the data for the specified
getColumnList { table wild } - sqlrcurCmd.tcl
  Sends a query that returns a list of columns in the table specified by the "table" parameter matching "wild".
getColumnName { col } - sqlrcurCmd.tcl
  Returns the name of the specified
getColumnNameByIndex { col } - sqlrcurCmd.tcl
  Returns the name of the specified
getColumnNames { } - sqlrcurCmd.tcl
  Returns a null terminated array of the column names of the current result
getColumnPrecisionByIndex { col } - sqlrcurCmd.tcl
  Returns the precision of the specified column.
getColumnPrecisionByName { col } - sqlrcurCmd.tcl
  Returns the precision of the specified column.
getColumnScaleByIndex { col } - sqlrcurCmd.tcl
  Returns the scale of the specified column.
getColumnScaleByName { col } - sqlrcurCmd.tcl
  Returns the scale of the specified column.
getColumnTypeByIndex { col } - sqlrcurCmd.tcl
  Returns the type of the specified
getColumnTypeByName { col } - sqlrcurCmd.tcl
  Returns the type of the specified
getColumnTypeByName { col } - sqlrcurCmd.tcl
  Returns the type of the specified
getConnectionPort { } - sqlrconCmd.tcl
  Returns the inet port that the connection is communicating over.
getConnectionSocket { } - sqlrconCmd.tcl
  Returns the unix socket that the connection is communicating over.
getCurrentDatabase { } - sqlrconCmd.tcl
  Returns the database/schema that is currently in
getDatabaseList { wild } - sqlrcurCmd.tcl
  Sends a query that returns a list of databases/schemas matching "wild".
getDebug { } - sqlrconCmd.tcl
  Returns false if debugging is off and true if debugging is
getFieldAsDoubleByIndex { row col } - sqlrcurCmd.tcl
  Returns the specified field as a
getFieldAsDoubleByName { row col } - sqlrcurCmd.tcl
  Returns the specified field as a
getFieldAsIntegerByIndex { row col } - sqlrcurCmd.tcl
  Returns the specified field as an
getFieldAsIntegerByName { row col } - sqlrcurCmd.tcl
  Returns the specified field as an
getFieldByIndex { row col } - sqlrcurCmd.tcl
  Returns the specified field as a
getFieldByName { row col } - sqlrcurCmd.tcl
  Returns the specified field as a
getFieldLengthByIndex { row col } - sqlrcurCmd.tcl
  Returns the length of the specified
getFieldLengthByName { row col } - sqlrcurCmd.tcl
  Returns the length of the specified
getLastInsertId { } - sqlrconCmd.tcl
  Returns the value of the autoincrement column for the last
getLongestByIndex { col } - sqlrcurCmd.tcl
  Returns the length of the longest field in the specified
getLongestByName { col } - sqlrcurCmd.tcl
  Returns the length of the longest field in the specified
getOutputBindBlob { variable } - sqlrcurCmd.tcl
  Get the value stored in a previously defined binary lob output bind
getOutputBindClob { variable } - sqlrcurCmd.tcl
  Get the value stored in a previously defined character lob output bind
getOutputBindCursor { variable } - sqlrcurCmd.tcl
  Get the cursor associated with a previously defined output bind
getOutputBindDouble { variable } - sqlrcurCmd.tcl
  Get the value stored in a previously defined decimal output bind
getOutputBindInteger { variable } - sqlrcurCmd.tcl
  Get the value stored in a previously defined integer output bind
getOutputBindLength { variable } - sqlrcurCmd.tcl
  Get the length of the value stored in a previously defined output bind
getOutputBindString { variable } - sqlrcurCmd.tcl
  Get the value stored in a previously defined string output bind
getResultSetBufferSize { } - sqlrcurCmd.tcl
  Returns the number of result set rows that will be buffered at a time or 0 for the entire result
getResultSetId { } - sqlrcurCmd.tcl
  Returns the internal ID of this result set.
getRow { row } - sqlrcurCmd.tcl
  Returns a null terminated array of the values of the fields in the specified
getRowLengths { row } - sqlrcurCmd.tcl
  Returns a null terminated array of the lengths of the fields in the specified
getTableList { wild } - sqlrcurCmd.tcl
  Sends a query that returns a list of tables matching "wild".

### I

identify { } - sqlrconCmd.tcl
  Returns the type of database: oracle postgresql mysql
inputBind { variable value precision scale } - sqlrcurCmd.tcl
  Defines a input bind variable.
inputBindBlob { variable value size } - sqlrcurCmd.tcl
  Defines a binary lob input bind
inputBindClob { variable value size } - sqlrcurCmd.tcl
  Defines a character lob input bind
inputBinds { variables values precisions scales } - sqlrcurCmd.tcl
  Defines an array of input bind

### L

lowerCaseColumnNames { } - sqlrcurCmd.tcl
  Columns names are converted to lower

### M

mixedCaseColumnNames { } - sqlrcurCmd.tcl
  Columns names are returned in the same case as they are defined in the database.

### O

openCachedResultSet { filename } - sqlrcurCmd.tcl
  Opens a cached result set.

### P

ping { } - sqlrconCmd.tcl
  Returns true if the database is up and false if it's
prepareFileQuery { path filename } - sqlrcurCmd.tcl
  Prepare to execute the contents of "path"/"filename".
prepareQuery { query } - sqlrcurCmd.tcl
  Prepare to execute
prepareQuery { query length } - sqlrcurCmd.tcl
  Prepare to execute "query" with length "length".

### R

resumeCachedResultSet { id filename } - sqlrcurCmd.tcl
  Resumes a result set previously left open using suspendSession and continues caching the result set to "filename".
resumeResultSet { id } - sqlrcurCmd.tcl
  Resumes a result set previously left open using suspendSession.
resumeSession { port socket } - sqlrconCmd.tcl
  Resumes a session previously left open using suspendSession {}.
rollback { } - sqlrconCmd.tcl
  Issues a rollback.
rowCount { } - sqlrcurCmd.tcl
  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

### S

selectDatabase { database } - sqlrconCmd.tcl
  Sets the current database/schema to
sendFileQuery { path filename } - sqlrcurCmd.tcl
  Sends the query in file "path"/"filename" directly and gets a result
sendQuery { query } - sqlrcurCmd.tcl
  Sends "query" directly and gets a result
sendQueryWithLength { query length } - sqlrcurCmd.tcl
  Sends "query" with length "length" directly and gets a result set.
serverVersion { } - sqlrconCmd.tcl
  Returns the version of the sqlrelay server
setAuthenticationTimeout { timeoutsec timeoutusec } - sqlrconCmd.tcl
  Sets the authentication timeout in seconds and milliseconds.
setCacheTtl { ttl } - sqlrcurCmd.tcl
  Sets the time-to-live for cached result sets.
setClientInfo { clientinfo } - sqlrconCmd.tcl
  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
setConnectTimeout { timeoutsec timeoutusec } - sqlrconCmd.tcl
  Sets the server connect timeout in seconds and milliseconds.
setDebugFile { debugfilename } - sqlrconCmd.tcl
  Allows you to specify a file to write debug to.
setResponseTimeout { timeoutsec timeoutusec } - sqlrconCmd.tcl
  Sets the response timeout (for queries, commits, rollbacks, pings,
setResultSetBufferSize { rows } - sqlrcurCmd.tcl
  Sets the number of rows of the result set to buffer at a time.
sqlrconCmd { server port socket user password retrytime tries } - sqlrconCmd.tcl
  Initiates a connection to "server" on "port" or to the unix "socket" on the local machine and authenticates with "user" and "password".
sqlrconCmd.tcl - file found in `../../../src/api/tcl`
sqlrconDelete { } - sqlrconCmd.tcl
  Disconnects and ends the session if it hasn't been ended
sqlrcurCmd { sqlrc } - sqlrcurCmd.tcl
  Creates a cursor to run queries and fetch result sets using connecton
sqlrcurCmd.tcl - file found in `../../../src/api/tcl`
sqlrcurDelete { } - sqlrcurCmd.tcl
  Destroys the cursor and cleans up all associated result set
substitution { variable value precision scale } - sqlrcurCmd.tcl
  Defines a substitution
substitutions { variables values precisions scales } - sqlrcurCmd.tcl
  Defines an array of substitution
suspendResultSet { } - sqlrcurCmd.tcl
  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
suspendSession { } - sqlrconCmd.tcl
  Disconnects this connection from the current session but leaves the session open so that another connection can connect to it using resumeSession

### T

totalRows { } - sqlrcurCmd.tcl
  Returns the total number of rows that will be returned in the result set.

### U

upperCaseColumnNames { } - sqlrcurCmd.tcl
  Columns names are converted to upper

### V

validateBinds { } - sqlrcurCmd.tcl
  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.
validBind { variable } - sqlrcurCmd.tcl
  Returns true if "variable" was a valid bind variable of the

Index by: file name | procedure name | procedure call | annotation
File generated 2016-03-15 at 02:51.