Module com.aoapps.dbc

Package com.aoapps.dbc

Class Database

java.lang.Object

com.aoapps.dbc.Database

All Implemented Interfaces:

DatabaseAccess

Direct Known Subclasses:

CloseableDatabase

public class Database
extends Object
implements DatabaseAccess

Wraps and simplifies access to a JDBC database. If used directly as a DatabaseAccess each individual call is a separate transaction. If the current thread is already in a transaction, the calls will be performed using the connection associated with that transaction. For transactions across multiple statements, use DatabaseConnection.

Author:

AO Industries, Inc.

See Also:

createDatabaseConnection(), DatabaseConnection

Nested Class Summary

Nested classes/interfaces inherited from interface com.aoapps.dbc.DatabaseAccess

DatabaseAccess.Null

Constructor Summary

Constructors

Constructor	Description
Database(AOConnectionPool pool)
Database(String driver, String url, String user, String password, int numConnections, long maxConnectionAge, Logger logger)
Database(DataSource dataSource, Logger logger)

Method Summary

Modifier and Type	Method	Description
protected void	close()	Closes the database.
DatabaseConnection	connect()	Creates a new DatabaseConnection instance.
DatabaseConnection	createDatabaseConnection()	Deprecated, for removal: This API element is subject to removal in a future version. Please use either connect() or one of the various call/run methods, which enforce the transaction semantics.
protected void	deinitConnection(Connection conn)	Before a connection is released back to the pool or the dataSource, it is passed here for any custom de-initialization routine.
protected void	deinitSqlDataTypes(Connection conn)	Before a connection is release back to the pool or the dataSource, it is passed here for de-initialization of getSqlDataTypes().
DoubleStream	doubleStream(int isolationLevel, boolean readOnly, String sql, Object... params)	Query the database with a DoubleStream return type.
<V> V	executeTransaction(DatabaseCallable<V> callable)	Deprecated, for removal: This API element is subject to removal in a future version. Please use transactionCall(com.aoapps.dbc.DatabaseCallable)
void	executeTransaction(DatabaseRunnable runnable)	Deprecated, for removal: This API element is subject to removal in a future version. Please use transactionRun(com.aoapps.dbc.DatabaseRunnable)
<V,Ex extends Exception> V	executeTransaction(Class<Ex> exClass, DatabaseCallableE<V,Ex> callable)	Deprecated, for removal: This API element is subject to removal in a future version. Please use transactionCall(java.lang.Class, com.aoapps.dbc.DatabaseCallableE)
<Ex extends Exception> void	executeTransaction(Class<Ex> exClass, DatabaseRunnableE<Ex> runnable)	Deprecated, for removal: This API element is subject to removal in a future version. Please use transactionRun(java.lang.Class, com.aoapps.dbc.DatabaseRunnableE)
Connection	getConnection()	Gets a read/write connection to the database with a transaction level of Connections.DEFAULT_TRANSACTION_ISOLATION, warning when a connection is already used by this thread.
Connection	getConnection(boolean readOnly)	Gets a connection to the database with a transaction level of Connections.DEFAULT_TRANSACTION_ISOLATION, warning when a connection is already used by this thread.
Connection	getConnection(int maxConnections)	Gets a read/write connection to the database with a transaction level of Connections.DEFAULT_TRANSACTION_ISOLATION.
Connection	getConnection(int isolationLevel, boolean readOnly)	Gets a connection to the database, warning when a connection is already used by this thread.
Connection	getConnection(int isolationLevel, boolean readOnly, int maxConnections)	Gets a connection to the database.
protected FailFastConnection	getConnection(int isolationLevel, boolean readOnly, int maxConnections, boolean allowClose)
AOConnectionPool	getConnectionPool()	Gets the pool or null if using a DataSource.
DataSource	getDataSource()	Gets the data source or null if using an AOConnectionPool.
Logger	getLogger()
protected void	initConnection(Connection conn)	Whenever a new connection is obtained from the pool or the dataSource, it is passed here for any custom initialization routine.
protected void	initSqlDataTypes(Connection conn)	Whenever a new connection is obtained from the pool or the dataSource, it is passed here for initialization of getSqlDataTypes().
IntStream	intStream(int isolationLevel, boolean readOnly, String sql, Object... params)	Query the database with an IntStream return type.
boolean	isInTransaction()	Checks if the current thread is in a transaction.
long	largeUpdate(String sql, Object... params)	Performs an update on the database and returns the number of rows affected.
LongStream	longStream(int isolationLevel, boolean readOnly, String sql, Object... params)	Query the database with a LongStream return type.
<T,Ex extends Throwable> T	queryCall(int isolationLevel, boolean readOnly, Class<? extends Ex> exClass, ResultSetCallableE<? extends T,? extends Ex> resultSetCallable, String sql, Object... params)	Query the database, calling the ResultSetCallableE once.
protected void	release(FailFastConnection conn)	Closes and/or releases the given connection back to the pool.
void	releaseConnection(Connection conn)	Deprecated, for removal: This API element is subject to removal in a future version. Please release to the pool by closing the connection, preferably via try-with-resources.
<T,Ex extends Throwable> Stream<T>	stream(int isolationLevel, boolean readOnly, Class<? extends Ex> exClass, ObjectFactoryE<? extends T,? extends Ex> objectFactory, String sql, Object... params)	Query the database with a Stream<T> return type, objects are created with the provided factory.
String	toString()
<V> V	transactionCall(DatabaseCallable<? extends V> callable)	Executes an arbitrary transaction, providing automatic commit, rollback, and connection management.
<V> V	transactionCall(CallableE<? extends V,? extends SQLException> callable)	Executes an arbitrary transaction, providing automatic commit, rollback, and connection management.
<V,Ex extends Throwable> V	transactionCall(Class<? extends Ex> exClass, DatabaseCallableE<? extends V,? extends Ex> callable)	Executes an arbitrary transaction, providing automatic commit, rollback, and connection management.
<V,Ex extends Throwable> V	transactionCall(Class<? extends Ex> exClass, CallableE<? extends V,? extends Ex> callable)	Executes an arbitrary transaction, providing automatic commit, rollback, and connection management.
void	transactionRun(DatabaseRunnable runnable)	Executes an arbitrary transaction, providing automatic commit, rollback, and connection management.
void	transactionRun(RunnableE<? extends SQLException> runnable)	Executes an arbitrary transaction, providing automatic commit, rollback, and connection management.
<Ex extends Throwable> void	transactionRun(Class<? extends Ex> exClass, DatabaseRunnableE<? extends Ex> runnable)	Executes an arbitrary transaction, providing automatic commit, rollback, and connection management.
<Ex extends Throwable> void	transactionRun(Class<? extends Ex> exClass, RunnableE<? extends Ex> runnable)	Executes an arbitrary transaction, providing automatic commit, rollback, and connection management.
int	update(String sql, Object... params)	Performs an update on the database and returns the number of rows affected.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aoapps.dbc.DatabaseAccess

