../../../src/api/tcl/sqlrcurCmd.tcl
Procedure Summary |
affectedRows { } Returns the number of rows that were updated inserted or deleted by the query. |
cacheOff { } Sets query caching |
cacheToFile { filename } Sets query caching on. |
clearBinds { } Clears all bind |
closeResultSet { } Closes the current result set, if one is open. |
colCount { } Returns the number of columns in the current result |
countBindVariables { } Parses the previously prepared query counts the number of bind variables defined in it and returns that |
defineOutputBindBlob { variable } Defines a binary lob output bind |
defineOutputBindClob { variable } Defines a character lob output bind |
defineOutputBindCursor { variable } Defines a cursor output bind |
defineOutputBindDouble { variable } Defines a decimal output bind |
defineOutputBindInteger { variable } Defines an integer output bind |
defineOutputBindString { variable bufferlength } Defines an output bind variable. |
dontGetColumnInfo { } Tells the server not to send any column info {names types sizes}. |
endOfResultSet { } Returns false if part of the result set is still pending on the server and true if not. |
errorMessage { } If a query failed and generated an error the error message is available here. |
errorNumber { } If a query failed and generated an error, the error number is available here. |
executeQuery { } Execute the query that was previously prepared and |
fetchFromBindCursor { } Fetch from a cursor that was returned as an output bind |
firstRowIndex { } Returns the index of the first buffered row. |
getCacheFileName { } Returns the name of the file containing the cached result |
getColumnInfo { } Tells the server to send column |
getColumnIsAutoIncrementByIndex { col } Returns true if the specified column auto-increments and false |
getColumnIsAutoIncrementByName { col } Returns true if the specified column auto-increments and false |
getColumnIsBinaryByIndex { col } Returns true if the specified column contains binary data and false |
getColumnIsBinaryByName { col } Returns true if the specified column contains binary data and false |
getColumnIsNullableByIndex { col } Returns true if the specified column can contain nulls and false |
getColumnIsNullableByName { col } Returns true if the specified column can contain nulls and false |
getColumnIsPartOfKeyByIndex { col } Returns true if the specified column is part of a composite key and false |
getColumnIsPartOfKeyByName { col } Returns true if the specified column is part of a composite key and false |
getColumnIsPrimaryKeyByIndex { col } Returns true if the specified column is a primary key and false |
getColumnIsPrimaryKeyByName { col } Returns true if the specified column is a primary key and false |
getColumnIsUniqueByIndex { col } Returns true if the specified column is unique and false |
getColumnIsUniqueByName { col } Returns true if the specified column is unique and false |
getColumnIsUnsignedByIndex { col } Returns true if the specified column is an unsigned number and false |
getColumnIsUnsignedByName { col } Returns true if the specified column is an unsigned number and false |
getColumnIsZeroFilledByIndex { col } Returns true if the specified column was created with the zero-fill flag and false |
getColumnIsZeroFilledByName { col } Returns true if the specified column was created with the zero-fill flag and false |
getColumnLengthByIndex { col } Returns the number of bytes required on the server to store the data for the specified |
getColumnLengthByName { col } Returns the number of bytes required on the server to store the data for the specified |
getColumnList { table wild } Sends a query that returns a list of columns in the table specified by the "table" parameter matching "wild". |
getColumnName { col } Returns the name of the specified |
getColumnNameByIndex { col } Returns the name of the specified |
getColumnNames { } Returns a null terminated array of the column names of the current result |
getColumnPrecisionByIndex { col } Returns the precision of the specified column. |
getColumnPrecisionByName { col } Returns the precision of the specified column. |
getColumnScaleByIndex { col } Returns the scale of the specified column. |
getColumnScaleByName { col } Returns the scale of the specified column. |
getColumnTypeByIndex { col } Returns the type of the specified |
getColumnTypeByName { col } Returns the type of the specified |
getColumnTypeByName { col } Returns the type of the specified |
getDatabaseList { wild } Sends a query that returns a list of databases/schemas matching "wild". |
getFieldAsDoubleByIndex { row col } Returns the specified field as a |
getFieldAsDoubleByName { row col } Returns the specified field as a |
getFieldAsIntegerByIndex { row col } Returns the specified field as an |
getFieldAsIntegerByName { row col } Returns the specified field as an |
getFieldByIndex { row col } Returns the specified field as a |
getFieldByName { row col } Returns the specified field as a |
getFieldLengthByIndex { row col } Returns the length of the specified |
getFieldLengthByName { row col } Returns the length of the specified |
getLongestByIndex { col } Returns the length of the longest field in the specified |
getLongestByName { col } Returns the length of the longest field in the specified |
getOutputBindBlob { variable } Get the value stored in a previously defined binary lob output bind |
getOutputBindClob { variable } Get the value stored in a previously defined character lob output bind |
getOutputBindCursor { variable } Get the cursor associated with a previously defined output bind |
getOutputBindDouble { variable } Get the value stored in a previously defined decimal output bind |
getOutputBindInteger { variable } Get the value stored in a previously defined integer output bind |
getOutputBindLength { variable } Get the length of the value stored in a previously defined output bind |
getOutputBindString { variable } Get the value stored in a previously defined string output bind |
getResultSetBufferSize { } Returns the number of result set rows that will be buffered at a time or 0 for the entire result |
getResultSetId { } Returns the internal ID of this result set. |
getRow { row } Returns a null terminated array of the values of the fields in the specified |
getRowLengths { row } Returns a null terminated array of the lengths of the fields in the specified |
getTableList { wild } Sends a query that returns a list of tables matching "wild". |
inputBind { variable value precision scale } Defines a input bind variable. |
inputBindBlob { variable value size } Defines a binary lob input bind |
inputBindClob { variable value size } Defines a character lob input bind |
inputBinds { variables values precisions scales } Defines an array of input bind |
lowerCaseColumnNames { } Columns names are converted to lower |
mixedCaseColumnNames { } Columns names are returned in the same case as they are defined in the database. |
openCachedResultSet { filename } Opens a cached result set. |
prepareFileQuery { path filename } Prepare to execute the contents of "path"/"filename". |
prepareQuery { query length } Prepare to execute "query" with length "length". |
prepareQuery { query length } Prepare to execute "query" with length "length". |
resumeCachedResultSet { id filename } Resumes a result set previously left open using suspendSession and continues caching the result set to "filename". |
resumeResultSet { id } Resumes a result set previously left open using suspendSession. |
rowCount { } 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 |
sendFileQuery { path filename } Sends the query in file "path"/"filename" directly and gets a result |
sendQuery { query } Sends "query" directly and gets a result |
sendQueryWithLength { query length } Sends "query" with length "length" directly and gets a result set. |
setCacheTtl { ttl } Sets the time-to-live for cached result sets. |
setResultSetBufferSize { rows } Sets the number of rows of the result set to buffer at a time. |
sqlrcurCmd { sqlrc } Creates a cursor to run queries and fetch result sets using connecton |
sqlrcurDelete { } Destroys the cursor and cleans up all associated result set |
substitution { variable value precision scale } Defines a substitution |
substitutions { variables values precisions scales } Defines an array of substitution |
suspendResultSet { } 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 |
totalRows { } Returns the total number of rows that will be returned in the result set. |
upperCaseColumnNames { } Columns names are converted to upper |
validateBinds { } 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 } Returns true if "variable" was a valid bind variable of the |
Procedure Detail |
proc affectedRows { }
proc cacheOff { }
proc cacheToFile { filename }
proc clearBinds { }
proc closeResultSet { }
proc colCount { }
proc countBindVariables { }
proc defineOutputBindBlob { variable }
proc defineOutputBindClob { variable }
proc defineOutputBindCursor { variable }
proc defineOutputBindDouble { variable }
proc defineOutputBindInteger { variable }
proc defineOutputBindString { variable bufferlength }
proc dontGetColumnInfo { }
proc endOfResultSet { }
proc errorMessage { }
proc errorNumber { }
proc executeQuery { }
proc fetchFromBindCursor { }
proc firstRowIndex { }
proc getCacheFileName { }
proc getColumnInfo { }
proc getColumnIsAutoIncrementByIndex { col }
proc getColumnIsAutoIncrementByName { col }
proc getColumnIsBinaryByIndex { col }
proc getColumnIsBinaryByName { col }
proc getColumnIsNullableByIndex { col }
proc getColumnIsNullableByName { col }
proc getColumnIsPartOfKeyByIndex { col }
proc getColumnIsPartOfKeyByName { col }
proc getColumnIsPrimaryKeyByIndex { col }
proc getColumnIsPrimaryKeyByName { col }
proc getColumnIsUniqueByIndex { col }
proc getColumnIsUniqueByName { col }
proc getColumnIsUnsignedByIndex { col }
proc getColumnIsUnsignedByName { col }
proc getColumnIsZeroFilledByIndex { col }
proc getColumnIsZeroFilledByName { col }
proc getColumnLengthByIndex { col }
proc getColumnLengthByName { col }
proc getColumnList { table wild }
proc getColumnName { col }
proc getColumnNameByIndex { col }
proc getColumnNames { }
proc getColumnPrecisionByIndex { col }
proc getColumnPrecisionByName { col }
proc getColumnScaleByIndex { col }
proc getColumnScaleByName { col }
proc getColumnTypeByIndex { col }
proc getColumnTypeByName { col }
proc getColumnTypeByName { col }
proc getDatabaseList { wild }
proc getFieldAsDoubleByIndex { row col }
proc getFieldAsDoubleByName { row col }
proc getFieldAsIntegerByIndex { row col }
proc getFieldAsIntegerByName { row col }
proc getFieldByIndex { row col }
proc getFieldByName { row col }
proc getFieldLengthByIndex { row col }
proc getFieldLengthByName { row col }
proc getLongestByIndex { col }
proc getLongestByName { col }
proc getOutputBindBlob { variable }
proc getOutputBindClob { variable }
proc getOutputBindCursor { variable }
proc getOutputBindDouble { variable }
proc getOutputBindInteger { variable }
proc getOutputBindLength { variable }
proc getOutputBindString { variable }
proc getResultSetBufferSize { }
proc getResultSetId { }
proc getRow { row }
proc getRowLengths { row }
proc getTableList { wild }
proc inputBind { variable value precision scale }
proc inputBindBlob { variable value size }
proc inputBindClob { variable value size }
proc inputBinds { variables values precisions scales }
proc lowerCaseColumnNames { }
proc mixedCaseColumnNames { }
proc openCachedResultSet { filename }
proc prepareFileQuery { path filename }
proc prepareQuery { query length }
proc prepareQuery { query length }
proc resumeCachedResultSet { id filename }
proc resumeResultSet { id }
proc rowCount { }
proc sendFileQuery { path filename }
proc sendQuery { query }
proc sendQueryWithLength { query length }
proc setCacheTtl { ttl }
proc setResultSetBufferSize { rows }
proc sqlrcurCmd { sqlrc }
proc sqlrcurDelete { }
proc substitution { variable value precision scale }
proc substitutions { variables values precisions scales }
proc suspendResultSet { }
proc totalRows { }
proc upperCaseColumnNames { }
proc validateBinds { }
proc validBind { variable }