com.github.susom.database

Interface DatabaseProviderVertx.Builder

Enclosing class:

DatabaseProviderVertx

public static interface DatabaseProviderVertx.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
void	close()
DatabaseProviderVertx	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.
<T> void	transactAsync(DbCodeTyped<T> code, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>> resultHandler)
<T> void	transactAsync(DbCodeTypedTx<T> code, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>> resultHandler)
<T> T	transactReturning(DbCodeTyped<T> code) This method is the same as transact(DbCode) but allows a return value.
DatabaseProviderVertx.Builder	withConnectionAccess() Allow direct access to the underlying database connection.
DatabaseProviderVertx.Builder	withDatePerAppOnly() Wherever argDateNowPerDb() is specified, use argDateNowPerApp() instead.
DatabaseProviderVertx.Builder	withOptions(OptionsOverride options)
DatabaseProviderVertx.Builder	withSqlInExceptionMessages() Include SQL in exception messages.
DatabaseProviderVertx.Builder	withSqlParameterLogging() Enable logging of parameter values along with the SQL.
DatabaseProviderVertx.Builder	withTransactionControl() Allow provided Database instances to explicitly control transactions using the commitNow() and rollbackNow() methods.
DatabaseProviderVertx.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
DatabaseProviderVertx.Builder withOptions(OptionsOverride options)

withSqlParameterLogging

@CheckReturnValue
DatabaseProviderVertx.Builder withSqlParameterLogging()

Enable logging of parameter values along with the SQL.

withSqlInExceptionMessages

@CheckReturnValue
DatabaseProviderVertx.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
DatabaseProviderVertx.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
DatabaseProviderVertx.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
DatabaseProviderVertx.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
DatabaseProviderVertx.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
DatabaseProviderVertx 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

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 the transaction will commit unless either the DbCode.run(Supplier) method threw a Throwable.

Here is a typical usage:

   dbp.transact(dbs -> {
     List r = dbs.get().toSelect("select a from b where c=?").argInteger(1).queryStrings();
   });
 

Parameters:

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

See Also:

transact(DbCodeTx)

transactReturning

<T> T transactReturning(DbCodeTyped<T> code)

This method is the same as transact(DbCode) but allows a return value.

Here is a typical usage:

   List r = dbp.transact(dbs -> {
     return dbs.get().toSelect("select a from b where c=?").argInteger(1).queryStrings();
   });
 

transactAsync

<T> void transactAsync(DbCodeTyped<T> code,
                       io.vertx.core.Handler<io.vertx.core.AsyncResult<T>> resultHandler)

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

transactAsync

<T> void transactAsync(DbCodeTypedTx<T> code,
                       io.vertx.core.Handler<io.vertx.core.AsyncResult<T>> resultHandler)

close

void close()