doubleStream, doubleStreamUpdate, executeBigDecimalQuery, executeBigDecimalQuery, executeBigDecimalUpdate, executeBooleanQuery, executeBooleanQuery, executeBooleanUpdate, executeByteArrayQuery, executeByteArrayQuery, executeByteArrayUpdate, executeDateQuery, executeDateQuery, executeDateUpdate, executeIntListQuery, executeIntListQuery, executeIntListUpdate, executeIntQuery, executeIntQuery, executeIntUpdate, executeLongListQuery, executeLongListQuery, executeLongListUpdate, executeLongQuery, executeLongQuery, executeLongUpdate, executeObjectCollectionQuery, executeObjectCollectionQuery, executeObjectCollectionQuery, executeObjectCollectionQuery, executeObjectCollectionQuery, executeObjectCollectionQuery, executeObjectCollectionUpdate, executeObjectCollectionUpdate, executeObjectCollectionUpdate, executeObjectListQuery, executeObjectListQuery, executeObjectListQuery, executeObjectListQuery, executeObjectListQuery, executeObjectListQuery, executeObjectListUpdate, executeObjectListUpdate, executeObjectListUpdate, executeObjectQuery, executeObjectQuery, executeObjectQuery, executeObjectQuery, executeObjectQuery, executeObjectQuery, executeObjectUpdate, executeObjectUpdate, executeObjectUpdate, executeQuery, executeQuery, executeQuery, executeQuery, executeShortListQuery, executeShortListQuery, executeShortListUpdate, executeShortQuery, executeShortQuery, executeShortUpdate, executeStringListQuery, executeStringListQuery, executeStringListUpdate, executeStringQuery, executeStringQuery, executeStringUpdate, executeTimestampQuery, executeTimestampQuery, executeTimestampUpdate, executeUpdate, executeUpdate, executeUpdate, intStream, intStreamUpdate, longStream, longStreamUpdate, queryBigDecimal, queryBigDecimal, queryBoolean, queryBoolean, queryByteArray, queryByteArray, queryCall, queryCall, queryCall, queryCollection, queryCollection, queryCollection, queryCollection, queryDate, queryDate, queryDouble, queryDouble, queryFloat, queryFloat, queryInt, queryInt, queryIntList, queryIntList, queryList, queryList, queryList, queryList, queryLong, queryLong, queryLongList, queryLongList, queryNewCollection, queryNewCollection, queryNewCollection, queryNewCollection, queryObject, queryObject, queryObject, queryObject, queryRun, queryRun, queryRun, queryRun, queryShort, queryShort, queryString, queryString, queryStringList, queryStringList, queryTimestamp, queryTimestamp, stream, stream, stream, streamOptional, streamOptional, streamOptional, streamOptional, streamOptionalUpdate, streamOptionalUpdate, streamString, streamString, streamStringUpdate, streamUpdate, streamUpdate, updateBigDecimal, updateBoolean, updateByteArray, updateCall, updateCall, updateCollection, updateCollection, updateDate, updateDouble, updateFloat, updateInt, updateIntList, updateList, updateList, updateLong, updateLongList, updateNewCollection, updateNewCollection, updateObject, updateObject, updateRun, updateRun, updateShort, updateString, updateStringList, updateTimestamp

