4 The Informix Driver

AccountingInfo

Accounting information to be stored in the database. This value is stored locally and is used for database administration/monitoring purposes

Data type: string

Valid Values: string where string is the accounting information. The default value is an empty string.

AlternateServers

A list of alternate database servers that is used to failover new or lost connections, depending on the failover method selected. See the FailoverMode property for information about choosing a failover method.

Data type: String

Valid Values:

(servername1[:port1][;property=value[;...]

,servername2[:port2][;property=value[;...]]]...]

The server name (servername1, servername2, and so on) is required for each alternate server entry. Port number (port1, port2, and so on) and connection properties (property=value) are optional for each alternate server entry. If the port is unspecified, the port number of the primary server is used. If the port number of the primary server is unspecified, the default port number of 2003 is used. Optional connection properties are DatabaseName and InformixServer.

Example: The following URL contains alternate server entries for server2 and server3. The alternate server entries contain the optional InformixServer property.

jdbc:weblogic:informix://server1:2003;InformixServer=TestServer;DatabaseName=Test;AlternateServers=(server2:2003;InformixServer=TestServer2,server3:2003;InformixServer=TestServer3)

Default: None

ApplicationName

The name of the application to be stored in the database. Thisvalue is stored locally and is used for database administration/value is stored locally and is used for database administration/monitoring purposes.

Data Type: String

Valid Values: string where string is the name of the application. The default value is empty string.

ClientHostName

The host name of the client machine to be stored in the database. This value is stored locally and is used for database administration/monitoring purposes.

Data Type: String

Valid Values: string where string is the host name of the client machine. The default value is empty string.

ClientUser

The user ID to be stored in the database. This value is stored locally and is used for database administration/monitoring purposes.

Data Type: String

Valid Values: string where string is a valid user ID. The default value is empty string.

CodePageOverride

The code page to be used by the driver to convert Character data. The specified code page overrides the default database code page or column collation. All Character data that is returned from or written to the database is converted using the specified code page.

By default, the driver automatically determines which code page to use to convert Character data. Use this property only if you need to change the driver's default behavior. For example: CP950.

Data Type: String

Valid Values: string where string is the name of a valid code page that is supported by your JVM. The default value is None.

ConnectionRetryCount

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. If an application sets a login timeout value (for example, using DataSource.loginTimeout or DriverManager.loginTimeout), and the login timeout expires, the driver ceases connection attempts.

Data Type: Int

Valid values: 0 | x where x is a positive integer. The default is 5.

If set to 0, the driver does not try to reconnect 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 exception that is generated by the last database server to which it tried to connect. The ConnectionRetryDelay property specifies the wait interval, in seconds, to occur between retry attempts.

For example: If this property is set to 2 and alternate servers are specified using the AlternateServers property, the driver retries the list of servers (primary and alternate) twice after the initial retry attempt.

ConnectionRetryDelay

The number of seconds the driver waits between connection retry attempts when ConnectionRetryCount is set to a positive integer.

For example: If ConnectionRetryCount is set to 2, this property is set to 3, and alternate servers are specified using the AlternateServers property, the driver retries the list of servers (primary and alternate) twice after the initial retry attempt. The driver waits 3 seconds between retry attempts.

Data Type: Int

Valid values: 0 | x where x is a positive integer. The default is 1.

ConvertNull

Controls how data conversions are handled for null values.

Data Type: Int

Valid values: 0 | 1. The default is 1.

If set to 1, the driver checks the data type being requested against the data type of the table column storing the data. If a conversion between the requested type and column type is not defined, the driver generates an "unsupported data conversion" exception regardless of the data type of the column value.

If set to 0, the driver does not perform the data type check if the value of the column is null. This allows null values to be returned even though a conversion between the requested type and the column type is undefined.

Database

An alias for the DatabaseName property.

DatabaseName

The name of the database to which you want to connect.

If this property is not specified, a connection is established to the specified server without connecting to a particular database. A connection that is established to the server without connecting to the database allows an application to use CREATE DATABASE and DROP DATABASE SQL statements. These statements require that the driver cannot be connected to a database. An application can connect to the database after the connection is established by executing the DATABASE SQL statement.

Refer to your IBM Informix documentation for details on using the CREATE DATABASE, DROP DATABASE, and DATABASE SQL statements.

Data Type: String

Valid values: string where string is the name of a Informix database.

Alias Database property. If both the Database and DatabaseName properties are specified in a connection URL, the last property that is positioned in the connection URL is used. For example, if your application specifies the following connection URL, the value of the Database connection property would be used instead of the value of the DatabaseName connection property.

jdbc:datadirect:informix://server1:2003; InformixServer=ol_test;DatabaseName=jdbc;Database=acct; User=test;Password=secret

