org.h2.jdbc

Class JdbcConnection

java.lang.Object

org.h2.message.TraceObject

org.h2.jdbc.JdbcConnection

All Implemented Interfaces:

AutoCloseable, Connection, Wrapper

public class JdbcConnection
extends TraceObject
implements Connection

Represents a connection (session) to a database.

Thread safety: the connection is thread-safe, because access is synchronized. However, for compatibility with other databases, a connection should only be used in one thread at any time.

Field Summary

Fields inherited from class org.h2.message.TraceObject

ARRAY, BLOB, CALLABLE_STATEMENT, CLOB, CONNECTION, DATA_SOURCE, DATABASE_META_DATA, PARAMETER_META_DATA, PREPARED_STATEMENT, RESULT_SET, RESULT_SET_META_DATA, SAVEPOINT, SQL_EXCEPTION, STATEMENT, XA_DATA_SOURCE, XA_RESOURCE, XID

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Constructor Summary

Constructors

Constructor and Description
JdbcConnection(ConnectionInfo ci, boolean useBaseDir) INTERNAL
JdbcConnection(JdbcConnection clone) INTERNAL
JdbcConnection(SessionInterface session, String user, String url) INTERNAL
JdbcConnection(String url, Properties info) INTERNAL

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterWriting() INTERNAL.
protected void	checkClosed() INTERNAL.
protected void	checkClosed(boolean write) INTERNAL.
void	clearWarnings() Clears all warnings.
void	close() Closes this connection.
void	commit() Commits the current transaction.
Blob	createBlob() Create a new empty Blob object.
Value	createBlob(InputStream x, long length) Create a Blob value from this input stream.
Clob	createClob() Create a new empty Clob object.
Value	createClob(Reader x, long length) Create a Clob value from this reader.
Statement	createStatement() Creates a new statement.
Statement	createStatement(int resultSetType, int resultSetConcurrency) Creates a statement with the specified result set type and concurrency.
Statement	createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) Creates a statement with the specified result set type, concurrency, and holdability.
boolean	getAutoCommit() Gets the current setting for auto commit.
String	getCatalog() Gets the current catalog name.
int	getHoldability() Returns the current result set holdability.
DatabaseMetaData	getMetaData() Gets the database meta data for this database.
int	getPowerOffCount() INTERNAL
int	getQueryTimeout() INTERNAL
SessionInterface	getSession() INTERNAL
int	getTransactionIsolation() Returns the current transaction isolation level.
Map<String,Class<?>>	getTypeMap() Gets the type map.
SQLWarning	getWarnings() Gets the first warning reported by calls on this object.
boolean	isClosed() Returns true if this connection has been closed.
boolean	isReadOnly() Returns true if the database is read-only.
boolean	isValid(int timeout) Returns true if this connection is still valid.
String	nativeSQL(String sql) Translates a SQL statement into the database grammar.
CallableStatement	prepareCall(String sql) Creates a new callable statement.
CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency) Creates a callable statement with the specified result set type and concurrency.
CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) Creates a callable statement with the specified result set type, concurrency, and holdability.
PreparedStatement	prepareStatement(String sql) Creates a new prepared statement.
PreparedStatement	prepareStatement(String sql, int autoGeneratedKeys) Creates a new prepared statement.
PreparedStatement	prepareStatement(String sql, int[] columnIndexes) Creates a new prepared statement.
PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency) Creates a prepared statement with the specified result set type and concurrency.
PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) Creates a prepared statement with the specified result set type, concurrency, and holdability.
PreparedStatement	prepareStatement(String sql, String[] columnNames) Creates a new prepared statement.
void	releaseSavepoint(Savepoint savepoint) Releases a savepoint.
void	rollback() Rolls back the current transaction.
void	rollback(Savepoint savepoint) Rolls back to a savepoint.
void	setAutoCommit(boolean autoCommit) Switches auto commit on or off.
void	setCatalog(String catalog) Set the default catalog name.
void	setExecutingStatement(Statement stat) INTERNAL
void	setHoldability(int holdability) Changes the current result set holdability.
void	setPowerOffCount(int count) INTERNAL
void	setQueryTimeout(int seconds) INTERNAL
void	setReadOnly(boolean readOnly) According to the JDBC specs, this setting is only a hint to the database to enable optimizations - it does not cause writes to be prohibited.
Savepoint	setSavepoint() Creates a new unnamed savepoint.
Savepoint	setSavepoint(String name) Creates a new named savepoint.
void	setTraceLevel(int level) INTERNAL
void	setTransactionIsolation(int level) Changes the current transaction isolation level.
void	setTypeMap(Map<String,Class<?>> map) [Partially supported] Sets the type map.
String	toString() INTERNAL

