vortex.sql
Class vortexConnection

java.lang.Object
  extended by vortex.sql.vortexConnection
All Implemented Interfaces:
java.sql.Connection, java.sql.Wrapper

public class vortexConnection
extends java.lang.Object
implements java.sql.Connection

A connection (session) with a specific database.


Field Summary
 
Fields inherited from interface java.sql.Connection
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
 
Method Summary
 void clearWarnings()
          Clear the warning chain.
 void close()
          Close the database connection.
 void commit()
          Commit a transaction.
 java.sql.Array createArrayOf(java.lang.String typeName, java.lang.Object[] elements)
          Not supported by VORTEXjdbc.
 java.sql.Blob createBlob()
          Not supported by VORTEXjdbc.
 java.sql.Clob createClob()
          Not supported by VORTEXjdbc.
 java.sql.NClob createNClob()
          Not supported by VORTEXjdbc.
 java.sql.SQLXML createSQLXML()
          Not supported by VORTEXjdbc.
 java.sql.Statement createStatement()
          Create a SQL statement object.
 java.sql.Statement createStatement(int resultSetType, int resultSetConcurrency)
          Creates a Statement object that will generate ResultSet objects with the given type and concurrency.
 java.sql.Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability.
 java.sql.Struct createStruct(java.lang.String typeName, java.lang.Object[] attributes)
          Not supported by VORTEXjdbc.
 void disableAutoClose()
          Disable closing of statements and result sets.
 boolean getAutoClose()
          Get the current auto-close state.
 boolean getAutoCommit()
          Getting auto-commit mode.
 java.lang.String getCatalog()
          Return the catalog.
 java.util.Properties getClientInfo()
          Not supported by VORTEXjdbc.
 java.lang.String getClientInfo(java.lang.String name)
          Not supported by VORTEXjdbc.
 int getHoldability()
          Retrieves the current holdability of ResultSet objects created using this Connection object.
 java.sql.DatabaseMetaData getMetaData()
          Return information about the database.
 java.lang.String getSchema()
           
 int getTransactionIsolation()
          Retrive the transaction isolation level for the connection.
 java.util.Map<java.lang.String,java.lang.Class<?>> getTypeMap()
          Get type map.
 java.lang.String getURL()
          Gives the URL used to connect to the database.
 java.lang.String getUser()
          Retrieve the user name of the connection.
 java.sql.SQLWarning getWarnings()
          Retrieving a chain of warnings related to the connection.
 boolean isClosed()
          Checking the connection status.
 boolean isReadOnly()
          Checking the read-only status of the connection.
 boolean isValid(int timeout)
          Returns true if the connection has not been closed and is still valid.
 boolean isWrapperFor(java.lang.Class<?> Connection)
           
 java.lang.String nativeSQL(java.lang.String sql)
          Converts the given SQL statement into the system's native SQL grammar.
 java.sql.CallableStatement prepareCall(java.lang.String sql)
          Not supported by VORTEXjdbc.
 java.sql.CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency)
          Not supported by VORTEXjdbc.
 java.sql.CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          Not supported by VORTEXjdbc.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql)
          Create an SQL pre-compiled statement.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int autoGeneratedKeys)
          Not supported by VORTEXjdbc.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int[] columnIndexes)
          Not supported by VORTEXjdbc.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency)
          Creates a PreparedStatement object that will generate ResultSet objects with the given type and concurrency.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, java.lang.String[] columnNames)
          Not supported by VORTEXjdbc.
 void releaseSavepoint(java.sql.Savepoint savepoint)
          Not supported by VORTEXjdbc.
 void rollback()
          Rollback a transaction.
 void rollback(java.sql.Savepoint savepoint)
          Not supported by VORTEXjdbc.
 void setAutoClose(boolean autoClose)
          Not supported by VORTEXjdbc.
 void setAutoCommit(boolean b)
          Setting the auto-commit mode.
 void setCatalog(java.lang.String str)
          Select a sub-space of the target database.
 void setClientInfo(java.util.Properties properties)
          Not supported by VORTEXjdbc.
 void setClientInfo(java.lang.String name, java.lang.String value)
          Not supported by VORTEXjdbc.
 void setHoldability(int holdability)
          Changes the holdability of ResultSet objects created using this Connection object to the given holdability.
 void setReadOnly(boolean b)
          Puts this connection in read-only mode as a hint to the driver to enable database optimizations.
 java.sql.Savepoint setSavepoint()
          Not supported by VORTEXjdbc.
 java.sql.Savepoint setSavepoint(java.lang.String name)
          Not supported by VORTEXjdbc.
 void setTransactionIsolation(int level)
          Set the transaction isolation level for the connection.
 void setTypeMap(java.util.Map<java.lang.String,java.lang.Class<?>> map)
          Not supported by VORTEXjdbc.