DBDate

Sets the Informix DBDate server option for formatting literal date values when inserting, updating, and retrieving data in DATE columns. Using this property, you can customize the following items:

• Order in which the month, day, and year fields appear in a date string

• Year field to contain two or four digits

• Separator character used to separate the date fields

Data Type: String

Valid values are: DMY2, DMY4, MDY2, MDY4, Y4DM, Y4MD, Y2DM, and Y4MD

where D is a 2-digit day field, M is a 2-digit month field, Y2 is a 2-digit year field, and Y4 is a 4-digit year field.

If unspecified, the format of literal date values conforms to the default server behavior.

Optionally, a separator character may be specified as the last character of the value. Valid separator characters are the hyphen (-), a period (.), and a forward slash (/).

If a separator is not specified, a forward slash (/) is used to separate the fields. For example, a value of Y4MD- specifies a date format that has a 4-digit year, followed by the month and then by the day. The date fields are separated by a hyphen (-). For example: 2004-02-15.

This property does not affect the format of the string in the date escape syntax. Dates specified using the date escape syntax always use the JDBC escape format yyyy-mm-dd.

FailoverGranularity

Determines whether the driver fails the entire failover process or continues with the process if exceptions occur while trying to reestablish a lost connection. This property is ignored if FailoverMode=connect.

Data Type: String

Valid Values: nonAtomic | atomic | atomicWithRepositioning | disableIntegrityCheck

If set to nonAtomic, the driver continues with the failover process and posts any exceptions on the statement on which they occur.

If set to atomic, the driver fails the entire failover process if an exception is generated as the result of restoring the state of the connection. If an exception is generated as a result of restoring the state of work in progress, the driver continues with the failover process, but generates an exception warning that the Select statement must be reissued.

If set to atomicWithRepositioning, the driver fails the entire failover process if any exception is generated as the result of restoring the state of the connection or the state of work in progress.

If set to disableIntegrityCheck, the driver does not verify that the rows that are restored during the failover process match the original rows. This value is applicable only when FailoverMode=select.

Default is nonAtomic

FailoverMode

Specifies the type of failover method the driver uses.

Data Type: String

Valid Values connect | extended | select

If set to connect, the driver provides failover protection for new connections only.

If set to extended, the driver provides failover protection for new and lost connections, but not any work in progress.

If set to select, the driver provides failover protection for new and lost connections. In addition, it preserves the state of work that is performed by the last Select statement that was executed on the Statement object.

Note the following:

• The AlternateServers property specifies one or multiple alternate servers for failover and is required for all failover methods.

• The FailoverGranularity property determines which action the driver takes if exceptions occur during the failover process.

• The FailoverPreconnect property specifies whether the driver tries to connect to multiple database servers (primary and alternate) at the same time.

Default is connect.

FailoverPreconnect

Specifies whether the driver tries to connect to the primary and an alternate server at the same time. This property is ignored if FailoverMode=connect.

Data Type: boolean

Valid Values: true | false

If set to true, the driver tries to connect to the primary and an alternate server at the same time. This can be useful if your application is time-sensitive and cannot absorb the wait for the failover connection to succeed.

If set to false, the driver tries to connect to an alternate server only when failover is caused by an unsuccessful connection attempt or a lost connection. This value provides the best performance, but your application typically experiences a short wait while the failover connection is attempted.

The AlternateServers property specifies one or multiple alternate servers for failover.

Default is false.

FetchBufferSize

Specifies the size (in bytes) of the fetch buffer that the driver uses when retrieving data from the database. Valid values are any positive integer from 1 to 32767.

Decreasing the fetch buffer size reduces memory consumption, but means more network round trips, which decreases performance. Increasing the fetch buffer size improves performance because fewer network round trips are needed to return data from the database.

To determine the optimal value, use the following formula: X = A * B * 50

where A is the number of rows your application returns when executing Select statements and B is the number of row columns typically returned when executing Select statements.

See Performance Considerations for information about configuring this property for optimal performance.

The default is 32767

ImportStatementPool

Specifies the path and file name of the file to be used to load the contents of the statement pool. When this property is specified, statements are imported into the statement pool from the specified file.

If the driver cannot locate the specified file when establishing the connection, the connection fails and the driver throws an exception.

Data Type: String

Valid Values: string where string is the path and file name of the file to be used to load the contents of the statement pool. The default is empty string.

InformixServer (REQUIRED)

The name of the Informix database server to which you want to connect.

Data Type: String

Valid Values: string where string is the name of the Informix database server.

InitializationString

