Class Database.Builder

java.lang.Object

com.pyranid.Database.Builder

Enclosing class:

Database

@NotThreadSafe
public static class Database.Builder
extends Object

Builder used to construct instances of Database.

This class is intended for use by a single thread.

Since:

1.0.0

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
@NonNull Database.Builder	ambiguousTimestampBindingStrategy(@Nullable AmbiguousTimestampBindingStrategy ambiguousTimestampBindingStrategy)	Configures how Pyranid binds Instant and OffsetDateTime parameters when JDBC parameter metadata cannot identify whether the target is TIMESTAMP or TIMESTAMP WITH TIME ZONE.
@NonNull Database	build()
@NonNull Database.Builder	databaseType(@Nullable DatabaseType databaseType)	Overrides automatic database type detection.
@NonNull Database.Builder	fetchSize(@Nullable Integer fetchSize)	Configures a database-wide JDBC fetch size default.
@NonNull Database.Builder	instanceProvider(@Nullable InstanceProvider instanceProvider)
@NonNull Database.Builder	maxRows(@Nullable Integer maxRows)	Configures a database-wide JDBC maximum row count default.
@NonNull Database.Builder	metricsCollector(@Nullable MetricsCollector metricsCollector)	Configures the metrics collector for the Database being built.
@NonNull Database.Builder	parameterRedactor(@Nullable ParameterRedactor parameterRedactor)	Configures the redactor used for non-secure parameters in diagnostics.
@NonNull Database.Builder	parsedSqlCacheCapacity(@Nullable Integer parsedSqlCacheCapacity)	Configures the size of the parsed SQL cache.
@NonNull Database.Builder	preparedStatementBinder(@Nullable PreparedStatementBinder preparedStatementBinder)
@NonNull Database.Builder	queryTimeout(@Nullable Duration queryTimeout)	Configures a database-wide JDBC query timeout default.
@NonNull Database.Builder	resultSetMapper(@Nullable ResultSetMapper resultSetMapper)
@NonNull Database.Builder	statementLogger(@Nullable StatementLogger statementLogger)	Configures the statement logger for the Database being built.
@NonNull Database.Builder	timeZone(@Nullable ZoneId timeZone)	Configures the database time zone Pyranid should use when converting zone-less temporal values.

Methods inherited from class Object

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

Method Details

databaseType

public @NonNull Database.Builder databaseType(@Nullable DatabaseType databaseType)

Overrides automatic database type detection.

If null, the database type is detected lazily when database-type-specific behavior is first needed. Supplying a non-null value avoids automatic detection and its metadata lookup entirely.

Parameters:

databaseType - the database type to use (null to enable auto-detection)

Returns:

this Builder, for chaining

Since:

4.0.0

timeZone

public @NonNull Database.Builder timeZone(@Nullable ZoneId timeZone)

Configures the database time zone Pyranid should use when converting zone-less temporal values.

This value is used when mapping TIMESTAMP values to instant-based Java types, and when binding Instant or OffsetDateTime parameters to known TIMESTAMP targets. It also applies to ambiguous timestamp bindings if ambiguousTimestampBindingStrategy(AmbiguousTimestampBindingStrategy) is configured with AmbiguousTimestampBindingStrategy.TIMESTAMP_WITHOUT_TIME_ZONE.

If null, Pyranid uses ZoneId.systemDefault().

Parameters:

timeZone - database time zone to use, or null for the JVM default zone

Returns:

this Builder, for chaining

Since:

3.0.0

ambiguousTimestampBindingStrategy

public @NonNull Database.Builder ambiguousTimestampBindingStrategy(@Nullable AmbiguousTimestampBindingStrategy ambiguousTimestampBindingStrategy)

Configures how Pyranid binds Instant and OffsetDateTime parameters when JDBC parameter metadata cannot identify whether the target is TIMESTAMP or TIMESTAMP WITH TIME ZONE.

The default, AmbiguousTimestampBindingStrategy.TIMESTAMP_WITH_TIME_ZONE, is appropriate for timestamp-with-time-zone targets. Use AmbiguousTimestampBindingStrategy.TIMESTAMP_WITHOUT_TIME_ZONE for drivers or proxies that cannot provide identifying parameter metadata when your target columns are zone-less TIMESTAMP values that should be interpreted in timeZone(ZoneId).

