Package org.hibernate.cfg
Interface AgroalSettings
- All Known Subinterfaces:
AvailableSettings,JdbcSettings
- All Known Implementing Classes:
Environment
public interfaceAgroalSettings
Field Summary
Fields Modifier and Type Field Description staticStringAGROAL_ACQUISITION_TIMEOUTThe maximum amount of time a thread can wait for a connection, after which an exception is thrown instead.staticStringAGROAL_CONFIG_PREFIXA setting prefix used to indicate settings that target thehibernate-agroalintegration.staticStringAGROAL_FLUSH_ON_CLOSEIftrue, connections will be flushed whenever they return to the pool.staticStringAGROAL_IDLE_TIMEOUTThe maximum amount of time a connection can remain idle, after which it is evicted.staticStringAGROAL_IDLE_VALIDATION_TIMEOUTA foreground validation is executed if a connection has been idle in the pool for longer than this value.staticStringAGROAL_INITIAL_SIZEInitial size of the connection pool.staticStringAGROAL_INITIAL_SQLAn SQL command to be executed when a connection is created.staticStringAGROAL_LEAK_TIMEOUTThe maximum amount of time a connection can remain out of the pool, after which it is reported as a leak.staticStringAGROAL_MAX_LIFETIMEThe maximum amount of time a connection can live, after which it is evicted.staticStringAGROAL_MAX_SIZEThe maximum size of the connection pool.staticStringAGROAL_MIN_SIZEThe ninimum size of the connection pool.staticStringAGROAL_VALIDATE_ON_BORROWIftrue, connections will receive foreground validation on every acquisition regardless ofAGROAL_IDLE_VALIDATION_TIMEOUT.staticStringAGROAL_VALIDATION_TIMEOUTBackground validation is executed at intervals of this value.
Field Detail
AGROAL_CONFIG_PREFIX
static final String AGROAL_CONFIG_PREFIX
A setting prefix used to indicate settings that target thehibernate-agroalintegration.- See Also:
- Constant Field Values
AGROAL_MAX_SIZE
static final String AGROAL_MAX_SIZE
The maximum size of the connection pool.There is no default, this setting is mandatory.
- See Also:
- Constant Field Values
AGROAL_MIN_SIZE
static final String AGROAL_MIN_SIZE
The ninimum size of the connection pool.The default is zero.
- See Also:
- Constant Field Values
AGROAL_INITIAL_SIZE
static final String AGROAL_INITIAL_SIZE
Initial size of the connection pool.The default is zero.
- See Also:
- Constant Field Values
AGROAL_MAX_LIFETIME
static final String AGROAL_MAX_LIFETIME
The maximum amount of time a connection can live, after which it is evicted.The default is zero, resulting in no restriction on connection lifetime.
Parsed as a
Duration.
AGROAL_LEAK_TIMEOUT
static final String AGROAL_LEAK_TIMEOUT
The maximum amount of time a connection can remain out of the pool, after which it is reported as a leak.The default is zero, resulting in no checks for connection leaks.
Parsed as a
Duration.
AGROAL_IDLE_TIMEOUT
static final String AGROAL_IDLE_TIMEOUT
The maximum amount of time a connection can remain idle, after which it is evicted.The default is zero, resulting in connections never being considered idle.
Parsed as a
Duration.
AGROAL_ACQUISITION_TIMEOUT
static final String AGROAL_ACQUISITION_TIMEOUT
The maximum amount of time a thread can wait for a connection, after which an exception is thrown instead.The default is zero, resulting in threads waiting indefinitely.
Parsed as a
Duration.
AGROAL_VALIDATION_TIMEOUT
static final String AGROAL_VALIDATION_TIMEOUT
Background validation is executed at intervals of this value.The default is zero, resulting in background validation not being performed.
Parsed as a
Duration.
AGROAL_IDLE_VALIDATION_TIMEOUT
static final String AGROAL_IDLE_VALIDATION_TIMEOUT
A foreground validation is executed if a connection has been idle in the pool for longer than this value.The default is zero, resulting in foreground validation not being performed.
Parsed as a
Duration.
AGROAL_INITIAL_SQL
static final String AGROAL_INITIAL_SQL
An SQL command to be executed when a connection is created.- See Also:
- Constant Field Values
AGROAL_FLUSH_ON_CLOSE
static final String AGROAL_FLUSH_ON_CLOSE
Iftrue, connections will be flushed whenever they return to the pool.The default is
false.- Since:
- agroal-api 1.6
- See Also:
- Constant Field Values
AGROAL_VALIDATE_ON_BORROW
static final String AGROAL_VALIDATE_ON_BORROW
Iftrue, connections will receive foreground validation on every acquisition regardless ofAGROAL_IDLE_VALIDATION_TIMEOUT.The default is
false.- Since:
- agroal-api 2.3
- See Also:
- Constant Field Values