Methods inherited from class org.h2.message.TraceObject

debugCode, debugCodeAssign, debugCodeCall, debugCodeCall, debugCodeCall, getNextId, getTrace, getTraceId, getTraceObjectName, isDebugEnabled, isInfoEnabled, logAndConvert, quote, quoteArray, quoteBigDecimal, quoteBytes, quoteDate, quoteIntArray, quoteMap, quoteTime, quoteTimestamp, setTrace, unsupported

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.sql.Connection

abort, createArrayOf, createNClob, createSQLXML, createStruct, getClientInfo, getClientInfo, getNetworkTimeout, getSchema, setClientInfo, setClientInfo, setNetworkTimeout, setSchema

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Constructor Detail

JdbcConnection

public JdbcConnection(String url,
              Properties info)
               throws SQLException

INTERNAL

Throws:

SQLException

JdbcConnection

public JdbcConnection(ConnectionInfo ci,
              boolean useBaseDir)
               throws SQLException

INTERNAL

Throws:

SQLException

JdbcConnection

public JdbcConnection(JdbcConnection clone)

INTERNAL

JdbcConnection

public JdbcConnection(SessionInterface session,
              String user,
              String url)

INTERNAL

Method Detail

createStatement

public Statement createStatement()
                          throws SQLException

Creates a new statement.

Specified by:

createStatement in interface Connection

Returns:

the new statement

Throws:

SQLException - if the connection is closed

createStatement

public Statement createStatement(int resultSetType,
                        int resultSetConcurrency)
                          throws SQLException

Creates a statement with the specified result set type and concurrency.

Specified by:

createStatement in interface Connection

Parameters:

resultSetType - the result set type (ResultSet.TYPE_*)

resultSetConcurrency - the concurrency (ResultSet.CONCUR_*)

Returns:

the statement

Throws:

SQLException - if the connection is closed or the result set type or concurrency are not supported

createStatement

public Statement createStatement(int resultSetType,
                        int resultSetConcurrency,
                        int resultSetHoldability)
                          throws SQLException

Creates a statement with the specified result set type, concurrency, and holdability.

Specified by:

createStatement in interface Connection

Parameters:

resultSetType - the result set type (ResultSet.TYPE_*)

resultSetConcurrency - the concurrency (ResultSet.CONCUR_*)

resultSetHoldability - the holdability (ResultSet.HOLD* / CLOSE*)

Returns:

the statement

Throws:

SQLException - if the connection is closed or the result set type, concurrency, or holdability are not supported

prepareStatement

public PreparedStatement prepareStatement(String sql)
                                   throws SQLException

Creates a new prepared statement.

Specified by:

prepareStatement in interface Connection

Parameters:

sql - the SQL statement

Returns:

the prepared statement

Throws:

SQLException - if the connection is closed

getMetaData

public DatabaseMetaData getMetaData()
                             throws SQLException

Gets the database meta data for this database.

Specified by:

getMetaData in interface Connection

Returns:

the database meta data

Throws:

SQLException - if the connection is closed

getSession

