A default implementation for the TransactionProvider SPI.

This implementation is entirely based on JDBC transactions and is intended to work with DefaultConnectionProvider (which is implicitly created when using DSL#using(Connection)).

Nesting of transactions

By default, nested transactions are supported by modeling them implicitly with JDBC Savepoints, if supported by the underlying JDBC driver, and if nested() is true. To deactivate nested transactions, use DefaultTransactionProvider(ConnectionProvider, boolean).

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	DefaultTransactionProvider.DefaultSavepoint

Field Summary

Modifier and Type	Field and Description
private final ConnectionProvider	connectionProvider
private static final Savepoint	IGNORED_SAVEPOINT This `Savepoint` serves as a marker for top level transactions if `nested()` transactions are deactivated.
private final boolean	nested

Constructor Summary

Access	Constructor and Description
public	DefaultTransactionProvider(ConnectionProvider connectionProvider)
public	DefaultTransactionProvider(ConnectionProvider connectionProvider, boolean Whether nested transactions via `Savepoint`s are supported. nested)

Method Summary

Modifier and Type	Method and Description
private final boolean	autoCommit(Configuration configuration)
public final void	begin(TransactionContext the configuration scoped to this transaction and its nested transactions. ctx) Implements org.jooq.TransactionProvider.begin. Begin a new transaction.
private final void	brace(Configuration configuration, boolean start) Ensure an `autoCommit` value on the connection, if it was set to `true`, originally.
public final void	commit(TransactionContext the configuration scoped to this transaction and its nested transactions. ctx) Implements org.jooq.TransactionProvider.commit. Commit a transaction.
private final DefaultConnectionProvider	connection(Configuration configuration)
public final boolean	nested()
pack-priv final int	nestingLevel(Configuration configuration)
public final void	rollback(TransactionContext the configuration scoped to this transaction and its nested transactions. ctx) Implements org.jooq.TransactionProvider.rollback. Rollback a transaction.
private final Deque<Savepoint>	savepoints(Configuration configuration)
private final Savepoint	setSavepoint(Configuration configuration, boolean topLevel)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

connectionProvider	back to summary
private final ConnectionProvider connectionProvider

IGNORED_SAVEPOINT	back to summary
private static final Savepoint IGNORED_SAVEPOINT This `Savepoint` serves as a marker for top level transactions if `nested()` transactions are deactivated.

nested	back to summary
private final boolean nested

Constructor Detail

DefaultTransactionProvider	back to summary
public DefaultTransactionProvider(ConnectionProvider connectionProvider)

DefaultTransactionProvider	back to summary
public DefaultTransactionProvider(ConnectionProvider connectionProvider, boolean nested) Parameters nested:boolean Whether nested transactions via `Savepoint`s are supported.

Method Detail

autoCommit	back to summary
private final boolean autoCommit(Configuration configuration)

begin back to summary

begin	back to summary
public final void begin(TransactionContext ctx) Implements org.jooq.TransactionProvider.begin. Doc from org.jooq.TransactionProvider.begin. Begin a new transaction. This method begins a new transaction with a `Configuration` scoped for this transaction. The resulting `Transaction` object may be used by implementors to identify the transaction when `commit(TransactionContext)` or `rollback(TransactionContext)` is called. Parameters ctx:TransactionContext the configuration scoped to this transaction and its nested transactions. Annotations @Override

public final void begin(TransactionContext ctx)

Implements org.jooq.TransactionProvider.begin.

Doc from org.jooq.TransactionProvider.begin.

Begin a new transaction.

This method begins a new transaction with a Configuration scoped for this transaction. The resulting Transaction object may be used by implementors to identify the transaction when commit(TransactionContext) or rollback(TransactionContext) is called.

Parameters

ctx:TransactionContext: the configuration scoped to this transaction and its nested transactions.

Annotations

@Override

brace	back to summary
private final void brace(Configuration configuration, boolean start) Ensure an `autoCommit` value on the connection, if it was set to `true`, originally.

commit	back to summary
public final void commit(TransactionContext ctx) Implements org.jooq.TransactionProvider.commit. Doc from org.jooq.TransactionProvider.commit. Commit a transaction. Parameters ctx:TransactionContext the configuration scoped to this transaction and its nested transactions. Annotations @Override

commit

back to summary

public final void commit(TransactionContext ctx)

Implements org.jooq.TransactionProvider.commit.

Doc from org.jooq.TransactionProvider.commit.

Commit a transaction.

Parameters

ctx:TransactionContext: the configuration scoped to this transaction and its nested transactions.

Annotations

@Override

connection	back to summary
private final DefaultConnectionProvider connection(Configuration configuration)

nested	back to summary
public final boolean nested()

nestingLevel	back to summary
pack-priv final int nestingLevel(Configuration configuration)

rollback	back to summary
public final void rollback(TransactionContext ctx) Implements org.jooq.TransactionProvider.rollback. Doc from org.jooq.TransactionProvider.rollback. Rollback a transaction. Parameters ctx:TransactionContext the configuration scoped to this transaction and its nested transactions. Annotations @Override

rollback

back to summary

public final void rollback(TransactionContext ctx)

Implements org.jooq.TransactionProvider.rollback.

Doc from org.jooq.TransactionProvider.rollback.

Rollback a transaction.

Parameters

ctx:TransactionContext: the configuration scoped to this transaction and its nested transactions.

Annotations

@Override

savepoints	back to summary
private final Deque<Savepoint> savepoints(Configuration configuration) Annotations @SuppressWarnings:unchecked

setSavepoint	back to summary
private final Savepoint setSavepoint(Configuration configuration, boolean topLevel)

org.jooq.impl back to summary

private Class DefaultTransactionProvider.DefaultSavepoint

Class Inheritance

extends Object
implements Savepoint

java.lang.Object
org.jooq.impl.DefaultTransactionProvider.DefaultSavepoint

All Implemented Interfaces

java.sql.Savepoint

Constructor Summary

Access	Constructor and Description
private	DefaultSavepoint()

Method Summary

Modifier and Type	Method and Description
public int	getSavepointId() Implements java.sql.Savepoint.getSavepointId. Retrieves the generated ID for the savepoint that this `Savepoint` object represents.
public String	getSavepointName() Implements java.sql.Savepoint.getSavepointName. Retrieves the name of the savepoint that this `Savepoint` object represents.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

DefaultSavepoint	back to summary
private DefaultSavepoint()

Method Detail

getSavepointId back to summary

getSavepointId	back to summary
public int getSavepointId() throws SQLException Implements java.sql.Savepoint.getSavepointId. Doc from java.sql.Savepoint.getSavepointId. Retrieves the generated ID for the savepoint that this `Savepoint` object represents. Returns:int the numeric ID of this savepoint Annotations @Override Exceptions SQLException: if this is a named savepoint

public int getSavepointId() throws SQLException

Implements java.sql.Savepoint.getSavepointId.

Doc from java.sql.Savepoint.getSavepointId.

Retrieves the generated ID for the savepoint that this Savepoint object represents.

Returns:int

the numeric ID of this savepoint

Annotations

@Override

Exceptions

SQLException:: if this is a named savepoint

getSavepointName back to summary

getSavepointName	back to summary
public String getSavepointName() throws SQLException Implements java.sql.Savepoint.getSavepointName. Doc from java.sql.Savepoint.getSavepointName. Retrieves the name of the savepoint that this `Savepoint` object represents. Returns:String the name of this savepoint Annotations @Override Exceptions SQLException: if this is an un-named savepoint

public String getSavepointName() throws SQLException

Implements java.sql.Savepoint.getSavepointName.

Doc from java.sql.Savepoint.getSavepointName.

Retrieves the name of the savepoint that this Savepoint object represents.

Returns:String

the name of this savepoint

Annotations

@Override

Exceptions

SQLException:: if this is an un-named savepoint

public Class DefaultTransactionProvider

Nesting of transactions

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DefaultTransactionProvider.DefaultSavepoint

Constructor Summary

Method Summary

Constructor Detail

Method Detail