Skip to content

io.helidon.data.sql.datasource.hikari.HikariDataSourceConfig

Description

Hikari connection pool specific configuration for javax.sql.DataSource

Configuration options

KeyTypeDescription
register-mbeansBooleanConfigures whether HikariCP self-registers the com.zaxxer.hikari.HikariConfigMXBean and com.zaxxer.hikari.HikariPoolMXBean in JMX
schemaStringSet the default schema name to be set on connections
auto-commitBooleanSet the default auto-commit behavior of connections in the pool
pool-nameStringSet the name of the connection pool
catalogStringSet the default catalog name to be set on connections
minimum-idleIntegerThe property controls the minimum number of idle connections that HikariCP tries to maintain in the pool, including both idle and in-use connections
connection-test-queryStringSet the SQL query to be executed to test the validity of connections
maximum-pool-sizeIntegerThe property controls the maximum size that the pool is allowed to reach, including both idle and in-use connections
leak-detection-thresholdLongThis 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
connection-init-sqlStringSet the SQL string that will be executed on all new connections when they are created, before they are added to the pool
connection-timeoutLongSet the maximum number of milliseconds that a client will wait for a connection from the pool
allow-pool-suspensionBooleanSet whether pool suspension is allowed
keepalive-timeLongThis property controls the keepalive interval for a connection in the pool
max-lifetimeLongThis property controls the maximum lifetime of a connection in the pool
validation-timeoutLongSets the maximum number of milliseconds that the pool will wait for a connection to be validated as alive
health-check-propertiesMap<String, String>Add properties (name/value pair) that will be used to configure the connection pool health check
isolate-internal-queriesBooleanConfigure whether internal pool queries, principally aliveness checks, will be isolated in their own transaction via java.sql.Connection#rollback()
idle-timeoutLongThis property controls the maximum amount of time that a connection is allowed to sit idle in the pool
read-onlyBooleanConfigures the Connections to be added to the pool as read-only Connections
transaction-isolationTransactionIsolationSet the default transaction isolation level
initialization-fail-timeoutLongSet the pool initialization failure timeout
propertiesMap<String, String>Add properties (name/value pair) that will be used to configure the DataSource/Driver

Usages


See the manifest for all available types.