DB2 10.5 for Linux, UNIX, and Windows
DB2 10.5 for Linux, UNIX, and Windows
Embedded SQL applications support use of the IBM® data server driver configuration file (db2dsdriver.cfg) for high availability solutions with supported servers.
You can use the IBM data server driver configuration file (db2dsdriver.cfg) for work load balancing (WLB) and automatic client reroute (ACR) with supported servers. The WLB and ACR associated keywords are available for use with the embedded applications.
| Element in the db2dsdriver.cfg configuration file | Section | Value |
|---|---|---|
| connectionLevelLoadBalancing | <database> | Must be set to true if you want to use transaction-level workload balancing. The value is true by default. However, the default is false if the server accessed is DB2® for z/OS® . |
| enableWLB | <wlb> | Specifies whether transaction-level workload balancing is in effect. The value is false by default. |
| maxTransportIdleTime | <wlb> | Specifies the maximum elapsed time in number of seconds before an idle transport is dropped. The default is 60 seconds. The minimum supported value is 0. |
| maxTransportWaitTime | <wlb> | Specifies the number of seconds that the client waits for a transport to become available. The default is 1 second. The minimum supported value is 0 and -1 is used to specify unlimited value. |
| maxTransports | <wlb> | Specifies the maximum number of physical connections that can be made for each application process that connects to the DB2 pureScale® instance. The default is -1 (unlimited). However, the default is 1000 if the server accessed is DB2 for z/OS. |
| maxRefreshInterval | <wlb> | Specifies the maximum elapsed time in number of seconds before the server list is refreshed. The default is 10 seconds. The minimum supported value is 0. |
| Element in the <acr> section of the db2dsdriver configuration file | Value |
|---|---|
| enableAcr | Specifies whether automatic client reroute is in effect. The default is true. If the server accessed is DB2 for z/OS, the enableAcr parameter should be enabled only when the enableWLB parameter is in effect. |
| acrRetryInterval | The number of seconds to wait between consecutive connection retries. The registry variable DB2_CONNRETRIES_INTERVAL overrides this value. The valid range is 0 to MAX_INT. The default is no wait (0), if DB2_CONNRETRIES_INTERVAL is not set. When enabling automatic client reroute to the DB2 for z/OS data sharing group, the default value of no wait is recommended. |
| maxAcrRetries | The maximum number of connection retries for automatic client reroute. The registry variable DB2_MAX_CLIENT_CONNRETRIES overrides this value. If DB2_MAX_CLIENT_CONNRETRIES is not set, the default is that the connection is tried again for 10 minutes. A value of 0 means that one attempt at reconnection is made. If the server accessed isDB2 for z/OS, the maxAcrRetries is recommended to be set to no higher than 5. |
| enableAlternateServerListFirstConnect | Specifies whether there is an alternate server list that is used only if a failure occurs on the first connection to the data server. The default is false. When the value of enableAlternateServerListFirstConnect is true, automatic client reroute with seamless failover is implicitly enabled, regardless of the other settings that are specified for automatic client reroute in the db2dsdriver configuration file. To use this feature, you also require an <alternateserverlist> element in the db2dsdriver configuration file. This parameter is not supported against DB2 for z/OS. |
| alternateserverlist | Specifies a set of server names and port numbers that identify alternate servers to which a connection is attempted if a failure occurs on the first connection to the database. The alternate server list is not used after the first connection. In a DB2 pureScale environment, the entries in the list can be members of a DB2 pureScale instance. In a non-DB2 pureScale environment, there is an entry for the primary server and an entry for the high availability disaster recovery (HADR) standby server. The alternate server list is not used after the first connection. |
| affinityFailbackInterval | The number of seconds to wait after the first transaction boundary to fail back to the primary server. Set this value if you want to fail back to the primary server. The default is 0, which means that no attempt is made to fail back to the primary server. |
| affinitylist | <list> elements with serverorder attributes. The serverorder attribute value specifies a list of servers, in the order that they should be tried during automatic client reroute with client affinities. The servers in <list> elements must also be defined in <server> elements in the <alternateserverlist>. You can specify multiple <list> elements, each of which has different server orders. The presence of the <affinitylist> element does not activate automatic client reroute. |
| clientaffinitydefined | <client> elements that define the server order for automatic client reroute for each client. Each <client> element contains a listname attribute that associates a client with a <list> element from the <affinitylist> element. |
| clientaffinityroundrobin | <client> elements whose order in the <clientaffinityroundrobin> element defines the first server that is chosen for automatic client reroute. Each <client> element has an index. The first <client> element in the <clientaffinityroundrobin> element has index 0, the second <client> element has index 1, and so on. Suppose that the number of servers in the <alternateserverlist> element is n and the index in the <clientaffinityroundrobin> element of a <client> element is i. The first server to be tried is the server whose index in the <alternateserverlist> element is i mod n. The next server to be tried is the server whose index in the <alternateserverlist> element is (i +1) mod n), and so on. |
| Keywords | Header |
|---|---|
| ClientAccountingString | Sets the client accounting string that is sent to a database. |
| ClientApplicationName | Sets the client application name that is sent to a database. |
| ClientCorrelationToken1 | Sets the client correlation token that is sent to a DB2 for z/OS Version 11 server in new function mode (NFM). |
| ClientUserID | Sets the client user ID (accounting user ID) that is sent to a database. The ClientUserID keyword is for identification purposes only and is not used for any authentication. |
| ClientWorkstationName | Sets the client workstation name that is sent to a database server. |
| enableDefaultClientInfo1 | Specifies whether the default client information register values, which are set on the DB2 for z/OS server, are returned to the application. |
1 You can set the specified keyword only when you are connecting to the DB2 for z/OS server.
The embedded SQL application cannot perform seamless failover. Also, the ability to resolve the data source name (DSN) with <dsncollection> section entry in the db2dsdriver.cfg file is only supported with IBM Data Server Driver Package.
IBM data server clients supports the use of the <dsncollection> section entry in the db2dsdriver.cfg file to resolve DSN entry.