|
|
What this is
This file is included in the DevDaily.com
"Java Source Code
Warehouse" project. The intent of this project is to help you "Learn
Java by Example" TM.
Other links
The source code
/* Copyright (c) 2001-2004, The HSQL Development Group
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the HSQL Development Group nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.hsqldb.jdbc;
import java.sql.*; // avoid specific import due to java.sql.Savepoint
import java.util.*; // java.util.Map
import org.hsqldb.DatabaseManager;
import org.hsqldb.HSQLClientConnection;
import org.hsqldb.HTTPClientConnection;
import org.hsqldb.HsqlException;
import org.hsqldb.HsqlProperties;
import org.hsqldb.Result;
import org.hsqldb.ResultConstants;
import org.hsqldb.Session;
import org.hsqldb.SessionInterface;
import org.hsqldb.Trace;
import org.hsqldb.lib.StringUtil;
// fredt@users 20020320 - patch 1.7.0 - JDBC 2 support and error trapping
// JDBC 2 methods can now be called from jdk 1.1.x - see javadoc comments
// boucherb@users 20020509 - added "throws SQLException" to all methods where
// it was missing here but specified in the java.sql.Connection interface,
// updated generic documentation to JDK 1.4, and added JDBC3 methods and docs
// boucherb@users and fredt@users 20020505 - extensive review and update
// of docs and behaviour to comply with java.sql specification
// fredt@users 20020830 - patch 487323 by xclayl@users - better synchronization
// fredt@users 20020930 - patch 1.7.1 - support for connection properties
// kneedeepincode@users 20021110 - patch 635816 - correction to properties
// unsaved@users 20021113 - patch 1.7.2 - SSL support
// boucherb@users 2003 ??? - patch 1.7.2 - SSL support moved to factory interface
// fredt@users 20030620 - patch 1.7.2 - reworked to use a SessionInterface
// boucherb@users 20030801 - JavaDoc updates to reflect new connection urls
// boucherb@users 20030819 - patch 1.7.2 - partial fix for broken nativeSQL method
// boucherb@users 20030819 - patch 1.7.2 - SQLWarning cases implemented
/**
*
* 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 (updated to reflect the most recent
* recommendations):
*
*
*
* When using HSQLDB, the database connection <url> must start with
* 'jdbc:hsqldb:'
*
* Since 1.7.2, connection properties (<key-value-pairs>) may be appended
* to the database connection <url>, using the form:
*
*
* '<url>[;key=value]*'
*
*
* Also since 1.7.2, the allowable forms of the HSQLDB database connection
* <url> have been extended. However, all legacy forms continue
* to work, with unchanged semantics. The extensions are as described in the
* following material.
*
*
*
* Network Server Database Connections:
*
* The 1.7.2 {@link Server Server} database connection <url> has
* changed to take one of the two following forms:
*
*
*
* - 'jdbc:hsqldb:hsql://host[:port][/<alias>][<key-value-pairs>]'
*
*
- 'jdbc:hsqldb:hsqls://host[:port][/<alias>][<key-value-pairs>]'
* (with TLS).
*
*
*
* The 1.7.2 {@link WebServer WebServer} database connection <url>
* also changes to take one of two following forms:
*
*
*
* - 'jdbc:hsqldb:http://host[:port][/<alias>][<key-value-pairs>]'
*
*
- 'jdbc:hsqldb:https://host[:port][/<alias>][<key-value-pairs>]'
* (with TLS).
*
*
*
* In both network server database connection <url> forms, the
* optional <alias> component is used to identify one of possibly
* several database instances available at the indicated host and port. If the
* <alias> component is omitted, then a connection is made to the
* network server's default database instance.
*
* For more information on server configuration regarding mounting multiple
* databases and assigning them <alias> values, please read the
* Java API documentation for {@link org.hsqldb.Server Server} and related
* chapters in the general documentation, especially the Advanced Users
* Guide.
*
*
*
* Transient, In-Process Database Connections:
*
* The 1.7.2 100% in-memory (transient, in-process) database connection
* <url> takes one of the two following forms:
*
*
*
* - 'jdbc:hsqldb:.[<key-value-pairs>]'
* (the legacy form, extended)
*
*
- 'jdbc:hsqldb:mem:<alias>[<key-value-pairs>]'
* (the new form)
*
*
*
* With the 1.7.2 transient, in-process database connection <url>,
* the <alias> component is the key used to look up a transient,
* in-process database instance amongst the collection of all such instances
* already in existence within the current class loading context in the
* current JVM. If no such instance exists, one may be automatically
* created and mapped to the <alias>, as governed by the
* 'ifexists=true|false' connection property.
*
*
*
* Persistent, In-Process Database Connections:
*
* The 1.7.2 standalone (persistent, in-process) database connection
* <url> takes one of the three following forms:
*
*
*
* - 'jdbc:hsqldb:<path>[<key-value-pairs>]'
* (the legacy form, extended)
*
*
- 'jdbc:hsqldb:file:<path>[<key-value-pairs>]'
* (same semantics as the legacy form)
*
*
- 'jdbc:hsqldb:res:<path>[<key-value-pairs>]'
* (new form with 'files_in_jar' semantics)
*
*
*
* For the persistent, in-process database connection <url>,
* the <path> component is the path prefix common to all of
* the files that compose the database.
*
* As of 1.7.2, although other files may be involved (such as transient working
* files and/or TEXT table CSV data source files), the essential set that may,
* at any particular point in time, compose an HSQLDB database are:
*
*
*
* - <path>.properties
*
- <path>.script
*
- <path>.log
*
- <path>.data
*
- <path>.backup
*
- <path>.lck
*
*
*
* For example: 'jdbc:hsqldb:file:test' connects to a database
* composed of some subset of the files listed above, where the expansion
* of <path> is 'test' prefixed with the path of the
* working directory fixed at the time the JVM is started.
*
* Under Windows TM ,
* 'jdbc:hsqldb:file:c:\databases\test' connects to a database located
* on drive 'C:' in the directory 'databases', composed
* of some subset of the files:
*
*
* C:\
* +--databases\
* +--test.properties
* +--test.script
* +--test.log
* +--test.data
* +--test.backup
* +--test.lck
*
*
* Under most variations of UNIX, 'jdbc:hsqldb:file:/databases/test'
* connects to a database located in the directory 'databases' directly
* under root, once again composed of some subset of the files:
*
*
* /
* +--databases/
* +--test.properties
* +--test.script
* +--test.log
* +--test.data
* +--test.backup
* +--test.lck
*
*
* Some Guidelines:
*
*
* - Both relative and absolute database file paths are supported.
*
* - Relative database file paths can be specified in a platform independent
* manner as: '[dir1/dir2/.../dirn/]<file-name-prefix>'.
*
* - Specification of absolute file paths is operating-system specific.
* Please read your OS file system documentation.
*
* - Specification of network mounts may be operating-system specific.
* Please read your OS file system documentation.
*
* - Special care may be needed w.r.t. file path specifications
* containing whitespace, mixed-case, special characters and/or
* reserved file names.
* Please read your OS file system documentation.
*
*
* Note: Versions of HSQLDB previous to 1.7.0 did not support creating
* directories along the file path specified in the persistent, in-process mode
* database connection <url> form, in the case that they did
* not already exist. Starting with HSQLDB 1.7.0, directories will
* be created if they do not already exist., but only if HSQLDB is built under
* a version of the compiler greater than JDK 1.1.x.
*
* res: Connections
*
* The new 'jdbc:hsqldb:res:<path>' database connection
* <url> has different semantics than the
* 'jdbc:hsqldb:file:<path>' form. The semantics are similar to
* those of a 'files_read_only' database, but with some additional
* points to consider.
*
* Specifically, the '<path>' component of a res: type
* database connection <url> is used to obtain resource URL
* objects and thereby read the database files as resources on the class path.
* Moreover, the URL objects must point only to resources contained
* in one or more jars on the class path (must be jar protocol).
*
* This restriction is enforced to avoid the unfortunate situation in which,
* because res: database instances do not create a <path>.lck file
* (they are strictly files-read-only) and because the <path>
* components of res: and file: database URIs are not checked
* for file system equivalence, it is possible for the same database files to
* be accessed concurrently by both file: and res: database
* instances. That is, without this restriction, it is possible that
* <path>.data and <path>.properties file content may be written
* by a file: database instance without the knowlege or cooperation
* of a res: database instance open on the same files, potentially
* resulting in unexpected database errors, inconsistent operation
* and/or data corruption.
*
* In short, a res: type database connection <url> is
* designed specifically to connect to a 'files_in_jar' mode database
* instance, which in turn is designed specifically to operate under
* Java WebStartTM and
* Java AppletTMconfigurations,
* where co-locating the database files in the jars that make up the
* WebStart application or Applet avoids the need for special security
* configuration or code signing.
*
* Note: Since it is difficult and often nearly impossible to determine
* or control at runtime from where all classes are being loaded or which class
* loader is doing the loading under 'files_in_jar' semantics, the
* <path> component of the res: database connection
* <url> is always taken to be relative to the default package.
* That is, if the <path> component does not start with '/', then
* '/' is prepended when obtaining the resource URLs used to read the database
* files.
*
*
*
* For more information about HSQLDB file structure, various database modes
* and other attributes such as those controlled through the HSQLDB properties
* files, please read the general documentation, especially the Advanced Users
* Guide.
*
*
*
* 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, in addition to this technique requiring explicit casts to the
* org.hsqldb.jdbcXXX classes, some of the method calls also 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
* in {@link org.hsqldb.jdbc.jdbcResultSet jdbcResultSet}.
*
* 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
* // etc.
*
*
* However, please note that code written to use HSQLDB JDBC 2 features under
* JDK 1.1.x will not be compatible for use with other JDBC 2 drivers. Please
* also note that 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)
*
* 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:
*
* Starting with HSQLDB 1.7.2, support for precompilation at the engine level
* has been implemented, so it is now much more efficient and performant
* to use a PreparedStatement object if the same SQL statement
* is executed many times.
*
* 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.
*
*
* @see #createStatement(int,int)
* @see #createStatement(int,int,int)
*/
public synchronized Statement createStatement() throws SQLException {
checkClosed();
Statement stmt = new jdbcStatement(this,
jdbcResultSet.TYPE_FORWARD_ONLY);
return stmt;
}
/**
*
* 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:
*
* Starting with HSQLDB 1.7.2, support for precompilation at the engine level
* has been implemented, so it is now much more efficient and performant
* to use a PreparedStatement object if the same SQL statement
* is executed many times.
*
* Starting with 1.7.2, the support for and behaviour of
* PreparedStatment has changed. Please read the introductory section
* of the documentation for org.hsqldb.jdbc.jdbcPreparedStatement.
*
* PreparedStatement object
* containing the pre-compiled SQL statement
* @exception SQLException if a database access error occurs
* @see #prepareStatement(String,int,int)
*/
public synchronized PreparedStatement prepareStatement(String sql)
throws SQLException {
PreparedStatement stmt;
checkClosed();
try {
stmt = new jdbcPreparedStatement(this, sql,
jdbcResultSet.TYPE_FORWARD_ONLY);
return stmt;
} catch (HsqlException e) {
throw jdbcUtil.sqlException(e);
}
}
/**
*
* 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:
*
* Starting with 1.7.2, the support for and behaviour of
* CallableStatement has changed. Please read the introductory section
* of the documentation for org.hsqldb.jdbc.jdbcCallableStatement.
*
*
*
* Note: Typically the SQL statement is a JDBC
* function call escape string.
* @return a new default CallableStatement object
* containing the pre-compiled SQL statement
* @exception SQLException if a database access error occurs
* @see #prepareCall(String,int,int)
*/
public synchronized CallableStatement prepareCall(String sql)
throws SQLException {
CallableStatement stmt;
checkClosed();
try {
stmt = new jdbcCallableStatement(this, sql,
jdbcResultSet.TYPE_FORWARD_ONLY);
return stmt;
} catch (HsqlException e) {
throw jdbcUtil.sqlException(e);
}
}
/**
*
* 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.2, HSQLDB converts the JDBC SQL
* grammar into the system's native SQL grammar prior to sending
* it, if escape processing is set true; this method returns the
* native form of the statement that the driver would send in place
* of client-specified JDBC SQL grammar.
*
* Before 1.7.2, escape processing was incomplete and
* also broken in terms of support for nested escapes.
*
* Starting with 1.7.2, escape processing is complete and handles nesting
* to arbitrary depth, but enforces a very strict interpretation of the
* syntax and does not detect or process SQL comments.
*
* In essence, the HSQLDB engine directly handles the prescribed syntax
* and date / time formats specified internal to the JDBC escapes.
* It also directly offers the XOpen / ODBC extended scalar
* functions specified available internal to the {fn ...} JDBC escape.
* As such, the driver simply removes the curly braces and JDBC escape
* codes in the simplest and fastest fashion possible, by replacing them
* with whitespace.
*
* But to avoid a great deal of complexity, certain forms of input
* whitespace are currently not recognised. For instance,
* the driver handles "{?= call ...}" but not "{ ?= call ...} or
* "{? = call ...}"
*
* Also, comments embedded in SQL are currently not detected or
* processed and thus may have unexpected effects on the output
* of this method, for instance causing otherwise valid SQL to become
* invalid. It is especially important to be aware of this because escape
* processing is set true by default for Statement objects and is always
* set true when producing a PreparedStatement from prepareStatement()
* or CallableStatement from prepareCall(). Currently, it is simply
* recommended to avoid submitting SQL having comments containing JDBC
* escape sequence patterns and/or single or double quotation marks,
* as this will avoid any potential problems.
*
* It is intended to implement a less strict handling of whitespace and
* proper processing of SQL comments at some point in the near future,
* perhaps before the final 1.7.2 release.
*
* In any event, 1.7.2 now correctly processes the following JDBC escape
* forms to arbitrary nesting depth, but only if the exact whitespace
* layout described below is used:
*
*
* - {call ...}
*
- {?= call ...}
*
- {fn ...}
*
- {oj ...}
*
- {d ...}
*
- {t ...}
*
- {ts ...}
*
*
*
*/
public synchronized String nativeSQL(final String sql)
throws SQLException {
// boucherb@users 20030405
// FIXME: does not work properly for nested escapes
// e.g. {call ...(...,{ts '...'},....)} does not work
// boucherb@users 20030817
// TESTME: First kick at the FIXME cat done. Now lots of testing
// and refinment
checkClosed();
// CHECKME: Thow or return null if input is null?
if (sql == null || sql.length() == 0 || sql.indexOf('{') == -1) {
return sql;
}
// boolean changed = false;
int state = 0;
int len = sql.length();
int nest = 0;
StringBuffer sb = new StringBuffer(sql.length()); //avoid 16 extra
String msg;
//--
final int outside_all = 0;
final int outside_escape_inside_single_quotes = 1;
final int outside_escape_inside_double_quotes = 2;
//--
final int inside_escape = 3;
final int inside_escape_inside_single_quotes = 4;
final int inside_escape_inside_double_quotes = 5;
// TODO:
// final int inside_single_line_comment = 6;
// final int inside_multi_line_comment = 7;
// Better than old way for large inputs and for avoiding GC overhead;
// toString() reuses internal char[], reducing memory requirment
// and garbage items 3:2
sb.append(sql);
for (int i = 0; i < len; i++) {
char c = sb.charAt(i);
switch (state) {
case outside_all : // Not inside an escape or quotes
if (c == '\'') {
state = outside_escape_inside_single_quotes;
} else if (c == '"') {
state = outside_escape_inside_double_quotes;
} else if (c == '{') {
sb.setCharAt(i++, ' ');
i = StringUtil.skipSpaces(sql, i);
if (sql.regionMatches(true, i, "fn ", 0, 3)
|| sql.regionMatches(true, i, "oj ", 0, 3)
|| sql.regionMatches(true, i, "ts ", 0, 3)) {
sb.setCharAt(i++, ' ');
sb.setCharAt(i++, ' ');
} else if (sql.regionMatches(true, i, "d ", 0, 2)
|| sql.regionMatches(true, i, "t ", 0,
2)) {
sb.setCharAt(i++, ' ');
} else if (sql.regionMatches(true, i, "call ", 0,
5)) {
i += 4;
} else if (sql.regionMatches(true, i, "?= call ", 0,
8)) {
sb.setCharAt(i++, ' ');
sb.setCharAt(i++, ' ');
i += 5;
} else if (sql.regionMatches(true, i, "escape ", 0,
7)) {
i += 6;
} else {
i--;
throw new SQLException(Trace
.getMessage(Trace
.jdbcConnection_nativeSQL, true, new Object[]{ sql
.substring(i) }), "S0010", Trace
.INVALID_JDBC_ARGUMENT);
}
// changed = true;
nest++;
state = inside_escape;
}
break;
case outside_escape_inside_single_quotes : // inside ' ' only
case inside_escape_inside_single_quotes : // inside { } and ' '
if (c == '\'') {
state -= 1;
}
break;
case outside_escape_inside_double_quotes : // inside " " only
case inside_escape_inside_double_quotes : // inside { } and " "
if (c == '"') {
state -= 2;
}
break;
case inside_escape : // inside { }
if (c == '\'') {
state = inside_escape_inside_single_quotes;
} else if (c == '"') {
state = inside_escape_inside_double_quotes;
} else if (c == '}') {
sb.setCharAt(i, ' ');
// changed = true;
nest--;
state = (nest == 0) ? outside_all
: inside_escape;
} else if (c == '{') {
sb.setCharAt(i++, ' ');
if (sql.regionMatches(true, i, "fn ", 0, 3)
|| sql.regionMatches(true, i, "oj ", 0, 3)
|| sql.regionMatches(true, i, "ts ", 0, 3)) {
sb.setCharAt(i++, ' ');
sb.setCharAt(i++, ' ');
} else if (sql.regionMatches(true, i, "d ", 0, 2)
|| sql.regionMatches(true, i, "t ", 0,
2)) {
sb.setCharAt(i++, ' ');
} else if (sql.regionMatches(true, i, "call ", 0,
5)) {
i += 4;
} else if (sql.regionMatches(true, i, "?= call ", 0,
8)) {
sb.setCharAt(i++, ' ');
sb.setCharAt(i++, ' ');
i += 5;
} else if (sql.regionMatches(true, i, "escape ", 0,
7)) {
i += 6;
} else {
i--;
throw new SQLException(Trace
.getMessage(Trace
.jdbcConnection_nativeSQL, true, new Object[]{ sql
.substring(i) }), "S0010", Trace
.INVALID_JDBC_ARGUMENT);
}
// changed = true;
nest++;
state = inside_escape;
}
}
}
return sb.toString();
}
/**
*
* 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.2,
*
*
* - 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.
*
* - Multiple result sets and output parameters are not yet
* supported.
*
*
*
* (boucherb@users) true to enable auto-commit
* mode; false to disable it
* @exception SQLException if a database access error occurs
* @see #getAutoCommit
*/
public synchronized void setAutoCommit(boolean autoCommit)
throws SQLException {
checkClosed();
try {
sessionProxy.setAutoCommit(autoCommit);
} catch (HsqlException e) {
throw jdbcUtil.sqlException(e);
}
}
/**
* Gets the current auto-commit state.
*
* @return the current state of auto-commit mode
* @exception SQLException Description of the Exception
* @see #setAutoCommit
*/
public synchronized boolean getAutoCommit() throws SQLException {
checkClosed();
try {
return sessionProxy.isAutoCommit();
} catch (HsqlException e) {
throw jdbcUtil.sqlException(e);
}
}
/**
*
* 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:
*
* Starting with HSQLDB 1.7.2, savepoints are supported both
* in SQL and via the JDBC interface.
*
* Using SQL, savepoints may be set, released and used in rollback
* as follows:
*
*
* SAVEPOINT <savepoint-name>
* RELEASE SAVEPOINT <savepoint-name>
* ROLLBACK TO SAVEPOINT <savepoint-name>
*
*
*
*
*
*
*
* HSQLDB-Specific Information:
*
* Starting with HSQLDB 1.7.2, savepoints are fully supported both
* in SQL and via the JDBC interface.
*
* Using SQL, savepoints may be set, released and used in rollback
* as follows:
*
*
* SAVEPOINT <savepoint-name>
* RELEASE SAVEPOINT <savepoint-name>
* ROLLBACK TO SAVEPOINT <savepoint-name>
*
*
* 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 1.7.2, INTERNAL Connection
* objects are not closable from JDBC client code.
*
* DatabaseMetaData object.
*
*
*
*
* HSQLDB-Specific Information:
*
* JDBC DatabaseMetaData methods returning
* ResultSet were not implemented fully before 1.7.2.
* Some of these methods always returned empty result sets.
* Other methods did not accurately
* reflect all of the MetaData for the category.
* Also, some method ignored the filters provided as
* parameters, returning an unfiltered result each time.
*
* Also, the majority of methods returning ResultSet
* threw an SQLException when accessed by a non-admin
* user.
*
*
* Starting with HSQLDB 1.7.2, essentially full database metadata
* is supported.
*
* For discussion in greater detail, please follow the link to the
* overview for jdbcDatabaseMetaData, below.
*
*
*
* Note: This method should not be called while in the
* middle of a transaction.
*
*
*
*
* HSQLDB-Specific Information:
*
* Up to and including 1.7.2, 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 CD-based
* readonly databases. To create a CD-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 before copying the database
* files to CD. This will reduce the space required and may
* improve access times against the .data file which holds the
* CACHED table data.
*
* Starting with 1.7.2, an alternate approach to opimizing the
* .data file before creating a CD-based readonly database is to issue
* the CHECKPOINT DEFRAG command followed by SHUTDOWN to take the
* database offline in preparation to burn the database files to CD.
*
*
*
*
*
*
* HSQLDB-Specific Information:
*
* HSQLDB does not yet support catalogs and simply ignores this
* request.
*
*/
public synchronized void setCatalog(String catalog) throws SQLException {
checkClosed();
}
/**
*
* Returns the Connection's current catalog name.
*
*
*
*
* HSQLDB-Specific Information:
*
* HSQLDB does not yet support catalogs and always returns null.
*
*
*
*
* For HSQLDB, this is always null.
* @exception SQLException Description of the Exception
*/
public synchronized String getCatalog() throws SQLException {
checkClosed();
return null;
}
/**
*
* 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.
*
* 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.)
* @exception SQLException if a database access error occurs or
* the given parameter is not one of the Connection
* constants
* @see jdbcDatabaseMetaData#supportsTransactionIsolationLevel
* @see #getTransactionIsolation
*/
public synchronized void setTransactionIsolation(int level)
throws SQLException {
checkClosed();
if (level != Connection.TRANSACTION_READ_UNCOMMITTED) {
throw jdbcUtil.notSupported;
}
}
/**
*
* Retrieves this Connection
* object's current transaction isolation level.
*
*
*
*
* HSQLDB-Specific Information:
*
* HSQLDB always returns
* Connection.TRANSACTION_READ_UNCOMMITED.
*
* 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
* @exception SQLException if a database access error occurs
* @see jdbcDatabaseMetaData#supportsTransactionIsolationLevel
* @see #setTransactionIsolation setTransactionIsolation
*/
public synchronized int getTransactionIsolation() throws SQLException {
checkClosed();
return Connection.TRANSACTION_READ_UNCOMMITTED;
}
/**
*
* 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:
*
* Starting with 1.7.2, HSQLDB produces warnings whenever a createStatement(),
* prepareStatement() or prepareCall() invocation requests an unsupported
* but defined combination of result set type, concurrency and holdability,
* such that another set is substituted.
*
* SQLWarning object or null
* if there are none
* @exception SQLException if a database access error occurs or
* this method is called on a closed connection
* @see SQLWarning
*/
public synchronized SQLWarning getWarnings() throws SQLException {
checkClosed();
synchronized (rootWarning_mutex) {
return rootWarning;
}
}
/**
*
* 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:
*
* Before HSQLDB 1.7.2, SQLWarning was not
* supported, and calls to this method are simply ignored.
*
* Starting with HSQLDB 1.7.2, the standard behaviour is implemented.
*
*
*/
public synchronized void clearWarnings() throws SQLException {
checkClosed();
synchronized (rootWarning_mutex) {
rootWarning = null;
}
}
//--------------------------JDBC 2.0-----------------------------
/**
*
* 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.
*
* Starting with HSQLDB 1.7.2, the behaviour regarding the type and
* concurrency values has changed to more closely conform to the
* specification. That is, if an unsupported combination is requested,
* a SQLWarning is issued on this Connection and the closest supported
* combination is used instead.
*
* 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.
*
* ResultSet.TYPE_FORWARD_ONLY,
* ResultSet.TYPE_SCROLL_INSENSITIVE, or
* ResultSet.TYPE_SCROLL_SENSITIVE (not
* supported)
* @param concurrency a concurrency type; one of
* ResultSet.CONCUR_READ_ONLY
* or ResultSet.CONCUR_UPDATABLE (not supported)
* @return a new Statement object that will, within
* the release-specific documented limitations of support,
* generate ResultSet objects with the given
* type and concurrency
* @exception 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)
*/
public synchronized Statement createStatement(int type,
int concurrency) throws SQLException {
checkClosed();
type = xlateRSType(type);
concurrency = xlateRSConcurrency(concurrency);
return new jdbcStatement(this, type);
}
/**
*
* 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:
*
* Starting with HSQLDB 1.7.2, the behaviour regarding the type and
* concurrency values has changed to more closely conform to the
* specification. That is, if an unsupported combination is requested,
* a SQLWarning is issued on this Connection and the closest supported
* combination is used instead.
*
* Also starting with 1.7.2, the support for and behaviour of
* PreparedStatment has changed. Please read the introductory section
* of the documentation for org.hsqldb.jdbc.jdbcPreparedStatement.
*
* ResultSet.TYPE_FORWARD_ONLY,
* ResultSet.TYPE_SCROLL_INSENSITIVE, or
* ResultSet.TYPE_SCROLL_SENSITIVE (not
* supported)
* @param concurrency a concurrency type; one of
* ResultSet.CONCUR_READ_ONLY
* or ResultSet.CONCUR_UPDATABLE (not supported)
* @return a new PreparedStatement object containing the
* pre-compiled SQL statement that will produce
* ResultSet
* objects with the given type and concurrency
* @exception 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)
*/
public synchronized PreparedStatement prepareStatement(String sql,
int type, int concurrency) throws SQLException {
checkClosed();
type = xlateRSType(type);
concurrency = xlateRSConcurrency(concurrency);
try {
return new jdbcPreparedStatement(this, sql, type);
} catch (HsqlException e) {
throw jdbcUtil.sqlException(e);
}
}
/**
*
* 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:
*
* Starting with HSQLDB 1.7.2, the behaviour regarding the type,
* concurrency and holdability values has changed to more closely
* conform to the specification. That is, if an unsupported
* combination is requrested, a SQLWarning is issued on this Connection
* and the closest supported combination is used instead.
*
* Also starting with 1.7.2, the support for and behaviour of
* CallableStatement has changed. Please read the introdutory section
* of the documentation for org.hsqldb.jdbc.jdbcCallableStatement.
*
* ResultSet.TYPE_FORWARD_ONLY,
* ResultSet.TYPE_SCROLL_INSENSITIVE, (not
* supported) or ResultSet.TYPE_SCROLL_SENSITIVE
* (not supported)
* @param resultSetConcurrency a concurrency type; one of
* ResultSet.CONCUR_READ_ONLY
* or ResultSet.CONCUR_UPDATABLE (not supported)
* @return a new CallableStatement object containing the
* pre-compiled SQL statement
* @exception 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)
*/
public synchronized CallableStatement prepareCall(String sql,
int resultSetType, int resultSetConcurrency) throws SQLException {
checkClosed();
resultSetType = xlateRSType(resultSetType);
resultSetConcurrency = xlateRSConcurrency(resultSetConcurrency);
try {
return new jdbcCallableStatement(this, sql, resultSetType);
} catch (HsqlException e) {
throw jdbcUtil.sqlException(e);
}
}
/**
*
* 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.2 does not support this feature. Calling this
* method always throws a SQLException, stating that the
* function is not supported.
*
* java.util.Map object associated with
* this Connection object
* @exception 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)
*/
public synchronized Map getTypeMap() throws SQLException {
checkClosed();
throw jdbcUtil.notSupported;
}
/**
*
* 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.2 does not support this feature. Calling this
* method always throws a SQLException, stating that
* the function is not supported.
*
* java.util.Map object to install as
* the replacement for this Connection object's
* default type map
* @exception 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 #getTypeMap
*/
public synchronized void setTypeMap(Map map) throws SQLException {
checkClosed();
throw jdbcUtil.notSupported;
}
// boucherb@users 20020409 - javadocs for all JDBC 3 methods
// boucherb@users 20020509 - todo
// start adding implementations where it is easy: Savepoints
//--------------------------JDBC 3.0-----------------------------
/**
*
* Changes the holdability of
* ResultSet objects created using this
* Connection object to the given holdability.
*
*
*
*
* HSQLDB-Specific Information:
*
* Starting with HSQLDB 1.7.2, this feature is supported.
*
* As of 1.7.2, only HOLD_CURSORS_OVER_COMMIT is supported; supplying
* any other value will throw an exception.
*
* ResultSet holdability
* constant; one of ResultSet.HOLD_CURSORS_OVER_COMMIT
* or ResultSet.CLOSE_CURSORS_AT_COMMIT
* @throws SQLException if a database access occurs, the given
* parameter is not a ResultSet constant
* indicating holdability, or the given holdability is not
* supported
* @see #getHoldability
* @see ResultSet
* @since JDK 1.4, HSQLDB 1.7.2
*/
//#ifdef JDBC3
public synchronized void setHoldability(int holdability)
throws SQLException {
checkClosed();
if (holdability != jdbcResultSet.HOLD_CURSORS_OVER_COMMIT) {
String msg = "ResultSet holdability: " + holdability;
throw jdbcUtil.sqlException(Trace.FUNCTION_NOT_SUPPORTED, msg);
}
}
//#endif JDBC3
/**
*
* Retrieves the current
* holdability of ResultSet objects created using
* this Connection object.
*
*
*
*
* HSQLDB-Specific Information:
*
* Starting with HSQLDB 1.7.2, this feature is supported.
*
* Calling this method always returns HOLD_CURSORS_OVER_COMMIT.
*
* ResultSet.HOLD_CURSORS_OVER_COMMIT
* or ResultSet.CLOSE_CURSORS_AT_COMMIT
* @throws SQLException if a database access occurs
* @see #setHoldability
* @see ResultSet
* @since JDK 1.4, HSQLDB 1.7.2
*/
//#ifdef JDBC3
public synchronized int getHoldability() throws SQLException {
checkClosed();
return jdbcResultSet.HOLD_CURSORS_OVER_COMMIT;
}
//#endif JDBC3
/**
*
* Creates an unnamed savepoint in
* the current transaction and returns the new Savepoint
* object that represents it.
*
*
*
*
* HSQLDB-Specific Information:
*
* HSQLDB 1.7.2 does not support this feature.
*
* Calling this method always throws a SQLException,
* stating that the function is not supported.
*
* Use setSavepoint(String name) instead
*
* Savepoint object
* @exception SQLException if a database access error occurs or
* this Connection object is currently in
* auto-commit mode
* @see jdbcSavepoint
* @see java.sql.Savepoint
* @since JDK 1.4, HSQLDB 1.7.2
*/
//#ifdef JDBC3
public synchronized Savepoint setSavepoint() throws SQLException {
checkClosed();
throw jdbcUtil.notSupported;
}
//#endif JDBC3
/**
*
* Creates a savepoint with the
* given name in the current transaction and returns the new
* Savepoint object that represents it.
*
*
*
* @param name a String containing the name of the savepoint
* @return the new Savepoint object
* @exception SQLException if a database access error occurs or
* this Connection object is currently in
* auto-commit mode
*
* @see jdbcSavepoint
* @see java.sql.Savepoint
* @since JDK 1.4, HSQLDB 1.7.2
*/
//#ifdef JDBC3
public synchronized Savepoint setSavepoint(String name)
throws SQLException {
Result req;
checkClosed();
if (name == null) {
String msg = "name is null";
throw jdbcUtil.sqlException(Trace.INVALID_JDBC_ARGUMENT, msg);
}
req = Result.newSetSavepointRequest(name);
try {
sessionProxy.execute(req);
} catch (HsqlException e) {
jdbcUtil.throwError(e);
}
return new jdbcSavepoint(name, this);
}
//#endif JDBC3
/**
*
* Undoes all changes made after
* the given Savepoint object was set.
*
* This method should be used only when auto-commit has been
* disabled.
*
*
*
* @param savepoint the Savepoint object to roll back to
* @exception SQLException if a database access error occurs,
* the Savepoint object is no longer valid,
* or this Connection object is currently in
* auto-commit mode
* @see jdbcSavepoint
* @see java.sql.Savepoint
* @see #rollback
* @since JDK 1.4, HSQLDB 1.7.2
*/
//#ifdef JDBC3
public synchronized void rollback(Savepoint savepoint)
throws SQLException {
String msg;
jdbcSavepoint sp;
Result req;
checkClosed();
if (savepoint == null) {
msg = "savepoint is null";
throw jdbcUtil.sqlException(Trace.INVALID_JDBC_ARGUMENT, msg);
}
try {
if (sessionProxy.isAutoCommit()) {
msg = "connection is autocommit";
throw jdbcUtil.sqlException(Trace.INVALID_JDBC_ARGUMENT, msg);
}
} catch (HsqlException e) {
throw jdbcUtil.sqlException(e);
}
// fredt - might someone call this with a Savepoint from a different driver???
if (!(savepoint instanceof jdbcSavepoint)) {
throw jdbcUtil.sqlException(Trace.INVALID_JDBC_ARGUMENT);
}
sp = (jdbcSavepoint) savepoint;
if (this != sp.connection) {
msg = savepoint + " was not issued on this connection";
throw jdbcUtil.sqlException(Trace.INVALID_JDBC_ARGUMENT, msg);
}
req = Result.newRollbackToSavepointRequest(sp.name);
try {
Result result = sessionProxy.execute(req);
if (result.iMode == ResultConstants.ERROR) {
jdbcUtil.throwError(result);
}
} catch (HsqlException e) {
jdbcUtil.throwError(e);
}
}
//#endif JDBC3
/**
*
* 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.
*
*
*
* @param savepoint the Savepoint object to be removed
* @exception SQLException if a database access error occurs or
* the given Savepoint object is not a valid
* savepoint in the current transaction
*
* @see jdbcSavepoint
* @see java.sql.Savepoint
* @since JDK 1.4, HSQLDB 1.7.2
*/
//#ifdef JDBC3
public synchronized void releaseSavepoint(Savepoint savepoint)
throws SQLException {
String msg;
jdbcSavepoint sp;
Result req;
checkClosed();
if (savepoint == null) {
msg = "savepoint is null";
throw jdbcUtil.sqlException(Trace.INVALID_JDBC_ARGUMENT, msg);
}
// fredt - might someone call this with a Savepoint from a different driver???
if (!(savepoint instanceof jdbcSavepoint)) {
throw jdbcUtil.sqlException(Trace.INVALID_JDBC_ARGUMENT);
}
sp = (jdbcSavepoint) savepoint;
if (this != sp.connection) {
msg = savepoint.getSavepointName()
+ " was not issued on this connection";
throw jdbcUtil.sqlException(Trace.INVALID_JDBC_ARGUMENT, msg);
}
req = Result.newReleaseSavepointRequest(sp.name);
try {
Result result = sessionProxy.execute(req);
if (result.iMode == ResultConstants.ERROR) {
jdbcUtil.throwError(result);
}
} catch (HsqlException e) {
jdbcUtil.throwError(e);
}
}
//#endif JDBC3
/**
*
* 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:
*
* Starting with HSQLDB 1.7.2, this feature is supported.
*
* Starting with HSQLDB 1.7.2, the behaviour regarding the type,
* concurrency and holdability values has changed to more closely conform
* to the specification. That is, if an unsupported combination is requested,
* a SQLWarning is issued on this Connection and the closest supported
* combination is used instead.
*
* ResultSet
* constants: ResultSet.TYPE_FORWARD_ONLY,
* ResultSet.TYPE_SCROLL_INSENSITIVE,
* or ResultSet.TYPE_SCROLL_SENSITIVE
* @param resultSetConcurrency one of the following
* ResultSet
* constants: ResultSet.CONCUR_READ_ONLY or
* ResultSet.CONCUR_UPDATABLE
* @param resultSetHoldability one of the following
* code>ResultSet
* constants: ResultSet.HOLD_CURSORS_OVER_COMMIT
* or ResultSet.CLOSE_CURSORS_AT_COMMIT
* @return a new Statement object that will generate
* ResultSet objects with the given type,
* concurrency, and holdability
* @exception SQLException if a database access error occurs or
* the given parameters are not ResultSet
* constants indicating type, concurrency, and holdability
* @see ResultSet
* @since JDK 1.4, HSQLDB 1.7.2
*/
//#ifdef JDBC3
public synchronized Statement createStatement(int resultSetType,
int resultSetConcurrency,
int resultSetHoldability) throws SQLException {
checkClosed();
resultSetType = xlateRSType(resultSetType);
resultSetConcurrency = xlateRSConcurrency(resultSetConcurrency);
resultSetHoldability = xlateRSHoldability(resultSetHoldability);
return new jdbcStatement(this, resultSetType);
}
//#endif JDBC3
/**
*
* 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:
*
* Starting with HSQLDB 1.7.2, this feature is supported.
*
* Starting with HSQLDB 1.7.2, the behaviour regarding the type,
* concurrency and holdability values has changed to more closely
* conform to the specification. That is, if an unsupported
* combination is requested, a SQLWarning is issued on this Connection
* and the closest supported combination is used instead.
*
* Also starting with 1.7.2, the support for and behaviour of
* PreparedStatment has changed. Please read the introductory section
* of the documentation for org.hsqldb.jdbc.jdbcPreparedStatement.
*
* String object that is the SQL
* statement to be sent to the database; may contain one or
* more ? IN parameters
* @param resultSetType one of the following ResultSet
* constants: ResultSet.TYPE_FORWARD_ONLY,
* ResultSet.TYPE_SCROLL_INSENSITIVE,
* or ResultSet.TYPE_SCROLL_SENSITIVE
* @param resultSetConcurrency one of the following
* ResultSet
* constants: ResultSet.CONCUR_READ_ONLY or
* ResultSet.CONCUR_UPDATABLE
* @param resultSetHoldability one of the following
* ResultSet
* constants: ResultSet.HOLD_CURSORS_OVER_COMMIT
* or ResultSet.CLOSE_CURSORS_AT_COMMIT
* @return a new PreparedStatement object,
* containing the pre-compiled SQL statement, that will
* generate ResultSet objects with the given
* type, concurrency, and holdability
* @exception SQLException if a database access error occurs or
* the given parameters are not ResultSet
* constants indicating type, concurrency, and holdability
* @see ResultSet
* @since JDK 1.4, HSQLDB 1.7.2
*/
//#ifdef JDBC3
public synchronized PreparedStatement prepareStatement(String sql,
int resultSetType, int resultSetConcurrency,
int resultSetHoldability) throws SQLException {
checkClosed();
resultSetType = xlateRSType(resultSetType);
resultSetConcurrency = xlateRSConcurrency(resultSetConcurrency);
resultSetHoldability = xlateRSHoldability(resultSetHoldability);
try {
return new jdbcPreparedStatement(this, sql, resultSetType);
} catch (HsqlException e) {
throw jdbcUtil.sqlException(e);
}
}
//#endif JDBC3
/**
*
* 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:
*
* Starting with HSQLDB 1.7.2, this feature is supported.
*
* Starting with HSQLDB 1.7.2, the behaviour regarding the type,
* concurrency and holdability values has changed to more closely
* conform to the specification. That is, if an unsupported
* combination is requrested, a SQLWarning is issued on this Connection
* and the closest supported combination is used instead.
*
* Also starting with 1.7.2, the support for and behaviour of
* CallableStatment has changed. Please read the introdutory section
* of the documentation for org.hsqldb.jdbc.jdbcCallableStatement.
*
* String object that is the SQL
* statement to be sent to the database; may contain on or
* more ? parameters
* @param resultSetType one of the following ResultSet
* constants: ResultSet.TYPE_FORWARD_ONLY,
* ResultSet.TYPE_SCROLL_INSENSITIVE, or
* ResultSet.TYPE_SCROLL_SENSITIVE
* @param resultSetConcurrency one of the following
* ResultSet
* constants: ResultSet.CONCUR_READ_ONLY or
* ResultSet.CONCUR_UPDATABLE
* @param resultSetHoldability one of the following
* ResultSet
* constants: ResultSet.HOLD_CURSORS_OVER_COMMIT
* or ResultSet.CLOSE_CURSORS_AT_COMMIT
* @return a new CallableStatement object,
* containing the pre-compiled SQL statement, that will
* generate ResultSet objects with the given
* type, concurrency, and holdability
* @exception SQLException if a database access error occurs or
* the given parameters are not ResultSet
* constants indicating type, concurrency, and holdability
* @see ResultSet
* @since JDK 1.4, HSQLDB 1.7.2
*/
//#ifdef JDBC3
public synchronized CallableStatement prepareCall(String sql,
int resultSetType, int resultSetConcurrency,
int resultSetHoldability) throws SQLException {
checkClosed();
resultSetType = xlateRSType(resultSetType);
resultSetConcurrency = xlateRSConcurrency(resultSetConcurrency);
resultSetHoldability = xlateRSHoldability(resultSetHoldability);
try {
return new jdbcCallableStatement(this, sql, resultSetType);
} catch (HsqlException e) {
throw jdbcUtil.sqlException(e);
}
}
//#endif JDBC3
/**
*
* 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.2 does not support this feature.
*
* Calling this method always throws a SQLException,
* stating that the function is not supported.
*
* Statement.NO_GENERATED_KEYS.
* @return a new PreparedStatement object,
* containing the pre-compiled SQL statement, that will have
* the capability of returning auto-generated keys
* @exception 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.2
*/
//#ifdef JDBC3
public synchronized PreparedStatement prepareStatement(String sql,
int autoGeneratedKeys) throws SQLException {
checkClosed();
throw jdbcUtil.notSupported;
}
//#endif JDBC3
/**
*
* 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.2 does not support this feature.
*
* Calling this method always throws a SQLException,
* stating that the function is not supported.
*
* PreparedStatement object,
* containing the pre-compiled statement, that is capable of
* returning the auto-generated keys designated by the given
* array of column indexes
* @exception SQLException if a database access error occurs
* @since JDK 1.4, HSQLDB 1.7.2
*/
//#ifdef JDBC3
public synchronized PreparedStatement prepareStatement(String sql,
int columnIndexes[]) throws SQLException {
checkClosed();
throw jdbcUtil.notSupported;
}
//#endif JDBC3
/**
*
* 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.2 does not support this feature.
*
* Calling this method always throws a SQLException,
* stating that the function is not supported.
*
* 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
* @since JDK 1.4, HSQLDB 1.7.2
*/
//#ifdef JDBC3
public synchronized PreparedStatement prepareStatement(String sql,
String columnNames[]) throws SQLException {
checkClosed();
throw jdbcUtil.notSupported;
}
//#endif JDBC3
//---------------------- internal implementation ---------------------------
/**
* Constructs a new external Connection to an HSQLDB
* Database.
*
* This constructor is called on behalf of the
* java.sql.DriverManager when getting a
* Connection for use in normal (external)
* client code.
*
* Internal client code, that being code located in HSQLDB SQL
* functions and stored procedures, receives an INTERNAL
* connection constructed by the {@link #jdbcConnection(Session)
* jdbcConnection(Session)} constructor.
*
* @param props A Properties object containing the connection
* properties
* @exception SQLException when the user/password combination is
* invalid, the connection url is invalid, or the
* Database is unavailable.
*
* The Database may be unavailable for a number
* of reasons, including network problems or the fact that it
* may already be in use by another process.
*/
public jdbcConnection(HsqlProperties props) throws SQLException {
String user = (String) props.getProperty("user");
String password = (String) props.getProperty("password");
boolean ifExists = props.isPropertyTrue("ifexists");
String connType = (String) props.getProperty("connection_type");
String host = props.getProperty("host");
int port = props.getIntegerProperty("port", 0);
String path = props.getProperty("path");
String database = (String) props.getProperty("database");
boolean isTLS = (connType == DatabaseManager.S_HSQLS
|| connType == DatabaseManager.S_HTTPS);
if (user == null) {
user = "SA";
}
if (password == null) {
password = "";
}
user = user.toUpperCase();
password = password.toUpperCase();
try {
if (connType == DatabaseManager.S_FILE
|| connType == DatabaseManager.S_MEM
|| connType == DatabaseManager.S_RES) {
// loosecannon1@users 1.7.2 patch properties on the JDBC URL
/** @todo fredt - this should be the only static reference to a core class in
* the jdbc package - we may make it dynamic */
sessionProxy = DatabaseManager.newSession(connType, database,
user, password, ifExists, props);
} else if (connType == DatabaseManager.S_HSQL
|| connType == DatabaseManager.S_HSQLS) {
sessionProxy = new HSQLClientConnection(host, port, path,
database, isTLS, user, password);
isNetConn = true;
} else if (connType == DatabaseManager.S_HTTP
|| connType == DatabaseManager.S_HTTPS) {
sessionProxy = new HTTPClientConnection(host, port, path,
database, isTLS, user, password);
isNetConn = true;
} else { // alias: type not yet implemented
throw jdbcUtil.sqlException(Trace.INVALID_JDBC_ARGUMENT);
}
connProperties = props;
} catch (HsqlException e) {
throw jdbcUtil.sqlException(e);
}
}
/**
* Constructs an INTERNAL Connection,
* using the specified {@link Session Session}.
*
* This constructor is called only on behalf of an existing
* Session (the internal parallel of a
* Connection), to be used as a parameter to a SQL
* function or stored procedure that needs to execute in the context
* of that Session.
*
* When a Java SQL function or stored procedure is called and its
* first parameter is of type Connection, HSQLDB
* automatically notices this and constructs an INTERNAL
* Connection using the current Session.
* HSQLDB then passes this Connection in the first
* parameter position, moving any other parameter values
* specified in the SQL statement to the right by one position.
*
*
* To read more about this, see {@link Function#getValue()}.
*
* Notes:
*
* Starting with HSQLDB 1.7.2, INTERNAL connections are not
* closed by a call to close() or by a SQL DISCONNECT.
*
* For HSQLDB developers not involved with writing database
* internals, this change only applies 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. Presently, 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.
*
* @param c the Session requesting the construction of this
* Connection
* @exception HsqlException never (reserved for future use);
* @see org.hsqldb.Function
*/
public jdbcConnection(Session c) throws HsqlException {
// PRE: Session is non-null
isInternal = true;
sessionProxy = c;
}
/**
* The default implementation simply attempts to silently {@link
* #close() close()} this Connection
*/
public void finalize() {
try {
close();
} catch (SQLException e) {}
}
/**
* Retrieves this connection's JDBC url.
*
* This method is in support of the jdbcDatabaseMetaData.getURL() method.
*
* @return the database connection url with which this object was
* constructed
*/
synchronized String getURL() throws SQLException {
checkClosed();
if (isInternal) {
return ((Session) sessionProxy).getInternalConnectionURL();
}
return connProperties.getProperty("url");
}
/**
* An internal check for closed connections.
*
* @throws SQLException when the connection is closed
*/
synchronized void checkClosed() throws SQLException {
if (isClosed) {
throw jdbcUtil.sqlException(Trace.CONNECTION_IS_CLOSED);
}
}
/**
* Adds another SQLWarning to this Connection object's warning chain.
*
* @param w the SQLWarning to add to the chain
*/
void addWarning(SQLWarning w) {
// PRE: w is never null
synchronized (rootWarning_mutex) {
if (rootWarning == null) {
rootWarning = w;
} else {
rootWarning.setNextWarning(w);
}
}
}
/**
* Clears the warning chain without checking if this Connection is closed.
*/
void clearWarningsNoCheck() {
synchronized (rootWarning_mutex) {
rootWarning = null;
}
}
/**
* Translates ResultSet type, adding to the warning
* chain if the requested type is downgraded.
*
* Up to and including HSQLDB 1.7.2, TYPE_FORWARD_ONLY and
* TYPE_SCROLL_INSENSITIVE are passed through.
*
* Starting with 1.7.2, while TYPE_SCROLL_SENSITIVE is
* downgraded to TYPE_SCROLL_INSENSITIVE and an SQLWarning is
* issued.
*
* @param type of ResultSet; one of
* jdbcResultSet.TYPE_XXX
* @return the actual type that will be used
* @throws SQLException if type is not one of the defined values
*/
int xlateRSType(int type) throws SQLException {
SQLWarning w;
String msg;
switch (type) {
case jdbcResultSet.TYPE_FORWARD_ONLY :
case jdbcResultSet.TYPE_SCROLL_INSENSITIVE : {
return type;
}
case jdbcResultSet.TYPE_SCROLL_SENSITIVE : {
msg = "TYPE_SCROLL_SENSITIVE => TYPE_SCROLL_SENSITIVE";
w = new SQLWarning(msg, "SOO10", Trace.INVALID_JDBC_ARGUMENT);
addWarning(w);
return jdbcResultSet.TYPE_SCROLL_INSENSITIVE;
}
default : {
msg = "ResultSet type: " + type;
throw jdbcUtil.sqlException(Trace.INVALID_JDBC_ARGUMENT, msg);
}
}
}
/**
* Translates ResultSet concurrency, adding to the warning
* chain if the requested concurrency is downgraded.
*
* Starting with HSQLDB 1.7.2, CONCUR_READ_ONLY is
* passed through while CONCUR_UPDATABLE is downgraded
* to CONCUR_READ_ONLY and an SQLWarning is issued.
*
* @param concurrency of ResultSet; one of
* jdbcResultSet.CONCUR_XXX
* @return the actual concurrency that will be used
* @throws SQLException if concurrency is not one of the defined values
*/
int xlateRSConcurrency(int concurrency) throws SQLException {
SQLWarning w;
String msg;
switch (concurrency) {
case jdbcResultSet.CONCUR_READ_ONLY : {
return concurrency;
}
case jdbcResultSet.CONCUR_UPDATABLE : {
msg = "CONCUR_UPDATABLE => CONCUR_READ_ONLY";
w = new SQLWarning(msg, "SOO10", Trace.INVALID_JDBC_ARGUMENT);
addWarning(w);
return jdbcResultSet.CONCUR_READ_ONLY;
}
default : {
msg = "ResultSet concurrency: " + concurrency;
throw jdbcUtil.sqlException(Trace.INVALID_JDBC_ARGUMENT, msg);
}
}
}
/**
* Translates ResultSet holdability, adding to the warning
* chain if the requested holdability is changed from an unsupported to
* a supported value.
*
* Starting with HSQLDB 1.7.2, HOLD_CURSORS_OVER_COMMIT is
* passed through while CLOSE_CURSORS_AT_COMMIT is changed
* to HOLD_CURSORS_OVER_COMMIT and an SQLWarning is
* issued.
*
* @param holdability of ResultSet; one of
* jdbcResultSet.HOLD_CURSORS_OVER_COMMIT or
* jdbcResultSet.CLOSE_CURSORS_AT_COMMIT
* @return the actual holdability that will be used
* @throws SQLException if holdability is not one of the defined values
*/
int xlateRSHoldability(int holdability) throws SQLException {
SQLWarning w;
String msg;
switch (holdability) {
case jdbcResultSet.HOLD_CURSORS_OVER_COMMIT : {
return holdability;
}
case jdbcResultSet.CLOSE_CURSORS_AT_COMMIT : {
msg = "CLOSE_CURSORS_AT_COMMIT => HOLD_CURSORS_OVER_COMMIT";
w = new SQLWarning(msg, "SOO10", Trace.INVALID_JDBC_ARGUMENT);
addWarning(w);
return jdbcResultSet.HOLD_CURSORS_OVER_COMMIT;
}
default : {
msg = "ResultSet holdability: " + holdability;
throw jdbcUtil.sqlException(Trace.INVALID_JDBC_ARGUMENT, msg);
}
}
}
}
|
The search page
Other source code files at this package level
Click here to learn more about this project