<T> T
unwrap(java.lang.Class<T> Connection)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

createStatement

public java.sql.Statement createStatement()
                                   throws java.sql.SQLException
Create a SQL statement object.

Specified by:
createStatement in interface java.sql.Connection
Returns:
a new statement object
Throws:
java.sql.SQLException - thrown in the event the creation fails

createStatement

public java.sql.Statement createStatement(int resultSetType,
                                          int resultSetConcurrency)
                                   throws java.sql.SQLException
Creates a Statement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the createStatement method above, but it allows the default result set type and result set concurrency type to be overridden.

Specified by:
createStatement in interface java.sql.Connection
Returns:
a new statement object
Throws:
java.sql.SQLException - thrown in the event the creation fails

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql)
                                            throws java.sql.SQLException
Create an SQL pre-compiled statement.

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - SQL statement
Returns:
the prepared SQL statement
Throws:
java.sql.SQLException - gets if the prepare fails

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int resultSetType,
                                                   int resultSetConcurrency)
                                            throws java.sql.SQLException
Creates a PreparedStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareStatement method above, but it allows the default result set type and result set concurrency type to be overridden.

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - SQL statement
resultSetType - - a result set type; see ResultSet.TYPE_XXX
resultSetConcurrency - - a concurrency type; see ResultSet.CONCUR_XXX
Returns:
a new statement object
Throws:
java.sql.SQLException - thrown in the event the creation fails

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String sql)
                                       throws java.sql.SQLException

Not supported by VORTEXjdbc. Create a stored procedure call.

Specified by:
prepareCall in interface java.sql.Connection
Parameters:
sql - SQL statement
Throws:
java.sql.SQLException - is thrown any time this is called

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String sql,
                                              int resultSetType,
                                              int resultSetConcurrency)
                                       throws java.sql.SQLException

Not supported by VORTEXjdbc. Create a stored procedure call.

Specified by:
prepareCall in interface java.sql.Connection
Parameters:
sql - SQL statement
resultSetType -
resultSetConcurrency -
Throws:
java.sql.SQLException - is thrown any time this is called

setTypeMap

public void setTypeMap(java.util.Map<java.lang.String,java.lang.Class<?>> map)
                throws java.sql.SQLException

Not supported by VORTEXjdbc. Set type map.

Specified by:
setTypeMap in interface java.sql.Connection
Parameters:
map -
Throws:
java.sql.SQLException - is thrown any time this is called

getTypeMap

public java.util.Map<java.lang.String,java.lang.Class<?>> getTypeMap()
                                                              throws java.sql.SQLException
Get type map.

Specified by:
getTypeMap in interface java.sql.Connection
Returns:
the map in use, NULL if not set
Throws:
java.sql.SQLException - is thrown any time this is called

nativeSQL

public java.lang.String nativeSQL(java.lang.String sql)
                           throws java.sql.SQLException
Converts the given SQL statement into the system's native SQL grammar. A driver may convert the JDBC sql grammar into its system's native SQL grammar prior to sending it; this method returns the native form of the statement that the driver would have sent.

Specified by:
nativeSQL in interface java.sql.Connection
Returns:
the SQL string
Throws:
java.sql.SQLException - if a database access error occurs

setAutoCommit

public void setAutoCommit(boolean b)
                   throws java.sql.SQLException
Setting the auto-commit mode.

