org.hsqldb
Class jdbcConnection

java.lang.Object
  extended byorg.hsqldb.jdbcConnection
All Implemented Interfaces:
java.sql.Connection

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

A connection (session) with a specific database. Within the context of a Connection, SQL statements are executed and results are returned.

A Connection's database is able to provide information describing its tables, its supported SQL grammar, its stored procedures, the capabilities of this connection, and so on. This information is obtained with the getMetaData method.

Note: By default the Connection automatically commits changes after executing each statement. If auto commit has been disabled, an explicit commit must be done or database changes will not be saved.

HSQLDB-Specific Information:

To get a Connection to an HSQLDB database, the following code may be used:

Class.forName ( "org.hsqldb.jdbcDriver" );
Connection c = DriverManager.getConnection (url,user,password);

For HSQLDB connections, the url must start with 'jdbc:hsqldb' .

The Server database url is 'jdbc:hsqldb:hsql://host[:port]' .

The WebServer database url is 'jdbc:hsqldb:http://host[:port]' .

The In-Memory (diskless, in-process) database url is 'jdbc:hsqldb:.' .

The Standalone (in-process) database connection url is 'jdbc:hsqldb:name' .

'name' is the common prefix of the files that compose the database, including the path .

For example: 'jdbc:hsqldb:test' connects to a database named 'test' , which is composed of the files 'test.properties' , 'test.data' and 'test.script' , all located in the working directory fixed at the time the JVM is started.

Under Windows TM , 'jdbc:hsqldb:c:\databases\test' connects to a database named 'test' , located on drive c: in the directory 'databases' , composed of the files: 'test.properties' , 'test.data' and 'test.script' .

Under most variations of UNIX, 'jdbc:hsqldb:/databases/test' connects to a database named 'test' located in the directory 'databases' directly under root, and composed of the files: 'test.properties' , 'test.data' and 'test.script' .

Some Guidelines:

  1. Both relative and absolute paths are supported.
  2. Relative paths can be specified in a platform independent manner as: '[dir1/dir2/.../dirn/]name'.
  3. Specification of absolute paths is operating-system specific.
    Please read your OS file system documentation.
  4. Typically, special care must be taken w.r.t. path specifications containing whitespace, and mixed-case may also be a concern.
    Please read your OS file system documentation.
Note: Previous versions of HSQLDB did not support creating directories along the path specified in Standalone mode jdbc urls, in the case that they did not already exist. As of HSQLDB 1.7.0, directories will be created if they do not already exist (but not if the HSQLDB Jar is built under JDK 1.1.x).

For more information about HSQLDB file structure, please read the Files section of the documentation.

JRE 1.1.x Notes:

In general, JDBC 2 support requires Java 1.2 and above, and JDBC3 requires Java 1.4 and above. In HSQLDB, support for methods introduced in different versions of JDBC depends on the JDK version used for compiling and building HSQLDB.

Since 1.7.0, it is possible to build the product so that all JDBC 2 methods can be called while executing under the version 1.1.x Java Runtime EnvironmentTM. However, some of these method calls require int values that are defined only in the JDBC 2 or greater version of ResultSet interface. For this reason, when the product is compiled under JDK 1.1.x, these values are defined here in this class.

In a JRE 1.1.x environment, calling JDBC 2 methods that take or return the JDBC2-only ResultSet values can be achieved by referring to them in parameter specifications and return value comparisons, respectively, as follows:

jdbcResultSet.FETCH_FORWARD
jdbcResultSet.TYPE_FORWARD_ONLY
jdbcResultSet.TYPE_SCROLL_INSENSITIVE
jdbcResultSet.CONCUR_READ_ONLY

However, please note that code written in such a manner will not be compatible for use with other JDBC 2 drivers, since they expect and use ResultSet, rather than jdbcResultSet. Also note, this feature is offered solely as a convenience to developers who must work under JDK 1.1.x due to operating constraints, yet wish to use some of the more advanced features available under the JDBC 2 specification.

(fredt@users)
(boucherb@users)

See Also:
jdbcDriver, jdbcStatement, jdbcResultSet, jdbcDatabaseMetaData

Field Summary
static int DEFAULT_HSQLDB_PORT
          Used when no port is explicitly specified in the url for a network Connection of type HSQLDB.
 
Fields inherited from interface java.sql.Connection
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
 
