Module org.itsallcode.jdbc

Package org.itsallcode.jdbc

Class Transaction

java.lang.Object

org.itsallcode.jdbc.Transaction

All Implemented Interfaces:

AutoCloseable, DbOperations

public final class Transaction
extends Object
implements DbOperations

A running database transaction. The transaction will be rolled back automatically in close() if not explicitly committed using commit() or rolled back using rollback() before.

Start a new transaction using SimpleConnection.startTransaction().

Operations are not allowed on a closed, committed or rolled back transaction.

Closing an already closed transaction is a no-op.

Method Summary

Modifier and Type	Method	Description
void	close()	Rollback transaction if not already committed or rolled back and restore original auto commit setting if necessary.
void	commit()	Commit the transaction.
void	executeScript(String sqlScript)	Execute all commands in a SQL script, separated with ;.
int	executeUpdate(String sql)	Execute a single SQL statement.
int	executeUpdate(String sql, PreparedStatementSetter preparedStatementSetter)	Execute a single SQL statement as a prepared statement with placeholders.
Connection	getOriginalConnection()	Get the original wrapped connection.
PreparedStatementBatchBuilder	preparedStatementBatch()	Create a prepared statement batch builder for inserting or updating rows by directly setting values of a PreparedStatement.
<T> RowPreparedStatementBatchBuilder<T>	preparedStatementBatch(Class<T> rowType)	Create a row-based prepared statement batch builder for inserting or updating rows from an Iterator or a Stream.
SimpleResultSet<Row>	query(String sql)	Execute a SQL query and return a result set with generic Rows.
<T> SimpleResultSet<T>	query(String sql, PreparedStatementSetter preparedStatementSetter, RowMapper<T> rowMapper)	Execute a SQL query, set parameters and return a result set with rows converted to a custom type DbOperations.
void	rollback()	Rollback the transaction.
StatementBatchBuilder	statementBatch()	Create a batch statement builder for executing multiple statements in a batch.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.itsallcode.jdbc.DbOperations

executeUpdate, query, query

Method Details

commit

public void commit()

Commit the transaction.

No further operations are allowed on this transaction afterwards.

See Also:

• Connection.commit()

rollback

public void rollback()

Rollback the transaction.

No further operations are allowed on this transaction afterwards.

See Also:

• Connection.rollback()

executeUpdate

public int executeUpdate(String sql)

Description copied from interface: DbOperations

Execute a single SQL statement.

Specified by:

executeUpdate in interface DbOperations

Parameters:

sql - SQL statement

Returns:

either the row count for SQL Data Manipulation Language (DML) statements or 0 for SQL statements that return nothing

executeUpdate

public int executeUpdate(String sql,
 PreparedStatementSetter preparedStatementSetter)

Description copied from interface: DbOperations

Execute a single SQL statement as a prepared statement with placeholders.

Specified by:

executeUpdate in interface DbOperations

Parameters:

sql - SQL statement

preparedStatementSetter - prepared statement setter

Returns:

either the row count for SQL Data Manipulation Language (DML) statements or 0 for SQL statements that return nothing

query

public SimpleResultSet<Row> query(String sql)

Description copied from interface: DbOperations

Execute a SQL query and return a result set with generic Rows.

Specified by:

query in interface DbOperations

Parameters:

sql - SQL query

Returns:

result set

executeScript

public void executeScript(String sqlScript)

Description copied from interface: DbOperations

Execute all commands in a SQL script, separated with ;.

Specified by:

executeScript in interface DbOperations

Parameters:

sqlScript - script to execute.

query

public <T> SimpleResultSet<T> query(String sql,
 PreparedStatementSetter preparedStatementSetter,
 RowMapper<T> rowMapper)

Description copied from interface: DbOperations

Execute a SQL query, set parameters and return a result set with rows converted to a custom type DbOperations.

Specified by:

query in interface DbOperations

Type Parameters:

T - generic row type

Parameters:

sql - SQL query

preparedStatementSetter - the prepared statement setter

rowMapper - row mapper

Returns:

the result set

statementBatch

public StatementBatchBuilder statementBatch()

Description copied from interface: DbOperations

Create a batch statement builder for executing multiple statements in a batch.

Specified by:

statementBatch in interface DbOperations

Returns:

batch statement builder

preparedStatementBatch

public PreparedStatementBatchBuilder preparedStatementBatch()

Description copied from interface: DbOperations

Create a prepared statement batch builder for inserting or updating rows by directly setting values of a PreparedStatement.

If you want to insert rows from an Iterator or a Stream, use DbOperations.preparedStatementBatch(Class).

Specified by:

preparedStatementBatch in interface DbOperations

Returns:

batch insert builder

preparedStatementBatch

public <T> RowPreparedStatementBatchBuilder<T> preparedStatementBatch(Class<T> rowType)

Description copied from interface: DbOperations

Create a row-based prepared statement batch builder for inserting or updating rows from an Iterator or a Stream.

If you want to insert rows by directly setting values of a PreparedStatement, use DbOperations.preparedStatementBatch().

Specified by:

preparedStatementBatch in interface DbOperations

Type Parameters:

T - row type

Parameters:

rowType - row type

Returns:

row-based batch insert builder

getOriginalConnection

public Connection getOriginalConnection()

Description copied from interface: DbOperations

Get the original wrapped connection.

Use this in case of missing features in DbOperations.

Specified by:

getOriginalConnection in interface DbOperations

Returns:

original wrapped connection

close

public void close()

Rollback transaction if not already committed or rolled back and restore original auto commit setting if necessary.

Explicitly run commit() before to commit your transaction.

No further operations are allowed on this transaction afterwards.

This does not close the connection, so you can continue using it.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface DbOperations