Specified by:
setAutoCommit in interface java.sql.Connection
Parameters:
b - this set auto commit
Throws:
java.sql.SQLException

getAutoCommit

public boolean getAutoCommit()
                      throws java.sql.SQLException
Getting auto-commit mode.

Specified by:
getAutoCommit in interface java.sql.Connection
Returns:
the true/false
Throws:
java.sql.SQLException

commit

public void commit()
            throws java.sql.SQLException
Commit a transaction.

Specified by:
commit in interface java.sql.Connection
Throws:
java.sql.SQLException - thrown in the event the commit fails

rollback

public void rollback()
              throws java.sql.SQLException
Rollback a transaction.

Specified by:
rollback in interface java.sql.Connection
Throws:
java.sql.SQLException - thrown in the event the rollback fails

close

public void close()
           throws java.sql.SQLException
Close the database connection.

Specified by:
close in interface java.sql.Connection
Throws:
java.sql.SQLException - thrown in the event of an cursor close fails

isClosed

public boolean isClosed()
                 throws java.sql.SQLException
Checking the connection status.

Specified by:
isClosed in interface java.sql.Connection
Returns:
true if the connection is closed, false otherwise
Throws:
java.sql.SQLException - Not apply

getMetaData

public java.sql.DatabaseMetaData getMetaData()
                                      throws java.sql.SQLException
Return information about the database.

Specified by:
getMetaData in interface java.sql.Connection
Returns:
a DatabaseMetaData object with database info
Throws:
java.sql.SQLException - thrown if an error occurs reading meta-data

setReadOnly

public void setReadOnly(boolean b)
                 throws java.sql.SQLException
Puts this connection in read-only mode as a hint to the driver to enable database optimizations. Ignored by GENESIS.

Specified by:
setReadOnly in interface java.sql.Connection
Parameters:
b - boolean read-only
Throws:
java.sql.SQLException - Not apply

isReadOnly

public boolean isReadOnly()
                   throws java.sql.SQLException
Checking the read-only status of the connection.

Specified by:
isReadOnly in interface java.sql.Connection
Returns:
status of read-only
Throws:
java.sql.SQLException - Not apply

setCatalog

public void setCatalog(java.lang.String str)
                throws java.sql.SQLException
Select a sub-space of the target database. It has no meaning to VORTEXjdbc.

Specified by:
setCatalog in interface java.sql.Connection
Parameters:
str - the catalog
Throws:
java.sql.SQLException - thrown method does not support

getCatalog

public java.lang.String getCatalog()
                            throws java.sql.SQLException
Return the catalog.

Specified by:
getCatalog in interface java.sql.Connection
Returns:
the catalog name
Throws:
java.sql.SQLException - thrown method does not support

setTransactionIsolation

public void setTransactionIsolation(int level)
                             throws java.sql.SQLException
Set the transaction isolation level for the connection. GENESISsql data sources do not support dynamically modifying the transaction isolation level.

Note: setTransactionIsolation cannot be called while in the middle of a transaction.

Specified by:
setTransactionIsolation in interface java.sql.Connection
Parameters:
level - TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, or TRANSACTION_SERIALIZABLE.
Throws:
java.sql.SQLException
See Also:
DatabaseMetaData.supportsTransactionIsolationLevel(int)

getTransactionIsolation

public int getTransactionIsolation()
                            throws java.sql.SQLException
Retrive the transaction isolation level for the connection.

VORTEXjdbc GENESISsql always returns TRANSACTION_READ_UNCOMMITTED

Specified by:
getTransactionIsolation in interface java.sql.Connection
Returns:
TRANSACTION_DIRTY_READ always
Throws:
java.sql.SQLException - Not apply

disableAutoClose

public void disableAutoClose()
                      throws java.sql.SQLException
Disable closing of statements and result sets.

Throws:
java.sql.SQLException

setAutoClose

public void setAutoClose(boolean autoClose)
                  throws java.sql.SQLException

Not supported by VORTEXjdbc. When a Connection is in auto-close mode all its PreparedStatements, CallableStatements, and ResultSets will be closed when a transaction is committed or rolled back. By default, a new Connection is in auto-close mode.