Method Summary
 void clearWarnings()
           Clears all warnings reported for this Connection object.
 void close()
           Releases this Connection object's database and JDBC resources immediately instead of waiting for them to be automatically released.
 void commit()
           Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by the Connection.
 java.sql.Statement createStatement()
           Creates a Statement object for sending SQL statements to the database.
 java.sql.Statement createStatement(int type, int concurrency)
           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.
 void finalize()
          The default implementation simply attempts to silently close() this Connection
 boolean getAutoCommit()
          Gets the current auto-commit state.
 java.lang.String getCatalog()
           Returns the Connection's current catalog name.
 int getHoldability()
           Retrieves the current holdability of ResultSet objects created using this Connection object.
 java.sql.DatabaseMetaData getMetaData()
           Gets the metadata regarding this connection's database.
 int getTransactionIsolation()
           Retrieves this Connection object's current transaction isolation level.
 java.util.Map getTypeMap()
           Gets the type map object associated with this connection.
 java.sql.SQLWarning getWarnings()
           Retrieves the first warning reported by calls on this Connection object.
 boolean isClosed()
          Tests to see if a Connection is closed.
 boolean isReadOnly()
          Tests to see if the connection is in read-only mode.
 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)
           Creates a CallableStatement object for calling database stored procedures.
 java.sql.CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency)
           Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.
 java.sql.CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
           Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql)
           Creates a PreparedStatement object for sending parameterized SQL statements to the database.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int autoGeneratedKeys)
           Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int[] columnIndexes)
           Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int type, int concurrency)
           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)
           Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
 void releaseSavepoint(java.sql.Savepoint savepoint)
           Removes the given Savepoint object from the current transaction.
 void rollback()
           Drops all changes made since the previous commit/rollback and releases any database locks currently held by this Connection.
 void rollback(java.sql.Savepoint savepoint)
           Undoes all changes made after the given Savepoint object was set.
 void setAutoCommit(boolean autoCommit)
           Sets this connection's auto-commit mode to the given state.
 void setCatalog(java.lang.String catalog)
           Sets a catalog name in order to select a subspace of this Connection's database in which to work.
 void setHoldability(int holdability)
           Changes the holdability of ResultSet objects created using this Connection object to the given holdability.
 void setReadOnly(boolean readonly)
           Puts this connection in read-only mode as a hint to enable database optimizations.
 java.sql.Savepoint setSavepoint()
           Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.
 java.sql.Savepoint setSavepoint(java.lang.String name)
           Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.
 void setTransactionIsolation(int level)
           Attempts to change the transaction isolation level for this Connection object to the one given.
 void setTypeMap(java.util.Map map)
           Installs the given TypeMap object as the type map for this Connection object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_HSQLDB_PORT

public static final int DEFAULT_HSQLDB_PORT
Used when no port is explicitly specified in the url for a network Connection of type HSQLDB.

This value is used as the port number for network connections to Server mode databases, when no port number is explictly specified in the connection url.

In the standard distribution, this will always be 9001 .

See Also:
Constant Field Values
Method Detail

createStatement

public java.sql.Statement createStatement()
                                   throws java.sql.SQLException
Creates a Statement object for sending SQL statements to the database. SQL statements without parameters are normally executed using Statement objects. If the same SQL statement is executed many times, it may be more efficient to use a PreparedStatement object.

Result sets created using the returned Statement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

HSQLDB-Specific Information:

The standard java.sql API documentation above suggests that if the same SQL statement is executed many times, it may be more efficient to use a PreparedStatement object. As of HSQLDB 1.7.0, this is still not the case. However, this feature is slated to be part of the HSQLDB 1.7.x series.

Up to 1.6.1, HSQLDB supported TYPE_FORWARD_ONLY - CONCUR_READ_ONLY results only, so ResultSet objects created using the returned Statement object would always be type TYPE_FORWARD_ONLY with CONCUR_READ_ONLY concurrency.

Starting with 1.7.0, HSQLDB also supports TYPE_SCROLL_INSENSITIVE results.

Notes:

Up to 1.6.1, calling this method returned null if the connection was already closed. This was possibly counter-intuitive to the expectation that an exception would be thrown for closed connections. Starting with 1.7.0. the behaviour is to throw a SQLException if the connection is closed.

Specified by:
createStatement in interface java.sql.Connection
Returns:
a new default Statement object
Throws:
java.sql.SQLException - if a database access error occurs

