Configuration data for communicating with a data source.

Name

Type

Details

url

String

Set the URL to use for accessing the datasource.

schema

String

Set the schema to use for accessing the datasource.

user

Credentials

Set the user to use for accessing the datasource for CRUD operations.

adminUser

Credentials

Set the user to use for accessing the datasource for DDL operations.

maxPoolSize

int

Set the maximum number of concurrent connections that should be made to this datasource.

minimumIdle

int

Set the minimum number of idle connections that HikariCP tries to maintain in the pool.

connectionTimeout

long

Set the maximum number of milliseconds that a client will wait for a connection from the pool.

idleTimeout

long

Set the maximum amount of time that a connection is allowed to sit idle in the pool.

keepaliveTime

long

Set the frequency at which HikariCP will attempt to keep a connection alive.

maxLifetime

long

Set the maximum lifetime of a connection in the pool.

validationTimeout

long

Set the maximum amount of time that a connection will be tested for aliveness.

initializationFailTimeout

long

Set the time that pool initialization will fail fast if the pool cannot be seeded.

leakDetectionThreshold

long

Set the amount of time that a connection can be out of the pool before a message is logged.

autoCommit

boolean

Set the default auto-commit behavior of connections returned from the pool.

readOnly

boolean

Set the default read-only behavior of connections returned from the pool.

isolationLevel

String

Set the default transaction isolation level for connections returned from the pool.

catalog

String

Set the default catalog for connections returned from the pool.

allowPoolSuspension

boolean

Set whether the pool can be suspended and resumed through JMX.

registerMbeans

boolean

Set whether or not JMX Management Beans are registered.

driverClassName

String

Set the fully qualified class name of the JDBC driver.

dataSourceClassName

String

Set the name of the DataSource class provided by the JDBC driver.

connectionTestQuery

String

Set the SQL query to be executed to test the validity of connections.

connectionInitSql

String

Set the SQL statement that will be executed after every new connection creation.

poolName

String

Set the user-defined name for the connection pool.