Parameters:

ambiguousTimestampBindingStrategy - strategy to use, or null for the default

Returns:

this Builder, for chaining

Since:

4.2.0

instanceProvider

public @NonNull Database.Builder instanceProvider(@Nullable InstanceProvider instanceProvider)

preparedStatementBinder

public @NonNull Database.Builder preparedStatementBinder(@Nullable PreparedStatementBinder preparedStatementBinder)

resultSetMapper

public @NonNull Database.Builder resultSetMapper(@Nullable ResultSetMapper resultSetMapper)

statementLogger

public @NonNull Database.Builder statementLogger(@Nullable StatementLogger statementLogger)

Configures the statement logger for the Database being built.

StatementLogger failures are fail-fast: a logger exception can make a successful statement operation throw, and inside a Pyranid transaction it participates in normal rollback handling. If the database statement itself failed, logger failures are suppressed onto the primary statement failure.

Parameters:

statementLogger - statement logger to use, or null for a no-op logger

Returns:

this Builder, for chaining

parameterRedactor

public @NonNull Database.Builder parameterRedactor(@Nullable ParameterRedactor parameterRedactor)

Configures the redactor used for non-secure parameters in diagnostics.

SecureParameter values always render via SecureParameter.getMask() and are never passed to this redactor. Batch executions render a bounded batch summary instead of invoking the redactor for each batch value. Specify null or omit this setter to render non-secure, non-batch values verbatim.

Parameters:

parameterRedactor - parameter redactor to use, or null for the default

Returns:

this Builder, for chaining

Since:

4.4.0

metricsCollector

public @NonNull Database.Builder metricsCollector(@Nullable MetricsCollector metricsCollector)

Configures the metrics collector for the Database being built.

Like all Database configuration, this value is fixed at build() time. Specify null or omit this setter to disable metrics collection.

Parameters:

metricsCollector - metrics collector to use, or null to disable

Returns:

this Builder, for chaining

Since:

4.2.0

queryTimeout

public @NonNull Database.Builder queryTimeout(@Nullable Duration queryTimeout)

Configures a database-wide JDBC query timeout default.

This maps to Statement.setQueryTimeout(int). null leaves the timeout unset. Duration.ZERO disables the JDBC timeout. Positive sub-second durations are rounded up to one second because JDBC accepts whole seconds. Per-query Query.queryTimeout(Duration) settings override this value, and Query.customize(PreparedStatementCustomizer) runs last.

Parameters:

queryTimeout - timeout to apply by default, or null to leave unset

Returns:

this Builder, for chaining

Since:

4.2.0

fetchSize

public @NonNull Database.Builder fetchSize(@Nullable Integer fetchSize)

Configures a database-wide JDBC fetch size default.

This maps to Statement.setFetchSize(int). null leaves the fetch size unset. A value of 0 uses the driver's default fetch-size behavior. Per-query Query.fetchSize(Integer) settings override this value, and Query.customize(PreparedStatementCustomizer) runs last.

Parameters:

fetchSize - fetch size to apply by default, or null to leave unset

Returns:

this Builder, for chaining

Since:

4.2.0

maxRows

public @NonNull Database.Builder maxRows(@Nullable Integer maxRows)

Configures a database-wide JDBC maximum row count default.

This maps to Statement.setMaxRows(int). null leaves the maximum row count unset. A value of 0 disables the JDBC row limit. Per-query Query.maxRows(Integer) settings override this value, and Query.customize(PreparedStatementCustomizer) runs last.

Parameters:

maxRows - maximum rows to apply by default, or null to leave unset

Returns:

this Builder, for chaining

Since:

4.2.0

parsedSqlCacheCapacity

public @NonNull Database.Builder parsedSqlCacheCapacity(@Nullable Integer parsedSqlCacheCapacity)

Configures the size of the parsed SQL cache.

A value of 0 disables caching. A value of null uses the default size.

Parameters:

parsedSqlCacheCapacity - cache size (0 disables caching, null uses default)

Returns:

this Builder, for chaining

build

public @NonNull Database build()