See Also:
createStatement(int,int), createStatement(int,int,int)

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql)
                                            throws java.sql.SQLException
Creates a PreparedStatement object for sending parameterized SQL statements to the database.

A 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 SQLException objects.

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.

HSQLDB-Specific Information:

The standard java.sql API documentation above suggests that if the same SQL statement is executed many times, it may be more efficient to use a PreparedStatement object. As of HSQLDB 1.7.0, this is still not the case. Rather, the statement is stored on the client and is not sent to the database until the PreparedStatement object is executed. However, precompilation on the database is a feature slated to be part of the 1.7.x series.

Up to 1.6.1, HSQLDB supported TYPE_FORWARD_ONLY - CONCUR_READ_ONLY results only, so ResultSet objects created using the returned PreparedStatement object would always be type TYPE_FORWARD_ONLY with CONCUR_READ_ONLY concurrency.

Starting with 1.7.0, HSQLDB also supports TYPE_SCROLL_INSENSITIVE results.

Notes:

Up to 1.6.1, calling this method returned null if the connection was already closed. This was possibly counter-intuitive to the expectation that an exception would be thrown for closed connections. Starting with 1.7.0. the behaviour is to throw a SQLException if the connection is closed.

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - an SQL statement that may contain one or more '?' IN parameter placeholders
Returns:
a new default PreparedStatement object containing the pre-compiled SQL statement
Throws:
java.sql.SQLException - if a database access error occurs

See Also:
prepareStatement(String,int,int)

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String sql)
                                       throws java.sql.SQLException
Creates a CallableStatement object for calling database stored procedures. The CallableStatement object provides methods for setting up its IN and OUT parameters, and methods for executing the call to a stored procedure.

Note: This method is optimized for handling stored procedure call statements. Some drivers may send the call statement to the database when the method prepareCall is done; others may wait until the CallableStatement object is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions.

Result sets created using the returned CallableStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

HSQLDB-Specific Information:

The standard java.sql API documentation above suggests that if the same stored procedure is executed many times, it may be more efficient to use a CallableStatement object. As of HSQLDB 1.7.0, this is still not the case. Rather, the statement is stored on the client and is not sent to the database until the CallableStatement object is executed. However, protocol optimizations and statement precompilation on the database for optimization of stored procedure execution are a features slated to be part of the 1.7.x series.

Up to and including 1.7.1, HSQLDB supports only the default TYPE_FORWARD_ONLY - CONCUR_READ_ONLY for results obtained from CallableStatement objects.

Notes:

Up to 1.6.1, calling this method returned null if the connection was already closed. This was possibly counter-intuitive to the expectation that an exception would be thrown for closed connections. Starting with 1.7.0. the behaviour is to throw a SQLException if the connection is closed.

Up to and including 1.7.1, each HSQLDB stored procedure returns only a single value wrapped in a ResultSet object. That is, HSQLDB stored procedures act very much like SQL functions and can actually always be used in such a capacity. As such, there is really no point in supporting anything but TYPE_FORWARD_ONLY, since the result obtained by executing a CallableStatement object has always just one column and one row. Be aware that this behaviour will change in HSQLDB 1.7.1, in that support will be added for Java stored procedures that return multi-column, multi-row results. At that point, support will be added for CallableStatement objects that return TYPE_SCROLL_INSENSITIVE ResultSet objects.

New to 1.7.0, HSQLDB now allows calling void Java methods as SQL functions and stored procedures, the result being a SQL NULL value or a result with one column and one row whose single field is the SQL NULL value, respectiviely. Previously, calling such Java methods in either context resulted in throwing a SQLException. Finally, up to and including 1.7.1, the returned CallableStatement object does not support any getXXX methods. That is, HSQLDB stored procedures do not support OUT or IN OUT parameters. This behaviour may change at some point in the 1.7.x series, but no decisions have yet been made.

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 one or more ? parameters.

Note: Typically the SQL statement is a JDBC function call escape string.

Returns:
a new default CallableStatement object containing the pre-compiled SQL statement
Throws:
java.sql.SQLException - if a database access error occurs

See Also:
prepareCall(String,int,int)

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.

HSQLDB-Specific Information:

Up to and including 1.7.1, HSQLDB converts the JDBC SQL grammar into the system's native SQL grammar prior to sending it; this method returns the native form of the statement that the driver would send in place of client-specified JDBC SQL grammar.