When auto-close is disabled JDBC attempts to keep all statements and ResultSets open across commits and rollbacks. However the actual behaviour will vary depending on what the underlying database supports. Some databases allow these objects to remain open across commits whereas other databases insist on closing them.

Parameters:
autoClose - true enables auto-close, false disables auto-close.
Throws:
java.sql.SQLException - Not apply
See Also:
DatabaseMetaData.supportsOpenCursorsAcrossCommit(), DatabaseMetaData.supportsOpenCursorsAcrossRollback(), DatabaseMetaData.supportsOpenStatementsAcrossCommit(), DatabaseMetaData.supportsOpenStatementsAcrossRollback()

getAutoClose

public boolean getAutoClose()
                     throws java.sql.SQLException
Get the current auto-close state.

Returns:
Current state of auto-close mode.
Throws:
java.sql.SQLException - Not apply

getWarnings

public java.sql.SQLWarning getWarnings()
                                throws java.sql.SQLException
Retrieving a chain of warnings related to the connection.

Specified by:
getWarnings in interface java.sql.Connection
Returns:
the chain of warnings for this connection
Throws:
java.sql.SQLException - Not apply

clearWarnings

public void clearWarnings()
                   throws java.sql.SQLException
Clear the warning chain.

Specified by:
clearWarnings in interface java.sql.Connection
Throws:
java.sql.SQLException - Not apply

getURL

public final java.lang.String getURL()
Gives the URL used to connect to the database.

Returns:
the URL

getUser

public final java.lang.String getUser()
Retrieve the user name of the connection.

Returns:
the user name used to connect to the database

setHoldability

public void setHoldability(int holdability)
                    throws java.sql.SQLException
Changes the holdability of ResultSet objects created using this Connection object to the given holdability.

Specified by:
setHoldability in interface java.sql.Connection
Parameters:
holdability - - a ResultSet holdability constant; one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Throws:
java.sql.SQLException - - if a database access occurs, the given parameter is not a ResultSet constant indicating holdability, or the given holdability is not supported

getHoldability

public int getHoldability()
                   throws java.sql.SQLException
Retrieves the current holdability of ResultSet objects created using this Connection object.

Specified by:
getHoldability in interface java.sql.Connection
Returns:
the holdability, one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Throws:
java.sql.SQLException - - if a database access occurs

setSavepoint

public java.sql.Savepoint setSavepoint()
                                throws java.sql.SQLException

Not supported by VORTEXjdbc. Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.

Specified by:
setSavepoint in interface java.sql.Connection
Returns:
the new Savepoint object
Throws:
java.sql.SQLException - - if a database access error occurs or this Connection object is currently in auto-commit mode

setSavepoint

public java.sql.Savepoint setSavepoint(java.lang.String name)
                                throws java.sql.SQLException

Not supported by VORTEXjdbc. Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.

Specified by:
setSavepoint in interface java.sql.Connection
Parameters:
name - - a String containing the name of the savepoint
Returns:
the new Savepoint object
Throws:
java.sql.SQLException - - if a database access error occurs or this Connection object is currently in auto-commit mode

rollback

public void rollback(java.sql.Savepoint savepoint)
              throws java.sql.SQLException

Not supported by VORTEXjdbc. Undoes all changes made after the given Savepoint object was set. This method should be used only when auto-commit has been disabled.

Specified by:
rollback in interface java.sql.Connection
Parameters:
savepoint - - the Savepoint object to roll back to
Throws:
java.sql.SQLException - - if a database access error occurs, the Savepoint object is no longer valid, or this Connection object is currently in auto-commit mode

releaseSavepoint

public void releaseSavepoint(java.sql.Savepoint savepoint)
                      throws java.sql.SQLException

Not supported by VORTEXjdbc. Removes the given Savepoint object from the current transaction. Any reference to the savepoint after it have been removed will cause an SQLException to be thrown.

Specified by:
releaseSavepoint in interface java.sql.Connection
Parameters:
savepoint - - the Savepoint object to be removed
Throws:
java.sql.SQLException - - if a database access error occurs or the given Savepoint object is not a valid savepoint in the current transaction

createStatement

