com.github.susom.database

Interface DatabaseProvider.Builder

Enclosing class:

DatabaseProvider

public static interface DatabaseProvider.Builder

This builder is immutable, so setting various options does not affect the previous instance. This is intended to make it safe to pass builders around without risk someone will reconfigure it.

Method Summary

Modifier and Type	Method and Description
DatabaseProvider	create() WARNING: You should try to avoid using this method.
void	transact(DbCode code) This is a convenience method to eliminate the need for explicitly managing the resources (and error handling) for this class.
void	transact(DbCodeTx code) This is a convenience method to eliminate the need for explicitly managing the resources (and error handling) for this class.
void	transact(DbRun run) Deprecated. Replace with transact(DbCodeTx) and a call to Transaction.setRollbackOnError(boolean) providing a value of false.
DatabaseProvider.Builder	withConnectionAccess() Allow direct access to the underlying database connection.
DatabaseProvider.Builder	withDatePerAppOnly() Wherever argDateNowPerDb() is specified, use argDateNowPerApp() instead.
DatabaseProvider.Builder	withOptions(OptionsOverride options)
DatabaseProvider.Builder	withSqlInExceptionMessages() Include SQL in exception messages.
DatabaseProvider.Builder	withSqlParameterLogging() Enable logging of parameter values along with the SQL.
DatabaseProvider.Builder	withTransactionControl() Allow provided Database instances to explicitly control transactions using the commitNow() and rollbackNow() methods.
DatabaseProvider.Builder	withTransactionControlSilentlyIgnored() This can be useful when testing code, as it can pretend to use transactions, while giving you control over whether it actually commits or rolls back.

Method Detail

withOptions

@CheckReturnValue
DatabaseProvider.Builder withOptions(OptionsOverride options)

withSqlParameterLogging

@CheckReturnValue
DatabaseProvider.Builder withSqlParameterLogging()

Enable logging of parameter values along with the SQL.

withSqlInExceptionMessages

@CheckReturnValue
DatabaseProvider.Builder withSqlInExceptionMessages()

Include SQL in exception messages. This will also include parameters in the exception messages if SQL parameter logging is enabled. This is handy for development, but be careful as this is an information disclosure risk, dependent on how the exception are caught and handled.

withDatePerAppOnly

@CheckReturnValue
DatabaseProvider.Builder withDatePerAppOnly()

Wherever argDateNowPerDb() is specified, use argDateNowPerApp() instead. This is useful for testing purposes as you can use OptionsOverride to provide your own system clock that will be used for time travel.

withTransactionControl

@CheckReturnValue
DatabaseProvider.Builder withTransactionControl()

Allow provided Database instances to explicitly control transactions using the commitNow() and rollbackNow() methods. Otherwise calling those methods would throw an exception.

withTransactionControlSilentlyIgnored

@CheckReturnValue
DatabaseProvider.Builder withTransactionControlSilentlyIgnored()

This can be useful when testing code, as it can pretend to use transactions, while giving you control over whether it actually commits or rolls back.

withConnectionAccess

@CheckReturnValue
DatabaseProvider.Builder withConnectionAccess()

Allow direct access to the underlying database connection. Normally this is not allowed, and is a bad idea, but it can be helpful when migrating from legacy code that works with raw JDBC.

create

@CheckReturnValue
DatabaseProvider create()

WARNING: You should try to avoid using this method. If you use it more that once or twice in your entire codebase you are probably doing something wrong.

If you use this method you are responsible for managing the transaction and commit/rollback/close.

transact

@Deprecated
void transact(DbRun run)

Deprecated. Replace with transact(DbCodeTx) and a call to Transaction.setRollbackOnError(boolean) providing a value of false.

This method runs the provided block of code, and commits the transaction after either successful completion of the block or an exceptional condition.

transact

void transact(DbCode code)

This is a convenience method to eliminate the need for explicitly managing the resources (and error handling) for this class. After the run block is complete commit() will be called unless either the DbCode.run(Supplier) method threw a Throwable.

Parameters:

code - the code you want to run as a transaction with a Database

See Also:

#transact(DbCodeTx)} if you want to explicitly manage when the transaction commits or rolls back

transact

void transact(DbCodeTx code)

This is a convenience method to eliminate the need for explicitly managing the resources (and error handling) for this class. After the run block is complete commit() will be called unless either the DbCodeTx.run(Supplier, Transaction) method threw a Throwable while Transaction.isRollbackOnError() returns true, or Transaction.isRollbackOnly() returns a true value.

Parameters:

code - the code you want to run as a transaction with a Database