Specified by:
nativeSQL in interface java.sql.Connection
Parameters:
sql - a SQL statement that may contain one or more '?' parameter placeholders
Returns:
the native form of this statement
Throws:
java.sql.SQLException - if a database access error occurs


setAutoCommit

public void setAutoCommit(boolean autoCommit)
                   throws java.sql.SQLException
Sets this connection's auto-commit mode to the given state. If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by a call to either the method commit or the method rollback. By default, new connections are in auto-commit mode.

The commit occurs when the statement completes or the next execute occurs, whichever comes first. In the case of statements returning a ResultSet object, the statement completes when the last row of the ResultSet object has been retrieved or the ResultSet object has been closed. In advanced cases, a single statement may return multiple results as well as output parameter values. In these cases, the commit occurs when all results and output parameter values have been retrieved.

NOTE: If this method is called during a transaction, the transaction is committed.

HSQLDB-Specific Information:

Up to and including HSQLDB 1.7.0,

  1. All rows of a result set are retrieved internally before the first row can actually be fetched.
    Therefore, a statement can be considered complete as soon as any XXXStatement.executeXXX method returns.
  2. Multiple result sets and output parameters are not yet supported.

(boucherb@users)

Specified by:
setAutoCommit in interface java.sql.Connection
Parameters:
autoCommit - true to enable auto-commit mode; false to disable it
Throws:
java.sql.SQLException - if a database access error occurs
See Also:
getAutoCommit()

getAutoCommit

public boolean getAutoCommit()
                      throws java.sql.SQLException
Gets the current auto-commit state.

Specified by:
getAutoCommit in interface java.sql.Connection
Returns:
the current state of auto-commit mode
Throws:
java.sql.SQLException - Description of the Exception
See Also:
setAutoCommit(boolean)

commit

public void commit()
            throws java.sql.SQLException
Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by the Connection. This method should be used only when auto-commit mode has been disabled.

HSQLDB-Specific Information:

As of HSQLDB 1.7.0, SQL Savepoints are supported. As such, successfully calling this method now also removes all Savepoints from this connection's Session.

Up to 1.6.1, HSQLDB did not support Savepoints in transactions, named or anonymous.

As of 1.7.0, HSQLDB supports an arbitrary number of named Savepoints per transaction and allows explicitly rolling back to any one of them. At this time, HSQLDB does not support anonymous Savepoints. However, this feature is slated for the 1.7.x series.

Also, JDBC 3 support for java.sql.Savepoint has not yet been implemented. At present, rather, the following SQL syntax must be used:

SAVEPOINT savepoint_name1;
... -- perform some work
SAVEPOINT savepoint_name2;
...-- perform some work
ROLLABACK TO SAVEPOINT savepoint_name2
...-- perform some work
ROLLABACK TO SAVEPOINT savepoint_name1;

Note: If two or more Savepoints with the same name are performed during the same transaction, the latest one replaces the previous one, so that it is impossible to roll back to the previous one.

Specified by:
commit in interface java.sql.Connection
Throws:
java.sql.SQLException - if a database access error occurs
See Also:
setAutoCommit(boolean)

rollback

public void rollback()
              throws java.sql.SQLException
Drops all changes made since the previous commit/rollback and releases any database locks currently held by this Connection. This method should be used only when auto- commit has been disabled.

HSQLDB-Specific Information:

As of HSQLDB 1.7.0, SQL Savepoints are supported. As such, successfully calling this method also removes all Savepoints from this Connection's Session.

Up to 1.6.1, HSQLDB did not support Savepoints in transactions, named or anonymous.

As of 1.7.0, HSQLDB supports an arbitrary number of named Savepoints per transaction and allows explicitly rolling back to any one of them. At this time, HSQLDB does not support anonymous Savepoints. However, this feature is slated for the 1.7.x series.

Also, as of 1.7.0, JDBC 3 support for java.sql.Savepoint has not yet been implemented. At present, rather, the following SQL syntax must be used:

SAVEPOINT savepoint_name1;
...-- perform some work
SAVEPOINT savepoint_name2;
...-- perform some work
ROLLABACK TO SAVEPOINT savepoint_name2
...-- perform some work
ROLLABACK TO SAVEPOINT savepoint_name1;