Specifies one or multiple SQL commands to be executed by the driver after it has established the connection to the database and has performed all initialization for the connection. For example: InitializationString=command

Multiple commands must be separated by semicolons. In addition, if this property is specified in a connection URL, the entire value must be enclosed in parentheses when multiple commands are specified. For example:

jdbc:weblogic:informix://server1:2003;
InformixServer=TestServer;DatabaseName=Test;
InitializationString=(command1;command2)

If the execution of a SQL command fails, the connection attempt also fails and the driver throws an exception indicating which SQL command or commands failed.

Data Type: String

Default: None

InsensitiveResultSetBufferSize

-1, zero (0), or x. Determines the amount of memory used by the driver to cache insensitive result set data.

If set to -1, the driver caches all insensitive result set data in memory. If the size of the result set exceeds available memory, an OutOfMemoryException is generated. Because the need to write result set data to disk is eliminated, the driver processes the data more efficiently.

If set to 0, the driver caches all insensitive result set data in memory, up to a maximum of 2 GB. If the size of the result set data exceeds available memory, the driver pages the result set data to disk. Because result set data may be written to disk, the driver may have to reformat the data to write it correctly to disk.

If set to x, where x is a positive integer, the driver caches all insensitive result set data in memory, using this value to set the size (in KB) of the memory buffer for caching insensitive result set data. If the size of the result set data exceeds the buffer size, the driver pages the result set data to disk. Because the result set data may be written to disk, the driver may have to reformat the data to write it correctly to disk. Specifying a buffer size that is a power of 2 results in more efficient memory use.

Data Type: int

The default is 2048 (KB)

JavaDoubleToString

True or false. Determines whether the driver uses its internal conversion algorithm or the JVM conversion algorithm when converting double or float values to string values.

If set to true, the driver uses the JVM algorithm when converting double or float values to string values.

If set to false (the default), the driver uses its internal algorithm when converting double or float values to string values. Setting the property to false improves performance; however, slight rounding differences can occur when compared to the same conversion using the JVM algorithm. These differences are within the allowable error of the double and float data types.

The default is false.

JavaDoubleToString

Determines which algorithm the driver uses when converting a double or float value to a string value. By default, the driver uses its own internal conversion algorithm, which improves performance.

Data Type: boolean

Valid Values: true | false

If true, the driver uses the JVM algorithm when converting a double or float value to a string value. If your application a double or float value to a string value. If your application sacrifice performance, set this value to true to use the JVM conversion algorithm.

If false, the driver uses its own internal algorithm when converting a double or float value to a string value. This value improves performance, but slight rounding differences within the allowable error of the double and float data types can occur when compared to the same conversion using the JVM algorithm. The default value is false.

JDBCBehavior

Determines how the driver describes database data types that map to the following JDBC 4.0 data types: NCHAR, NVARCHAR, NLONGVARCHAR, NCLOB, and SQLXML.

This property is applicable only when the application is using Java SE 6.

Data Type: int

Valid Values: 0 | 1

If 0, the driver describes the data types as JDBC 4.0 data types when using Java SE 6.

If 1, the driver describes the data types using JDBC 3.0-equivalent data types, regardless of JVM. This allows your application to continue using JDBC 3.0 types in a Java SE 6 environment. The default value is 1.

LoadBalancing

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 AlternateServers property.

Data Type: boolean

Valid Values: true | false

If true, the driver uses client load balancing and attempts to connect to the database servers (primary and alternate) in random order. The driver randomly selects from the list of primary and alternate servers which server to connect to first. If that connection fails, the driver again randomly selects from this list of servers until all servers in the list have been tried or a connection is successfully established.

If false, 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). The default value is false.

LoginTimeout

The amount of time, in seconds, the driver waits for a connection to be established before returning control to the application and throwing a timeout exception.

Data Type: int

Valid Values: 0 | x where x is a positive integer.

If 0, the driver does not time out a connection request. The default value is 0.

If x, the driver waits for the specified number of seconds before returning control to the application and throwing a timeout exception.

MaxPooledStatements

The maximum number of pooled prepared statements for this connection. Setting MaxPooledStatements to an integer greater than zero (0) enables the driver's internal prepared statement pooling, which is useful when the driver is not running from within an application server or another application that provides its own prepared statement pooling.Data Type: int

Valid Values: 0 | x where x is a positive integer.

If set to 0, the driver's internal prepared statement pooling is not enabled. The default value is 0.

If set to x, the driver enables the Statement Pool Monitor and uses the specified value to cache a certain number of prepared statements that are created by an application. If the value set for this property is greater than the number of prepared statements used by the application, all prepared statements that are created by the application are cached. Because CallableStatement is a sub-class of PreparedStatement, CallableStatements also are cached.

