Configuration for database connections. There are some common, and a number of vendor-specific, properties.

Database User Name (username)

The user name to use to connec to the database.

Database Password (password)

The password used to connect to the database.

Publish This Configuration (canPublish)

Can this configuration be published? This flag is used to indicate whether a given configuration is complete and may be published as a DataSource into OSGi.

Name (name)

Name

id (id)

ID

type (type)

Type

Admin Username (adminUsername)

Admin Username

driver (driver)

Driver

url (url)

URL

Max Active Connections (maxPoolSize)

The maximum number of active connections in the connection pool

Min Active Connections (minPoolSize)

The minimum number of active connections in the connection pool

Max Connection Wait Time (maxWait)

The maximum time to wait, in milliseconds, to get a connection from the pool

Validation Query (validationQuery)

Optional validation query for a connection in order to determine if it is still valid

Log Abandoned Connections (logAbandoned)

Logs abandoned connections to log file Note: This property only applies to Apache connection pool

Remove Abandoned Connections (removeAbandoned)

Removes abandoned connections from pool. logAbandoned must be true for this to work Note: This property only applies to Apache connection pool

Encrypt Values (encryptValues)

Encrypts Database Password

Use Tracking Connections (useTrackingConnections)

Use tracking connections

Eviction Interval (timeBetweenEvictionRunsMillis)

Indicates how long the eviction thread should sleep before 'runs' of examining idle objects. When non-positive, no eviction thread will be launched. Note: This property only applies to Apache connection pool

Test while idle (testWhileIdle)

Indicates whether or not idle objects should be validated using the factory's PoolableObjectFactory.validateObject(T) method. Objects that fail to validate will be dropped from the pool. This setting has no effect unless timeBetweenEvictionRunsMillis > 0. Note: This property only applies to Apache connection pool

Test on return (testOnReturn)

The indication of whether objects will be validated before being returned to the pool. Note: This property only applies to Apache connection pool

number of connections to test (numTestsPerEvictionRun)

Determines the number of objects examined in each run of the idle object evictor. Note: This property only applies to Apache connection pool This setting has no effect unless timeBetweenEvictionRunsMillis > 0

Minimum idle time (minEvictableIdleTimeMillis)

Specifies the minimum amount of time that an object may sit idle in the pool before it is eligible for eviction due to idle time. When non-positive, no object will be dropped from the pool due to idle time alone. This setting has no effect unless > 0

Maximum idle connections (maxIdle)

Controls the maximum number of objects that can sit idle in the pool at any time. When negative, there is no limit to the number of objects that may be idle at one time Note: This property only applies to Apache connection pool

Test on Borrow (testOnBorrow)

The indication of whether objects will be validated before being borrowing from the pool. Note: This property only applies to Apache connection pool

Last in First out (lifo)

True means that borrowObject returns the most recently used ('last in') connection in the pool (if there are idle connections available). False means that the pool behaves as a FIFO queue - connections are taken from the idle instance pool in the order that they are returned to the pool. Note: This property only applies to Apache connection pool

Soft Minimum Evictable Idle Time (softMinEvictableIdleTimeMillis)

The minimum amount of time a connection may sit idle in the pool before it is eligible for eviction by the idle object evictor, with the extra condition that at least 'minIdle' connections remain in the pool. Note that minEvictableIdleTimeMillis takes precedence over this parameter. This property only applies to Apache connection pool

Default Catalog (defaultCatalog)

The default 'catalog' of connections created by this pool. Note: This property only applies to Apache connection pool

Validation Query Timeout (validationQueryTimeout)

Sets the validation query timeout, the amount of time, in seconds, that connection validation will wait for a response from the database when executing a validation query. Use a value less than or equal to 0 for no timeout.

Connection Initializtion SQLs (connectionInitSqls)

Semicolon separated list of SQL statements executed when a physical connection is first created.

Cache State (cacheState)

Controls if the pooled connections cache some state rather than query the database for current state to improve performance Note: This property only applies to Apache connection pool

Pool Prepared Statements (poolPreparedStatements)

Prepared statement pooling for this pool. Note: This property only applies to Apache connection pool

Maximum Open Prepared Statements (maxOpenPreparedStatements)

The maximum number of open statements that can be allocated from the statement pool at the same time, or negative for no limit. Since connection usually only uses one or two statements at a time, this is mostly used to help detect resource leaks Note: This property only applies to Apache connection pool

