Package io.quarkus.agroal.runtime

Class DataSourceJdbcRuntimeConfig

java.lang.Object

io.quarkus.agroal.runtime.DataSourceJdbcRuntimeConfig

public class DataSourceJdbcRuntimeConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Optional<Duration>	acquisitionTimeout	The timeout before cancelling the acquisition of a new connection
Map<String,String>	additionalJdbcProperties	Other unspecified properties to be passed to the JDBC driver when creating new connections.
Optional<Duration>	backgroundValidationInterval	The interval at which we validate idle connections in the background.
boolean	detectStatementLeaks	When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements.
boolean	extendedLeakReport	Collect and display extra troubleshooting info on leaked connections.
Optional<Duration>	foregroundValidationInterval	Perform foreground validation on connections that have been idle for longer than the specified interval.
Optional<Duration>	idleRemovalInterval	The interval at which we try to remove idle connections.
OptionalInt	initialSize	The initial size of the pool.
Optional<Duration>	leakDetectionInterval	The interval at which we check for connection leaks.
Optional<Duration>	maxLifetime	The max lifetime of a connection.
int	maxSize	The datasource pool maximum size
int	minSize	The datasource pool minimum size
Optional<String>	newConnectionSql	Query executed when first using a connection.
boolean	poolingEnabled	Disable pooling to prevent reuse of Connections.
Optional<io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation>	transactionIsolationLevel	The transaction isolation level.
Optional<io.agroal.api.configuration.AgroalConnectionPoolConfiguration.TransactionRequirement>	transactionRequirement	Require an active transaction when acquiring a connection.
Optional<String>	url	The datasource URL
Optional<String>	validationQuerySql	Query executed to validate a connection.

Constructor Summary

Constructors

Constructor	Description
DataSourceJdbcRuntimeConfig()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

url

@ConfigItem
public Optional<String> url

The datasource URL

initialSize

@ConfigItem
public OptionalInt initialSize

The initial size of the pool. Usually you will want to set the initial size to match at least the minimal size, but this is not enforced so to allow for architectures which prefer a lazy initialization of the connections on boot, while being able to sustain a minimal pool size after boot.

minSize

@ConfigItem
public int minSize

The datasource pool minimum size

maxSize

@ConfigItem(defaultValue="20")
public int maxSize

The datasource pool maximum size

backgroundValidationInterval

@ConfigItem(defaultValue="2M")
public Optional<Duration> backgroundValidationInterval

The interval at which we validate idle connections in the background.

Set to 0 to disable background validation.

foregroundValidationInterval

@ConfigItem
public Optional<Duration> foregroundValidationInterval

Perform foreground validation on connections that have been idle for longer than the specified interval.

acquisitionTimeout

@ConfigItem(defaultValue="5")
public Optional<Duration> acquisitionTimeout

The timeout before cancelling the acquisition of a new connection

leakDetectionInterval

@ConfigItem
public Optional<Duration> leakDetectionInterval

The interval at which we check for connection leaks.

idleRemovalInterval

@ConfigItem(defaultValue="5M")
public Optional<Duration> idleRemovalInterval

The interval at which we try to remove idle connections.

maxLifetime

@ConfigItem
public Optional<Duration> maxLifetime

The max lifetime of a connection.

transactionIsolationLevel

@ConfigItem
public Optional<io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation> transactionIsolationLevel

The transaction isolation level.

extendedLeakReport

@ConfigItem
public boolean extendedLeakReport

Collect and display extra troubleshooting info on leaked connections.

detectStatementLeaks

@ConfigItem(defaultValue="true")
public boolean detectStatementLeaks

When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening.

newConnectionSql

@ConfigItem
public Optional<String> newConnectionSql

Query executed when first using a connection.

validationQuerySql

@ConfigItem
public Optional<String> validationQuerySql

Query executed to validate a connection.

poolingEnabled

@ConfigItem(defaultValue="true")
public boolean poolingEnabled

Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections.

transactionRequirement

@ConfigItem
public Optional<io.agroal.api.configuration.AgroalConnectionPoolConfiguration.TransactionRequirement> transactionRequirement

Require an active transaction when acquiring a connection. Recommended for production. WARNING: Some extensions acquire connections without holding a transaction for things like schema updates and schema validation. Setting this setting to STRICT may lead to failures in those cases.

additionalJdbcProperties

@ConfigItem
public Map<String,String> additionalJdbcProperties

Other unspecified properties to be passed to the JDBC driver when creating new connections.

Constructor Detail

DataSourceJdbcRuntimeConfig

public DataSourceJdbcRuntimeConfig()