Note: If two or more Savepoints with the same name are performed during the same transaction, the latest one replaces the previous one, making it impossible to roll back to the previous one.

Specified by:
rollback in interface java.sql.Connection
Throws:
java.sql.SQLException - if a database access error occurs
See Also:
setAutoCommit(boolean)

close

public void close()
           throws java.sql.SQLException
Releases this Connection object's database and JDBC resources immediately instead of waiting for them to be automatically released.

Calling the method close on a Connection object that is already closed is a no-op.

Note: A Connection object is automatically closed when it is garbage collected. Certain fatal errors also close a Connection object.

HSQLDB-Specific Information:

In a future release, INTERNAL Connection objects may not be closable from JDBC client code, and disconnect statements issued on INTERNAL Connection objects may be ignored.

For HSQLDB developers not involved with writing database internals, this change will only apply to connections obtained automatically from the database as the first parameter to stored procedures and SQL functions. This is mainly an issue to developers writing custom SQL function and stored procedure libraries for HSQLDB. As we anticipate this change, it is recommended that SQL function and stored procedure code avoid depending on closing or issuing a disconnect on a connection obtained in this manner.

Specified by:
close in interface java.sql.Connection
Throws:
java.sql.SQLException - if a database access error occurs

isClosed

public boolean isClosed()
Tests to see if a Connection is closed.

Specified by:
isClosed in interface java.sql.Connection
Returns:
true if the connection is closed; false if it's still open

getMetaData

public java.sql.DatabaseMetaData getMetaData()
Gets the metadata regarding this connection's database. A Connection's database is able to provide information describing its tables, its supported SQL grammar, its stored procedures, the capabilities of this connection, and so on. This information is made available through a DatabaseMetaData object.

HSQLDB-Specific Information:

Up to and including 1.7.1, HSQLDB does not provide accurate results for the full range of DatabaseMetaData methods returning ResultSet. Some of these methods may always return empty result sets, even though they should contain information. Other methods may not accurately reflect all of the MetaData for the category they report on. Also, some methods may ignore the filters provided as parameters, returning an unfiltered result each time.

As of version 1.7.1, the only completely accurate DatabaseMetaData methods returning ResultSet are getTables, getColumns, getPrimaryKeys, and getIndexInfo. Also, the majority of methods returning ResultSet throw a SQLException when accessed by a non-admin user. In order to provide non-admin users access to these methods, an admin user must explicitly grant SELECT to such users or to the PUBLIC user on each HSQLDB system table corresponding to a DatabaseMetaData method that returns ResultSet. For example, to provide access to getTables to all users, the following must be issued by an admin user:

GRANT SELECT ON SYSTEM_TABLES TO PUBLIC

Care should be taken when making such grants, however, since HSQLDB makes no attempt to filter such information, based on the grants of the accessing user. That is, in the example above, getTables will return information about all tables (except system tables, which are never listed in MetaData), regardless of whether the calling user has any rights on any of the tables.

HSQLDB 1.7.1 will provide the option of installing a full and accurate DatabaseMetaData implementation that is accessible to all database users, regardless of admin status. In that implementation, DatabaseMetaData methods returning ResultSet will yield results that have been automatically pre-filtered to omit entries to which the connected user has not been granted access, regardless of the filter parameters specified to those methods. That is, supplied filter parameters will only further restrict results that already comply with the security set up by administration, and will never give greater access than has been granted. Also in that implementation, full MetaData will be reported to all users about all system tables, unless SELECT on any system table providing DatabaseMetaData is specifically revoked from PUBLIC and not explicitly granted to each user.

Specified by:
getMetaData in interface java.sql.Connection
Returns:
a DatabaseMetaData object for this Connection
See Also:
jdbcDatabaseMetaData

setReadOnly

public void setReadOnly(boolean readonly)
                 throws java.sql.SQLException
Puts this connection in read-only mode as a hint to enable database optimizations.

Note: This method should not be called while in the middle of a transaction.

HSQLDB-Specific Information:

Up to and including 1.7.1, HSQLDB will commit the current transaction automatically when this method is called.

Additionally, HSQLDB provides a way to put a whole database in read-only mode. This is done by manually adding the line 'readonly=true' to the database's .properties file while the database is offline. Upon restart, all connections will be readonly, since the entire database will be readonly. To take a database out of readonly mode, simply take the database offline and remove the line 'readonly=true' from the database's .properties file. Upon restart, the database will be in regular (read-write) mode.

