vortex.sql
Class vortexConnection

java.lang.Object
  |
  +--vortex.sql.vortexConnection

public class vortexConnection

extends java.lang.Object

implements java.sql.Connection

Constructor Summary

vortexConnection(java.lang.String conn, int port, java.lang.String host, java.lang.String service, java.lang.String environs, int fbs, int mcl, int dbc, int mlc, java.lang.String login, java.lang.String socksHost, java.lang.String socksPort)
Constructs a new JDBC connection object for the VORTEX Channel

Method Summary

void	clearWarnings() Clear the warning chain.
void	close() Close the database connection.
void	commit() Commit a transaction.
java.sql.Statement	createStatement() Create a SQL statement object.
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() JDBC draft specification method to return the catalog.
java.sql.DatabaseMetaData	getMetaData() Return information about the database.
int	getTransactionIsolation() JDBC draft specification method for retrieving the transaction isolation level for the connection.
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.
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) Create a stored procedure call.
java.sql.PreparedStatement	prepareStatement(java.lang.String sql) Create an SQL pre-compiled statement.
void	rollback() Rollback a transaction.
void	setAutoClose(boolean autoClose) 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.
void	setAutoCommit(boolean b) Setting the auto-commit mode.
void	setCatalog(java.lang.String str) JDBC draft specification method to select a sub-space of the target database.
void	setReadOnly(boolean b) Setup the connection in read-only mode.
void	setTransactionIsolation(int x) This method has no meaning to VORTEX since VORTEX support isolation level on a newly opened connection, using TRANSACTION_REPEATABLE_READ only Note: setTransactionIsolation cannot be called while in the middle of a transaction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

vortexConnection

public vortexConnection(java.lang.String conn,
                        int port,
                        java.lang.String host,
                        java.lang.String service,
                        java.lang.String environs,
                        int fbs,
                        int mcl,
                        int dbc,
                        int mlc,
                        java.lang.String login,
                        java.lang.String socksHost,
                        java.lang.String socksPort)
                 throws java.sql.SQLException

Constructs a new JDBC connection object for the VORTEX Channel

Parameters:

conn - the database login like 'scott/tiger' for Oracle

port - the TCP/IP services port number

host - the IP address of the host on which the VORTEX server resides

service - the host program on server like '/usr2/vortex/bin/vtxhost.ora'

environs - the environment variables

fbs - the fetch buffer size for query like 8192

mcl - the max DB columns like 256

dbc - the number of DB cursors

mlc - the max number of logical cursors

login - the operating system logon like '(user/password)'

socksHost - the IP address or name of the SOCKS server

socksPort - the port of the SOCKS server

Throws:

java.sql.SQLException - raised in the event of connection failure

java.sql.SQLException - thrown in the event the connection fails

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

See Also:

Connection.createStatement()

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 thrown any time this is called

See Also:

Connection.prepareStatement(java.lang.String)

prepareCall

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

Create a stored procedure call.

Note that stored procedures aren't supported by VORTEXjdbc now, so this method throws an exception.

Specified by:

prepareCall in interface java.sql.Connection

Parameters:

sql - SQL statement

Throws:

java.sql.SQLException - gets thrown any time this is called

See Also:

Connection.prepareCall(java.lang.String)

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 - Not apply

See Also:

Connection.setAutoCommit(boolean)

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 - Not apply

See Also:

Connection.getAutoCommit()

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

See Also:

Connection.commit()

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

See Also:

Connection.rollback()

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

See Also:

Connection.close()

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

See Also:

Connection.isClosed()

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

See Also:

Connection.getMetaData()

setReadOnly

public void setReadOnly(boolean b)
                 throws java.sql.SQLException

Setup the connection in read-only mode.

Specified by:

setReadOnly in interface java.sql.Connection

Parameters:

b - boolean read-only

Throws:

java.sql.SQLException - Not apply

See Also:

Connection.setReadOnly(boolean)

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

See Also:

Connection.isReadOnly()

setCatalog

public void setCatalog(java.lang.String str)
                throws java.sql.SQLException

JDBC draft specification method to select a sub-space of the target database. It basically has no menaing to VORTEXjdbc.

Specified by:

setCatalog in interface java.sql.Connection

Parameters:

str - the catalog

Throws:

java.sql.SQLException - thrown method does not support

See Also:

Connection.setCatalog(java.lang.String)

getCatalog

public java.lang.String getCatalog()
                            throws java.sql.SQLException

JDBC draft specification method to return the catalog.

Specified by:

getCatalog in interface java.sql.Connection

Returns:

the catalog name

Throws:

java.sql.SQLException - thrown method does not support

See Also:

Connection.getCatalog()

setTransactionIsolation

public void setTransactionIsolation(int x)
                             throws java.sql.SQLException

This method has no meaning to VORTEX since VORTEX support isolation level on a newly opened connection, using TRANSACTION_REPEATABLE_READ only

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

Specified by:

setTransactionIsolation in interface java.sql.Connection

Parameters:

level - one of the TRANSACTION_* isolation values with the exception of TRANSACTION_NONE; some databases may not support other values

Throws:

java.sql.SQLException - threw method does not support by VORTEXjdbc.

See Also:

DatabaseMetaData.supportsTransactionIsolationLevel(int)

getTransactionIsolation

public int getTransactionIsolation()
                            throws java.sql.SQLException

JDBC draft specification method for retrieving the transaction isolation level for the connection.

VORTEXjdbc return TRANSACTION_REPEATABLE_READ only

Specified by:

getTransactionIsolation in interface java.sql.Connection

Returns:

TRANSACTION_REPEATABLE_READ always

Throws:

java.sql.SQLException - Not apply

See Also:

Connection.getTransactionIsolation()

disableAutoClose

public void disableAutoClose()
                      throws java.sql.SQLException

Disable closing of statements and result sets.

Throws:

java.sql.SQLException - Not apply

setAutoClose

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

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

See Also:

setAutoClose(boolean)

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

See Also:

Connection.getWarnings()

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

See Also:

Connection.clearWarnings()

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