true value to have any effect,
the <code>validationQuery parameter must be set to a non-null
string.
</td>
</tr>
<tr>
<td>testOnReturn
<td>false
<td>
The indication of whether objects will be validated before being
returned to the pool. <br/> NOTE - for a
<code>true value to have any effect, the
<code>validationQuery parameter must be set to a non-null string.
</td>
</tr>
<tr>
<td>testWhileIdle
<td>false
<td>
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. <br/> NOTE - for a true
value to have any effect, the <code>validationQuery parameter
must be set to a non-null string.
</td>
</tr>
<tr>
<td>timeBetweenEvictionRunsMillis
<td>-1
<td>
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.
</td>
</tr>
<tr>
<td>numTestsPerEvictionRun
<td>3
<td>
The number of objects to examine during each run of the idle object
evictor thread (if any).
</td>
</tr>
<tr>
<td>minEvictableIdleTimeMillis
<td>1000 * 60 * 30
<td>
The minimum amount of time an object may sit idle in the pool before it
is eligable for eviction by the idle object evictor (if any).
</td>
</tr>
<tr>
<td>connectionInitSqls
<td>null
<td>
A Collection of SQL statements that will be used to initialize physical
connections when they are first created. These statements are executed
only once - when the configured connection factory creates the connection.
</td>
</tr>
</table>
<table>
<hr>
<td>poolPreparedStatements
<td>false
<td>Enable prepared statement pooling for this pool.
</tr>
<tr>
<td>maxOpenPreparedStatements
<td>unlimited
<td>
The maximum number of open statements that can be allocated from
the statement pool at the same time, or zero for no limit.
</td>
</tr>
</table>
<p>
<img src="images/icon_info_sml.gif"/>
This component has also the ability to pool PreparedStatements.
When enabled a statement pool will be created for each Connection
and PreparedStatements created by one of the following methods will be pooled:
<ul>
<li>public PreparedStatement prepareStatement(String sql)
<li>public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
</ul>
</p>
<p>
<img src="images/icon_warning_sml.gif"/>
<strong>NOTE - Make sure your connection has some resources left for the other statements.
Pooling PreparedStatements may keep their cursors open in the database, causing a connection to run out of cursors,
especially if maxOpenPreparedStatements is left at the default (unlimited) and an application opens a large number
of different PreparedStatements per connection. To avoid this problem, maxOpenPreparedStatements should be set to a
value less than the maximum number of cursors that can be open on a Connection.
</p>
<table>
<hr>
<td>accessToUnderlyingConnectionAllowed
<td>false
<td>Controls if the PoolGuard allows access to the underlying connection.
</tr>
</table>
<p>When allowed you can access the underlying connection using the following construct:
<source>
Connection conn = ds.getConnection();
Connection dconn = ((DelegatingConnection) conn).getInnermostDelegate();
...
conn.close()
</source>
<p>
<img src="images/icon_info_sml.gif"/>
Default is false, it is a potential dangerous operation and misbehaving programs can do harmfull things. (closing the underlying or continue using it when the guarded connection is already closed)
Be carefull and only use when you need direct access to driver specific extentions.
</p>
<p>
<img src="images/icon_warning_sml.gif"/>
<b>NOTE: Do not close the underlying connection, only the original one.
</p>
<table>
<hr>
<tr>
<td>removeAbandoned
<td>false
<td>
Flag to remove abandoned connections if they exceed the
removeAbandonedTimout.<br/>
If set to true a connection is considered abandoned and eligible
for removal if it has been idle longer than the removeAbandonedTimeout.
Setting this to true can recover db connections from poorly written
applications which fail to close a connection.
</td>
</tr>
<tr>
<td>removeAbandonedTimeout
<td>300
<td>Timeout in seconds before an abandoned connection can be removed.
</tr>
<tr>
<td>logAbandoned
<td>false
<td>
Flag to log stack traces for application code which abandoned
a Statement or Connection.<br/>
Logging of abandoned Statements and Connections adds overhead
for every Connection open or new Statement because a stack
trace has to be generated.
</td>
</tr>
</table>
<p>
<img src="images/icon_info_sml.gif"/>
If you have enabled "removeAbandoned" then it is possible that a connection is reclaimed by the pool because it is considered to be abandoned.
This mechanism is triggered when (getNumIdle() < 2) and (getNumActive() > getMaxActive() - 3)
</p>
<p>
<img src="images/icon_info_sml.gif"/>
For example maxActive=20 and 18 active connections and 1 idle connection would trigger the "removeAbandoned".
But only the active connections that aren't used for more then "removeAbandonedTimeout" seconds are removed,
default (300 sec). Traversing a resultset doesn't count as being used.
</p>
</section>
</body>
</document>
Other Commons DBCP examples (source code examples)
Here is a short list of links related to this Commons DBCP configuration.xml source code file:
The search page
Other Commons DBCP source code examples at this package level
Click here to learn more about this project
Commons DBCP example source code file (configuration.xml)
The Commons DBCP configuration.xml source code<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<properties>
<title>Configuration
<author email="dev@commons.apache.org">Commons Documentation Team
</properties>
<body>
<!--
<section name="Introduction">
<p>TODO: add section about tomcat configuration and avoiding the resource leak when reloading tomcat webapps.
</section>
-->
<!--
<section name="Dynamic Properties">
maxActive
maxIdle
minIdle
maxWait
testOnBorrow
testOnReturn
timeBetweenEvictionRunsMillis
numTestsPerEvictionRun
minEvictableIdleTimeMillis
testWhileIdle
</section>
-->
<section name="Parameters">
<table>
<hr> | Parameter | Description | Parameter | Default | Description | Parameter | Default | Description | Parameter | Default | Description | Parameter | Default | Description | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Parameter | Default | Description | |||||||||||||
| Parameter | Default | Description |
