Oracle® TopLink Developer's Guide 10g Release 3 (10.1.3.1.0) Part Number B28218-01 |
|
|
View PDF |
This chapter describes the various components that you must configure to use an internal connection pool.
Table 86-1 lists the configurable options for an internal connection pool.
When you are using server sessions, you can configure the default read connection pool and write connection pool. You can also configure the optional named connection pools and sequence connection pool you may have created (see "Internal Connection Pool Creation Overview").
Table 86-1 lists the configurable options for an internal connection pool.
Table 86-1 Configurable Options for Connection Pool
Option | Type | TopLink Workbench |
Java |
---|---|---|---|
"Configuring Connection Pool Sizes" |
Basic |
|
|
"Configuring Exclusive Read Connections"Footref 1 |
Advanced |
|
|
Advanced |
|
|
|
|
Advanced |
|
|
Advanced |
|
|
Footnote 1 Read connection pools only.
Footnote 2 Not applicable to write connection pools.
By default, if using TopLink internal connection pooling, the TopLink write connection pool maintains a minimum of five connections and a maximum of ten. The read connection pool maintains a minimum and maximum of two connections.
Connection pool size can significantly influence the concurrency of your application and should be set to be large enough to handle your expected application load.
Tip: To maintain compatibility with JDBC drivers that do not support many connections, the default number of connections is small. If your JDBC driver supports it, use a larger number of connections for reading and writing. |
The smallest value you can enter is 0. Setting the maximum number of connections to 0 will make it impossible for TopLink to allocate any connections.
The minimum number of connections should always be less than or equal to the maximum number of connections.
If the maximum number of connections is in use, the next connection request will be blocked until a connection is available.
To specify the minimum and maximum number of connections in a TopLink internal connection pool, use this procedure:
Expand a server session to reveal its connection pools in the Navigator.
Select a connection pool in the Navigator. Its properties appear in the Editor.
Click the General tab. The General tab appears.
Figure 86-1 General Tab, Connection Count Options
Enter the desired minimum and maximum number of connections and press Enter or use the increment and decrement arrows.
For all connection pools, except write connection pools, you can specify arbitrary named values, called properties.
Some data sources require additional, driver-specific properties not supported in the ConnectionPool
API. Add these properties to the ConnectionPool
so that TopLink can pass them to the driver.
To specify arbitrary named value pairs that TopLink associates with a ConnectionPool
, use this procedure:
Expand a server session to reveal its connection pools in the Navigator.
Select a read, named, or sequence connection pool in the Navigator. Its properties appear in the Editor.
Click the Login tab. The Login tab appears.
Click the Properties subtab. The Properties subtab appears.
Use the following information to add or edit a login property on the Add Property dialog box to add or edit a login property:
Option | Description |
---|---|
Name | The name by which TopLink retrieves the property value using the DatasourceLogin method getProperty . |
Value | The value TopLink retrieves using the DatasourceLogin method getProperty passing in the corresponding property name.
Using TopLink Workbench, you can set only character values which TopLink returns as |
To add (or change) a new Name/Value property, click Add (or Edit).
To delete an existing property, select the Name/Value row and click Remove.
When you use an external transaction controller (see "Configuring the Server Platform"), establishing a connection requires not only the usual connection setup overhead, but also transactional overhead. If your application reads data only to display it and only infrequently modifies data, you can configure an internal read connection pool to use its own connection specification that does not use the external transaction controller. This may improve performance by reducing the time it takes to establish a new read connection.
To enable the configuration of nontransactional connection information for a TopLink read connection pool, use this procedure:
Expand a server session to reveal its connection pools in the Navigator.
Select a read connection pool in the Navigator. Its properties appear in the Editor.
Click the Login tab. The Login tab appears.
Click the Connection subtab. The Connection subtab appears.
To enable a nontransactional read login, select the Use Non-Transactional Read Login option (see "Externally Managed Transactional Data Sources"). Continue with "Configuring Connection Pool Connection Options" to specify the connection information.
By default, connection pools use the login configuration specified for their session (see "Configuring Database Login Connection Options" and "Configuring EIS Connection Specification Options at the Session Level").
For read, named, and sequence connection pools, you can override the session login configuration on a per-connection pool basis.
To configure login configuration for a read connection pool, you must first enable it for a nontransactional read login (see "Configuring a Nontransactional Read Login").
To configure connection information for a TopLink read, named, or sequence connection pool, use this procedure:
Expand a server session to reveal its connection pools in the Navigator.
Select a read, named, or sequence connection pool in the Navigator. Its properties appear in the Editor.
Click the Login tab. The Login tab appears.
Click the Connection subtab. The Connection subtab appears.
Figure 86-4 Login Tab, Connection Subtab, Relational Session Connection Pool Options
Figure 86-5 Login Tab, Connection Subtab, EIS Session Connection Pool Options
Ensure the Use Non-Transaction Read Login option is selected.
Use the following information to complete fields on the Connection subtab:
Field | Description |
---|---|
Database DriverFoot 1 | Specify the appropriate database driver:
Note: If you select J2EE Datasource, you must use external connection pooling. You cannot use internal connection pools with this Database Driver option (for more information, see "Configuring External Connection Pooling"). |
Driver ClassFootref 1 | Configure this field when Database Driver is set to Driver Manager. Select from the menu of options. This menu includes all JDBC drivers in the TopLink application classpath. |
URLFootref 1 | Configure this field when Database Driver is set to Driver Manager. Select from the menu of options relevant to the selected Driver Class and edit the URL to suit your data source. |
Datasource NameFootref 1 | Configure this field when Database Driver is set to J2EE Datasource. Specify any valid JNDI name that identifies the J2EE data source preconfigured on your target application server (For example: jdbc/EmployeeDB ).
By convention, all such names should resolve to the JDBC subcontext (relative to the standard |
Connection Specification ClassFoot 2 | Specify the appropriate connection specification class for the selected Platform. Click Browse to choose from all the classes in the TopLink classpath. (For example: if Platform is oracle.toplink.eis.aq.AQPlatform , use oracle.toplink.eis.aq.AQEISConnectionSpec ).
For more information on platform configuration, see "Configuring an EIS Data Source Platform at the Session Level". |
Connection Factory URLFootref 2 | Specify the appropriate connection factory URL for the selected Connection Specification Class (For example: jdbc:oracle:thin@:localhost:1521:orcl ). |
Footnote 1 For sessions that contain a DatabaseLogin
.
Footnote 2 For sessions that contain an EISLogin
.
An exclusive connection is one that TopLink allocates specifically to a given session and one that is never used by any other session.
Allowing concurrent reads on the same connection reduces the number of read connections required and reduces the risk of having to wait for an available connection. However, many JDBC drivers do not support concurrent reads.
If you are using internal connection pools (see "Internal Connection Pools"), you can configure TopLink to acquire an exclusive connection from the read connection pool.
By default, TopLink acquires exclusive read connections.
If you are using external connection pools, read connections are always exclusive.
To configure a TopLink read connection pool to allocate exclusive connections, use this procedure:
Expand a server session to reveal its connection pools in the Navigator.
Select a read connection pool in the Navigator. Its properties appear in the Editor.
Click the Login tab. The Login tab appears.
Click the Connection subtab. The Connection subtab appears.
Figure 86-6 Login Tab, Connection Subtab, Exclusive Connections Option
Select the Exclusive Connections option to configure TopLink to acquire an exclusive connection from the read connection pool.
Deselect the Exclusive Connections option to configure TopLink to share read connections and allow concurrent reads. Before selecting this option, ensure that your JDBC driver supports concurrent reads.