When a database is put in readonly mode, its files are opened in readonly mode, making it possible to create CDROM-based readonly databases. To create a CDROM-based readonly database that has CACHED tables and whose .data file is suspected of being highly fragmented, it is recommended that the database first be SHUTDOWN COMPACTed, taken off-line, restarted, SHUTDOWN and taken off-line again before copying the database files to CDROM. This will reduce the space required and may improve access times against the .data file which holds the CACHED table data.

Specified by:
setReadOnly in interface java.sql.Connection
Parameters:
readonly - The new readOnly value
Throws:
java.sql.SQLException - if a database access error occurs

isReadOnly

public boolean isReadOnly()
                   throws java.sql.SQLException
Tests to see if the connection is in read-only mode.

Specified by:
isReadOnly in interface java.sql.Connection
Returns:
true if connection is read-only and false otherwise
Throws:
java.sql.SQLException - if a database access error occurs

setCatalog

public void setCatalog(java.lang.String catalog)
                throws java.sql.SQLException
Sets a catalog name in order to select a subspace of this Connection's database in which to work.

HSQLDB-Specific Information:

HSQLDB does not yet support catalogs and simply ignores this request.

Specified by:
setCatalog in interface java.sql.Connection
Parameters:
catalog - the name of a catalog (subspace in this Connection object's database) in which to work (Ignored)
Throws:
java.sql.SQLException - if a database access error occurs


getCatalog

public java.lang.String getCatalog()
                            throws java.sql.SQLException
Returns the Connection's current catalog name.

HSQLDB-Specific Information:

HSQLDB does not yet support catalogs and always returns null.

Specified by:
getCatalog in interface java.sql.Connection
Returns:
the current catalog name or null

For HSQLDB, this is always null.

Throws:
java.sql.SQLException - Description of the Exception

setTransactionIsolation

public void setTransactionIsolation(int level)
                             throws java.sql.SQLException
Attempts to change the transaction isolation level for this Connection object to the one given. The constants defined in the interface Connection are the possible transaction isolation levels.

Note: If this method is called during a transaction, the result is implementation-defined.

HSQLDB-Specific Information:

Up to and including 1.7.1, HSQLDB supports only Connection.TRANSACTION_READ_UNCOMMITTED.

Specified by:
setTransactionIsolation in interface java.sql.Connection
Parameters:
level - one of the following Connection constants: Connection.TRANSACTION_READ_UNCOMMITTED , Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ, or Connection.TRANSACTION_SERIALIZABLE. (Note that Connection.TRANSACTION_NONE cannot be used because it specifies that transactions are not supported.)
Throws:
java.sql.SQLException - if a database access error occurs or the given parameter is not one of the Connection constants

See Also:
jdbcDatabaseMetaData.supportsTransactionIsolationLevel(int), getTransactionIsolation()

getTransactionIsolation

public int getTransactionIsolation()
                            throws java.sql.SQLException
Retrieves this Connection object's current transaction isolation level.

HSQLDB-Specific Information:

HSQLDB always returns Connection.TRANSACTION_READ_UNCOMMITED.

Specified by:
getTransactionIsolation in interface java.sql.Connection
Returns:
the current transaction isolation level, which will be one of the following constants: Connection.TRANSACTION_READ_UNCOMMITTED , Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ, Connection.TRANSACTION_SERIALIZABLE, or Connection.TRANSACTION_NONE

Up to and including 1.7.1, TRANSACTION_READ_UNCOMMITTED is always returned

Throws:
java.sql.SQLException - if a database access error occurs

See Also:
jdbcDatabaseMetaData.supportsTransactionIsolationLevel(int), setTransactionIsolation

getWarnings

public java.sql.SQLWarning getWarnings()
                                throws java.sql.SQLException
Retrieves the first warning reported by calls on this Connection object. If there is more than one warning, subsequent warnings will be chained to the first one and can be retrieved by calling the method SQLWarning.getNextWarning on the warning that was retrieved previously.

This method may not be called on a closed connection; doing so will cause an SQLException to be thrown.

Note: Subsequent warnings will be chained to this SQLWarning.

HSQLDB-Specific Information:

Up to and including 1.7.1, HSQLDB never produces warnings, always returns null.

Specified by:
getWarnings in interface java.sql.Connection
Returns:
the first SQLWarning object or null if there are none

Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection

See Also:
SQLWarning

clearWarnings

public void clearWarnings()
                   throws java.sql.SQLException
Clears all warnings reported for this Connection object. After a call to this method, the method getWarnings returns null until a new warning is reported for this Connection.

HSQLDB-Specific Information:

Up to and including HSQLDB 1.7.0, SQLWarning is not supported, and calls to this method are simply ignored.

Specified by:
clearWarnings in interface java.sql.Connection
Throws:
java.sql.SQLException - if a database access error occurs


createStatement

public java.sql.Statement createStatement(int type,
                                          int concurrency)
                                   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.

HSQLDB-Specific Information:

Up to HSQLDB 1.6.1, support was provided only for type TYPE_FORWARD_ONLY and concurrency CONCUR_READ_ONLY.

Starting with HSQLDB 1.7.0, support is now provided for types TYPE_FORWARD_ONLY, and TYPE_SCROLL_INSENSITIVE, with concurrency CONCUR_READ_ONLY. Specifying any other values will throw a SQLException.

Notes:

Up to 1.6.1, calling this method returned null if the connection was already closed and a supported combination of type and concurrency was specified. This was possibly counter-intuitive to the expectation that an exception would be thrown for closed connections. Starting with 1.7.0. the behaviour is to throw a SQLException if the connection is closed.

Specified by:
createStatement in interface java.sql.Connection
Parameters:
type - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE (not supported)
concurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE (not supported)
Returns:
a new Statement object that will, within the release-specific documented limitations of support, generate ResultSet objects with the given type and concurrency
Throws:
java.sql.SQLException - if a database access error occurs or the given parameters are not ResultSet constants indicating a supported type and concurrency
Since:
JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcConnection)

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int type,
                                                   int concurrency)
                                            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.