Maximum Connection Lifetime (maxConnLifetimeMillis)

Sets the maximum permitted lifetime of a connection in milliseconds. A value of zero or less indicates an infinite lifetime

Rollback on Return (rollbackOnReturn)

Controls if a connection will be rolled back when it is returned to the pool if auto commit is not enabled and the connection is not read only Note: This property only applies to Apache connection pool

Return Autocommit state (enableAutoCommitOnReturn)

Controls whether or not connections being returned to the pool will checked and configured with Connection.setAutoCommit(true) if the auto commit setting is false when the connection is returned Note: This property only applies to Apache connection pool

Default Query Timeout (defaultQueryTimeout)

The default query timeout that will be used for Statements created from this connection Note: This property only applies to Apache connection pool

Default Autocommit state (defaultAutoCommit)

Default auto-commit state of connections created by this pool Note: This property only applies to Apache connection pool

Encryption Type (encryptionType)

Encryption type

Default: SK

Truststore file location (trustStore)

MS-SQL truststore file location

Truststore password (trustStorePassword)

MS-SQL truststore password

Return if the IAM flag is Enabled (iamRDSAWSEnabled)

Controls whether or not IAM based token is required to authenticate and connect to database server. if the IAMEnabled flag is false then traditional password is used to authenticate and connect to database server. Note: If this flag is enabled, Hikari connection pool is used by default irrespective of the Hikari connection poolEnabled value.

Default: false

Return IAM RDS Token Lifetime in minutes (iamRDSAWSTokenLifeTimeInMins)

IAM RDS Token Lifetime in minutes.

Default: 15

Return IAM RDS AWS region (iamRDSAWSRegion)

IAM RDS AWS region.

Cache Prepared Stmts enabled (cachePrepStmts)

Controls whether to cache prepared statements. If this property is false, prepStmtCacheSize and prepStmtCacheSqlLimit properties will not take into effect. Note: This property only applies to Hikari connection pool

Default: true

Prepared Stmts cache size (prepStmtCacheSize)

This sets the number of prepared statements that the MySQL driver will cache per connection. The default is a conservative 25. Recommended setting is between 250-500. Note: This property only applies to Hikari connection pool

Default: 300

Prepared Stmts cache sql limit (prepStmtCacheSqlLimit)

This is the maximum length of a prepared SQL statement that the driver will cache. The MySQL default is 256 bytes. Recommended setting is 2048 bytes. Note: This property only applies to Hikari connection pool

Default: 2048

leakDetectionThreshold (leakDetectionThreshold)

This property controls the amount of time in milliseconds that a connection can be out of the pool before a message is logged indicating a possible connection leak. A value of 0 means leak detection is disabled Note: This property only applies to Hikari connection pool

Default: 2000

initializationFailTimeout (initializationFailTimeout)

This property controls whether the pool will 'fail fast' if the pool cannot be seeded with an initial connection successfully. Any positive number is taken to be the number of milliseconds to attempt to acquire an initial connection; the application thread will be blocked during this period. If a connection cannot be acquired before this timeout occurs, an exception will be thrown. If the value is zero (0), HikariCP will attempt to obtain and validate a connection. If a connection is obtained, but fails validation, an exception will be thrown and the pool not started. However, if a connection cannot be obtained, the pool will start, but later efforts to obtain a connection may fail. A value less than zero will bypass any initial connection attempt, and the pool will start immediately while trying to obtain connections in the background. Consequently, later efforts to obtain a connection may fail. Note: This property only applies to Hikari connection pool

Default: 1000

Return if the IAM flag is Enabled (iamRDSEnabled)

Controls whether or not IAM based token is required to authenticate and connect to database server. if the IAMEnabled flag is false then traditional password is used to authenticate and connect to database server. Note: If this flag is enabled, Hikari connection pool is used by default irrespective of the Hikari connection poolEnabled value.

Default: false

Return IAM RDS Token Lifetime in minutes (iamRDSTokenLifeTimeInMins)

IAM RDS Token Lifetime in minutes.

Default: 15

Return IAM RDS AWS Token Provider (iamRDSAWSProvider)

Controls which provider should be used to generate the token. If value is set to DEFAULT it will use DefaultAWSCredentialsProviderChain If value is set to STS_ASSUME_ROLE it will use STSAssumeRoleSessionCredentialsProvider

Default: DEFAULT

Return IAM RDS AWS ARN (iamRDSAWSARN)

IAM RDS AWS ARN.