Package org.hibernate.cfg
Interface HikariCPSettings
-
- All Known Subinterfaces:
AvailableSettings
,JdbcSettings
- All Known Implementing Classes:
Environment
public interface HikariCPSettings
-
-
Field Summary
Fields Modifier and Type Field Description static String
HIKARI_ACQUISITION_TIMEOUT
The maximum amount of time a thread can wait for a connection, after which an exception is thrown instead.static String
HIKARI_CONFIG_PREFIX
A setting prefix used to indicate settings that target thehibernate-hikaricp
integration.static String
HIKARI_IDLE_TIMEOUT
The maximum amount of time a connection can remain idle, after which it is evicted.static String
HIKARI_INITIAL_SQL
An SQL command to be executed when a connection is created.static String
HIKARI_INITIALIZATION_TIMEOUT
The maximum amount of time the application thread can wait to attempt to acquire an initial connection.static String
HIKARI_ISOLATE_INTERNAL_QUERIES
Iftrue
, internal pool queries (such as keep-alives) will be isolated in their own transaction.static String
HIKARI_KEEPALIVE_TIME
How often connections will attempt to be kept alive to prevent a timeout.static String
HIKARI_LEAK_TIMEOUT
The maximum amount of time a connection can remain out of the pool, after which it is reported as a leak.static String
HIKARI_MAX_LIFETIME
The maximum amount of time a connection can live, after which it is evicted.static String
HIKARI_MAX_SIZE
The maximum size of the connection pool.static String
HIKARI_MIN_IDLE_SIZE
The minimum number of idle connections to try and maintain in the pool.static String
HIKARI_POOL_NAME
A user-defined name for the pool that appears in logging.static String
HIKARI_READ_ONLY
Iftrue
, connections obtained from the pool are in read-only mode by default.static String
HIKARI_VALIDATION_TIMEOUT
The maximum amount of time that a connection will be tested for aliveness.
-
-
-
Field Detail
-
HIKARI_CONFIG_PREFIX
static final String HIKARI_CONFIG_PREFIX
A setting prefix used to indicate settings that target thehibernate-hikaricp
integration.- See Also:
- Constant Field Values
-
HIKARI_MAX_SIZE
static final String HIKARI_MAX_SIZE
The maximum size of the connection pool.The default is 10.
- See Also:
- Constant Field Values
-
HIKARI_MIN_IDLE_SIZE
static final String HIKARI_MIN_IDLE_SIZE
The minimum number of idle connections to try and maintain in the pool.The default is the same as
HIKARI_MAX_SIZE
.- See Also:
- Constant Field Values
-
HIKARI_MAX_LIFETIME
static final String HIKARI_MAX_LIFETIME
The maximum amount of time a connection can live, after which it is evicted.The default is 1800000 milliseconds (30 minutes).
- See Also:
- Constant Field Values
-
HIKARI_LEAK_TIMEOUT
static final String HIKARI_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 0 milliseconds, resulting in no checks for connection leaks.
- See Also:
- Constant Field Values
-
HIKARI_IDLE_TIMEOUT
static final String HIKARI_IDLE_TIMEOUT
The maximum amount of time a connection can remain idle, after which it is evicted.The default is 600000 milliseconds (10 minutes).
- See Also:
- Constant Field Values
-
HIKARI_ACQUISITION_TIMEOUT
static final String HIKARI_ACQUISITION_TIMEOUT
The maximum amount of time a thread can wait for a connection, after which an exception is thrown instead.The default is 30000 milliseconds (30 seconds).
- See Also:
- Constant Field Values
-
HIKARI_VALIDATION_TIMEOUT
static final String HIKARI_VALIDATION_TIMEOUT
The maximum amount of time that a connection will be tested for aliveness. Must be lower thanHIKARI_ACQUISITION_TIMEOUT
.The default is 5000 milliseconds (5 seconds).
- See Also:
- Constant Field Values
-
HIKARI_INITIALIZATION_TIMEOUT
static final String HIKARI_INITIALIZATION_TIMEOUT
The maximum amount of time the application thread can wait to attempt to acquire an initial connection. Applied afterHIKARI_ACQUISITION_TIMEOUT
.The default is 1 millisecond.
- See Also:
- Constant Field Values
-
HIKARI_KEEPALIVE_TIME
static final String HIKARI_KEEPALIVE_TIME
How often connections will attempt to be kept alive to prevent a timeout.The default is 0 milliseconds, resulting in no keep-alive behaviour.
- See Also:
- Constant Field Values
-
HIKARI_INITIAL_SQL
static final String HIKARI_INITIAL_SQL
An SQL command to be executed when a connection is created.- See Also:
- Constant Field Values
-
HIKARI_POOL_NAME
static final String HIKARI_POOL_NAME
A user-defined name for the pool that appears in logging.The default is auto-generated.
- See Also:
- Constant Field Values
-
HIKARI_READ_ONLY
static final String HIKARI_READ_ONLY
Iftrue
, connections obtained from the pool are in read-only mode by default.Some databases do not support read-only mode while some will provide query optimizations when a connection is in read-only mode.
The default is
false
.- See Also:
- Constant Field Values
-
HIKARI_ISOLATE_INTERNAL_QUERIES
static final String HIKARI_ISOLATE_INTERNAL_QUERIES
Iftrue
, internal pool queries (such as keep-alives) will be isolated in their own transaction.Only applies if
JdbcSettings.AUTOCOMMIT
is disabled.The default is
false
.- See Also:
- Constant Field Values
-
-