HSQLDB-Specific Information:

Up to HSQLDB 1.6.1, support was provided only for type TYPE_FORWARD_ONLY and concurrency CONCUR_READ_ONLY.

Starting with HSQLDB 1.7.0, support is now provided for types TYPE_FORWARD_ONLY, and TYPE_SCROLL_INSENSITIVE, with concurrency CONCUR_READ_ONLY. Specifying any other values will throw a SQLException.

Notes:

Up to 1.6.1, calling this method returned null if the connection was already closed and a supported combination of type and concurrency was specified. This was possibly counter-intuitive to the expectation that an exception would be thrown for closed connections. Starting with 1.7.0. the behaviour is to throw a SQLException if the connection is closed.

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
type - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE (not supported)
concurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE (not supported)
Returns:
a new PreparedStatement object containing the pre-compiled SQL statement that will produce ResultSet objects with the given type and concurrency
Throws:
java.sql.SQLException - if a database access error occurs or the given parameters are not ResultSet constants indicating a supported type and concurrency
Since:
JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcConnection)

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String sql,
                                              int resultSetType,
                                              int resultSetConcurrency)
                                       throws java.sql.SQLException
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 and result set concurrency type to be overridden.

HSQLDB-Specific Information:

Up to and including HSQLDB 1.7.0, support is provided only for type TYPE_FORWARD_ONLY and concurrency CONCUR_READ_ONLY. Specifying any other values will throw a SQLException.

Notes:

Up to 1.6.1, calling this method returned null if the connection was already closed and a supported combination of type and concurrency was specified. This was possibly counter-intuitive to the expectation that an exception would be thrown for closed connections. Starting with 1.7.0. the behaviour is to throw a SQLException if the connection is closed.

Up to and including 1.7.1, each HSQLDB stored procedure returns only a single value wrapped in a ResultSet object. That is, HSQLDB stored procedures act very much like SQL functions, and can actually always be used in such a capacity. As such, there is really no point in supporting anything but TYPE_FORWARD_ONLY, since the result obtained by executing a CallableStatement object has always just one column and one row. Be aware that this behaviour will change in HSQLDB 1.7., in that support will be added for Java stored procedures that return multi-column, multi-row results. At that point, support will be added for CallableStatement objects that return TYPE_FORWARD_ONLY ResultSet objects.