public SessionInterface getSession()

INTERNAL

close

public void close()
           throws SQLException

Closes this connection. All open statements, prepared statements and result sets that where created by this connection become invalid after calling this method. If there is an uncommitted transaction, it will be rolled back.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

Throws:

SQLException

setAutoCommit

public void setAutoCommit(boolean autoCommit)
                   throws SQLException

Switches auto commit on or off. Calling this function does not commit the current transaction.

Specified by:

setAutoCommit in interface Connection

Parameters:

autoCommit - true for auto commit on, false for off

Throws:

SQLException - if the connection is closed

getAutoCommit

public boolean getAutoCommit()
                      throws SQLException

Gets the current setting for auto commit.

Specified by:

getAutoCommit in interface Connection

Returns:

true for on, false for off

Throws:

SQLException - if the connection is closed

commit

public void commit()
            throws SQLException

Commits the current transaction. This call has only an effect if auto commit is switched off.

Specified by:

commit in interface Connection

Throws:

SQLException - if the connection is closed

rollback

public void rollback()
              throws SQLException

Rolls back the current transaction. This call has only an effect if auto commit is switched off.

Specified by:

rollback in interface Connection

Throws:

SQLException - if the connection is closed

isClosed

public boolean isClosed()
                 throws SQLException

Returns true if this connection has been closed.

Specified by:

isClosed in interface Connection

Returns:

true if close was called

Throws:

SQLException

nativeSQL

public String nativeSQL(String sql)
                 throws SQLException

Translates a SQL statement into the database grammar.

Specified by:

nativeSQL in interface Connection

Parameters:

sql - the SQL statement with or without JDBC escape sequences

Returns:

the translated statement

Throws:

SQLException - if the connection is closed

setReadOnly

public void setReadOnly(boolean readOnly)
                 throws SQLException

According to the JDBC specs, this setting is only a hint to the database to enable optimizations - it does not cause writes to be prohibited.

Specified by:

setReadOnly in interface Connection

Parameters:

readOnly - ignored

Throws:

SQLException - if the connection is closed

isReadOnly

public boolean isReadOnly()
                   throws SQLException

Returns true if the database is read-only.

Specified by:

isReadOnly in interface Connection

Returns:

if the database is read-only

Throws:

SQLException - if the connection is closed

setCatalog

public void setCatalog(String catalog)
                throws SQLException

Set the default catalog name. This call is ignored.

Specified by:

setCatalog in interface Connection

Parameters:

catalog - ignored

Throws:

SQLException - if the connection is closed

getCatalog

public String getCatalog()
                  throws SQLException

Gets the current catalog name.

Specified by:

getCatalog in interface Connection

Returns:

the catalog name

Throws:

SQLException - if the connection is closed

getWarnings

public SQLWarning getWarnings()
                       throws SQLException

Gets the first warning reported by calls on this object.

Specified by:

getWarnings in interface Connection

Returns:

null

Throws:

SQLException

clearWarnings

public void clearWarnings()
                   throws SQLException

Clears all warnings.

Specified by:

clearWarnings in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                 int resultSetType,
                                 int resultSetConcurrency)
                                   throws SQLException

Creates a prepared statement with the specified result set type and concurrency.

Specified by:

prepareStatement in interface Connection

Parameters:

sql - the SQL statement

resultSetType - the result set type (ResultSet.TYPE_*)

resultSetConcurrency - the concurrency (ResultSet.CONCUR_*)

Returns:

the prepared statement

Throws:

SQLException - if the connection is closed or the result set type or concurrency are not supported

setTransactionIsolation

public void setTransactionIsolation(int level)
                             throws SQLException

Changes the current transaction isolation level. Calling this method will commit an open transaction, even if the new level is the same as the old one, except if the level is not supported. Internally, this method calls SET LOCK_MODE. The following isolation levels are supported:

