Index
Date: 2016-03-15

A B C D E F G I L M O P R S T U V

## A

affectedRows() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the number of rows that were updated, inserted or deleted by the query.
autoCommitOff() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Instructs the database to wait for the client to tell it when to commit.
autoCommitOn() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Instructs the database to perform a commit after every successful query.

## B

begin() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Begins a transaction.
bindFormat() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Returns a string representing the format of the bind variables used in the db.

## C

cacheOff() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Sets query caching off.
cacheToFile(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Sets query caching on.
clearBinds() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Clear all bind variables.
clientVersion() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Returns the version of the sqlrelay client software
closeResultSet() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Closes the current result set, if one is open.
colCount() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the number of columns in the current result set.
com.firstworks.sqlrelay - package com.firstworks.sqlrelay
commit() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Issues a commit.
connection - Variable in class com.firstworks.sqlrelay.SQLRConnection
  connection is used internally, it's just public to make the JNI wrapper work faster.
connection - Variable in class com.firstworks.sqlrelay.SQLRCursor
countBindVariables() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Parses the previously prepared query, counts the number of bind variables defined in it and returns that number.
cursor - Variable in class com.firstworks.sqlrelay.SQLRCursor
  cursor and connection are used internally, they're just public to make the JNI wrapper work faster.

## D

dbHostName() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Returns the host name of the database
dbIpAddress() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Returns the ip address of the database
dbVersion() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Returns the version of the database
debugOff() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Turns debugging off.
debugOn() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Causes verbose debugging information to be sent to standard output.
defineOutputBindBlob(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define an output bind variable.
defineOutputBindClob(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define an output bind variable.
defineOutputBindCursor(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define an output bind variable.
defineOutputBindDouble(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define a double precision floating point output bind variable.
defineOutputBindInteger(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define an integer output bind variable.
defineOutputBindString(String, int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define a string output bind variable.
delete() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Disconnects and ends the session if it hasn't been ended already.
delete() - Method in class com.firstworks.sqlrelay.SQLRCursor
disableEncryption() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Disables encryption.
dontGetColumnInfo() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Tells the server not to send any column info (names, types, sizes).

## E

enableKerberos(String, String, String) - Method in class com.firstworks.sqlrelay.SQLRConnection
  Enables Kerberos authentication and encryption.
enableTls(String, String, String, String, String, String, short) - Method in class com.firstworks.sqlrelay.SQLRConnection
  Enables TLS/SSL encryption, and optionally authentication.
endOfResultSet() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns 0 if part of the result set is still pending on the server and 1 if not.
endSession() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Ends the session.
errorMessage() - Method in class com.firstworks.sqlrelay.SQLRConnection
  If an operation failed and generated an error, the error message is available here.
errorMessage() - Method in class com.firstworks.sqlrelay.SQLRCursor
  If a query failed and generated an error, the error message is available here.
errorNumber() - Method in class com.firstworks.sqlrelay.SQLRConnection
  If an operation failed and generated an error, the error number is available here.
errorNumber() - Method in class com.firstworks.sqlrelay.SQLRCursor
  If a query failed and generated an error, the error number is available here.
executeQuery() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Execute the query that was previously prepared and bound.

## F

fetchFromBindCursor() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Fetch from a cursor that was returned as an output bind variable.
firstRowIndex() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the index of the first buffered row.

## G

getCacheFileName() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the name of the file containing the cached result set.
getClientInfo() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Returns the string that was set by setClientInfo().
getColumnInfo() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Tells the server to send column info.
getColumnIsAutoIncrement(int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns true if the specified column auto-increments and false otherwise.
getColumnIsAutoIncrement(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns true if the specified column auto-increments and false otherwise.
getColumnIsBinary(int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns true if the specified column contains binary data and false otherwise.
getColumnIsBinary(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns true if the specified column contains binary data and false otherwise.
getColumnIsNullable(int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns true if the specified column can contain nulls and false otherwise.
getColumnIsNullable(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns true if the specified column can contain nulls and false otherwise.
getColumnIsPartOfKey(int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns true if the specified column is part of a composite key and false otherwise.
getColumnIsPartOfKey(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns true if the specified column is part of a composite key and false otherwise.
getColumnIsPrimaryKey(int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns true if the specified column is a primary key and false otherwise.
getColumnIsPrimaryKey(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns true if the specified column is a primary key and false otherwise.
getColumnIsUnique(int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns true if the specified column is unique and false otherwise.
getColumnIsUnique(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns true if the specified column is unique and false otherwise.
getColumnIsUnsigned(int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns true if the specified column is an unsigned number and false otherwise.
getColumnIsUnsigned(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns true if the specified column is an unsigned number and false otherwise.
getColumnIsZeroFilled(int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns true if the specified column was created with the zero-fill flag and false otherwise.
getColumnIsZeroFilled(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns true if the specified column was created with the zero-fill flag and false otherwise.
getColumnLength(int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the length of the specified column.
getColumnLength(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the length of the specified column.
getColumnList(String, String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Sends a query that returns a list of columns in the table specified by the "table" parameter matching "wild".
getColumnName(int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the name of the specified column.
getColumnNames() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns a null terminated array of the column names of the current result set.
getColumnPrecision(int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the precision of the specified column.
getColumnPrecision(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the precision of the specified column.
getColumnScale(int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the scale of the specified column.
getColumnScale(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the scale of the specified column.
getColumnType(int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the type of the specified column.
getColumnType(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the type of the specified column.
getConnectionPort() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Returns the inet port that the connection is communicating over.
getConnectionSocket() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Returns the unix socket that the connection is communicating over.
getCurrentDatabase() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Returns the database/schema that is currently in use
getDatabaseList(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Sends a query that returns a list of databases/schemas matching "wild".
getDebug() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Returns 0 if debugging is off and 1 if debugging is on.
getField(long, int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns a pointer to the value of the specified row and column.
getField(long, String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns a pointer to the value of the specified row and column.
getFieldAsByteArray(long, int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns a pointer to the value of the specified row and column.
getFieldAsByteArray(long, String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the length of the specified row and column.
getFieldAsDouble(long, int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the specified field as a double floating point number
getFieldAsDouble(long, String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the specified field as a double floating point number
getFieldAsInteger(long, int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the specified field as a long integer
getFieldAsInteger(long, String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the specified field as a long integer
getFieldLength(long, int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the length of the specified row and column.
getFieldLength(long, String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the length of the specified row and column.
getLastInsertId() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Returns the value of the autoincrement column for the last insert
getLongest(int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the length of the longest field in the specified column.
getLongest(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the length of the longest field in the specified column.
getNullsAsEmptyStrings() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Tells the connection to return NULL fields and output bind variables as empty strings.
getNullsAsNulls() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Tells the connection to return NULL fields and output bind variables as NULL's rather than as empty strings.
getOutputBindAsByteArray(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Get the length of the value stored in a previously defined output bind variable.
getOutputBindBlob(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Get the value stored in a previously defined output bind variable.
getOutputBindClob(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Get the value stored in a previously defined output bind variable.
getOutputBindCursor(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Get the cursor associated with a previously defined output bind variable.
getOutputBindDouble(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Get the value stored in a previously defined output bind variable as a double precision floating point number.
getOutputBindInteger(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Get the value stored in a previously defined output bind variable as a long integer.
getOutputBindLength(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Get the length of the value stored in a previously defined output bind variable.
getOutputBindString(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Get the value stored in a previously defined output bind variable.
getResultSetBufferSize() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the number of result set rows that will be buffered at a time or 0 for the entire result set.
getResultSetId() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the internal ID of this result set.
getRow(long) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns a null terminated array of the values of the fields in the specified row.
getRowLengths(long) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns a null terminated array of the lengths of the fields in the specified row.
getTableList(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Sends a query that returns a list of tables matching "wild".

## I

identify() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Returns the type of database: oracle, postgresql, mysql, etc.
inputBind(String, String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define an input bind variable.
inputBind(String, String, int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define an input bind variable.
inputBind(String, long) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define an input bind variable.
inputBind(String, double, int, int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define an input bind variable.
inputBindBlob(String, byte[], long) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define an input bind variable.
inputBindClob(String, String, long) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define an input bind variable.
inputBinds(String[], String[]) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define an array of input bind variables.
inputBinds(String[], long[]) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define an array of input bind variables.
inputBinds(String[], double[], int[], int[]) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define an array of input bind variables.

## L

lowerCaseColumnNames() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Columns names are converted to lower case.

## M

mixedCaseColumnNames() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Columns names are returned in the same case as they are defined in the database.

## O

openCachedResultSet(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Opens a cached result set.

## P

ping() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Returns 1 if the database is up and 0 if it's down.
prepareFileQuery(String, String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Prepare to execute "query" with length "length".
prepareQuery(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Prepare to execute "query".
prepareQuery(String, int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Prepare to execute the contents of "path"/"filename".

## R

resumeCachedResultSet(short, String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Resumes a result set previously left open using suspendSession() and continues caching the result set to "filename".
resumeResultSet(short) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Resumes a result set previously left open using suspendSession().
resumeSession(short, String) - Method in class com.firstworks.sqlrelay.SQLRConnection
  Resumes a session previously left open using suspendSession().
rollback() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Issues a rollback.
rowCount() - Method in class com.firstworks.sqlrelay.SQLRCursor
  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).

## S

selectDatabase(String) - Method in class com.firstworks.sqlrelay.SQLRConnection
  Sets the current database/schema to "database"
sendFileQuery(String, String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Sends "query" with length "length" and gets a result set.
sendQuery(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Sends "query" and gets a result set.
sendQuery(String, int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Sends the query in file "path"/"filename" and gets a result set.
serverVersion() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Returns the version of the sqlrelay server software
setAuthenticationTimeout(int, int) - Method in class com.firstworks.sqlrelay.SQLRConnection
  Sets the authentication timeout in seconds and milliseconds.
setCacheTtl(int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Sets the time-to-live for cached result sets.
setClientInfo(String) - Method in class com.firstworks.sqlrelay.SQLRConnection
  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.
setConnectTimeout(int, int) - Method in class com.firstworks.sqlrelay.SQLRConnection
  Sets the server connect timeout in seconds and milliseconds.
setDebugFile(String) - Method in class com.firstworks.sqlrelay.SQLRConnection
  Allows you to specify a file to write debug to.
setResponseTimeout(int, int) - Method in class com.firstworks.sqlrelay.SQLRConnection
  Sets the response timeout (for queries, commits, rollbacks, pings, etc.) in seconds and milliseconds.
setResultSetBufferSize(long) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Sets the number of rows of the result set to buffer at a time.
SQLRConnection - Class in com.firstworks.sqlrelay
SQLRConnection(String, short, String, String, String, int, int) - Constructor for class com.firstworks.sqlrelay.SQLRConnection
  Initiates a connection to "server" on "port" or to the unix "socket" on the local machine and auths with "user" and "password".
SQLRCursor - Class in com.firstworks.sqlrelay
SQLRCursor(SQLRConnection) - Constructor for class com.firstworks.sqlrelay.SQLRCursor
substitution(String, String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define a substitution variable.
substitution(String, long) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define a substitution variable.
substitution(String, double, int, int) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define a substitution variable.
substitutions(String[], String[]) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define an array of substitution variables.
substitutions(String[], long[]) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define an array of substitution variables.
substitutions(String[], double[], int[], int[]) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Define an array of substitution variables.
suspendResultSet() - Method in class com.firstworks.sqlrelay.SQLRCursor
  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().
suspendSession() - Method in class com.firstworks.sqlrelay.SQLRConnection
  Disconnects this connection from the current session but leaves the session open so that another connection can connect to it using resumeSession().

## T

totalRows() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns the total number of rows that will be returned in the result set.

## U

upperCaseColumnNames() - Method in class com.firstworks.sqlrelay.SQLRCursor
  Columns names are converted to upper case.

## V

validateBinds() - Method in class com.firstworks.sqlrelay.SQLRCursor
  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(String) - Method in class com.firstworks.sqlrelay.SQLRCursor
  Returns true if "variable" was a valid bind variable of the query

A B C D E F G I L M O P R S T U V