public java.sql.Statement createStatement(int resultSetType,
                                          int resultSetConcurrency,
                                          int resultSetHoldability)
                                   throws java.sql.SQLException
Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability. This method is the same as the createStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

Specified by:
createStatement in interface java.sql.Connection
Parameters:
resultSetType - - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE. GENESISsql supports only TYPE_FORWARD_ONLY.
resultSetConcurrency - - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetHoldability - - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT. GENESISsql supports only HOLD_CURSORS_OVER_COMMIT.
Returns:
a new Statement object that will generate ResultSet objects with the given type, concurrency, and holdability
Throws:
java.sql.SQLException - - if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int resultSetType,
                                                   int resultSetConcurrency,
                                                   int resultSetHoldability)
                                            throws java.sql.SQLException
Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability. This method is the same as the prepareStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - - a String object that is the SQL statement to be sent to the database; may contain one or more ? IN parameters
resultSetType - - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE. GENESISsql supports only TYPE_FORWARD_ONLY.
resultSetConcurrency - - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetHoldability - - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT. GENESISsql supports only HOLD_CURSORS_OVER_COMMIT.
Returns:
a new PreparedStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability
Throws:
java.sql.SQLException - - if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String sql,
                                              int resultSetType,
                                              int resultSetConcurrency,
                                              int resultSetHoldability)
                                       throws java.sql.SQLException

Not supported by VORTEXjdbc. Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareCall method above, but it allows the default result set type, result set concurrency type and holdability to be overridden.

Specified by:
prepareCall in interface java.sql.Connection
Parameters:
sql - - a String object that is the SQL statement to be sent to the database; may contain on or more ? parameters
resultSetType - - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetHoldability - - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:
a new CallableStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability
Throws:
java.sql.SQLException - - if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int autoGeneratedKeys)
                                            throws java.sql.SQLException

Not supported by VORTEXjdbc. Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys. The given constant tells the driver whether it should make auto-generated keys available for retrieval. This parameter is ignored if the SQL statement is not an INSERT statement. Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions. Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - - an SQL statement that may contain one or more '?' IN parameter placeholders
autoGeneratedKeys - - a flag indicating whether auto-generated keys should be returned; one of Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS GENESISsql supports only NO_GENERATED_KEYS.
Returns:
a new PreparedStatement object, containing the pre-compiled SQL statement, that will have the capability of returning auto-generated keys
Throws:
java.sql.SQLException - - if a database access error occurs or the given parameter is not a Statement constant indicating whether auto-generated keys should be returned

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int[] columnIndexes)
                                            throws java.sql.SQLException

Not supported by VORTEXjdbc. Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the indexes of the columns in the target table that contain the auto-generated keys that should be made available. This array is ignored if the SQL statement is not an INSERT statement. An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times. Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions. Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - - an SQL statement that may contain one or more '?' IN parameter placeholders
columnIndexes - - an array of column indexes indicating the columns that should be returned from the inserted row or rows
Returns:
a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column indexes
Throws:
java.sql.SQLException - - if a database access error occurs

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   java.lang.String[] columnNames)
                                            throws java.sql.SQLException

Not supported by VORTEXjdbc. Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the names of the columns in the target table that contain the auto-generated keys that should be returned. This array is ignored if the SQL statement is not an INSERT statement. An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times. Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions. Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - - an SQL statement that may contain one or more '?' IN parameter placeholders
columnNames - - an array of column names indicating the columns that should be returned from the inserted row or rows
Returns:
a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column names exception SQLException - if a database access error occurs
Throws:
java.sql.SQLException

isWrapperFor

public boolean isWrapperFor(java.lang.Class<?> Connection)
                     throws java.sql.SQLException
Specified by:
isWrapperFor in interface java.sql.Wrapper
Throws:
java.sql.SQLException

unwrap

public <T> T unwrap(java.lang.Class<T> Connection)
         throws java.sql.SQLException
Specified by:
unwrap in interface java.sql.Wrapper
Throws:
java.sql.SQLException

getSchema

public java.lang.String getSchema()
                           throws java.sql.SQLException
Throws:
java.sql.SQLException

