- java.lang.Object
-
- org.hsqldb.jdbc.JDBCConnection
-
- All Implemented Interfaces:
java.lang.AutoCloseable,java.sql.Connection,java.sql.Wrapper
- Direct Known Subclasses:
JDBCXAConnectionWrapper
public class JDBCConnection extends java.lang.Object implements java.sql.ConnectionA connection (session) with a specific database. SQL statements are executed and results are returned within the context of a connection.A
Connectionobject'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 thegetMetaDatamethod.Note: When configuring a
Connection, JDBC applications should use the appropriateConnectionmethod such assetAutoCommitorsetTransactionIsolation. Applications should not invoke SQL commands directly to change the connection's configuration when there is a JDBC method available. By default aConnectionobject is in auto-commit mode, which means that it automatically commits changes after executing each statement. If auto-commit mode has been disabled, the methodcommitmust be called explicitly in order to commit changes; otherwise, database changes will not be saved.A new
Connectionobject created using the JDBC 2.1 core API has an initially empty type map associated with it. A user may enter a custom mapping for a UDT in this type map. When a UDT is retrieved from a data source with the methodResultSet.getObject, thegetObjectmethod will check the connection's type map to see if there is an entry for that UDT. If so, thegetObjectmethod will map the UDT to the class indicated. If there is no entry, the UDT will be mapped using the standard mapping.A user may create a new type map, which is a
java.util.Mapobject, make an entry in it, and pass it to thejava.sqlmethods that can perform custom mapping. In this case, the method will use the given type map instead of the one associated with the connection.For example, the following code fragment specifies that the SQL type
ATHLETESwill be mapped to the classAthletesin the Java programming language. The code fragment retrieves the type map for theConnectionobjectcon, inserts the entry into it, and then sets the type map with the new entry as the connection's type map.java.util.Map map = con.getTypeMap(); map.put("mySchemaName.ATHLETES", Class.forName("Athletes")); con.setTypeMap(map);HSQLDB-Specific Information:
To get aConnectionto 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
Serverdatabase connection <url> takes 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
WebServerdatabase connection <url> takes 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, if such an instance is available.
For more information on server configuration regarding mounting multiple databases and assigning them <alias> values, please read the Java API documentation for
Serverand related chapters in the general documentation, especially the HyperSQL User Guide.
Transient, In-Process Database Connections:The 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)
The driver converts the supplied <alias> component to Local.ENGLISH lower case and uses the resulting character sequence as the key used to look up a mem: protocol 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.
The rationale for converting the supplied <alias> component to lower case is to provide consistency with the behavior of res: protocol database connection <url>s, explained further on in this overview.
Persistent, In-Process Database Connections:The 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.
From 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 is:
- <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 canonical path of the JVM's effective working directory at the time the designated database is first opened in-process.
Be careful to note that this canonical expansion of <path> is cached by the driver until JVM exit. So, although legacy JVMs tend to fix the reported effective working directory at the one noted upon JVM startup, there is no guarantee that modern JVMs will continue to uphold this behaviour. What this means is there is effectively no guarantee into the future that a relative file: protocol database connection <url> will connect to the same database instance for the life of the JVM. To avoid any future ambiguity issues, it is probably a best practice for clients to attempt to pre-canonicalize the <path> component of file: protocol database connection* <url>s.
Under Windows, '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.lckUnder 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.lckSome 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:HSQLDB creates 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.
res: protocol Connections:The '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_readonly' database, but with some additional points to consider.
Specifically, the '<path>' component of a res: protocol database connection <url> is first converted to lower case with
Locale.ENGLISHand only then used to obtain resource URL objects, which in turn are used to read the database files as resources on the class path.Due to lower case conversion by the driver, res: '<path>' components never find jar resources stored with
Locale.ENGLISHmixed case paths. The rationale for converting to lower case is that not all pkzip implementations guarantee path case is preserved when archiving resources, and conversion to lower case seems to be the most common occurrence (although there is also no actual guarantee that the conversion isLocale.ENGLISH).More importantly, res: '<path>' components must point only to resources contained in one or more jars on the class path. That is, only resources having the jar sub-protocol are considered valid.
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 knowledge 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 WebStart and Java Applet configurations, 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 (and hence how relative path specifications are resolved) under 'files_in_jar' semantics, the <path> component of the res: database connection <url> is always taken to be relative to the default package and resource URL resolution is always performed using the ClassLoader that loads the org.hsqldb.persist.Logger class. That is, if the <path> component does not start with '/', then'/' is prepended when obtaining the resource URLs used to read the database files, and only the effective class path of org.hsqldb.persist.Logger's ClassLoader is searched.
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 HyperSQL User Guide.JDBC 4.0 Notes:
Starting with JDBC 4.0 (JDK 1.6), the
DriverManagermethodsgetConnectionandgetDrivershave been enhanced to support the Java Standard Edition Service Provider mechanism. HSQLDB distribution jars containing the Driver implementation also include the fileMETA-INF/services/java.sql.Driver. This file contains the fully qualified class name ('org.hsqldb.jdbc.JDBCDriver') of the HSQLDB implementation ofjava.sql.Driver.Hence, under JDBC 4.0 or greater, applications no longer need to explicitly load the HSQLDB JDBC driver using
Class.forName(). Of course, existing programs which do load JDBC drivers usingClass.forName()will continue to work without modification.
(fredt@users)
(campbell-burnet@users)- Since:
- HSQLDB 1.9.0
- Author:
- Campbell Burnet (campbell-burnet@users dot sourceforge.net), Fred Toussi (fredt@users dot sourceforge.net)
- See Also:
JDBCDriver,JDBCStatement,JDBCParameterMetaData,JDBCCallableStatement,JDBCResultSet,JDBCDatabaseMetaData,DriverManager,Statement,ResultSet,DatabaseMetaData
-
-
Constructor Summary
Constructors Constructor Description JDBCConnection(JDBCConnection c, JDBCConnectionEventListener eventListener)Constructor for use with connection pooling and XA.JDBCConnection(org.hsqldb.persist.HsqlProperties props)Constructs a new externalConnectionto an HSQLDBDatabase.JDBCConnection(org.hsqldb.SessionInterface c)Constructs anINTERNALConnection, using the specifiedSessionInterface.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidabort(java.util.concurrent.Executor executor)Terminates an open connection.voidbeginRequest()Hints to the driver that a request, an independent unit of work, is beginning on this connection.voidclearWarnings()Clears all warnings reported for thisConnectionobject.voidclose()Releases thisConnectionobject's database and JDBC resources immediately instead of waiting for them to be automatically released.voidcloseFully()Completely closes a pooled connectionvoidcommit()Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by thisConnectionobject.java.sql.ArraycreateArrayOf(java.lang.String typeName, java.lang.Object[] elements)Factory method for creating Array objects.java.sql.BlobcreateBlob()Constructs an object that implements theBlobinterface.java.sql.ClobcreateClob()Constructs an object that implements theClobinterface.java.sql.NClobcreateNClob()Constructs an object that implements theNClobinterface.java.sql.SQLXMLcreateSQLXML()Constructs an object that implements theSQLXMLinterface.java.sql.StatementcreateStatement()Creates aStatementobject for sending SQL statements to the database.java.sql.StatementcreateStatement(int resultSetType, int resultSetConcurrency)Creates aStatementobject that will generateResultSetobjects with the given type and concurrency.java.sql.StatementcreateStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)Creates aStatementobject that will generateResultSetobjects with the given type, concurrency, and holdability.java.sql.StructcreateStruct(java.lang.String typeName, java.lang.Object[] attributes)Factory method for creating Struct objects.voidendRequest()Hints to the driver that a request, an independent unit of work, has completed.booleangetAutoCommit()Retrieves the current auto-commit mode for thisConnectionobject.java.lang.StringgetCatalog()Retrieves thisConnectionobject's current catalog name.java.util.PropertiesgetClientInfo()Returns a list containing the name and current value of each client info property supported by the driver.java.lang.StringgetClientInfo(java.lang.String name)Returns the value of the client info property specified by name.org.hsqldb.persist.HsqlPropertiesgetConnProperties()intgetHoldability()Retrieves the current holdability ofResultSetobjects created using thisConnectionobject.java.sql.DatabaseMetaDatagetMetaData()Retrieves aDatabaseMetaDataobject that contains metadata about the database to which thisConnectionobject represents a connection.intgetNetworkTimeout()Retrieves the number of milliseconds the driver will wait for a database request to complete.java.lang.StringgetSchema()Retrieves thisConnectionobject's current schema name.org.hsqldb.SessionInterfacegetSession()provides cross-package access to the proprietary (i.e.intgetTransactionIsolation()Retrieves thisConnectionobject's current transaction isolation level.java.util.Map<java.lang.String,java.lang.Class<?>>getTypeMap()Retrieves theMapobject associated with thisConnectionobject.java.lang.StringgetURL()Retrieves this connection's JDBC url.java.sql.SQLWarninggetWarnings()Retrieves the first warning reported by calls on thisConnectionobject.booleanisClosed()Retrieves whether thisConnectionobject has been closed.booleanisInternal()booleanisNetwork()booleanisReadOnly()Retrieves whether thisConnectionobject is in read-only mode.booleanisValid(int timeout)Returns true if the connection has not been closed and is still valid.booleanisWrapperFor(java.lang.Class<?> iface)Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.java.lang.StringnativeSQL(java.lang.String sql)Converts the given SQL statement into the system's native SQL grammar.java.sql.CallableStatementprepareCall(java.lang.String sql)Creates aCallableStatementobject for calling database stored procedures.java.sql.CallableStatementprepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency)Creates aCallableStatementobject that will generateResultSetobjects with the given type and concurrency.java.sql.CallableStatementprepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)Creates aCallableStatementobject that will generateResultSetobjects with the given type and concurrency.java.sql.PreparedStatementprepareStatement(java.lang.String sql)Creates aPreparedStatementobject for sending parameterized SQL statements to the database.java.sql.PreparedStatementprepareStatement(java.lang.String sql, int autoGeneratedKeys)Creates a defaultPreparedStatementobject that has the capability to retrieve auto-generated keys.java.sql.PreparedStatementprepareStatement(java.lang.String sql, int[] columnIndexes)Creates a defaultPreparedStatementobject capable of returning the auto-generated keys designated by the given array.java.sql.PreparedStatementprepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency)Creates aPreparedStatementobject that will generateResultSetobjects with the given type and concurrency.java.sql.PreparedStatementprepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)Creates aPreparedStatementobject that will generateResultSetobjects with the given type, concurrency, and holdability.java.sql.PreparedStatementprepareStatement(java.lang.String sql, java.lang.String[] columnNames)Creates a defaultPreparedStatementobject capable of returning the auto-generated keys designated by the given array.voidreleaseSavepoint(java.sql.Savepoint savepoint)Removes the specifiedSavepointand subsequentSavepointobjects from the current transaction.voidreset()Resets the SQL session of this connection, so it can be used again.voidrollback()Undoes all changes made in the current transaction and releases any database locks currently held by thisConnectionobject.voidrollback(java.sql.Savepoint savepoint)Undoes all changes made after the givenSavepointobject was set.voidsetAutoCommit(boolean autoCommit)Sets this connection's auto-commit mode to the given state.voidsetCatalog(java.lang.String catalog)Sets the given catalog name in order to select a subspace of thisConnectionobject's database in which to work.voidsetClientInfo(java.lang.String name, java.lang.String value)Sets the value of the client info property specified by name to the value specified by value.voidsetClientInfo(java.util.Properties properties)Sets the value of the connection's client info properties.voidsetHoldability(int holdability)Changes the default holdability ofResultSetobjects created using thisConnectionobject to the given holdability.voidsetNetworkTimeout(java.util.concurrent.Executor executor, int milliseconds)Sets the maximum period aConnectionor objects created from theConnectionwill wait for the database to reply to any one request.voidsetReadOnly(boolean readOnly)Puts this connection in read-only mode as a hint to the driver to enable database optimizations.java.sql.SavepointsetSavepoint()Creates an unnamed savepoint in the current transaction and returns the newSavepointobject that represents it.java.sql.SavepointsetSavepoint(java.lang.String name)Creates a savepoint with the given name in the current transaction and returns the newSavepointobject that represents it.voidsetSchema(java.lang.String schema)Sets the given schema name to access.voidsetTransactionIsolation(int level)Attempts to change the transaction isolation level for thisConnectionobject to the one given.voidsetTypeMap(java.util.Map<java.lang.String,java.lang.Class<?>> map)Installs the givenTypeMapobject as the type map for thisConnectionobject.<T> Tunwrap(java.lang.Class<T> iface)Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.
-
-
-
Constructor Detail
-
JDBCConnection
public JDBCConnection(org.hsqldb.persist.HsqlProperties props) throws java.sql.SQLExceptionConstructs a new externalConnectionto an HSQLDBDatabase.This constructor is called on behalf of the
java.sql.DriverManagerwhen getting aConnectionfor 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
JDBCConnection(SessionInterface)constructor.- Parameters:
props- APropertiesobject containing the connection properties- Throws:
java.sql.SQLException- when the user/password combination is invalid, the connection url is invalid, or theDatabaseis unavailable.The
Databasemay be unavailable for a number of reasons, including network problems or the fact that it may already be in use by another process.
-
JDBCConnection
public JDBCConnection(org.hsqldb.SessionInterface c)
Constructs anINTERNALConnection, using the specifiedSessionInterface.This constructor is called only on behalf of an existing
Session(the internal parallel of aConnection), to be used as a parameter to a SQL function or stored procedure that needs to execute in the context of thatSession.When a Java SQL function or stored procedure is called and its first parameter is of type
Connection, HSQLDB automatically notices this and constructs anINTERNALConnectionusing the currentSession. HSQLDB then passes thisConnectionin 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
Routine.Notes:
Starting with HSQLDB 1.7.2,
INTERNALconnections 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 Java stored procedures and 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.- Parameters:
c- the Session requesting the construction of this Connection- Throws:
org.hsqldb.HsqlException- never (reserved for future use);- See Also:
Routine
-
JDBCConnection
public JDBCConnection(JDBCConnection c, JDBCConnectionEventListener eventListener)
Constructor for use with connection pooling and XA.- Parameters:
c- the connectioneventListener- the listener
-
-
Method Detail
-
createStatement
public java.sql.Statement createStatement() throws java.sql.SQLExceptionCreates aStatementobject for sending SQL statements to the database. SQL statements without parameters are normally executed usingStatementobjects. If the same SQL statement is executed many times, it may be more efficient to use aPreparedStatementobject.Result sets created using the returned
Statementobject will by default be typeTYPE_FORWARD_ONLYand have a concurrency level ofCONCUR_READ_ONLY. The holdability of the created result sets can be determined by callinggetHoldability().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 aPreparedStatementobject if the same short-running SQL statement is to be executed many times.HSQLDB supports
TYPE_FORWARD_ONLY,TYPE_SCROLL_INSENSITIVEandCONCUR_READ_ONLYresults.- Specified by:
createStatementin interfacejava.sql.Connection- Returns:
- a new default
Statementobject - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closed connection- See Also:
createStatement(int,int),createStatement(int,int,int)
-
prepareStatement
public java.sql.PreparedStatement prepareStatement(java.lang.String sql) throws java.sql.SQLExceptionCreates aPreparedStatementobject for sending parameterized SQL statements to the database.A SQL statement with or without IN parameters can be pre-compiled and stored in a
PreparedStatementobject. 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
prepareStatementwill 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 thePreparedStatementobject is executed. This has no direct effect on users; however, it does affect which methods throw certainSQLExceptionobjects.Result sets created using the returned
PreparedStatementobject will by default be typeTYPE_FORWARD_ONLYand have a concurrency level ofCONCUR_READ_ONLY. The holdability of the created result sets can be determined by callinggetHoldability().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 aPreparedStatementobject if the same short-running SQL statement is to be executed many times.The support for and behaviour of PreparedStatement complies with SQL and JDBC standards. Please read the introductory section of the documentation for ${link JDBCParameterMetaData}.
- Specified by:
prepareStatementin interfacejava.sql.Connection- Parameters:
sql- an SQL statement that may contain one or more '?' IN parameter placeholders- Returns:
- a new default
PreparedStatementobject containing the pre-compiled SQL statement - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closed connection
-
prepareCall
public java.sql.CallableStatement prepareCall(java.lang.String sql) throws java.sql.SQLExceptionCreates aCallableStatementobject for calling database stored procedures. TheCallableStatementobject 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
prepareCallis done; others may wait until theCallableStatementobject is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions.Result sets created using the returned
CallableStatementobject will by default be typeTYPE_FORWARD_ONLYand have a concurrency level ofCONCUR_READ_ONLY. The holdability of the created result sets can be determined by callinggetHoldability().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.- Specified by:
prepareCallin interfacejava.sql.Connection- Parameters:
sql- an SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is specified using JDBC call escape syntax.- Returns:
- a new default
CallableStatementobject containing the pre-compiled SQL statement - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closed connection
-
nativeSQL
public java.lang.String nativeSQL(java.lang.String sql) throws java.sql.SQLExceptionConverts 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:
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. 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 ...}
- Specified by:
nativeSQLin interfacejava.sql.Connection- Parameters:
sql- an 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 or this method is called on a closed connection
-
setAutoCommit
public void setAutoCommit(boolean autoCommit) throws java.sql.SQLExceptionSets 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 methodcommitor the methodrollback. By default, new connections are in auto-commit mode.The commit occurs when the statement completes. The time when the statement completes depends on the type of SQL Statement:
- For DML statements, such as Insert, Update or Delete, and DDL statements, the statement is complete as soon as it has finished executing.
- For Select statements, the statement is complete when the associated result set is closed.
- For
CallableStatementobjects or for statements that return multiple results, the statement is complete when all of the associated result sets have been closed, and all update counts and output parameters have been retrieved.
NOTE: If this method is called during a transaction and the auto-commit mode is changed, the transaction is committed. If
setAutoCommitis called and the auto-commit mode is not changed, the call is a no-op.HSQLDB-Specific Information:
Up to and including HSQLDB 2.0,- 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.
Starting with 2.0, HSQLDB may not return a result set to the network client as a whole; the generic documentation will apply. The fetch size is taken into account
- Specified by:
setAutoCommitin interfacejava.sql.Connection- Parameters:
autoCommit-trueto enable auto-commit mode;falseto disable it- Throws:
java.sql.SQLException- if a database access error occurs, setAutoCommit(true) is called while participating in a distributed transaction, or this method is called on a closed connection- See Also:
getAutoCommit()
-
getAutoCommit
public boolean getAutoCommit() throws java.sql.SQLExceptionRetrieves the current auto-commit mode for thisConnectionobject.- Specified by:
getAutoCommitin interfacejava.sql.Connection- Returns:
- the current state of this
Connectionobject's auto-commit mode - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closed connection- See Also:
setAutoCommit(boolean)
-
commit
public void commit() throws java.sql.SQLExceptionMakes all changes made since the previous commit/rollback permanent and releases any database locks currently held by thisConnectionobject. This method should be used only when auto-commit mode has been disabled.- Specified by:
commitin interfacejava.sql.Connection- Throws:
java.sql.SQLException- if a database access error occurs, this method is called while participating in a distributed transaction, if this method is called on a closed connection or thisConnectionobject is in auto-commit mode- See Also:
setAutoCommit(boolean)
-
rollback
public void rollback() throws java.sql.SQLExceptionUndoes all changes made in the current transaction and releases any database locks currently held by thisConnectionobject. This method should be used only when auto-commit mode has been disabled.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>
- Specified by:
rollbackin interfacejava.sql.Connection- Throws:
java.sql.SQLException- if a database access error occurs, this method is called while participating in a distributed transaction, this method is called on a closed connection or thisConnectionobject is in auto-commit mode- See Also:
setAutoCommit(boolean)
-
close
public void close() throws java.sql.SQLExceptionReleases thisConnectionobject's database and JDBC resources immediately instead of waiting for them to be automatically released.Calling the method
closeon aConnectionobject that is already closed is a no-op.It is strongly recommended that an application explicitly commits or rolls back an active transaction prior to calling the
closemethod. If theclosemethod is called and there is an active transaction, the results are implementation-defined.- Specified by:
closein interfacejava.lang.AutoCloseable- Specified by:
closein interfacejava.sql.Connection- Throws:
java.sql.SQLException- if a database access error occurs
-
isClosed
public boolean isClosed() throws java.sql.SQLExceptionRetrieves whether thisConnectionobject has been closed. A connection is closed if the methodclosehas been called on it or if certain fatal errors have occurred. This method is guaranteed to returntrueonly when it is called after the methodConnection.closehas been called.This method generally cannot be called to determine whether a connection to a database is valid or invalid. A typical client can determine that a connection is invalid by catching any exceptions that might be thrown when an operation is attempted.
- Specified by:
isClosedin interfacejava.sql.Connection- Returns:
trueif thisConnectionobject is closed;falseif it is still open- Throws:
java.sql.SQLException- if a database access error occurs
-
getMetaData
public java.sql.DatabaseMetaData getMetaData() throws java.sql.SQLExceptionRetrieves aDatabaseMetaDataobject that contains metadata about the database to which thisConnectionobject represents a connection. The metadata includes information about the database's tables, its supported SQL grammar, its stored procedures, the capabilities of this connection, and so on.HSQLDB-Specific Information:
HSQLDB 2.0 essentially supports full database metadata.For discussion in greater detail, please follow the link to the overview for JDBCDatabaseMetaData, below.
- Specified by:
getMetaDatain interfacejava.sql.Connection- Returns:
- a
DatabaseMetaDataobject for thisConnectionobject - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closed connection
-
setReadOnly
public void setReadOnly(boolean readOnly) throws java.sql.SQLExceptionPuts this connection in read-only mode as a hint to the driver to enable database optimizations.Note: This method cannot be called during a transaction.
HSQLDB-Specific Information:
HSQLDB 2.0 supports the SQL standard, which will not allow calls to this method to succeed during a transaction.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.
- Specified by:
setReadOnlyin interfacejava.sql.Connection- Parameters:
readOnly-trueenables read-only mode;falsedisables it- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closed connection or this method is called during a transaction
-
isReadOnly
public boolean isReadOnly() throws java.sql.SQLExceptionRetrieves whether thisConnectionobject is in read-only mode.- Specified by:
isReadOnlyin interfacejava.sql.Connection- Returns:
trueif thisConnectionobject is read-only;falseotherwise- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closed connection
-
setCatalog
public void setCatalog(java.lang.String catalog) throws java.sql.SQLExceptionSets the given catalog name in order to select a subspace of thisConnectionobject's database in which to work.If the driver does not support catalogs, it will silently ignore this request.
Calling
setCataloghas no effect on previously created or preparedStatementobjects. It is implementation defined whether a DBMS prepare operation takes place immediately when theConnectionmethodprepareStatementorprepareCallis invoked. For maximum portability,setCatalogshould be called before aStatementis created or prepared.HSQLDB-Specific Information:
HSQLDB supports a single catalog per database. If the given catalog name is not the same as the database catalog name, this method throws an error.- Specified by:
setCatalogin interfacejava.sql.Connection- Parameters:
catalog- the name of a catalog (subspace in thisConnectionobject's database) in which to work- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closed connection- See Also:
getCatalog()
-
getCatalog
public java.lang.String getCatalog() throws java.sql.SQLExceptionRetrieves thisConnectionobject's current catalog name.HSQLDB-Specific Information:
HSQLDB supports a single catalog per database. This method returns the catalog name for the current database error.- Specified by:
getCatalogin interfacejava.sql.Connection- Returns:
- the current catalog name or
nullif there is none - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closed connection- See Also:
setCatalog(java.lang.String)
-
setTransactionIsolation
public void setTransactionIsolation(int level) throws java.sql.SQLExceptionAttempts to change the transaction isolation level for thisConnectionobject to the one given. The constants defined in the interfaceConnectionare the possible transaction isolation levels.Note: If this method is called during a transaction, the result is implementation-defined.
HSQLDB-Specific Information:
HSQLDB 2.0 accepts all isolation levels.Connection.TRANSACTION_READ_UNCOMMITEDis promoted toConnection.TRANSACTION_READ_COMMITED, but the transactions become read only. Calling this method during a transaction always succeeds and the selected isolation level is used from the next transaction.- Specified by:
setTransactionIsolationin interfacejava.sql.Connection- Parameters:
level- one of the followingConnectionconstants:Connection.TRANSACTION_READ_UNCOMMITTED,Connection.TRANSACTION_READ_COMMITTED,Connection.TRANSACTION_REPEATABLE_READ, orConnection.TRANSACTION_SERIALIZABLE. (Note thatConnection.TRANSACTION_NONEcannot be used because it specifies that transactions are not supported.)- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closed connection or the given parameter is not one of theConnectionconstants- See Also:
JDBCDatabaseMetaData.supportsTransactionIsolationLevel(int),getTransactionIsolation()
-
getTransactionIsolation
public int getTransactionIsolation() throws java.sql.SQLExceptionRetrieves thisConnectionobject's current transaction isolation level.HSQLDB-Specific Information:
HSQLDB 2.0 supports all isolation levels.Connection.TRANSACTION_READ_UNCOMMITEDis promoted toConnection.TRANSACTION_READ_COMMITED.- Specified by:
getTransactionIsolationin interfacejava.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, orConnection.TRANSACTION_NONE. - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closed connection- See Also:
setTransactionIsolation(int)
-
getWarnings
public java.sql.SQLWarning getWarnings() throws java.sql.SQLExceptionRetrieves the first warning reported by calls on thisConnectionobject. If there is more than one warning, subsequent warnings will be chained to the first one and can be retrieved by calling the methodSQLWarning.getNextWarningon the warning that was retrieved previously.This method may not be called on a closed connection; doing so will cause an
SQLExceptionto be thrown.Note: Subsequent warnings will be chained to this SQLWarning.
HSQLDB-Specific Information:
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.Other warnings are typically raised during the execution of data change and query statements.
Only the warnings caused by the last operation on this connection are returned by this method. A single operation may return up to 10 chained warnings.
- Specified by:
getWarningsin interfacejava.sql.Connection- Returns:
- the first
SQLWarningobject ornullif 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.SQLExceptionClears all warnings reported for thisConnectionobject. After a call to this method, the methodgetWarningsreturnsnulluntil a new warning is reported for thisConnectionobject.HSQLDB-Specific Information:
The standard behaviour is implemented.- Specified by:
clearWarningsin interfacejava.sql.Connection- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closed connection
-
createStatement
public java.sql.Statement createStatement(int resultSetType, int resultSetConcurrency) throws java.sql.SQLExceptionCreates aStatementobject that will generateResultSetobjects with the given type and concurrency. This method is the same as thecreateStatementmethod above, but it allows the default result set type and concurrency to be overridden. The holdability of the created result sets can be determined by callinggetHoldability().HSQLDB-Specific Information:
HSQLDB 2.0 adheres closely to SQL and JDBC standards. The interpretation of of resultSetType and resultSetConcurrency has changed in this version.HSQLDB supports
TYPE_FORWARD_ONLY,TYPE_SCROLL_INSENSITIVE,CONCUR_READ_ONLY,CONCUR_UPDATABLEresults.If an unsupported combination is requested, a SQLWarning is issued on this Connection and the closest supported combination is used instead.
- Specified by:
createStatementin interfacejava.sql.Connection- Parameters:
resultSetType- a result set type; one ofResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVEresultSetConcurrency- a concurrency type; one ofResultSet.CONCUR_READ_ONLYorResultSet.CONCUR_UPDATABLE- Returns:
- a new
Statementobject that will generateResultSetobjects with the given type and concurrency - Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closed connection or the given parameters are notResultSetconstants indicating type and concurrencyjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method or this method is not supported for the specified result set type and result set concurrency.- Since:
- JDK 1.2
-
prepareStatement
public java.sql.PreparedStatement prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency) throws java.sql.SQLExceptionCreates aPreparedStatementobject that will generateResultSetobjects with the given type and concurrency. This method is the same as theprepareStatementmethod above, but it allows the default result set type and concurrency to be overridden. The holdability of the created result sets can be determined by callinggetHoldability().HSQLDB-Specific Information:
HSQLDB 2.0 adheres closely to SQL and JDBC standards. The interpretation of of resultSetType and resultSetConcurrency has changed in this version.HSQLDB supports
TYPE_FORWARD_ONLY,TYPE_SCROLL_INSENSITIVE,CONCUR_READ_ONLY,CONCUR_UPDATABLEresults.If an unsupported combination is requested, a SQLWarning is issued on this Connection and the closest supported combination is used instead.
- Specified by:
prepareStatementin interfacejava.sql.Connection- Parameters:
sql- aStringobject that is the SQL statement to be sent to the database; may contain one or more '?' IN parametersresultSetType- a result set type; one ofResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVEresultSetConcurrency- a concurrency type; one ofResultSet.CONCUR_READ_ONLYorResultSet.CONCUR_UPDATABLE- Returns:
- a new PreparedStatement object containing the
pre-compiled SQL statement that will produce
ResultSetobjects with the given type and concurrency - Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closed connection or the given parameters are notResultSetconstants indicating type and concurrencyjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method or this method is not supported for the specified result set type and result set concurrency.- Since:
- JDK 1.2
-
prepareCall
public java.sql.CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency) throws java.sql.SQLExceptionCreates aCallableStatementobject that will generateResultSetobjects with the given type and concurrency. This method is the same as theprepareCallmethod above, but it allows the default result set type and concurrency to be overridden. The holdability of the created result sets can be determined by callinggetHoldability().HSQLDB-Specific Information:
HSQLDB 2.0 adheres closely to SQL and JDBC standards. The interpretation of of resultSetType and resultSetConcurrency has changed in this version.HSQLDB supports
TYPE_FORWARD_ONLY,TYPE_SCROLL_INSENSITIVE,CONCUR_READ_ONLY,CONCUR_UPDATABLEresults.If an unsupported combination is requested, a SQLWarning is issued on this Connection and the closest supported combination is used instead.
- Specified by:
prepareCallin interfacejava.sql.Connection- Parameters:
sql- aStringobject that is the SQL statement to be sent to the database; may contain on or more '?' parametersresultSetType- a result set type; one ofResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVEresultSetConcurrency- a concurrency type; one ofResultSet.CONCUR_READ_ONLYorResultSet.CONCUR_UPDATABLE- Returns:
- a new
CallableStatementobject containing the pre-compiled SQL statement that will produceResultSetobjects with the given type and concurrency - Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closed connection or the given parameters are notResultSetconstants indicating type and concurrencyjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method or this method is not supported for the specified result set type and result set concurrency.- Since:
- JDK 1.2
-
getTypeMap
public java.util.Map<java.lang.String,java.lang.Class<?>> getTypeMap() throws java.sql.SQLExceptionRetrieves theMapobject associated with thisConnectionobject. Unless the application has added an entry, the type map returned will be empty.You must invoke
setTypeMapafter making changes to theMapobject returned fromgetTypeMapas a JDBC driver may create an internal copy of theMapobject passed tosetTypeMap:Map<String,Class<?>> myMap = con.getTypeMap(); myMap.put("mySchemaName.ATHLETES", Athletes.class); con.setTypeMap(myMap);HSQLDB-Specific Information:
For compatibility, HSQLDB returns an empty map.- Specified by:
getTypeMapin interfacejava.sql.Connection- Returns:
- the
java.util.Mapobject associated with thisConnectionobject - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closed connectionjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.2
- See Also:
setTypeMap(java.util.Map<java.lang.String, java.lang.Class<?>>)
-
setTypeMap
public void setTypeMap(java.util.Map<java.lang.String,java.lang.Class<?>> map) throws java.sql.SQLExceptionInstalls the givenTypeMapobject as the type map for thisConnectionobject. The type map will be used for the custom mapping of SQL structured types and distinct types.You must set the values for the
TypeMapprior to callingsetMapas a JDBC driver may create an internal copy of theTypeMap:Map myMap<String,Class<?>> = new HashMap<String,Class<?>>(); myMap.put("mySchemaName.ATHLETES", Athletes.class); con.setTypeMap(myMap);]HSQLDB-Specific Information:
HSQLDB does not yet support this feature. Calling this method always throws aSQLException, stating that the function is not supported.- Specified by:
setTypeMapin interfacejava.sql.Connection- Parameters:
map- thejava.util.Mapobject to install as the replacement for thisConnectionobject's default type map- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closed connection or the given parameter is not ajava.util.Mapobjectjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.2
- See Also:
getTypeMap()
-
setHoldability
public void setHoldability(int holdability) throws java.sql.SQLExceptionChanges the default holdability ofResultSetobjects created using thisConnectionobject to the given holdability. The default holdability ofResultSetobjects can be determined by invokingDatabaseMetaData.getResultSetHoldability().HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setHoldabilityin interfacejava.sql.Connection- Parameters:
holdability- aResultSetholdability constant; one ofResultSet.HOLD_CURSORS_OVER_COMMITorResultSet.CLOSE_CURSORS_AT_COMMIT- Throws:
java.sql.SQLException- if a database access occurs, this method is called on a closed connection, or the given parameter is not aResultSetconstant indicating holdabilityjava.sql.SQLFeatureNotSupportedException- if the given holdability is not supported- Since:
- JDK 1.4, HSQLDB 1.7.2
- See Also:
getHoldability(),DatabaseMetaData.getResultSetHoldability(),JDBCResultSet
-
getHoldability
public int getHoldability() throws java.sql.SQLExceptionRetrieves the current holdability ofResultSetobjects created using thisConnectionobject.HSQLDB-Specific Information:
HSQLDB returns the current holdability.The default is HOLD_CURSORS_OVER_COMMIT.
- Specified by:
getHoldabilityin interfacejava.sql.Connection- Returns:
- the holdability, one of
ResultSet.HOLD_CURSORS_OVER_COMMITorResultSet.CLOSE_CURSORS_AT_COMMIT - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closed connection- Since:
- JDK 1.4, HSQLDB 1.7.2
- See Also:
setHoldability(int),DatabaseMetaData.getResultSetHoldability(),JDBCResultSet
-
setSavepoint
public java.sql.Savepoint setSavepoint() throws java.sql.SQLExceptionCreates an unnamed savepoint in the current transaction and returns the newSavepointobject that represents it.if setSavepoint is invoked outside of an active transaction, a transaction will be started at this newly created savepoint.
HSQLDB-Specific Information:
From 2.0, HSQLDB supports this feature.Note: Unnamed savepoints are not part of the SQL:2003 standard. Use setSavepoint(String name) instead.
- Specified by:
setSavepointin interfacejava.sql.Connection- Returns:
- the new
Savepointobject - Throws:
java.sql.SQLException- if a database access error occurs, this method is called while participating in a distributed transaction, this method is called on a closed connection or thisConnectionobject is currently in auto-commit modejava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.2
- See Also:
JDBCSavepoint,Savepoint
-
setSavepoint
public java.sql.Savepoint setSavepoint(java.lang.String name) throws java.sql.SQLExceptionCreates a savepoint with the given name in the current transaction and returns the newSavepointobject that represents it.if setSavepoint is invoked outside of an active transaction, a transaction will be started at this newly created savepoint.
HSQLDB-Specific Information:
Previous to JDBC 4, if the connection is autoCommit, setting a savepoint has no effect, as it is cleared upon the execution of the next transactional statement. When built for JDBC 4, this method throws an SQLException when thisConnectionobject is currently in auto-commit mode, as per the JDBC 4 standard.- Specified by:
setSavepointin interfacejava.sql.Connection- Parameters:
name- aStringcontaining the name of the savepoint- Returns:
- the new
Savepointobject - Throws:
java.sql.SQLException- if a database access error occurs, this method is called while participating in a distributed transaction, this method is called on a closed connection or thisConnectionobject is currently in auto-commit modejava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.2
- See Also:
JDBCSavepoint,Savepoint
-
rollback
public void rollback(java.sql.Savepoint savepoint) throws java.sql.SQLExceptionUndoes all changes made after the givenSavepointobject was set.This method should be used only when auto-commit has been disabled.
- Specified by:
rollbackin interfacejava.sql.Connection- Parameters:
savepoint- theSavepointobject to roll back to- Throws:
java.sql.SQLException- if a database access error occurs, this method is called while participating in a distributed transaction, this method is called on a closed connection, theSavepointobject is no longer valid, or thisConnectionobject is currently in auto-commit modejava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.2
- See Also:
JDBCSavepoint,Savepoint,rollback()
-
releaseSavepoint
public void releaseSavepoint(java.sql.Savepoint savepoint) throws java.sql.SQLExceptionRemoves the specifiedSavepointand subsequentSavepointobjects from the current transaction. Any reference to the savepoint after it have been removed will cause anSQLExceptionto be thrown.- Specified by:
releaseSavepointin interfacejava.sql.Connection- Parameters:
savepoint- theSavepointobject to be removed- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closed connection or the givenSavepointobject is not a valid savepoint in the current transactionjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.2
- See Also:
JDBCSavepoint,Savepoint
-
createStatement
public java.sql.Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws java.sql.SQLExceptionCreates aStatementobject that will generateResultSetobjects with the given type, concurrency, and holdability. This method is the same as thecreateStatementmethod above, but it allows the default result set type, concurrency, and holdability to be overridden.HSQLDB-Specific Information:
HSQLDB 2.0 adheres closely to SQL and JDBC standards. The interpretation of of resultSetType and resultSetConcurrency has changed in this version.HSQLDB supports
TYPE_FORWARD_ONLY,TYPE_SCROLL_INSENSITIVE,CONCUR_READ_ONLY,CONCUR_UPDATABLEresults.If an unsupported combination is requested, a SQLWarning is issued on this Connection and the closest supported combination is used instead.
- Specified by:
createStatementin interfacejava.sql.Connection- Parameters:
resultSetType- one of the followingResultSetconstants:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVEresultSetConcurrency- one of the followingResultSetconstants:ResultSet.CONCUR_READ_ONLYorResultSet.CONCUR_UPDATABLEresultSetHoldability- one of the followingResultSetconstants:ResultSet.HOLD_CURSORS_OVER_COMMITorResultSet.CLOSE_CURSORS_AT_COMMIT- Returns:
- a new
Statementobject that will generateResultSetobjects with the given type, concurrency, and holdability - Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closed connection or the given parameters are notResultSetconstants indicating type, concurrency, and holdabilityjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method or this method is not supported for the specified result set type, result set holdability and result set concurrency.- Since:
- JDK 1.4, HSQLDB 1.7.2
- See Also:
JDBCResultSet
-
prepareStatement
public java.sql.PreparedStatement prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws java.sql.SQLExceptionCreates aPreparedStatementobject that will generateResultSetobjects with the given type, concurrency, and holdability.This method is the same as the
prepareStatementmethod above, but it allows the default result set type, concurrency, and holdability to be overridden.HSQLDB-Specific Information:
HSQLDB 2.0 adheres closely to SQL and JDBC standards. The interpretation of of resultSetType and resultSetConcurrency has changed in this version.HSQLDB supports
TYPE_FORWARD_ONLY,TYPE_SCROLL_INSENSITIVE,CONCUR_READ_ONLY,CONCUR_UPDATABLEresults.HOLD_CURSORS_OVER_COMMITis supported only whenCONCUR_READ_ONLYis requested.If an unsupported combination is requested, a SQLWarning is issued on this Connection and the closest supported combination is used instead.
- Specified by:
prepareStatementin interfacejava.sql.Connection- Parameters:
sql- aStringobject that is the SQL statement to be sent to the database; may contain one or more '?' IN parametersresultSetType- one of the followingResultSetconstants:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVEresultSetConcurrency- one of the followingResultSetconstants:ResultSet.CONCUR_READ_ONLYorResultSet.CONCUR_UPDATABLEresultSetHoldability- one of the followingResultSetconstants:ResultSet.HOLD_CURSORS_OVER_COMMITorResultSet.CLOSE_CURSORS_AT_COMMIT- Returns:
- a new
PreparedStatementobject, containing the pre-compiled SQL statement, that will generateResultSetobjects with the given type, concurrency, and holdability - Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closed connection or the given parameters are notResultSetconstants indicating type, concurrency, and holdabilityjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method or this method is not supported for the specified result set type, result set holdability and result set concurrency.- Since:
- JDK 1.4, HSQLDB 1.7.2
- See Also:
JDBCResultSet
-
prepareCall
public java.sql.CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws java.sql.SQLExceptionCreates aCallableStatementobject that will generateResultSetobjects with the given type and concurrency. This method is the same as theprepareCallmethod above, but it allows the default result set type, result set concurrency type and holdability to be overridden.HSQLDB-Specific Information:
HSQLDB 2.0 adheres closely to SQL and JDBC standards. The interpretation of of resultSetType and resultSetConcurrency has changed in this version.HSQLDB supports
TYPE_FORWARD_ONLY,TYPE_SCROLL_INSENSITIVE,CONCUR_READ_ONLY,CONCUR_UPDATABLEresults.If an unsupported combination is requested, a SQLWarning is issued on this Connection and the closest supported combination is used instead.
- Specified by:
prepareCallin interfacejava.sql.Connection- Parameters:
sql- aStringobject that is the SQL statement to be sent to the database; may contain on or more '?' parametersresultSetType- one of the followingResultSetconstants:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVEresultSetConcurrency- one of the followingResultSetconstants:ResultSet.CONCUR_READ_ONLYorResultSet.CONCUR_UPDATABLEresultSetHoldability- one of the followingResultSetconstants:ResultSet.HOLD_CURSORS_OVER_COMMITorResultSet.CLOSE_CURSORS_AT_COMMIT- Returns:
- a new
CallableStatementobject, containing the pre-compiled SQL statement, that will generateResultSetobjects with the given type, concurrency, and holdability - Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closed connection or the given parameters are notResultSetconstants indicating type, concurrency, and holdabilityjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method or this method is not supported for the specified result set type, result set holdability and result set concurrency.- Since:
- JDK 1.4, HSQLDB 1.7.2
- See Also:
JDBCResultSet
-
prepareStatement
public java.sql.PreparedStatement prepareStatement(java.lang.String sql, int autoGeneratedKeys) throws java.sql.SQLExceptionCreates a defaultPreparedStatementobject 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 anINSERTstatement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method
prepareStatementwill 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 thePreparedStatementobject is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.Result sets created using the returned
PreparedStatementobject will by default be typeTYPE_FORWARD_ONLYand have a concurrency level ofCONCUR_READ_ONLY. The holdability of the created result sets can be determined by callinggetHoldability().HSQLDB-Specific Information:
Starting with version 2.0, HSQLDB supports returning generated columns with single-row and multi-row INSERT, UPDATE and MERGE statements.If the table has an IDENTITY or GENERATED column(s) the values for these columns are returned in the next call to getGeneratedKeys() after each execution of the PreparedStatement.
HSQLDB also supports returning primary key values from he rows by using the
org.hsqldb.jdbc.JDBCStatement.RETURN_PRIMARY_KEYSconstant.- Specified by:
prepareStatementin interfacejava.sql.Connection- Parameters:
sql- an SQL statement that may contain one or more '?' IN parameter placeholdersautoGeneratedKeys- a flag indicating whether auto-generated keys should be returned; one ofStatement.RETURN_GENERATED_KEYSorStatement.NO_GENERATED_KEYS- Returns:
- a new
PreparedStatementobject, 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, this method is called on a closed connection or the given parameter is not aStatementconstant indicating whether auto-generated keys should be returnedjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method with a constant of Statement.RETURN_GENERATED_KEYS- Since:
- JDK 1.4, HSQLDB 1.7.2
-
prepareStatement
public java.sql.PreparedStatement prepareStatement(java.lang.String sql, int[] columnIndexes) throws java.sql.SQLExceptionCreates a defaultPreparedStatementobject 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. The driver will ignore the array if the SQL statement is not anINSERTstatement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).An SQL statement with or without IN parameters can be pre-compiled and stored in a
PreparedStatementobject. 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
prepareStatementwill 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 thePreparedStatementobject is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.Result sets created using the returned
PreparedStatementobject will by default be typeTYPE_FORWARD_ONLYand have a concurrency level ofCONCUR_READ_ONLY. The holdability of the created result sets can be determined by callinggetHoldability().HSQLDB-Specific Information:
Starting with version 2.0, HSQLDB supports returning generated columns with single-row and multi-row INSERT, UPDATE and MERGE statements.The columnIndexes may specify any set of columns of the table.
- Specified by:
prepareStatementin interfacejava.sql.Connection- Parameters:
sql- an SQL statement that may contain one or more '?' IN parameter placeholderscolumnIndexes- an array of column indexes indicating the columns that should be returned from the inserted row or rows- Returns:
- a new
PreparedStatementobject, 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 or this method is called on a closed connectionjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.2
-
prepareStatement
public java.sql.PreparedStatement prepareStatement(java.lang.String sql, java.lang.String[] columnNames) throws java.sql.SQLExceptionCreates a defaultPreparedStatementobject 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. The driver will ignore the array if the SQL statement is not anINSERTstatement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).An SQL statement with or without IN parameters can be pre-compiled and stored in a
PreparedStatementobject. 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
prepareStatementwill 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 thePreparedStatementobject is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.Result sets created using the returned
PreparedStatementobject will by default be typeTYPE_FORWARD_ONLYand have a concurrency level ofCONCUR_READ_ONLY. The holdability of the created result sets can be determined by callinggetHoldability().HSQLDB-Specific Information:
Starting with version 2.0, HSQLDB supports returning generated columns with single-row and multi-row INSERT, UPDATE and MERGE statements.The columnNames may specify any set of columns of the table. The names are case-sensitive, unlike column names in ResultSet methods.
- Specified by:
prepareStatementin interfacejava.sql.Connection- Parameters:
sql- an SQL statement that may contain one or more '?' IN parameter placeholderscolumnNames- an array of column names indicating the columns that should be returned from the inserted row or rows- Returns:
- a new
PreparedStatementobject, 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 or this method is called on a closed connectionjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.2
-
createClob
public java.sql.Clob createClob() throws java.sql.SQLExceptionConstructs an object that implements theClobinterface. The object returned initially contains no data. ThesetAsciiStream,setCharacterStreamandsetStringmethods of theClobinterface may be used to add data to theClob.- Specified by:
createClobin interfacejava.sql.Connection- Returns:
- An object that implements the
Clobinterface - Throws:
java.sql.SQLException- if an object that implements theClobinterface can not be constructed, this method is called on a closed connection or a database access error occurs.java.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this data type- Since:
- JDK 1.6, HSQLDB 2.0
-
createBlob
public java.sql.Blob createBlob() throws java.sql.SQLExceptionConstructs an object that implements theBlobinterface. The object returned initially contains no data. ThesetBinaryStreamandsetBytesmethods of theBlobinterface may be used to add data to theBlob.- Specified by:
createBlobin interfacejava.sql.Connection- Returns:
- An object that implements the
Blobinterface - Throws:
java.sql.SQLException- if an object that implements theBlobinterface can not be constructed, this method is called on a closed connection or a database access error occurs.java.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this data type- Since:
- JDK 1.6, HSQLDB 2.0
-
createNClob
public java.sql.NClob createNClob() throws java.sql.SQLExceptionConstructs an object that implements theNClobinterface. The object returned initially contains no data. ThesetAsciiStream,setCharacterStreamandsetStringmethods of theNClobinterface may be used to add data to theNClob.- Specified by:
createNClobin interfacejava.sql.Connection- Returns:
- An object that implements the
NClobinterface - Throws:
java.sql.SQLException- if an object that implements theNClobinterface can not be constructed, this method is called on a closed connection or a database access error occurs.java.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this data type- Since:
- JDK 1.6, HSQLDB 2.0
-
createSQLXML
public java.sql.SQLXML createSQLXML() throws java.sql.SQLExceptionConstructs an object that implements theSQLXMLinterface. The object returned initially contains no data. ThecreateXmlStreamWriterobject andsetStringmethod of theSQLXMLinterface may be used to add data to theSQLXMLobject.- Specified by:
createSQLXMLin interfacejava.sql.Connection- Returns:
- An object that implements the
SQLXMLinterface - Throws:
java.sql.SQLException- if an object that implements theSQLXMLinterface can not be constructed, this method is called on a closed connection or a database access error occurs.java.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this data type- Since:
- JDK 1.6, HSQLDB 2.0
-
isValid
public boolean isValid(int timeout) throws java.sql.SQLExceptionReturns true if the connection has not been closed and is still valid. The driver shall submit a query on the connection or use some other mechanism that positively verifies the connection is still valid when this method is called.The query submitted by the driver to validate the connection shall be executed in the context of the current transaction.
HSQLDB-Specific Information:
HSQLDB uses a maximum timeout of 60 seconds if timeout has been specified as zero.- Specified by:
isValidin interfacejava.sql.Connection- Parameters:
timeout- The time in seconds to wait for the database operation used to validate the connection to complete. If the timeout period expires before the operation completes, this method returns false. A value of 0 indicates a timeout is not applied to the database operation.- Returns:
- true if the connection is valid, false otherwise
- Throws:
java.sql.SQLException- if the value supplied fortimeoutis less than 0- Since:
- JDK 1.6, HSQLDB 2.0
- See Also:
JDBCDatabaseMetaData.getClientInfoProperties()
-
setClientInfo
public void setClientInfo(java.lang.String name, java.lang.String value) throws java.sql.SQLClientInfoExceptionSets the value of the client info property specified by name to the value specified by value.Applications may use the
DatabaseMetaData.getClientInfoPropertiesmethod to determine the client info properties supported by the driver and the maximum length that may be specified for each property.The driver stores the value specified in a suitable location in the database. For example in a special register, session parameter, or system table column. For efficiency the driver may defer setting the value in the database until the next time a statement is executed or prepared. Other than storing the client information in the appropriate place in the database, these methods shall not alter the behavior of the connection in any way. The values supplied to these methods are used for accounting, diagnostics and debugging purposes only.
The driver shall generate a warning if the client info name specified is not recognized by the driver.
If the value specified to this method is greater than the maximum length for the property the driver may either truncate the value and generate a warning or generate a
SQLClientInfoException. If the driver generates aSQLClientInfoException, the value specified was not set on the connection.The following are standard client info properties. Drivers are not required to support these properties however if the driver supports a client info property that can be described by one of the standard properties, the standard property name should be used.
- ApplicationName - The name of the application currently utilizing the connection
- ClientUser - The name of the user that the application using the connection is performing work for. This may not be the same as the user name that was used in establishing the connection.
- ClientHostname - The hostname of the computer the application using the connection is running on.
HSQLDB-Specific Information:
HSQLDB 2.0, throws an SQLClientInfoException when this method is called.- Specified by:
setClientInfoin interfacejava.sql.Connection- Parameters:
name- The name of the client info property to setvalue- The value to set the client info property to. If the value is null, the current value of the specified property is cleared.- Throws:
java.sql.SQLClientInfoException- if the database server returns an error while setting the client info value on the database server or this method is called on a closed connection- Since:
- JDK 1.6, HSQLDB 2.0
-
setClientInfo
public void setClientInfo(java.util.Properties properties) throws java.sql.SQLClientInfoExceptionSets the value of the connection's client info properties. ThePropertiesobject contains the names and values of the client info properties to be set. The set of client info properties contained in the properties list replaces the current set of client info properties on the connection. If a property that is currently set on the connection is not present in the properties list, that property is cleared. Specifying an empty properties list will clear all of the properties on the connection. SeesetClientInfo (String, String)for more information.If an error occurs in setting any of the client info properties, a
SQLClientInfoExceptionis thrown. TheSQLClientInfoExceptioncontains information indicating which client info properties were not set. The state of the client information is unknown because some databases do not allow multiple client info properties to be set atomically. For those databases, one or more properties may have been set before the error occurred.- Specified by:
setClientInfoin interfacejava.sql.Connection- Parameters:
properties- the list of client info properties to set- Throws:
java.sql.SQLClientInfoException- if the database server returns an error while setting the clientInfo values on the database server or this method is called on a closed connection- Since:
- JDK 1.6, HSQLDB 2.0
- See Also:
setClientInfo(String, String)
-
getClientInfo
public java.lang.String getClientInfo(java.lang.String name) throws java.sql.SQLExceptionReturns the value of the client info property specified by name. This method may return null if the specified client info property has not been set and does not have a default value. This method will also return null if the specified client info property name is not supported by the driver.Applications may use the
DatabaseMetaData.getClientInfoPropertiesmethod to determine the client info properties supported by the driver.- Specified by:
getClientInfoin interfacejava.sql.Connection- Parameters:
name- The name of the client info property to retrieve- Returns:
- The value of the client info property specified
- Throws:
java.sql.SQLException- if the database server returns an error when fetching the client info value from the database or this method is called on a closed connection- Since:
- JDK 1.6, HSQLDB 2.0
- See Also:
DatabaseMetaData.getClientInfoProperties()
-
getClientInfo
public java.util.Properties getClientInfo() throws java.sql.SQLExceptionReturns a list containing the name and current value of each client info property supported by the driver. The value of a client info property may be null if the property has not been set and does not have a default value.- Specified by:
getClientInfoin interfacejava.sql.Connection- Returns:
- A
Propertiesobject that contains the name and current value of each of the client info properties supported by the driver. - Throws:
java.sql.SQLException- if the database server returns an error when fetching the client info values from the database or this method is called on a closed connection- Since:
- JDK 1.6, HSQLDB 2.0
-
createArrayOf
public java.sql.Array createArrayOf(java.lang.String typeName, java.lang.Object[] elements) throws java.sql.SQLExceptionFactory method for creating Array objects.Note: When
createArrayOfis used to create an array object that maps to a primitive data type, then it is implementation-defined whether theArrayobject is an array of that primitive data type or an array ofObject.Note: The JDBC driver is responsible for mapping the elements
Objectarray to the default JDBC SQL type defined in java.sql.Types for the given class ofObject. The default mapping is specified in Appendix B of the JDBC specification. If the resulting JDBC type is not the appropriate type for the given typeName then it is implementation defined whether anSQLExceptionis thrown or the driver supports the resulting conversion.- Specified by:
createArrayOfin interfacejava.sql.Connection- Parameters:
typeName- the SQL name of the type the elements of the array map to. The typeName is a database-specific name which may be the name of a built-in type, a user-defined type or a standard SQL type supported by this database. This is the value returned byArray.getBaseTypeNameelements- the elements that populate the returned object- Returns:
- an Array object whose elements map to the specified SQL type
- Throws:
java.sql.SQLException- if a database error occurs, the JDBC type is not appropriate for the typeName and the conversion is not supported, the typeName is null or this method is called on a closed connectionjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this data type- Since:
- 1.6
-
createStruct
public java.sql.Struct createStruct(java.lang.String typeName, java.lang.Object[] attributes) throws java.sql.SQLExceptionFactory method for creating Struct objects.- Specified by:
createStructin interfacejava.sql.Connection- Parameters:
typeName- the SQL type name of the SQL structured type that thisStructobject maps to. The typeName is the name of a user-defined type that has been defined for this database. It is the value returned byStruct.getSQLTypeName.attributes- the attributes that populate the returned object- Returns:
- a Struct object that maps to the given SQL type and is populated with the given attributes
- Throws:
java.sql.SQLException- if a database error occurs, the typeName is null or this method is called on a closed connectionjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this data type- Since:
- JDK 1.6, HSQLDB 2.0
-
unwrap
public <T> T unwrap(java.lang.Class<T> iface) throws java.sql.SQLExceptionReturns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the result of callingunwraprecursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then anSQLExceptionis thrown.- Specified by:
unwrapin interfacejava.sql.Wrapper- Type Parameters:
T- by which the return type is inferred from input parameter.- Parameters:
iface- A Class defining an interface that the result must implement.- Returns:
- an object that implements the interface. May be a proxy for the actual implementing object.
- Throws:
java.sql.SQLException- If no object found that implements the interface- Since:
- JDK 1.6, HSQLDB 2.0
-
isWrapperFor
public boolean isWrapperFor(java.lang.Class<?> iface) throws java.sql.SQLExceptionReturns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively callingisWrapperForon the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared tounwrapso that callers can use this method to avoid expensiveunwrapcalls that may fail. If this method returns true then callingunwrapwith the same argument should succeed.- Specified by:
isWrapperForin interfacejava.sql.Wrapper- Parameters:
iface- a Class defining an interface.- Returns:
- true if this implements the interface or directly or indirectly wraps an object that does.
- Throws:
java.sql.SQLException- if an error occurs while determining whether this is a wrapper for an object with the given interface.- Since:
- JDK 1.6, HSQLDB 2.0
-
setSchema
public void setSchema(java.lang.String schema) throws java.sql.SQLExceptionSets the given schema name to access.If the driver does not support schemas, it will silently ignore this request.
Calling
setSchemahas no effect on previously created or preparedStatementobjects. It is implementation defined whether a DBMS prepare operation takes place immediately when theConnectionmethodprepareStatementorprepareCallis invoked. For maximum portability,setSchemashould be called before aStatementis created or prepared.- Specified by:
setSchemain interfacejava.sql.Connection- Parameters:
schema- the name of a schema in which to work- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closed connection- Since:
- JDK 1.7, HSQLDB 2.0.1
- See Also:
getSchema()
-
getSchema
public java.lang.String getSchema() throws java.sql.SQLExceptionRetrieves thisConnectionobject's current schema name.- Specified by:
getSchemain interfacejava.sql.Connection- Returns:
- the current schema name or
nullif there is none - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closed connection- Since:
- JDK 1.7, HSQLDB 2.0.1
- See Also:
setSchema(java.lang.String)
-
abort
public void abort(java.util.concurrent.Executor executor) throws java.sql.SQLExceptionTerminates an open connection. Callingabortresults in:- The connection marked as closed
- Closes any physical connection to the database
- Releases resources used by the connection
- Insures that any thread that is currently accessing the connection
will either progress to completion or throw an
SQLException.
Calling
abortmarks the connection closed and releases any resources. Callingaborton a closed connection is a no-op.It is possible that the aborting and releasing of the resources that are held by the connection can take an extended period of time. When the
abortmethod returns, the connection will have been marked as closed and theExecutorthat was passed as a parameter to abort may still be executing tasks to release resources.This method checks to see that there is an
SQLPermissionobject before allowing the method to proceed. If aSecurityManagerexists and itscheckPermissionmethod denies callingabort, this method throws ajava.lang.SecurityException.- Specified by:
abortin interfacejava.sql.Connection- Parameters:
executor- TheExecutorimplementation which will be used byabort.- Throws:
java.sql.SQLException- if a database access error occurs or theexecutorisnull,java.lang.SecurityException- if a security manager exists and itscheckPermissionmethod denies callingabort- Since:
- JDK 1.7, HSQLDB 2.0.1
- See Also:
SecurityManager.checkPermission(java.security.Permission),Executor
-
setNetworkTimeout
public void setNetworkTimeout(java.util.concurrent.Executor executor, int milliseconds) throws java.sql.SQLExceptionSets the maximum period aConnectionor objects created from theConnectionwill wait for the database to reply to any one request. If any request remains unanswered, the waiting method will return with aSQLException, and theConnectionor objects created from theConnectionwill be marked as closed. Any subsequent use of the objects, with the exception of theclose,isClosedorConnection.isValidmethods, will result in aSQLException.Note: This method is intended to address a rare but serious condition where network partitions can cause threads issuing JDBC calls to hang uninterruptedly in socket reads, until the OS TCP-TIMEOUT (typically 10 minutes). This method is related to the
abort()method which provides an administrator thread a means to free any such threads in cases where the JDBC connection is accessible to the administrator thread. ThesetNetworkTimeoutmethod will cover cases where there is no administrator thread, or it has no access to the connection. This method is severe in its effects, and should be given a high enough value so it is never triggered before any more normal timeouts, such as transaction timeouts.JDBC driver implementations may also choose to support the
setNetworkTimeoutmethod to impose a limit on database response time, in environments where no network is present.Drivers may internally implement some or all of their API calls with multiple internal driver-database transmissions, and it is left to the driver implementation to determine whether the limit will be applied always to the response to the API call, or to any single request made during the API call.
This method can be invoked more than once, such as to set a limit for an area of JDBC code, and to reset to the default on exit from this area. Invocation of this method has no impact on already outstanding requests.
The
Statement.setQueryTimeout()timeout value is independent of the timeout value specified insetNetworkTimeout. If the query timeout expires before the network timeout then the statement execution will be canceled. If the network is still active the result will be that both the statement and connection are still usable. However if the network timeout expires before the query timeout or if the statement timeout fails due to network problems, the connection will be marked as closed, any resources held by the connection will be released and both the connection and statement will be unusable.When the driver determines that the
setNetworkTimeouttimeout value has expired, the JDBC driver marks the connection closed and releases any resources held by the connection.This method checks to see that there is an
SQLPermissionobject before allowing the method to proceed. If aSecurityManagerexists and itscheckPermissionmethod denies callingsetNetworkTimeout, this method throws ajava.lang.SecurityException.- Specified by:
setNetworkTimeoutin interfacejava.sql.Connection- Parameters:
executor- TheExecutorimplementation which will be used bysetNetworkTimeout.milliseconds- The time in milliseconds to wait for the database operation to complete. If the JDBC driver does not support milliseconds, the JDBC driver will round the value up to the nearest second. If the timeout period expires before the operation completes, a SQLException will be thrown. A value of 0 indicates that there is no timeout for database operations.- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closed connection, theexecutorisnull, or the value specified forsecondsis less than 0.java.lang.SecurityException- if a security manager exists and itscheckPermissionmethod denies callingsetNetworkTimeout.java.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.7, HSQLDB 2.0.1
- See Also:
SecurityManager.checkPermission(java.security.Permission),Statement.setQueryTimeout(int),getNetworkTimeout(),abort(java.util.concurrent.Executor),Executor
-
getNetworkTimeout
public int getNetworkTimeout() throws java.sql.SQLExceptionRetrieves the number of milliseconds the driver will wait for a database request to complete. If the limit is exceeded, aSQLExceptionis thrown.- Specified by:
getNetworkTimeoutin interfacejava.sql.Connection- Returns:
- the current timeout limit in milliseconds; zero means there is no limit
- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedConnectionjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.7, HSQLDB 2.0.1
- See Also:
setNetworkTimeout(java.util.concurrent.Executor, int)
-
beginRequest
public void beginRequest() throws java.sql.SQLExceptionHints to the driver that a request, an independent unit of work, is beginning on this connection. Each request is independent of all other requests with regard to state local to the connection either on the client or the server. Work done betweenbeginRequest,endRequestpairs does not depend on any other work done on the connection either as part of another request or outside of any request. A request may include multiple transactions. There may be dependencies on committed database state as that is not local to the connection.Local state is defined as any state associated with a Connection that is local to the current Connection either in the client or the database that is not transparently reproducible.
Calls to
beginRequestandendRequestare not nested. Multiple calls tobeginRequestwithout an intervening call toendRequestis not an error. The firstbeginRequestcall marks the start of the request and subsequent calls are treated as a no-opUse of
beginRequestandendRequestis optional, vendor specific and should largely be transparent. In particular implementations may detect conditions that indicate dependence on other work such as an open transaction. It is recommended though not required that implementations throw aSQLExceptionif there is an active transaction andbeginRequestis called. Using these methods may improve performance or provide other benefits. Consult your vendors documentation for additional information.It is recommended to enclose each unit of work in
beginRequest,endRequestpairs such that there is no open transaction at the beginning or end of the request and no dependency on local state that crosses request boundaries. Committed database state is not local.The default implementation is a no-op.
This method is to be used by Connection pooling managers.
The pooling manager should call
beginRequeston the underlying connection prior to returning a connection to the caller.The pooling manager does not need to call
beginRequestif:- The connection pool caches
PooledConnectionobjects - Returns a logical connection handle when
getConnectionis called by the application - The logical
Connectionis closed by callingConnection.closeprior to returning thePooledConnectionto the cache.
- Specified by:
beginRequestin interfacejava.sql.Connection- Throws:
java.sql.SQLException- if an error occurs- Since:
- 9
- See Also:
PooledConnection
- The connection pool caches
-
endRequest
public void endRequest() throws java.sql.SQLExceptionHints to the driver that a request, an independent unit of work, has completed. Calls tobeginRequestandendRequestare not nested. Multiple calls toendRequestwithout an intervening call tobeginRequestis not an error. The firstendRequestcall marks the request completed and subsequent calls are treated as a no-op. IfendRequestis called without an initial call tobeginRequestis a no-op.The exact behavior of this method is vendor specific. In particular implementations may detect conditions that indicate dependence on other work such as an open transaction. It is recommended though not required that implementations throw a
SQLExceptionif there is an active transaction andendRequestis called.The default implementation is a no-op.
This method is to be used by Connection pooling managers.
The pooling manager should call
endRequeston the underlying connection when the application returns the connection back to the connection pool.The pooling manager does not need to call
endRequestif:- The connection pool caches
PooledConnectionobjects - Returns a logical connection handle when
getConnectionis called by the application - The logical
Connectionis closed by callingConnection.closeprior to returning thePooledConnectionto the cache.
HSQLDB-Specific Information:
HSQLDB resets the SQL session of this connection.The user of an SQL session may declare session variables and session-based temporary tables that keep their data at commit time. A session reset removes these tables and variables and resets all session settings to their defaults.
- Specified by:
endRequestin interfacejava.sql.Connection- Throws:
java.sql.SQLException- if an error occurs- Since:
- 9
- See Also:
PooledConnection
- The connection pool caches
-
getURL
public java.lang.String getURL() throws java.sql.SQLExceptionRetrieves this connection's JDBC url. This method is in support of the JDBCDatabaseMetaData.getURL() method.- Returns:
- the database connection url with which this object was constructed
- Throws:
java.sql.SQLException- if this connection is closed
-
reset
public void reset() throws java.sql.SQLExceptionResets the SQL session of this connection, so it can be used again. Used when connections are returned to a connection pool.- Throws:
java.sql.SQLException- if a database access error occurs
-
closeFully
public void closeFully()
Completely closes a pooled connection
-
getSession
public org.hsqldb.SessionInterface getSession()
provides cross-package access to the proprietary (i.e. non-JDBC) HSQLDB session interface.- Returns:
- the underlying sessionProxy for this connection
-
isInternal
public boolean isInternal()
-
isNetwork
public boolean isNetwork()
-
getConnProperties
public org.hsqldb.persist.HsqlProperties getConnProperties()
-
-