6 The Informix Wire Protocol Driver : Connection Option Descriptions

Connection Option Descriptions
The following connection option descriptions are listed alphabetically by the GUI name that appears on the driver Setup dialog box. The connection string attribute name, along with its short name, is listed immediately underneath the GUI name.
In most cases, the GUI name and the attribute name are the same; however, some exceptions exist. If you need to look up an option by its connection string attribute name, please refer to the alphabetical table of connection string attribute names.
Also, a few connection string attributes, for example, Password, do not have equivalent options that appear on the GUI. They are in the list of descriptions alphabetically by their attribute names.
Table 6-1 lists the connection string attributes supported by the Informix Wire Protocol driver.
Alternate Servers
Attribute
AlternateServers (ASRV)
Description
A list of alternate database servers to which the driver tries to connect if the primary database server is unavailable. Specifying a value for this option enables connection failover for the driver. The value you specify must be in the form of a string that defines the physical location of each alternate server. All of the other required connection information for each alternate server is the same as what is defined for the primary server connection.
Valid Values
(Database=databasename:HostName=hostvalue:
PortNumber=portvalue:ServerName=servervalue[, . . .])
You must specify the database, host name, port number, and the server name.
NOTE: An alternate server address in IPv6 format must be enclosed in double quotation marks.
Example
The following Alternate Servers value defines two alternate database servers for connection failover:
(Database=Infdb1:HostName=Informixhost1:PortNumber=5177:ServerName=accounting1, Database=Infdb2:HostName=Informixhost2:PortNumber=5178:ServerName=accounting2)
Default
None
GUI Tab
Failover tab
Application Using Threads
Attribute
ApplicationUsingThreads (AUT)
Description
Determines whether the driver works with applications using multiple ODBC threads.
This connection option can affect performance. See “Performance Considerations” for details.
Valid Values
0 | 1
If set to 1 (Enabled), the driver works with single-threaded and multi-threaded applications.
If set to 0 (Disabled), the driver does not work with multi-threaded applications. If using the driver with single-threaded applications, this value avoids additional processing required for ODBC thread-safety standards.
Default
1 (Enabled)
GUI Tab
Advanced tab
Cancel Detect Interval
Attribute
CancelDetectInterval (CDI)
Description
Determines whether long-running queries in threaded applications can be cancelled if the application issues a SQLCancel.
This connection option can affect performance. See “Performance Considerations” for details.
Valid Values
0 | x
where x is the number of seconds the driver waits before checking for SQLCancel calls.
If set to 0 (None), the driver does not allow long-running queries in threaded applications to be canceled, even if the application issues a SQLCancel.
If set to x (seconds), for every pending query, the driver checks for SQLCancel calls at the specified interval. If the driver determines that a SQLCancel has been issued, the driver cancels the query.
Example
If you specify 5, for every pending query, the driver checks every five seconds to see whether the application has issued a SQLCancel call. If it detects a SQLCancel call, the driver cancels the query.
Default
0 (None)
GUI Tab
Advanced tab
Connection Retry Count
Attribute
ConnectionRetryCount (CRC)
Description
The number of times the driver retries connection attempts to the primary database server, and if specified, alternate servers until a successful connection is established.
This option and the Connection Retry Delay connection option, which specifies the wait interval between attempts, can be used in conjunction with failover.
Valid Values
0 | x
where x is a positive integer from 1 to 65535.
If set to 0, the driver does not try to connect after the initial unsuccessful attempt.
If set to x, the driver retries connection attempts the specified number of times. If a connection is not established during the retry attempts, the driver returns an error that is generated by the last server to which it tried to connect.
Default
0
GUI Tab
See Failover tab
Connection Retry Delay
Attribute
ConnectionRetryDelay (CRD)
Description
The number of seconds the driver waits between connection retry attempts when Connection Retry Count is set to a positive integer.
This option and the Connection Retry Count connection option can be used in conjunction with failover.
Valid Values
0 | x
where x is a positive integer from 1 to 65535.
If set to 0, there is no delay between retries.
If set to x, the driver waits the specified number of seconds between connection retry attempts.
Default
3
GUI Tab
See Failover tab
Database Name
Attribute
Database (DB)
Description
The name of the database to which you want to connect.
Valid Values
database_name
where database_name is the name of a valid database.
Default
None
GUI Tab
General tab
Data Source Name
Attribute
DataSourceName (DSN)
Description
The name of a data source in your Windows Registry or odbc.ini file.
Valid Values
string
where string is the name of a data source.
Default
None
GUI Tab
General tab
Description
Attribute
Description (n/a)
Description
An optional long description of a data source. This description is not used as a runtime connection attribute, but does appear in the ODBC.INI section of the Registry and in the odbc.ini file.
Valid Values
string
where string is a description of a data source.
Default
None
GUI Tab
General tab
Host Name
Attribute
HostName (HOST)
Description
The name or the IP address of the server to which you want to connect.
Valid Values
server_name | IP_address
where:
server_name is the name of the server to which you want to connect.
IP_address is the IP address of the server to which you want to connect.
The IP address can be specified in either IPv4 or IPv6 format, or a combination of the two. See “Using IP Addresses” for details about these formats.
Default
None
GUI Tab
General tab
IANAAppCodePage
Attribute
IANAAppCodePage (IACP)
Description
An Internet Assigned Numbers Authority (IANA) value. You must specify a value for this option if your application is not Unicode‑enabled and/or if your database character set is not Unicode (refer to Chapter 4 “Internationalization, Localization, and Unicode” in the DataDirect Connect Series for ODBC Reference for details). The value you specify must match the database character encoding and the system locale.
The Driver Manager checks for the value of IANAAppCodePage in the following order:
Valid Values
IANA_code_page
where IANA_code_page is one of the valid values listed in Chapter 1 “Values for the Attribute IANAAppCodePage” in the DataDirect Connect Series for ODBC Reference. The value must match the database character encoding and the system locale.
Default
4 (ISO 8559-1 Latin-1)
GUI Tab
Advanced tab
Load Balancing
Attribute
LoadBalancing (LB)
Description
Determines whether the driver uses client load balancing in its attempts to connect to the database servers (primary and alternate). You can specify one or multiple alternate servers by setting the Alternate Servers option.
Valid Values
0 | 1
If set to 1 (Enabled), the driver uses client load balancing and attempts to connect to the database servers (primary and alternate servers) in random order.
If set to 0 (Disabled), the driver does not use client load balancing and connects to each server based on their sequential order (primary server first, then, alternate servers in the order they are specified).
NOTE: This option has no effect unless alternate servers are defined for the Alternate Servers connection option.
Default
0 (Disabled)
GUI Tab
Failover tab
Password
Attribute
Password (PWD)
Description
The password that the application uses to connect to your database. The Password option cannot be specified through the driver Setup dialog box and should not be stored in a data source. It is specified through the Logon dialog box or a connection string.
Valid Values
pwd
where pwd is a valid password.
Default
None
GUI Tab
n/a
Port Number
Attribute
PortNumber (PORT)
Description
The port number of the server listener.
Valid Values
port_name
where the port_name is the port number of the server listener. Check with your database administrator for the correct number.
Default
None
GUI Tab
General tab
Server Name
Attribute
ServerName (SRVR)
Description
The name of the Informix server.
Valid Values
server_name
where server_name is a name that uniquely identifies the Informix server.
Default
None
GUI Tab
General tab
Trim Blank From Index Name
Attribute
TrimBlankFromIndexName (TBFIN)
Description
Determines whether the driver trims leading spaces from system-generated index names. Some applications cannot process a leading space in index names.
Valid Values
If set to 1 (Enabled), the driver trims leading spaces from system-generated index names.
If set to 0 (Disabled), the driver does not trim leading spaces from system-generated index names.
Default
1 (Enabled)
GUI Tab
Advanced tab
Use Delimited Identifier
Attribute
UseDelimitedIdentifier (UDI)
Description
Determines whether the driver sets the Informix DELIMIDENT environment variable. The DELIMIDENT environment variable specifies that strings enclosed between double quotation marks (") are delimited database identifiers.
Valid Values
0 | 1
If set to 1 (enabled), the Informix server interprets strings enclosed in double quotation marks as identifiers, not as string literals.
If set to 0 (disabled), the Informix server interprets strings enclosed in double quotation marks as string literals, not as identifiers.
Default
0 (Disabled)
GUI Tab
Advanced tab
User Name
Attribute
LogonID (UID)
Description
The default user ID that is used to connect to your database. Your ODBC application may override this value or you may override it in the logon dialog box or connection string.
Valid Values
userid
where userid is a valid user ID with permissions to access the database.
Default
None
GUI Tab
General tab