Example: If the value of this property is set to 20, the driver caches the last 20 prepared statements that are created by the application.

MaxStatements

An alias for the MaxPooledStatements property.

Password (REQUIRED)

A password that is used to connect to your Informix database. A password is required if security is enabled on your database. Contact your system administrator to obtain your password.

Data Type: String

Valid Values: string where string is a valid password. The password is case-sensitive. The default value is null (no password).

PortNumber (REQUIRED)

The TCP port on which the database server listens for connections. The default varies depending on operating system.

This property is supported only for data source connections.

ProgramID

The product and version information of the driver on the client to be stored in the database. This value is stored locally and is used for database administration/monitoring purposes.

Data Type: String

Valid Values: DDJVVRRM where:

• VV identifies a 2-digit version number (with high-order 0 in the case of a 1-digit version).

• RR identifies a 2-digit release number (with high-order 0 in the case of a 1-digit release).

• M identifies a 1-character modification level (0-9 or A-Z).

• Default is empty string.

Example: DDJ04100

QueryTimeout

Positive integer, -1, or zero (0). Sets the default query timeout (in seconds) for all statements created by a connection.

If set to a positive integer, the driver uses the value as the default timeout for any statement created by the connection. To override the default timeout value set by this connection option, call the Statement.setQueryTimeout() method to set a timeout value for a particular statement.

If set to -1, the query timeout functionality is disabled. The driver silently ignores calls to the Statement.setQueryTimeout() method.

If set to 0 (the default), the default query timeout is infinite (the query does not time out).

ResultSetMetaDataOptions

Zero (0) or 1. The Informix driver can return table name information in the ResultSet metadata for Select statements if your application requires that information.

If set to 0 (the default) and the ResultSetMetaData.getTableName() method is called, the driver does not perform additional processing to determine the correct table name for each column in the result set. In this case, the getTableName() method may return an empty string for each column in the result set.

If set to 1 and the ResultSetMetaData.getTableName() method is called, the driver performs additional processing to determine the correct table name for each column in the result set. The driver also can return schema name and catalog name information when the ResultSetMetaData.getSchemaName() and ResultSetMetaData.getCatalogName() methods are called if the driver can determine that information.

See Performance Considerations for information about configuring this property for optimal performance.

The default is 0.

ServerName (REQUIRED)

Specifies either the IP address in IPv4 or IPv6, or the server name (if your network supports named servers) of the primary database server. For example, 122.23.15.12 or InformixServer.

This property is supported only for data source connections.

Data Type: String

SpyAttributes

Enables Spy to log detailed information about calls issued by the driver on behalf of the application.

Data Type: String

Default is not enabled.

See "Tracking JDBC Calls with WebLogic JDBC Spy" for more details.

UseDelimitedIdentifier

Controls how the Informix server interprets double quote (") characters in SQL statements.

Data Type: boolean

If set to true, the driver sets the Informix DELIMIDENT server option, causing the Informix server to interpret strings enclosed in double quotes as identifiers, not as string literals.

If set to false, the driver does not set the Informix DELIMIDENT server option, and the Informix server interprets strings enclosed in double quotes as string literals, not as identifiers.

Note: If the DELIMIDENT environment variable is set on the server, the driver cannot change the setting. In this case, the UseDelimitedIdentifier connection option is ignored.

The default is true.

User (REQUIRED)

The case-insensitive default user name used to connect to the Informix database. A user name is required only if security is enabled on your database. If so, contact your system administrator to obtain your user name.

Data Type: String

Default value is None.

BLOB

BLOB

BOOLEAN

BIT

BYTE

LONGVARBINARY

CHAR

CHAR

CLOB

CLOB

DATE

DATE

DATETIME HOUR TO SECOND

TIME

DATETIME YEAR TO DAY

DATE

DATETIME YEAR TO FRACTION(5)

TIMESTAMP

DATETIME YEAR TO SECOND

TIMESTAMP

DECIMAL

DECIMAL

FLOAT

FLOAT

INT8

BIGINT

INTEGER

INTEGER

LVARCHAR

VARCHAR

MONEY

DECIMAL

NCHAR

CHAR

If JDBCBehavior=0, the data type depends on the JVM used by the application: NCHAR (if using Java SE 6) or CHAR (if using another JVM).

NVARCHAR

VARCHAR

If JDBCBehavior=0, the data type depends on the JVM used by the application: NVARCHAR (if using Java SE 6) or VARCHAR (if using another JVM).

SERIAL

INTEGER

SERIAL8

BIGINT

SMALLFLOAT

REAL

SMALLINT

SMALLINT

TEXT

LONGVARCHAR

VARCHAR

VARCHAR