|
|
Commons DBCP example source code file (configuration.xml)
This example Commons DBCP source code file (configuration.xml) is included in the DevDaily.com
"Java Source Code
Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.
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 |
<tr>
<td>username |
<td>The connection username to be passed to our JDBC driver to establish a connection.
</tr>
<tr>
<td>password
<td>The connection password to be passed to our JDBC driver to establish a connection.
</tr>
<tr>
<td>url
<td>The connection URL to be passed to our JDBC driver to establish a connection.
</tr>
<tr>
<td>driverClassName
<td>The fully qualified Java class name of the JDBC driver to be used.
</tr>
<tr>
<td>connectionProperties
<td>The connection properties that will be sent to our JDBC driver when establishing new connections.
<br/>Format of the string must be [propertyName=property;]*
<br/>NOTE - The "user" and "password" properties will be passed explicitly,
so they do not need to be included here.
</td>
</tr>
</table>
<table>
<hr>Parameter | Default | Description |
<tr>
<td>defaultAutoCommit
<td>true
<td>The default auto-commit state of connections created by this pool.
</tr>
<tr>
<td>defaultReadOnly
<td>driver default
<td>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)
</td>
</tr>
<tr>
<td>defaultTransactionIsolation
<td>driver default
<td>The default TransactionIsolation state of connections created by this pool.
One of the following: (see
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/sql/Connection.html#field_summary">javadoc)
<ul>
<li>NONE
<li>READ_COMMITTED
<li>READ_UNCOMMITTED
<li>REPEATABLE_READ
<li>SERIALIZABLE
</ul>
</td>
</tr>
<tr>
<td>defaultCatalog
<td>
<td>The default catalog of connections created by this pool.
</tr>
</table>
<table>
<hr>Parameter | Default | Description |
<tr>
<td>initialSize
<td>0
<td>
The initial number of connections that are created when the pool
is started.
<br/>Since: 1.2
</td>
</tr>
<tr>
<td>maxActive
<td>8
<td>
The maximum number of active connections that can be allocated from
this pool at the same time, or negative for no limit.
</td>
</tr>
<tr>
<td>maxIdle
<td>8
<td>
The maximum number of connections that can remain idle in the
pool, without extra ones being released, or negative for no limit.
</td>
</tr>
<tr>
<td>minIdle
<td>0
<td>
The minimum number of connections that can remain idle in the
pool, without extra ones being created, or zero to create none.
</td>
</tr>
<tr>
<td>maxWait
<td>indefinitely
<td>
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.
</td>
</tr>
</table>
<p>
<img src="images/icon_warning_sml.gif"/>
<strong>NOTE: If maxIdle is set too low on heavily loaded systems it is
possible you will see connections being closed and almost immediately new
connections being opened. This is a result of the active threads momentarily
closing connections faster than they are opening them, causing the number of
idle connections to rise above maxIdle. The best value for maxIdle for heavily
loaded system will vary but the default is a good starting point.
</p>
<table>
<hr>Parameter | Default | Description |
<tr>
<td>validationQuery
<td>
<td>
The SQL query that will be used to validate connections from this pool
before returning them to the caller. If specified, this query
<strong>MUST be an SQL SELECT statement that returns at least
one row.
</td>
</tr>
<tr>
<td>testOnBorrow
<td>true
<td>
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.<br/>
<strong>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>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>Parameter | Default | Description |
The search page
Other Commons DBCP source code examples at this package level
Click here to learn more about this project
