POOL DBCP2

Technical information

• File Location : $USER_HOME/.magicDeskCompanion/pool/DBCP2.conf
• Category : POOL
• Version : 2.12.0
• Status : STABLE
• Need Authenticator : No

Configure the plugin

Key	Description	Type	Default Value	Allowed Values
testOnCreate	The indication of whether objects will be validated after creation. If the object fails to validate, the borrow attempt that triggered the object creation will fail.	Boolean	false	true false
validationQuery	The SQL query that will be used to validate connections from this pool before returning them to the caller. If specified, this query MUST be an SQL SELECT statement that returns at least one row. If not specified, connections will be validation by calling the isValid() method.	Text
timeBetweenEvictionRunsMILLIS	The number of milliseconds to sleep between runs of the idle object evictor thread. When non-positive, no idle object evictor thread will be run.	Text	-1	Any value > 1
rollbackOnReturn	True means a connection will be rolled back when returned to the pool if auto commit is not enabled and the connection is not read-only.	Boolean	true	true false
logExpiredConnections	Flag to log a message indicating that a connection is being closed by the pool due to maxConnLifetimeMillis exceeded. Set this property to false to suppress expired connection logging that is turned on by default.	Boolean	true	true false
poolPreparedStatements	Enable prepared statement pooling for this pool	Boolean	false	true false
maxConnLifetimeMILLIS	The maximum lifetime in milliseconds of a connection. After this time is exceeded the connection will fail the next activation, passivation or validation test. A value of zero or less means the connection has an infinite lifetime.	Number	-1	Any value > 0
testWhileIdle	The indication of whether objects will be validated by the idle object evictor (if any). If an object fails to validate, it will be dropped from the pool.	Boolean	false	true false
maxIdle	The maximum number of connections that can remain idle in the pool, without extra ones being released, or negative for no limit.	Number	8	Any value > -1
maxWaitMILLIS	The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or -1 to wait indefinitely.	Number	PT-0.001S	Any value > -1
maxOpenPreparedStatements	The maximum number of open statements that can be allocated from the statement pool at the same time, or negative for no limit.	Number	-1	Any value > 1
enableAutoCommitOnReturn	If true, connections being returned to the pool will be checked and configured with Connection.setAutoCommit(true) if the auto commit setting is false when the connection is returned.		true	true false
jmxName	Registers the DataSource as JMX MBean under specified name. The name has to conform to the JMX Object Name Syntax (see javadoc).	Array	org.magic.api:type=Pool,name=DBCP2
defaultAutoCommit	The default auto-commit state of connections created by this pool. If not set then the setAutoCommit method will not be called.	Boolean	true	true false
minIdle	The minimum number of connections that can remain idle in the pool, without extra ones being created, or zero to create none.	Number	0	Any value > -1
defaultReadOnly	The default read-only state of connections created by this pool. If not set then the setReadOnly method will not be called. (Some drivers don't support read only mode, ex: Informix)	Boolean	false	true false
minEvictableIdleTimeMILLIS	The minimum amount of time in milisecond an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any).	Text	1800000	Any value > 1000
initialSize	The initial number of connections that are created when the pool is started.	Number	3	Any value > 1
softMinEvictableIdleTimeMILLIS	The minimum amount of time a connection may sit idle in the pool before it is eligible for eviction by the idle connection evictor, with the extra condition that at least "minIdle" connections remain in the pool. When minEvictableIdleTimeMillis is set to a positive value, minEvictableIdleTimeMillis is examined first by the idle connection evictor - i.e. when idle connections are visited by the evictor, idle time is first compared against minEvictableIdleTimeMillis (without considering the number of idle connections in the pool) and then against softMinEvictableIdleTimeMillis, including the minIdle constraint.	Text	-1	Any value > -1
numTestsPerEvictionRun	The number of objects to examine during each run of the idle object evictor thread (if any).	Number	3	Any value > 1
testOnBorrow	The indication of whether objects will be validated before being borrowed from the pool. If the object fails to validate, it will be dropped from the pool, and we will attempt to borrow another.	Boolean	true	true false
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.	Boolean	true	true false
accessToUnderlyingConnectionAllowed	Controls if the PoolGuard allows access to the underlying connection.	Boolean	false	true false
testOnReturn	The indication of whether objects will be validated before being returned to the pool.	Boolean	false	true false
maxTotal	The maximum number of active connections that can be allocated from this pool at the same time, or negative for no limit.	Number	8	Any value > -1
cacheState	If true, the pooled connection will cache the current readOnly and autoCommit settings when first read or written and on all subsequent writes. This removes the need for additional database queries for any further calls to the getter. If the underlying connection is accessed directly and the readOnly and/or autoCommit settings changed the cached values will not reflect the current state. In this case, caching should be disabled by setting this attribute to false	Boolean	true	true false
fastFailValidation	When this property is true, validation fails fast for connections that have thrown "fatal" SQLExceptions. Requests to validate disconnected connections fail immediately, with no call to the driver's isValid method or attempt to execute a validation query.	Boolean	false	true false