Description

Hikari connection pool specific configuration for javax.sql.DataSource.

Usages

Configuration options

KeyKindTypeDescription
allow-pool-suspensionVALUEBooleanSet whether pool suspension is allowed
auto-commitVALUEBooleanSet the default auto-commit behavior of connections in the pool
catalogVALUEStringSet the default catalog name to be set on connections
connection-init-sqlVALUEStringSet the SQL string that will be executed on all new connections when they are created, before they are added to the pool
connection-test-queryVALUEStringSet the SQL query to be executed to test the validity of connections
connection-timeoutVALUELongSet the maximum number of milliseconds that a client will wait for a connection from the pool
health-check-propertiesMAPStringAdd properties (name/value pair) that will be used to configure the connection pool health check
idle-timeoutVALUELongThis property controls the maximum amount of time that a connection is allowed to sit idle in the pool
initialization-fail-timeoutVALUELongSet the pool initialization failure timeout
isolate-internal-queriesVALUEBooleanConfigure whether internal pool queries, principally aliveness checks, will be isolated in their own transaction via java.sql.Connection#rollback()
keepalive-timeVALUELongThis property controls the keepalive interval for a connection in the pool
leak-detection-thresholdVALUELongThis property controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak
max-lifetimeVALUELongThis property controls the maximum lifetime of a connection in the pool
maximum-pool-sizeVALUEIntegerThe property controls the maximum size that the pool is allowed to reach, including both idle and in-use connections
minimum-idleVALUEIntegerThe property controls the minimum number of idle connections that HikariCP tries to maintain in the pool, including both idle and in-use connections
pool-nameVALUEStringSet the name of the connection pool
propertiesMAPStringAdd properties (name/value pair) that will be used to configure the DataSource/Driver
read-onlyVALUEBooleanConfigures the Connections to be added to the pool as read-only Connections
register-mbeansVALUEBooleanConfigures whether HikariCP self-registers the com.zaxxer.hikari.HikariConfigMXBean and com.zaxxer.hikari.HikariPoolMXBean in JMX
schemaVALUEStringSet the default schema name to be set on connections
transaction-isolationVALUEi.h.d.s.d.TransactionIsolationSet the default transaction isolation level
validation-timeoutVALUELongSets the maximum number of milliseconds that the pool will wait for a connection to be validated as alive

See the manifest for all available types.