• Connection.TRANSACTION_READ_UNCOMMITTED = SET LOCK_MODE 0: no locking (should only be used for testing).
• Connection.TRANSACTION_SERIALIZABLE = SET LOCK_MODE 1: table level locking.
• Connection.TRANSACTION_READ_COMMITTED = SET LOCK_MODE 3: table level locking, but read locks are released immediately (default).

This setting is not persistent. Please note that using TRANSACTION_READ_UNCOMMITTED while at the same time using multiple connections may result in inconsistent transactions.

Specified by:

setTransactionIsolation in interface Connection

Parameters:

level - the new transaction isolation level: Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED, or Connection.TRANSACTION_SERIALIZABLE

Throws:

SQLException - if the connection is closed or the isolation level is not supported

setQueryTimeout

public void setQueryTimeout(int seconds)
                     throws SQLException

INTERNAL

Throws:

SQLException

getQueryTimeout

public int getQueryTimeout()
                    throws SQLException

INTERNAL

Throws:

SQLException

getTransactionIsolation

public int getTransactionIsolation()
                            throws SQLException

Returns the current transaction isolation level.

Specified by:

getTransactionIsolation in interface Connection

Returns:

the isolation level.

Throws:

SQLException - if the connection is closed

setHoldability

public void setHoldability(int holdability)
                    throws SQLException

Changes the current result set holdability.

Specified by:

setHoldability in interface Connection

Parameters:

holdability - ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT;

Throws:

SQLException - if the connection is closed or the holdability is not supported

getHoldability

public int getHoldability()
                   throws SQLException

Returns the current result set holdability.

Specified by:

getHoldability in interface Connection

Returns:

the holdability

Throws:

SQLException - if the connection is closed

getTypeMap

public Map<String,Class<?>> getTypeMap()
                                throws SQLException

Gets the type map.

Specified by:

getTypeMap in interface Connection

Returns:

null

Throws:

SQLException - if the connection is closed

setTypeMap

public void setTypeMap(Map<String,Class<?>> map)
                throws SQLException

[Partially supported] Sets the type map. This is only supported if the map is empty or null.

Specified by:

setTypeMap in interface Connection

Throws:

SQLException

prepareCall

public CallableStatement prepareCall(String sql)
                              throws SQLException

Creates a new callable statement.

Specified by:

prepareCall in interface Connection

Parameters:

sql - the SQL statement

Returns:

the callable statement

Throws:

SQLException - if the connection is closed or the statement is not valid

prepareCall

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

Creates a callable statement with the specified result set type and concurrency.

Specified by:

prepareCall in interface Connection

Parameters:

sql - the SQL statement

resultSetType - the result set type (ResultSet.TYPE_*)

resultSetConcurrency - the concurrency (ResultSet.CONCUR_*)

Returns:

the callable statement

Throws:

SQLException - if the connection is closed or the result set type or concurrency are not supported

prepareCall

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

Creates a callable statement with the specified result set type, concurrency, and holdability.

Specified by:

prepareCall in interface Connection

Parameters:

sql - the SQL statement

resultSetType - the result set type (ResultSet.TYPE_*)

resultSetConcurrency - the concurrency (ResultSet.CONCUR_*)

resultSetHoldability - the holdability (ResultSet.HOLD* / CLOSE*)

Returns:

the callable statement

Throws:

SQLException - if the connection is closed or the result set type, concurrency, or holdability are not supported

setSavepoint

public Savepoint setSavepoint()
                       throws SQLException

Creates a new unnamed savepoint.

Specified by:

setSavepoint in interface Connection

Returns:

the new savepoint

Throws:

SQLException

setSavepoint

public Savepoint setSavepoint(String name)
                       throws SQLException

Creates a new named savepoint.

Specified by:

setSavepoint in interface Connection

Parameters:

name - the savepoint name

Returns:

the new savepoint

Throws:

SQLException

rollback

public void rollback(Savepoint savepoint)
              throws SQLException

