JDBC Data Source: Configuration: Connection Pool
Configuration Options Advanced Configuration Options Related Tasks Related Topics
The connection pool within a JDBC data source contains a group of JDBC connections that applications reserve, use, and then return to the pool. The connection pool and the connections within it are created when the connection pool is registered, usually when starting up WebLogic Server or when deploying the data source to a new target.
Use this page to define the configuration for this data source's connection pool.
Configuration Options
Name Description URL The URL of the database to connect to. The format of the URL varies by JDBC driver.
The URL is passed to the JDBC driver to create the physical database connections.
MBean Attribute (Does not apply to application modules) :
JDBCDriverParamsBean.Url
Changes take effect after you redeploy the module or restart the server.
Driver Class Name The full package name of JDBC driver class used to create the physical database connections in the connection pool. (Note that this driver class must be in the classpath of any server to which it is deployed.)
MBean Attribute (Does not apply to application modules) :
JDBCDriverParamsBean.DriverName
Changes take effect after you redeploy the module or restart the server.
Properties The list of properties passed to the JDBC driver that are used to create physical database connections. For example: server=dbserver1. List each property=value pair on a separate line.
To enable driver-level features, add the driver property and its value to the Properties list. WebLogic Server sets driver-level properties in the Properties list on the driver's ConnectionPoolDataSource object.
- Note:
- For security reasons, when WebLogic Server is running in Production mode, you cannot specify database passwords in this properties list. Data source deployment will fail if a password is specified in the properties list. To override this security check, use the command line argument "weblogic.management.allowClearTextPasswords" when starting the server.
MBean Attribute (Does not apply to application modules) :
JDBCDriverParamsBean.Properties
Changes take effect after you redeploy the module or restart the server.
System Properties The list of System Properties names passed to the JDBC driver that are used to create physical database connections. For example: server=dbserver1. List each property=value pair on a separate line.
MBean Attribute (Does not apply to application modules) :
JDBCPropertyBean.SysPropValue
Changes take effect after you redeploy the module or restart the server.
Password The password attribute passed to the JDBC driver when creating physical database connections.
The value is stored in an encrypted form in the descriptor file and when displayed on the Administration Console.
MBean Attribute (Does not apply to application modules) :
JDBCDriverParamsBean.Password
Changes take effect after you redeploy the module or restart the server.
Initial Capacity The number of physical connections to create when creating the connection pool in the data source. If unable to create this number of connections, creation of the data source will fail.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.InitialCapacity
Minimum value:
0
Maximum value:
2147483647
Maximum Capacity The maximum number of physical connections that this connection pool can contain.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.MaxCapacity
Minimum value:
1
Maximum value:
2147483647
Minimum Capacity The minimum number of physical connections that this connection pool can contain after it is initialized.
Default: InitialCapacity
Used only for connection pool shrinking calculations.
For compatibility,
InitialCapacity
is used ifMinCapacity
is not configured.Once a data source has gone through a suspend/resume, the larger value of either
MinCapacity
orInitialCapacity
is used.MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.MinCapacity
Minimum value:
0
Maximum value:
2147483647
Statement Cache Type The algorithm used for maintaining the prepared statements stored in the statement cache.
Options are:
LRU - when a new prepared or callable statement is used, the least recently used statement is replaced in the cache.
FIXED - the first fixed number of prepared and callable statements are cached.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.StatementCacheType
Changes take effect after you redeploy the module or restart the server.
Statement Cache Size The number of prepared and callable statements stored in the cache. (This may increase server performance.)
WebLogic Server can reuse statements in the cache without reloading the statements, which can increase server performance. Each connection in the connection pool has its own cache of statements.
Setting the size of the statement cache to 0 turns off statement caching.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.StatementCacheSize
Minimum value:
0
Maximum value:
1024
Advanced Configuration Options
Name Description Test Table Name The name of the database table to use when testing physical database connections. This name is required when you specify a Test Frequency and enable Test Reserved Connections.
The default SQL code used to test a connection is
"select count(*) from TestTableName"
Most database servers optimize this SQL to avoid a table scan, but it is still a good idea to set the Test Table Name to the name of a table that is known to have few rows, or even no rows.
If the Test Table Name begins with
"SQL "
, then the rest of the string following that leading token will be taken as a literal SQL statement that will be used to test connections instead of the standard query. For example: SQL BEGIN; Null; END;MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.TestTableName
Init SQL SQL statement to execute that will initialize newly created physical database connections. Start the statement with SQL followed by a space.
If the Init SQL value begins with
"SQL "
, then the rest of the string following that leading token will be taken as a literal SQL statement that will be used to initialize database connections. If the Init SQL value does not begin with "SQL ", the value will be treated as the name of a table and the following SQL statement will be used to initialize connections:
"select count(*) from InitSQL"The table
InitSQL
must exist and be accessible to the database user for the connection. Most database servers optimize this SQL to avoid a table scan, but it is still a good idea to setInitSQL
to the name of a table that is known to have few rows, or even no rows.MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.InitSql
Changes take effect after you redeploy the module or restart the server.
Test Connections On Reserve Enables WebLogic Server to test a connection before giving it to a client. (Requires that you specify a Test Table Name.)
The test adds a small delay in serving the client's request for a connection from the pool, but ensures that the client receives a viable connection.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.TestConnectionsOnReserve
Test Frequency The number of seconds a WebLogic Server instance waits between attempts when testing unused connections. (Requires that you specify a Test Table Name.) Connections that fail the test are closed and reopened to re-establish a valid physical connection. If the test fails again, the connection is closed.
In the context of multi data sources, this attribute controls the frequency at which WebLogic Server checks the health of data sources it had previously marked as unhealthy.
When set to
0
, the feature is disabled.MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.TestFrequencySeconds
Minimum value:
0
Maximum value:
2147483647
Seconds to Trust an Idle Pool Connection The number of seconds within a connection use that WebLogic Server trusts that the connection is still viable and will skip the connection test, either before delivering it to an application or during the periodic connection testing process.
This option is an optimization that minimizes the performance impact of connection testing, especially during heavy traffic.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.SecondsToTrustAnIdlePoolConnection
Minimum value:
0
Maximum value:
2147483647
Shrink Frequency The number of seconds to wait before shrinking a connection pool that has incrementally increased to meet demand.
When set to
0
, shrinking is disabled.MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.ShrinkFrequencySeconds
Minimum value:
0
Maximum value:
2147483647
Connection Creation Retry Frequency The number of seconds between attempts to establish connections to the database.
If you do not set this value, data source creation fails if the database is unavailable. If set and if the database is unavailable when the data source is created, WebLogic Server will attempt to create connections in the pool again after the number of seconds you specify, and will continue to attempt to create the connections until it succeeds.
When set to
0
, connection retry is disabled.MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.ConnectionCreationRetryFrequencySeconds
Minimum value:
0
Maximum value:
2147483647
Login Delay The number of seconds to delay before creating each physical database connection. This delay supports database servers that cannot handle multiple connection requests in rapid succession.
The delay takes place both during initial data source creation and during the lifetime of the data source whenever a physical database connection is created.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.LoginDelaySeconds
Minimum value:
0
Maximum value:
2147483647
Changes take effect after you redeploy the module or restart the server.
Profile Connection Usage Collect profile information about threads currently using connections from the pool of connections in the data source.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.ProfileType
Profile Connection Reservation Wait Collect profile information about threads currently waiting to reserve a connection from the data source.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.ProfileType
Profile Connection Leak Collect profile information about threads that have reserved a connection from the data source and the connection leaked (was not properly returned to the pool of connections).
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.ProfileType
Profile Connection Reservation Failed Collect profile information about threads that attempt to reserve a connection from the data source but fail.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.ProfileType
Profile Statement Cache Entry Collect profile information for prepared and callable statements added to the statement cache, and for the threads that originated the cached statements.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.ProfileType
Profile Statement Usage Collect profile information about threads currently executing SQL statements from the statement cache.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.ProfileType
Profile Connection Last Usage Collect profile information about the previous thread that last used the connection.
This information is useful when debugging problems with connections infected with pending transactions that cause subsequent XA operations on the connections to fail.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.ProfileType
Profile Connection Multithreaded Usage Collect profile information about threads that erroneously use a connection previously obtained by a different thread.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.ProfileType
Profile Harvest Frequency Seconds The number of seconds between when WebLogic Server harvests profile data.
When set to
0
, harvesting of data is disabled.MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.ProfileHarvestFrequencySeconds
Minimum value:
0
Maximum value:
2147483647
Driver Interceptor Specifies the absolute name of the application class used to intercept method calls to the JDBC driver. The application specified must implement the weblogic.jdbc.extensions.DriverInterceptor interface.
Weblogic Server will invoke the preInvokeCallback(), postInvokeExceptionCallback(), and postInvokeCallback() methods of the registered application before and after invoking any method inside the JDBC driver. You can use this feature to profile JDBC driver usage and monitor:
Methods being executed
Any exceptions thrown
Time spent inside the driver executing methods
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.DriverInterceptor
Changes take effect after you redeploy the module or restart the server.
Set Client ID On Connection Enables credential mapping for the data source. When an application requests a database connection, WebLogic Server sets a light-weight client ID on the database connection based on a map of database IDs.
You must also specify the map of WebLogic Server user IDs to database user IDs (credential mapping).
This feature relies on features in the JDBC driver and DBMS. It is not supported with all drivers and DBMSs.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.CredentialMappingEnabled
Changes take effect after you redeploy the module or restart the server.
Inactive Connection Timeout The number of inactive seconds on a reserved connection before WebLogic Server reclaims the connection and releases it back into the connection pool.
You can use the Inactive Connection Timeout feature to reclaim leaked connections - connections that were not explicitly closed by the application. Note that this feature is not intended to be used in place of properly closing connections.
When set to
0
, the feature is disabled.MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.InactiveConnectionTimeoutSeconds
Minimum value:
0
Maximum value:
2147483647
Maximum Waiting for Connection The maximum number of connection requests that can concurrently block threads while waiting to reserve a connection from the data source's connection pool.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.HighestNumWaiters
Minimum value:
0
Maximum value:
2147483647
Connection Reserve Timeout The number of seconds after which a call to reserve a connection from the connection pool will timeout.
When set to
0
, a call will never timeout.When set to
-1
, a call will timeout immediately.MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.ConnectionReserveTimeoutSeconds
Minimum value:
-1
Maximum value:
2147483647
Statement Timeout The time after which a statement currently being executed will time out.
StatementTimeout relies on underlying JDBC driver support. WebLogic Server passes the time specified to the JDBC driver using the
java.sql.Statement.setQueryTimeout()
method. If your JDBC driver does not support this method, it may throw an exception and the timeout value is ignored.A value of
-1
disables this feature.A value of
0
means that statements will not time out.MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.StatementTimeout
Minimum value:
-1
Maximum value:
2147483647
Changes take effect after you redeploy the module or restart the server.
Ignore In-Use Connections Enables the data source to be shutdown even if connections obtained from the pool are still in use.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.IgnoreInUseConnectionsEnabled
Changes take effect after you redeploy the module or restart the server.
Pinned-To-Thread PinnedToThread is an option that can improve performance by enabling execute threads to keep a pooled database connection even after the application closes the logical connection.
When PinnedToThread is enabled, WebLogic Server pins a database connection from the connection pool to an execution thread the first time an application uses the thread to reserve a connection. When the application finishes using the connection and calls connection.close(), which otherwise returns the connection to the connection pool, WebLogic Server keeps the connection with the execute thread and does not return it to the connection pool. When an application subsequently requests a connection using the same execute thread, WebLogic Server provides the connection already reserved by the thread.
With PinnedToThread, there is no locking contention on the connection pool that occurs when multiple threads attempt to reserve a connection at the same time and there is no contention for threads that attempt to reserve the same connection from a limited number of database connections.
If an application concurrently reserves more than one connection from the connection pool using the same execute thread, WebLogic Server creates additional database connections and pins them to the thread, as well.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.PinnedToThread
Changes take effect after you redeploy the module or restart the server.
Remove Infected Connections Enabled Specifies whether a connection will be removed from the connection pool after the application uses the underlying vendor connection object.
If you disable removing infected connections, you must make sure that the database connection is suitable for reuse by other applications.
When set to
true
(the default), the physical connection is not returned to the connection pool after the application closes the logical connection. Instead, the physical connection is closed and recreated.When set to
false
, when the application closes the logical connection, the physical connection is returned to the connection pool and can be reused by the application or by another application.MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.RemoveInfectedConnections
Changes take effect after you redeploy the module or restart the server.
Wrap Data Types By default, data type objects for Array, Blob, Clob, NClob, Ref, SQLXML, and Struct, plus ParameterMetaData and ResultSetMetaData objects are wrapped with a WebLogic wrapper. This allows for features like debugging and connection usage to be done by the server.
The wrapping can be turned off by setting this value to false. This improves performance, in some cases significantly, and allows for the application to use the native driver objects directly.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.WrapTypes
Changes take effect after you redeploy the module or restart the server.
Fatal Error Codes Specifies a comma-separated list of error codes that are treated as fatal errors. These errors include deployment errors that cause a server to fail to boot and connection errors that prevent a connection from being put back in the connection pool.
This optional attribute is used to define fatal error codes, that when specified as the exception code within a
SQLException
(retrieved bysqlException.getErrorCode()
), indicate that a fatal error has occurred and the database is no longer reachable. For Oracle databases the following fatal error codes are predefined within WLS and do not need to be placed in the configuration file:
3113: "end-of-file on communication channel"
3114: "not connected to ORACLE"
1033: "ORACLE initialization or shutdown in progress"
1034: "ORACLE not available"
1089: "immediate shutdown in progress - no operations are permitted"
1090: "shutdown in progress - connection is not permitted"
17002: "I/O exception"
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.FatalErrorCodes
Changes take effect after you redeploy the module or restart the server.
Connection Labeling Callback Specifies the class that is called to clean up a connection when it is harvested. The class must implement
oracle.ucp.ConnectionHarvestingCallback
.MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.ConnectionLabelingCallback
Changes take effect after you redeploy the module or restart the server.
Connection Harvest Max Count The maximum number of connections that may be harvested when the connection harvesting occurs. The range of valid values is 1 to MaxCapacity.
MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.ConnectionHarvestMaxCount
Minimum value:
1
Connection Harvest Trigger Count Specifies the number of available connections (trigger value) used to determine when connection harvesting occurs.
Harvesting occurs when the number of available connections is below the trigger value for a connection pool.
The range of valid values is -1 to
MaxCapacity
.Default value is
-1
.Setting the value to
-1
disables connection harvesting.MBean Attribute (Does not apply to application modules) :
JDBCConnectionPoolParamsBean.ConnectionHarvestTriggerCount
Minimum value:
-1