Module org.dalesbred

Package org.dalesbred

Class Database

java.lang.Object

org.dalesbred.DatabaseAccess

org.dalesbred.Database

public final class Database
extends DatabaseAccess

The main abstraction of the library: represents a configured connection to database and provides a way to execute callbacks in transactions.

Usually you'll need only single instance of this in your application, unless you need to connect several different databases or need different default settings for different use cases.

Field Summary

Fields inherited from class org.dalesbred.DatabaseAccess

dialect, instantiatorRegistry

Constructor Summary

Constructors

Constructor	Description
Database(@NotNull DataSource dataSource)	Constructs a new Database that uses given DataSource and auto-detects the dialect to use.
Database(@NotNull DataSource dataSource, @NotNull Dialect dialect)	Constructs a new Database that uses given DataSource and Dialect.
Database(@NotNull ConnectionProvider connectionProvider)	Constructs a new Database that uses given ConnectionProvider and auto-detects the dialect to use.
Database(@NotNull ConnectionProvider connectionProvider, @NotNull Dialect dialect)	Constructs a new Database that uses given ConnectionProvider and Dialect.
Database(@NotNull TransactionManager transactionManager)	Constructs a new Database that uses given TransactionManager and auto-detects the dialect to use.
Database(@NotNull TransactionManager transactionManager, @NotNull Dialect dialect)	Constructs a new Database that uses given TransactionManager and Dialect.

Method Summary

Modifier and Type	Method	Description
static @NotNull Database	forDataSource(@NotNull DataSource dataSource)	Returns a new Database that uses given DataSource to retrieve connections.
static @NotNull Database	forJndiDataSource(@NotNull String jndiName)	Returns a new Database that uses DataSource with given JNDI-name.
static @NotNull Database	forUrlAndCredentials(@NotNull String url, @Nullable String username, @Nullable String password)	Returns a new Database that uses given connection options to open connection.
@NotNull TypeConversionRegistry	getTypeConversionRegistry()	Returns TypeConversionRegistry that can be used to register new type-conversions.
boolean	hasActiveTransaction()	Returns true if and only if the current thread has an active transaction for this database.
boolean	isAllowImplicitTransactions()	Returns whether queries outside an active transaction will start a fresh transaction (true, the default) or throw NoActiveTransactionException (false).
void	setAllowImplicitTransactions(boolean allowImplicitTransactions)	Controls whether queries outside an active transaction automatically start a fresh transaction.
@NotNull String	toString()	Returns a string containing useful debug information about the state of this object.
protected <T> T	withCurrentTransaction(@NotNull SqlQuery query, @NotNull TransactionCallback<T> callback)	Executes the block of code within context of current transaction.
<T> T	withTransaction(@NotNull Isolation isolation, @NotNull TransactionCallback<T> callback)	Executes a block of code with given isolation.
<T> T	withTransaction(@NotNull Propagation propagation, @NotNull Isolation isolation, @NotNull TransactionCallback<T> callback)	Executes a block of code with given propagation and isolation.
<T> T	withTransaction(@NotNull Propagation propagation, @NotNull TransactionCallback<T> callback)	Executes a block of code with given propagation and configuration default isolation.
<T> T	withTransaction(@NotNull TransactionCallback<T> callback)	Executes a block of code within a context of a transaction, using Propagation.REQUIRED propagation.
<T> T	withTransaction(@NotNull TransactionSettings settings, @NotNull TransactionCallback<T> callback)	Executes a block of code with given transaction settings.
void	withVoidTransaction(@NotNull Isolation isolation, @NotNull VoidTransactionCallback callback)	Executes a block of code with given isolation.
void	withVoidTransaction(@NotNull Propagation propagation, @NotNull Isolation isolation, @NotNull VoidTransactionCallback callback)	Executes a block of code with given propagation and isolation.
void	withVoidTransaction(@NotNull Propagation propagation, @NotNull VoidTransactionCallback callback)	Executes a block of code with given propagation and configuration default isolation.
void	withVoidTransaction(@NotNull TransactionSettings settings, @NotNull VoidTransactionCallback callback)	Executes a block of code with given transaction settings.
void	withVoidTransaction(@NotNull VoidTransactionCallback callback)	Executes a block of code within a context of a transaction, using Propagation.REQUIRED propagation.

Methods inherited from class org.dalesbred.DatabaseAccess

bindArguments, bindQueryParameters, executeQuery, executeQuery, findAll, findAll, findAll, findAll, findMap, findMap, findOptional, findOptional, findOptional, findOptional, findOptionalDouble, findOptionalDouble, findOptionalInt, findOptionalInt, findOptionalLong, findOptionalLong, findTable, findTable, findUnique, findUnique, findUnique, findUnique, findUniqueBoolean, findUniqueBoolean, findUniqueInt, findUniqueInt, findUniqueLong, findUniqueLong, findUniqueOrNull, findUniqueOrNull, findUniqueOrNull, findUniqueOrNull, getDefaultTimeout, prepareStatementFromQuery, setDefaultTimeout, update, update, updateAndProcessGeneratedKeys, updateAndProcessGeneratedKeys, updateBatch, updateBatchAndProcessGeneratedKeys, updateUnique, updateUnique

Methods inherited from class java.lang.Object

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

Constructor Details

Database

public Database(@NotNull
 @NotNull ConnectionProvider connectionProvider)

Constructs a new Database that uses given ConnectionProvider and auto-detects the dialect to use.

