17 The Informix 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 17-1 lists the connection string attributes supported by the Informix driver.
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
Cursor Behavior
Attribute
CursorBehavior (CB)
Description
Determines whether cursors will be preserved or closed at the end of transactions.
Valid Values
0 | 1
If set to 1 (Enabled), cursors are held at their current position when transactions end. This value may slow the performance of your database operations.
If set to set to 0 (Disabled), cursors are closed at the end of transactions.
Default
0 (Disabled)
GUI Tab
Advanced tab
Database List
Attribute
Database (DL)
Description
A list of database names that will be displayed in the Logon dialog box if Get DB List From Informix on the Advanced tab is not selected.
Valid Values
database_name[,database_name][...]
where database_name is a database name you want to appear in the Logon dialog box. Separate multiple values with commas.
Example
db1, db2, db3
Default
None
GUI Tab
Connection 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
Default 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
Connection 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
Enable Insert Cursors
Attribute
EnableInsertCursors (EIC)
Description
Determines whether the driver can use Insert cursors during inserts governed by parameters.
Valid Values
If set to 1 (Enabled), the driver uses Insert cursors.
If set to 0 (Disabled), the driver does not use Insert cursors.
Default
1 (Enabled)
GUI Tab
Advanced tab
Get DB List From Informix (GDBLFI)
Attribute
GetDBListFromInformix (GDBLFI)
Description
Determines whether the driver requests the database list to be returned from the Informix server or from the database list that the user entered at driver setup.
Valid Values
0 | 1
If set to 1 (Enabled), the driver requests the database list from the Informix server.
If set to 0 (Disabled), the driver uses the list that was entered by the user at driver setup.
Default
1 (Enabled)
GUI Tab
Advanced tab
Host Name
Attribute
HostName (HOST)
Description
The name of the server to which you want to connect.
Valid Values
server_name
where server_name is the name of the server to which you want to connect.
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
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
Protocol Type
Attribute
Protocol (PRO)
Description
Determines the protocol used by the driver to communicate with the server.
Valid Values
olsocspx | olsoctcp | onsocspx | onsoctcp | seipcpip | sesocspx | sesoctcp
Specify the appropriate Informix protocol.
Default
None
GUI Tab
Connection 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
Connection tab
Service Name
Attribute
Service (SERV)
Description
The name of the Informix service. The service name is assigned by the system administrator.
Valid Values
service_name
where service_name is the a name that uniquely identifies the Informix service. This name must be specified as it appears in the services file on the server machine.
Default
None
GUI Tab
Connection 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 Default Login
Attribute
UseDefaultLogin (UDL)
Description
Determines where the driver reads login credentials.
Valid Values
0 | 1
If set to 0 (Disabled), login credentials are read from the Windows Registry, the connection string, or the Logon to Informix dialog box.
If set to 1 (Enabled), login credentials are read directly from the Informix registry.
Default
0 (Disabled)
GUI Tab
Connection tab