New to 1.7.0, HSQLDB now allows calling void Java methods as SQL functions and stored procedures, the result being a SQL NULL value or a result with one column and one row whose single field is the SQL NULL value, respectiviely. Previously, calling such Java methods in either context resulted in throwing a SQLException. Finally, up to and including 1.7.1, the returned CallableStatement object does not support any getXXX methods. That is, HSQLDB stored procedures do not support OUT or IN OUT parameters. This behaviour may change at some point in the 1.7.x series, but no decisions have yet been made.

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 one or more ? parameters
resultSetType - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, (not supported) or ResultSet.TYPE_SCROLL_SENSITIVE (not supported)
resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE (not supported)
Returns:
a new CallableStatement object containing the pre-compiled SQL statement
Throws:
java.sql.SQLException - if a database access error occurs or the given parameters are not ResultSet constants indicating a supported type and concurrency
Since:
JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcConnection)

getTypeMap

public java.util.Map getTypeMap()
                         throws java.sql.SQLException
Gets the type map object associated with this connection. Unless the application has added an entry to the type map, the map returned will be empty.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature. Calling this method always throws a SQLException, stating that the function is not supported.

Specified by:
getTypeMap in interface java.sql.Connection
Returns:
the java.util.Map object associated with this Connection object
Throws:
java.sql.SQLException - if a database access error occurs (always, up to HSQLDB 1.7.0, inclusive)
Since:
JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcConnection)

setTypeMap

public void setTypeMap(java.util.Map map)
                throws java.sql.SQLException
Installs the given TypeMap object as the type map for this Connection object. The type map will be used for the custom mapping of SQL structured types and distinct types.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature. Calling this method always throws a SQLException, stating that the function is not supported.

Specified by:
setTypeMap in interface java.sql.Connection
Parameters:
map - the java.util.Map object to install as the replacement for this Connection object's default type map
Throws:
java.sql.SQLException - if a database access error occurs or the given parameter is not a java.util.Map object (always, up to HSQLDB 1.7.0, inclusive)
Since:
JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcConnection)
See Also:
getTypeMap()

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.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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
Since:
JDK 1.4, HSQLDB 1.7
See Also:
getHoldability(), ResultSet

getHoldability

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

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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
Since:
JDK 1.4, HSQLDB 1.7
See Also:
setHoldability(int), ResultSet

setSavepoint

public java.sql.Savepoint setSavepoint()
                                throws java.sql.SQLException
Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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
Since:
JDK 1.4, HSQLDB 1.7
See Also:
jdbcSavepoint, Savepoint

setSavepoint

public java.sql.Savepoint setSavepoint(java.lang.String name)
                                throws java.sql.SQLException
Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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
Since:
JDK 1.4, HSQLDB 1.7
See Also:
jdbcSavepoint, Savepoint

rollback

public void rollback(java.sql.Savepoint savepoint)
              throws java.sql.SQLException
Undoes all changes made after the given Savepoint object was set.

This method should be used only when auto-commit has been disabled.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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
Since:
JDK 1.4, HSQLDB 1.7
See Also:
jdbcSavepoint, Savepoint, rollback()

releaseSavepoint

public void releaseSavepoint(java.sql.Savepoint savepoint)
                      throws java.sql.SQLException
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.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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
Since:
JDK 1.4, HSQLDB 1.7
See Also:
jdbcSavepoint, Savepoint

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.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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
resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetHoldability - one of the following code>ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_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
Since:
JDK 1.4, HSQLDB 1.7
See Also:
ResultSet

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.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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
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 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
Since:
JDK 1.4, HSQLDB 1.7
See Also:
ResultSet

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String sql,
                                              int resultSetType,
                                              int resultSetConcurrency,
                                              int resultSetHoldability)
                                       throws java.sql.SQLException
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.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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
Since:
JDK 1.4, HSQLDB 1.7
See Also:
ResultSet

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int autoGeneratedKeys)
                                            throws java.sql.SQLException
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.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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 that auto-generated keys should be returned, one of code>Statement.RETURN_GENERATED_KEYS or Statement.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
Since:
JDK 1.4, HSQLDB 1.7

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int[] columnIndexes)
                                            throws java.sql.SQLException
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.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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
Since:
JDK 1.4, HSQLDB 1.7

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   java.lang.String[] columnNames)
                                            throws java.sql.SQLException
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.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7

finalize

public void finalize()
The default implementation simply attempts to silently close() this Connection



Copyright © 2001 - 2002 HSQL Development Group. All Rights Reserved.