Database

public Database(@NotNull
 @NotNull ConnectionProvider connectionProvider,
 @NotNull
 @NotNull Dialect dialect)

Constructs a new Database that uses given ConnectionProvider and Dialect.

Database

public Database(@NotNull
 @NotNull TransactionManager transactionManager)

Constructs a new Database that uses given TransactionManager and auto-detects the dialect to use.

Database

public Database(@NotNull
 @NotNull TransactionManager transactionManager,
 @NotNull
 @NotNull Dialect dialect)

Constructs a new Database that uses given TransactionManager and Dialect.

Database

public Database(@NotNull
 @NotNull DataSource dataSource)

Constructs a new Database that uses given DataSource and auto-detects the dialect to use.

Database

public Database(@NotNull
 @NotNull DataSource dataSource,
 @NotNull
 @NotNull Dialect dialect)

Constructs a new Database that uses given DataSource and Dialect.

Method Details

forDataSource

@NotNull
public static @NotNull Database forDataSource(@NotNull
 @NotNull DataSource dataSource)

Returns a new Database that uses given DataSource to retrieve connections.

forJndiDataSource

@NotNull
public static @NotNull Database forJndiDataSource(@NotNull
 @NotNull String jndiName)

Returns a new Database that uses DataSource with given JNDI-name.

forUrlAndCredentials

@NotNull
public static @NotNull Database forUrlAndCredentials(@NotNull
 @NotNull String url,
 @Nullable
 @Nullable String username,
 @Nullable
 @Nullable String password)

Returns a new Database that uses given connection options to open connection. The database opens connections directly from DriverManager without performing connection pooling.

See Also:

• DriverManagerConnectionProvider

withTransaction

public <T> T withTransaction(@NotNull
 @NotNull TransactionCallback<T> callback)

Executes a block of code within a context of a transaction, using Propagation.REQUIRED propagation.

withTransaction

public <T> T withTransaction(@NotNull
 @NotNull Propagation propagation,
 @NotNull
 @NotNull TransactionCallback<T> callback)

Executes a block of code with given propagation and configuration default isolation.

withTransaction

public <T> T withTransaction(@NotNull
 @NotNull Isolation isolation,
 @NotNull
 @NotNull TransactionCallback<T> callback)

Executes a block of code with given isolation.

withTransaction

public <T> T withTransaction(@NotNull
 @NotNull Propagation propagation,
 @NotNull
 @NotNull Isolation isolation,
 @NotNull
 @NotNull TransactionCallback<T> callback)

Executes a block of code with given propagation and isolation.

withTransaction

public <T> T withTransaction(@NotNull
 @NotNull TransactionSettings settings,
 @NotNull
 @NotNull TransactionCallback<T> callback)

Executes a block of code with given transaction settings.

See Also:

• TransactionSettings

withVoidTransaction

public void withVoidTransaction(@NotNull
 @NotNull VoidTransactionCallback callback)

Executes a block of code within a context of a transaction, using Propagation.REQUIRED propagation.

withVoidTransaction

public void withVoidTransaction(@NotNull
 @NotNull Propagation propagation,
 @NotNull
 @NotNull VoidTransactionCallback callback)

Executes a block of code with given propagation and configuration default isolation.

withVoidTransaction

public void withVoidTransaction(@NotNull
 @NotNull Isolation isolation,
 @NotNull
 @NotNull VoidTransactionCallback callback)

Executes a block of code with given isolation.

withVoidTransaction

public void withVoidTransaction(@NotNull
 @NotNull Propagation propagation,
 @NotNull
 @NotNull Isolation isolation,
 @NotNull
 @NotNull VoidTransactionCallback callback)

Executes a block of code with given propagation and isolation.

withVoidTransaction

public void withVoidTransaction(@NotNull
 @NotNull TransactionSettings settings,
 @NotNull
 @NotNull VoidTransactionCallback callback)

Executes a block of code with given transaction settings.

See Also:

• TransactionSettings

hasActiveTransaction

public boolean hasActiveTransaction()

Returns true if and only if the current thread has an active transaction for this database.

withCurrentTransaction

protected <T> T withCurrentTransaction(@NotNull
 @NotNull SqlQuery query,
 @NotNull
 @NotNull TransactionCallback<T> callback)

Executes the block of code within context of current transaction. If there's no transaction in progress throws NoActiveTransactionException unless implicit transaction are allowed: in this case, starts a new transaction.

Specified by:

withCurrentTransaction in class DatabaseAccess

Throws:

NoActiveTransactionException - if there's no active transaction.

See Also:

• setAllowImplicitTransactions(boolean)

getTypeConversionRegistry

@NotNull
public @NotNull TypeConversionRegistry getTypeConversionRegistry()

Returns TypeConversionRegistry that can be used to register new type-conversions.

isAllowImplicitTransactions

public boolean isAllowImplicitTransactions()

Returns whether queries outside an active transaction will start a fresh transaction (true, the default) or throw NoActiveTransactionException (false).

setAllowImplicitTransactions

public void setAllowImplicitTransactions(boolean allowImplicitTransactions)

Controls whether queries outside an active transaction automatically start a fresh transaction. When set to false, calling query methods without an active transaction throws NoActiveTransactionException. Defaults to true.

toString

@NotNull
public @NotNull String toString()

Returns a string containing useful debug information about the state of this object.

Overrides:

toString in class Object