Rolls back to a savepoint.

Specified by:

rollback in interface Connection

Parameters:

savepoint - the savepoint

Throws:

SQLException

releaseSavepoint

public void releaseSavepoint(Savepoint savepoint)
                      throws SQLException

Releases a savepoint.

Specified by:

releaseSavepoint in interface Connection

Parameters:

savepoint - the savepoint to release

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                 int resultSetType,
                                 int resultSetConcurrency,
                                 int resultSetHoldability)
                                   throws SQLException

Creates a prepared statement with the specified result set type, concurrency, and holdability.

Specified by:

prepareStatement in interface Connection

Parameters:

sql - the SQL statement

resultSetType - the result set type (ResultSet.TYPE_*)

resultSetConcurrency - the concurrency (ResultSet.CONCUR_*)

resultSetHoldability - the holdability (ResultSet.HOLD* / CLOSE*)

Returns:

the prepared statement

Throws:

SQLException - if the connection is closed or the result set type, concurrency, or holdability are not supported

prepareStatement

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

Creates a new prepared statement. This method just calls prepareStatement(String sql) internally. The method getGeneratedKeys only supports one column.

Specified by:

prepareStatement in interface Connection

Parameters:

sql - the SQL statement

autoGeneratedKeys - ignored

Returns:

the prepared statement

Throws:

SQLException - if the connection is closed

prepareStatement

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

Creates a new prepared statement. This method just calls prepareStatement(String sql) internally. The method getGeneratedKeys only supports one column.

Specified by:

prepareStatement in interface Connection

Parameters:

sql - the SQL statement

columnIndexes - ignored

Returns:

the prepared statement

Throws:

SQLException - if the connection is closed

prepareStatement

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

Creates a new prepared statement. This method just calls prepareStatement(String sql) internally. The method getGeneratedKeys only supports one column.

Specified by:

prepareStatement in interface Connection

Parameters:

sql - the SQL statement

columnNames - ignored

Returns:

the prepared statement

Throws:

SQLException - if the connection is closed

checkClosed

protected void checkClosed()

INTERNAL. Check if this connection is closed. The next operation is a read request.

Throws:

DbException - if the connection or session is closed

checkClosed

protected void checkClosed(boolean write)

INTERNAL. Check if this connection is closed.

Parameters:

write - if the next operation is possibly writing

Throws:

DbException - if the connection or session is closed

afterWriting

protected void afterWriting()

INTERNAL. Called after executing a command that could have written something.

getPowerOffCount

public int getPowerOffCount()

INTERNAL

setPowerOffCount

public void setPowerOffCount(int count)

INTERNAL

setExecutingStatement

public void setExecutingStatement(Statement stat)

INTERNAL

createClob

public Clob createClob()
                throws SQLException

Create a new empty Clob object.

Specified by:

createClob in interface Connection

Returns:

the object

Throws:

SQLException

createBlob

public Blob createBlob()
                throws SQLException

Create a new empty Blob object.

Specified by:

createBlob in interface Connection

Returns:

the object

Throws:

SQLException

isValid

public boolean isValid(int timeout)

Returns true if this connection is still valid.

Specified by:

isValid in interface Connection

Parameters:

timeout - the number of seconds to wait for the database to respond (ignored)

Returns:

true if the connection is valid.

createClob

public Value createClob(Reader x,
               long length)

Create a Clob value from this reader.

Parameters:

x - the reader

length - the length (if smaller or equal than 0, all data until the end of file is read)

Returns:

the value

createBlob

public Value createBlob(InputStream x,
               long length)

Create a Blob value from this input stream.

Parameters:

x - the input stream

length - the length (if smaller or equal than 0, all data until the end of file is read)

Returns:

the value

toString

public String toString()

INTERNAL

Overrides:

toString in class Object

setTraceLevel

public void setTraceLevel(int level)

INTERNAL