createArrayOf

public java.sql.Array createArrayOf(java.lang.String typeName,
                                    java.lang.Object[] elements)
                             throws java.sql.SQLException

Not supported by VORTEXjdbc. Factory method for creating Array objects. Note: When createArrayOf is used to create an array object that maps to a primitive data type, then it is implementation-defined whether the Array object is an array of that primitive data type or an array of Object.

Specified by:
createArrayOf in interface java.sql.Connection
Parameters:
typeName - the SQL name of the type the elements of the array map to. The typeName is a database-specific name which may be the name of a built-in type, a user-defined type or a standard SQL type supported by this database. This is the value returned by Array.getBaseTypeName
elements - the elements that populate the returned object
Returns:
an Array object whose elements map to the specified SQL type
Throws:
java.sql.SQLException - if a database error occurs, the JDBC type is not appropriate for the typeName and the conversion is not supported, the typeName is null or this method is called on a closed connection
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type

createStruct

public java.sql.Struct createStruct(java.lang.String typeName,
                                    java.lang.Object[] attributes)
                             throws java.sql.SQLException

Not supported by VORTEXjdbc. Factory method for creating Struct objects.

Specified by:
createStruct in interface java.sql.Connection
Parameters:
typeName - the SQL type name of the SQL structured type that this Struct object maps to. The typeName is the name of a user-defined type that has been defined for this database. It is the value returned by Struct.getSQLTypeName.
attributes - the attributes that populate the returned objectReturns:a Struct object that maps to the given SQL type and is populated with the given attributes
Throws:
java.sql.SQLException - if a database error occurs, the typeName is null or this method is called on a closed connection
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type

getClientInfo

public java.lang.String getClientInfo(java.lang.String name)
                               throws java.sql.SQLException

Not supported by VORTEXjdbc. Returns the value of the client info property specified by name. This method may return null if the specified client info property has not been set and does not have a default value. This method will also return null if the specified client info property name is not supported by the driver. Applications may use the DatabaseMetaData.getClientInfoProperties method to determine the client info properties supported by the driver.

Specified by:
getClientInfo in interface java.sql.Connection
Parameters:
name - The name of the client info property to retrieve
Returns:
The value of the client info property specified
Throws:
java.sql.SQLException - if the database server returns an error when fetching the client info value from the database or this method is called on a closed connection

getClientInfo

public java.util.Properties getClientInfo()
                                   throws java.sql.SQLException

Not supported by VORTEXjdbc. Returns a list containing the name and current value of each client info property supported by the driver. The value of a client info property may be null if the property has not been set and does not have a default value.

Specified by:
getClientInfo in interface java.sql.Connection
Returns:
A Properties object that contains the name and current value of each of the client info properties supported by the driver.
Throws:
java.sql.SQLException - if the database server returns an error when fetching the client info values from the database or this method is called on a closed connection

setClientInfo

public void setClientInfo(java.lang.String name,
                          java.lang.String value)
                   throws java.sql.SQLClientInfoException

Not supported by VORTEXjdbc. Sets the value of the client info property specified by name to the value specified by value. Applications may use the DatabaseMetaData.getClientInfoProperties method to determine the client info properties supported by the driver and the maximum length that may be specified for each property. The driver stores the value specified in a suitable location in the database. For example in a special register, session parameter, or system table column. For efficiency the driver may defer setting the value in the database until the next time a statement is executed or prepared. Other than storing the client information in the appropriate place in the database, these methods shall not alter the behavior of the connection in anyway. The values supplied to these methods are used for accounting, diagnostics and debugging purposes only. The driver shall generate a warning if the client info name specified is not recognized by the driver. If the value specified to this method is greater than the maximum length for the property the driver may either truncate the value and generate a warning or generate a SQLClientInfoException. If the driver generates a SQLClientInfoException, the value specified was not set on the connection. The following are standard client info properties. Drivers are not required to support these properties however if the driver supports a client info property that can be described by one of the standard properties, the standard property name should be used. ApplicationName - The name of the application currently utilizing the connection ClientUser - The name of the user that the application using the connection is performing work for. This may not be the same as the user name that was used in establishing the connection. ClientHostname - The hostname of the computer the application using the connection is running on.