Constructor Detail

Database

public Database(String driver,
                String url,
                String user,
                String password,
                int numConnections,
                long maxConnectionAge,
                Logger logger)

Database

public Database(AOConnectionPool pool)

Database

public Database(DataSource dataSource,
                Logger logger)

Method Detail

createDatabaseConnection

@Deprecated(forRemoval=true)
public final DatabaseConnection createDatabaseConnection()

Deprecated, for removal: This API element is subject to removal in a future version.

Please use either connect() or one of the various call/run methods, which enforce the transaction semantics.

connect

public DatabaseConnection connect()

Creates a new DatabaseConnection instance. The instance must be closed via DatabaseConnection.close() or DatabaseConnection.close(java.lang.Throwable), typically in a try/catch or try-with-resources block.

Note that the close methods will rollback any transaction in progress, so it is up to the caller to perform any necessary DatabaseConnection.commit().

See Also:

transactionCall(com.aoapps.lang.concurrent.CallableE), transactionCall(java.lang.Class, com.aoapps.lang.concurrent.CallableE), transactionCall(com.aoapps.dbc.DatabaseCallable), transactionCall(java.lang.Class, com.aoapps.dbc.DatabaseCallableE), transactionRun(com.aoapps.lang.RunnableE), transactionRun(java.lang.Class, com.aoapps.lang.RunnableE), transactionRun(com.aoapps.dbc.DatabaseRunnable), transactionRun(java.lang.Class, com.aoapps.dbc.DatabaseRunnableE)

getConnectionPool

public AOConnectionPool getConnectionPool()

Gets the pool or null if using a DataSource.

See Also:

getDataSource()

getDataSource

public DataSource getDataSource()

Gets the data source or null if using an AOConnectionPool.

See Also:

getConnectionPool()

close

protected void close()

Closes the database.

See Also:

AOPool.close(), Executors.close(), CloseableDatabase.close()

initSqlDataTypes

protected void initSqlDataTypes(Connection conn)
                         throws SQLException

Whenever a new connection is obtained from the pool or the dataSource, it is passed here for initialization of getSqlDataTypes().

Throws:

SQLException

See Also:

deinitSqlDataTypes(java.sql.Connection), getConnection(int, boolean, int, boolean)

deinitSqlDataTypes

protected void deinitSqlDataTypes(Connection conn)
                           throws SQLException

Before a connection is release back to the pool or the dataSource, it is passed here for de-initialization of getSqlDataTypes().

Throws:

SQLException

See Also:

initSqlDataTypes(java.sql.Connection), release(com.aoapps.sql.failfast.FailFastConnection)

initConnection

protected void initConnection(Connection conn)
                       throws SQLException

Whenever a new connection is obtained from the pool or the dataSource, it is passed here for any custom initialization routine.

This default implementation does nothing.

Throws:

SQLException

See Also:

deinitConnection(java.sql.Connection), getConnection(int, boolean, int, boolean)

deinitConnection

protected void deinitConnection(Connection conn)
                         throws SQLException

Before a connection is released back to the pool or the dataSource, it is passed here for any custom de-initialization routine.

This default implementation does nothing.

Throws:

SQLException

See Also:

initConnection(java.sql.Connection), release(com.aoapps.sql.failfast.FailFastConnection)

getConnection

public Connection getConnection()
                         throws SQLException

Gets a read/write connection to the database with a transaction level of Connections.DEFAULT_TRANSACTION_ISOLATION, warning when a connection is already used by this thread.

The connection will be in auto-commit mode, as configured by AOConnectionPool.resetConnection(java.sql.Connection) (or compatible DataSource implementation via AOConnectionPool.defaultResetConnection(java.sql.Connection)).

When obtaining a connection from a DataSource, if the connection is not in auto-commit mode, a warning will be logged, then the connection will be rolled-back and set to auto-commit.

If all the connections in the pool are busy and the pool is at capacity, waits until a connection becomes available.

The connection will be a FailFastConnection, which may be unwrapped via Wrapper.unwrap(java.lang.Class). The fail-fast connection is used to determine whether to roll-back or commit during automatic transaction management.

The connection will also be a ConnectionTracker, which may be unwrapped via Wrapper.unwrap(java.lang.Class). The connection tracking is used to close/free all objects before returning the connection to the underlying pool.

Returns:

The read/write connection to the database

Throws:

SQLException - when an error occurs, or when a thread attempts to allocate more than half the pool

See Also:

getConnection(int, boolean, int, boolean), DatabaseConnection.getConnection(), Connection.close()

getConnection

public Connection getConnection(int maxConnections)
                         throws SQLException

Gets a read/write connection to the database with a transaction level of Connections.DEFAULT_TRANSACTION_ISOLATION.

The connection will be in auto-commit mode, as configured by AOConnectionPool.resetConnection(java.sql.Connection) (or compatible DataSource implementation via AOConnectionPool.defaultResetConnection(java.sql.Connection)).

When obtaining a connection from a DataSource, if the connection is not in auto-commit mode, a warning will be logged, then the connection will be rolled-back and set to auto-commit.

If all the connections in the pool are busy and the pool is at capacity, waits until a connection becomes available.

The connection will be a FailFastConnection, which may be unwrapped via Wrapper.unwrap(java.lang.Class). The fail-fast connection is used to determine whether to roll-back or commit during automatic transaction management.

The connection will also be a ConnectionTracker, which may be unwrapped via Wrapper.unwrap(java.lang.Class). The connection tracking is used to close/free all objects before returning the connection to the underlying pool.

Parameters:

maxConnections - The maximum number of connections expected to be used by the current thread. This should normally be one to avoid potential deadlock.

The connection will continue to be considered used by the allocating thread until released (via Connection.close(), even if the connection is shared by another thread.

Returns:

The read/write connection to the database

Throws:

SQLException - when an error occurs, or when a thread attempts to allocate more than half the pool

See Also:

getConnection(int, boolean, int, boolean), DatabaseConnection.getConnection(int), Connection.close()

getConnection

public Connection getConnection(boolean readOnly)
                         throws SQLException

Gets a connection to the database with a transaction level of Connections.DEFAULT_TRANSACTION_ISOLATION, warning when a connection is already used by this thread.

The connection will be in auto-commit mode, as configured by AOConnectionPool.resetConnection(java.sql.Connection) (or compatible DataSource implementation via AOConnectionPool.defaultResetConnection(java.sql.Connection)).

When obtaining a connection from a DataSource, if the connection is not in auto-commit mode, a warning will be logged, then the connection will be rolled-back and set to auto-commit.

If all the connections in the pool are busy and the pool is at capacity, waits until a connection becomes available.

The connection will be a FailFastConnection, which may be unwrapped via Wrapper.unwrap(java.lang.Class). The fail-fast connection is used to determine whether to roll-back or commit during automatic transaction management.

The connection will also be a ConnectionTracker, which may be unwrapped via Wrapper.unwrap(java.lang.Class). The connection tracking is used to close/free all objects before returning the connection to the underlying pool.

Parameters:

readOnly - The read-only flag

Returns:

The connection to the database

Throws:

SQLException - when an error occurs, or when a thread attempts to allocate more than half the pool

See Also:

getConnection(int, boolean, int, boolean), DatabaseConnection.getConnection(boolean), Connection.close()

getConnection

public Connection getConnection(int isolationLevel,
                                boolean readOnly)
                         throws SQLException

Gets a connection to the database, warning when a connection is already used by this thread.

The connection will be in auto-commit mode, as configured by AOConnectionPool.resetConnection(java.sql.Connection) (or compatible DataSource implementation via AOConnectionPool.defaultResetConnection(java.sql.Connection)).

When obtaining a connection from a DataSource, if the connection is not in auto-commit mode, a warning will be logged, then the connection will be rolled-back and set to auto-commit.

If all the connections in the pool are busy and the pool is at capacity, waits until a connection becomes available.

The connection will be a FailFastConnection, which may be unwrapped via Wrapper.unwrap(java.lang.Class). The fail-fast connection is used to determine whether to roll-back or commit during automatic transaction management.

The connection will also be a ConnectionTracker, which may be unwrapped via Wrapper.unwrap(java.lang.Class). The connection tracking is used to close/free all objects before returning the connection to the underlying pool.

Parameters:

isolationLevel - The transaction isolation level

readOnly - The read-only flag

Returns:

The connection to the database

Throws:

SQLException - when an error occurs, or when a thread attempts to allocate more than half the pool

See Also:

getConnection(int, boolean, int, boolean), DatabaseConnection.getConnection(int, boolean), Connection.close()

getConnection

public Connection getConnection(int isolationLevel,
                                boolean readOnly,
                                int maxConnections)
                         throws SQLException

Gets a connection to the database.

The connection will be in auto-commit mode, as configured by AOConnectionPool.resetConnection(java.sql.Connection) (or compatible DataSource implementation via AOConnectionPool.defaultResetConnection(java.sql.Connection)).

When obtaining a connection from a DataSource, if the connection is not in auto-commit mode, a warning will be logged, then the connection will be rolled-back and set to auto-commit.

If all the connections in the pool are busy and the pool is at capacity, waits until a connection becomes available.

The connection will be a FailFastConnection, which may be unwrapped via Wrapper.unwrap(java.lang.Class). The fail-fast connection is used to determine whether to roll-back or commit during automatic transaction management.

The connection will also be a ConnectionTracker, which may be unwrapped via Wrapper.unwrap(java.lang.Class). The connection tracking is used to close/free all objects before returning the connection to the underlying pool.

Parameters:

isolationLevel - The transaction isolation level

readOnly - The read-only flag

maxConnections - The maximum number of connections expected to be used by the current thread. This should normally be one to avoid potential deadlock.

The connection will continue to be considered used by the allocating thread until released (via Connection.close(), even if the connection is shared by another thread.

Returns:

The connection to the database

Throws:

SQLException - when an error occurs, or when a thread attempts to allocate more than half the pool

See Also:

DatabaseConnection.getConnection(int, boolean, int), Connection.close()

getConnection

protected FailFastConnection getConnection(int isolationLevel,
                                           boolean readOnly,
                                           int maxConnections,
                                           boolean allowClose)
                                    throws SQLException

Throws:

SQLException

releaseConnection

@Deprecated(forRemoval=true)
public final void releaseConnection(Connection conn)
                             throws SQLException

Deprecated, for removal: This API element is subject to removal in a future version.

Please release to the pool by closing the connection, preferably via try-with-resources.

Throws:

SQLException

release

protected void release(FailFastConnection conn)
                throws SQLException

Closes and/or releases the given connection back to the pool. Any transaction in-progress is rolled-back.

When there is no fail-fast cause, the connection is immediately deinit'ed then closed (which returns the connection to the underlying pool).

Otherwise, when there remains an unresolved fail-fast cause, the connection is validated in the background before being either aborted or deinit'ed then closed (both of which return the connection to the underlying pool).

Throws:

SQLException

See Also:

getConnection(int, boolean, int, boolean), DatabaseConnection.close(), deinitConnection(java.sql.Connection), deinitSqlDataTypes(java.sql.Connection)

getLogger

public Logger getLogger()

isInTransaction

public boolean isInTransaction()

Checks if the current thread is in a transaction.

See Also:

transactionCall(com.aoapps.lang.concurrent.CallableE), transactionCall(java.lang.Class, com.aoapps.lang.concurrent.CallableE), transactionCall(com.aoapps.dbc.DatabaseCallable), transactionCall(java.lang.Class, com.aoapps.dbc.DatabaseCallableE), transactionRun(com.aoapps.lang.RunnableE), transactionRun(java.lang.Class, com.aoapps.lang.RunnableE), transactionRun(com.aoapps.dbc.DatabaseRunnable), transactionRun(java.lang.Class, com.aoapps.dbc.DatabaseRunnableE)

transactionCall

public <V> V transactionCall(CallableE<? extends V,? extends SQLException> callable)
                      throws SQLException

Executes an arbitrary transaction, providing automatic commit, rollback, and connection management.

1. Rolls-back the transaction on NoRowException, NullDataException, or ExtraRowException on the outer-most transaction only.
2. Rolls-back the transaction on all other Throwable.

The connection allocated is stored as a ThreadLocal and will be automatically reused if another transaction is performed within this transaction. Any nested transaction will automatically become part of the enclosing transaction. For safety, a nested transaction will still rollback the entire transaction on any exception.

Throws:

SQLException

See Also:

isInTransaction()

transactionCall

public <V,Ex extends Throwable> V transactionCall(Class<? extends Ex> exClass,
                                                        CallableE<? extends V,? extends Ex> callable)
                                                 throws SQLException,
                                                        Ex extends Throwable

Executes an arbitrary transaction, providing automatic commit, rollback, and connection management.

1. Rolls-back the transaction on NoRowException, NullDataException, or ExtraRowException on the outer-most transaction only.
2. Rolls-back the transaction on all other Throwable.

The connection allocated is stored as a ThreadLocal and will be automatically reused if another transaction is performed within this transaction. Any nested transaction will automatically become part of the enclosing transaction. For safety, a nested transaction will still rollback the entire transaction on any exception.

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

SQLException

Ex extends Throwable

See Also:

isInTransaction()

transactionCall

public <V> V transactionCall(DatabaseCallable<? extends V> callable)
                      throws SQLException

Executes an arbitrary transaction, providing automatic commit, rollback, and connection management.

1. Rolls-back the transaction on NoRowException, NullDataException, or ExtraRowException on the outer-most transaction only.
2. Rolls-back the transaction on all other Throwable.

The connection allocated is stored as a ThreadLocal and will be automatically reused if another transaction is performed within this transaction. Any nested transaction will automatically become part of the enclosing transaction. For safety, a nested transaction will still rollback the entire transaction on any exception.

Throws:

SQLException

See Also:

isInTransaction()

executeTransaction

@Deprecated(forRemoval=true)
public final <V> V executeTransaction(DatabaseCallable<V> callable)
                               throws SQLException

Deprecated, for removal: This API element is subject to removal in a future version.

Please use transactionCall(com.aoapps.dbc.DatabaseCallable)

Throws:

SQLException

transactionCall

public <V,Ex extends Throwable> V transactionCall(Class<? extends Ex> exClass,
                                                        DatabaseCallableE<? extends V,? extends Ex> callable)
                                                 throws SQLException,
                                                        Ex extends Throwable

Executes an arbitrary transaction, providing automatic commit, rollback, and connection management.

1. Rolls-back the transaction on NoRowException, NullDataException, or ExtraRowException on the outer-most transaction only.
2. Rolls-back the transaction on all other Throwable.

The connection allocated is stored as a ThreadLocal and will be automatically reused if another transaction is performed within this transaction. Any nested transaction will automatically become part of the enclosing transaction. For safety, a nested transaction will still rollback the entire transaction on any exception.

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

SQLException

Ex extends Throwable

See Also:

isInTransaction()

executeTransaction

@Deprecated(forRemoval=true)
public final <V,Ex extends Exception> V executeTransaction(Class<Ex> exClass,
                                                                 DatabaseCallableE<V,Ex> callable)
                                                          throws SQLException,
                                                                 Ex extends Exception

Deprecated, for removal: This API element is subject to removal in a future version.

Please use transactionCall(java.lang.Class, com.aoapps.dbc.DatabaseCallableE)

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

SQLException

Ex extends Exception

transactionRun

public void transactionRun(RunnableE<? extends SQLException> runnable)
                    throws SQLException

Executes an arbitrary transaction, providing automatic commit, rollback, and connection management.

1. Rolls-back the transaction on NoRowException, NullDataException, or ExtraRowException on the outer-most transaction only.
2. Rolls-back the transaction on all other Throwable.

The connection allocated is stored as a ThreadLocal and will be automatically reused if another transaction is performed within this transaction. Any nested transaction will automatically become part of the enclosing transaction. For safety, a nested transaction will still rollback the entire transaction on any exception.

Throws:

SQLException

See Also:

isInTransaction()

transactionRun

public <Ex extends Throwable> void transactionRun(Class<? extends Ex> exClass,
                                                  RunnableE<? extends Ex> runnable)
                                           throws SQLException,
                                                  Ex extends Throwable

Executes an arbitrary transaction, providing automatic commit, rollback, and connection management.

1. Rolls-back the transaction on NoRowException, NullDataException, or ExtraRowException on the outer-most transaction only.
2. Rolls-back the transaction on all other Throwable.

The connection allocated is stored as a ThreadLocal and will be automatically reused if another transaction is performed within this transaction. Any nested transaction will automatically become part of the enclosing transaction. For safety, a nested transaction will still rollback the entire transaction on any exception.

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

SQLException

Ex extends Throwable

See Also:

isInTransaction()

transactionRun

public void transactionRun(DatabaseRunnable runnable)
                    throws SQLException

Executes an arbitrary transaction, providing automatic commit, rollback, and connection management.

1. Rolls-back the transaction on NoRowException, NullDataException, or ExtraRowException on the outer-most transaction only.
2. Rolls-back the transaction on all other Throwable.

The connection allocated is stored as a ThreadLocal and will be automatically reused if another transaction is performed within this transaction. Any nested transaction will automatically become part of the enclosing transaction. For safety, a nested transaction will still rollback the entire transaction on any exception.

Throws:

SQLException

See Also:

isInTransaction()

executeTransaction

@Deprecated(forRemoval=true)
public final void executeTransaction(DatabaseRunnable runnable)
                              throws SQLException

Deprecated, for removal: This API element is subject to removal in a future version.

Please use transactionRun(com.aoapps.dbc.DatabaseRunnable)

Throws:

SQLException

transactionRun

public <Ex extends Throwable> void transactionRun(Class<? extends Ex> exClass,
                                                  DatabaseRunnableE<? extends Ex> runnable)
                                           throws SQLException,
                                                  Ex extends Throwable

Executes an arbitrary transaction, providing automatic commit, rollback, and connection management.

1. Rolls-back the transaction on NoRowException, NullDataException, or ExtraRowException on the outer-most transaction only.
2. Rolls-back the transaction on all other Throwable.

The connection allocated is stored as a ThreadLocal and will be automatically reused if another transaction is performed within this transaction. Any nested transaction will automatically become part of the enclosing transaction. For safety, a nested transaction will still rollback the entire transaction on any exception.

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

SQLException

Ex extends Throwable

See Also:

isInTransaction()

executeTransaction

@Deprecated(forRemoval=true)
public final <Ex extends Exception> void executeTransaction(Class<Ex> exClass,
                                                            DatabaseRunnableE<Ex> runnable)
                                                     throws SQLException,
                                                            Ex extends Exception

Deprecated, for removal: This API element is subject to removal in a future version.

Please use transactionRun(java.lang.Class, com.aoapps.dbc.DatabaseRunnableE)

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

SQLException

Ex extends Exception

toString

public String toString()

Overrides:

toString in class Object

doubleStream

public DoubleStream doubleStream(int isolationLevel,
                                 boolean readOnly,
                                 String sql,
                                 Object... params)
                          throws NullDataException,
                                 SQLException

Description copied from interface: DatabaseAccess

Query the database with a DoubleStream return type.

Specified by:

doubleStream in interface DatabaseAccess

Throws:

NullDataException

SQLException

intStream

public IntStream intStream(int isolationLevel,
                           boolean readOnly,
                           String sql,
                           Object... params)
                    throws NullDataException,
                           SQLException

Description copied from interface: DatabaseAccess

Query the database with an IntStream return type.

Specified by:

intStream in interface DatabaseAccess

Throws:

NullDataException

SQLException

longStream

public LongStream longStream(int isolationLevel,
                             boolean readOnly,
                             String sql,
                             Object... params)
                      throws NullDataException,
                             SQLException

Description copied from interface: DatabaseAccess

Query the database with a LongStream return type.

Specified by:

longStream in interface DatabaseAccess

Throws:

NullDataException

SQLException

stream

public <T,Ex extends Throwable> Stream<T> stream(int isolationLevel,
                                                       boolean readOnly,
                                                       Class<? extends Ex> exClass,
                                                       ObjectFactoryE<? extends T,? extends Ex> objectFactory,
                                                       String sql,
                                                       Object... params)
                                                throws SQLException,
                                                       Ex extends Throwable

Query the database with a Stream<T> return type, objects are created with the provided factory.

When the factory is nullable, the stream may contain null elements. Otherwise, will have the characteristic Spliterator.NONNULL.

Specified by:

stream in interface DatabaseAccess

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

SQLException

Ex extends Throwable

queryCall

public <T,Ex extends Throwable> T queryCall(int isolationLevel,
                                                  boolean readOnly,
                                                  Class<? extends Ex> exClass,
                                                  ResultSetCallableE<? extends T,? extends Ex> resultSetCallable,
                                                  String sql,
                                                  Object... params)
                                           throws SQLException,
                                                  Ex extends Throwable

Query the database, calling the ResultSetCallableE once.

Specified by:

queryCall in interface DatabaseAccess

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

SQLException

Ex extends Throwable

update

public int update(String sql,
                  Object... params)
           throws SQLException

Description copied from interface: DatabaseAccess

Performs an update on the database and returns the number of rows affected.

Specified by:

update in interface DatabaseAccess

Throws:

SQLException

largeUpdate

public long largeUpdate(String sql,
                        Object... params)
                 throws SQLException

Description copied from interface: DatabaseAccess

Performs an update on the database and returns the number of rows affected.

Specified by:

largeUpdate in interface DatabaseAccess

Throws:

SQLException