Specified by:
setClientInfo in interface java.sql.Connection
Parameters:
name - The name of the client info property to setvalue - The value to set the client info property to. If the value is null, the current value of the specified property is cleared.
Throws:
java.sql.SQLClientInfoException - if the database server returns an error while setting the client info value on the database server or this method is called on a closed connection

setClientInfo

public void setClientInfo(java.util.Properties properties)
                   throws java.sql.SQLClientInfoException

Not supported by VORTEXjdbc. Sets the value of the connection's client info properties. The Properties object contains the names and values of the client info properties to be set. The set of client info properties contained in the properties list replaces the current set of client info properties on the connection. If a property that is currently set on the connection is not present in the properties list, that property is cleared. Specifying an empty properties list will clear all of the properties on the connection. See setClientInfo (String, String) for more information. If an error occurs in setting any of the client info properties, a SQLClientInfoException is thrown. The SQLClientInfoException contains information indicating which client info properties were not set. The state of the client information is unknown because some databases do not allow multiple client info properties to be set atomically. For those databases, one or more properties may have been set before the error occurred.

Specified by:
setClientInfo in interface java.sql.Connection
Parameters:
properties - - the list of client info properties to set
Throws:
java.sql.SQLClientInfoException - if the database server returns an error while setting the clientInfo values on the database server or this method is called on a closed connection

isValid

public boolean isValid(int timeout)
                throws java.sql.SQLException
Returns true if the connection has not been closed and is still valid.

Specified by:
isValid in interface java.sql.Connection
Parameters:
timeout - The time in seconds to wait for the database operation used to validate the connection to complete. If the timeout period expires before the operation completes, this method returns false. A value of 0 indicates a timeout is not applied to the database operation.
Returns:
true if the connection is valid, false otherwise
Throws:
java.sql.SQLException - if the value supplied for timeout is less then 0

createClob

public java.sql.Clob createClob()
                         throws java.sql.SQLException

Not supported by VORTEXjdbc. Constructs an object that implements the Clob interface. The object returned initially contains no data. The setAsciiStream, setCharacterStream and setString methods of the Clob interface may be used to add data to the Clob.

Specified by:
createClob in interface java.sql.Connection
Returns:
An object that implements the Clob interface
Throws:
java.sql.SQLException - if an object that implements the Clob interface can not be constructed, this method is called on a closed connection or a database access error occurs.
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type

createBlob

public java.sql.Blob createBlob()
                         throws java.sql.SQLException

Not supported by VORTEXjdbc. Constructs an object that implements the Blob interface. The object returned initially contains no data. The setBinaryStream and setBytes methods of the Blob interface may be used to add data to the Blob.

Specified by:
createBlob in interface java.sql.Connection
Returns:
An object that implements the Blob interface
Throws:
java.sql.SQLException - if an object that implements the Blob interface can not be constructed, this method is called on a closed connection or a database access error occurs.
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type

createNClob

public java.sql.NClob createNClob()
                           throws java.sql.SQLException

Not supported by VORTEXjdbc. Constructs an object that implements the NClob interface. The object returned initially contains no data. The setAsciiStream, setCharacterStream and setString methods of the NClob interface may be used to add data to the NClob.

Specified by:
createNClob in interface java.sql.Connection
Returns:
An object that implements the NClob interface
Throws:
java.sql.SQLException - if an object that implements the NClob interface can not be constructed, this method is called on a closed connection or a database access error occurs.
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type

createSQLXML

public java.sql.SQLXML createSQLXML()
                             throws java.sql.SQLException

Not supported by VORTEXjdbc. Constructs an object that implements the SQLXML interface. The object returned initially contains no data. The createXmlStreamWriter object and setString method of the SQLXML interface may be used to add data to the SQLXML object.

Specified by:
createSQLXML in interface java.sql.Connection
Returns:
An object that implements the SQLXML interface
Throws:
java.sql.SQLException - if an object that implements the SQLXML interface can not be constructed, this method is called on a closed connection or a database access error occurs.
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type.


Updated May 06 2016