ODBC_DRV.INT

The general behavior of the DataFlex ODBC Driver can be configured through the configuration file, ODBC_DRV.INT. The configuration file is read when the driver initializes.

The example configuration file (ODBC_DRV.INT) is installed in the DataFlex Bin directory.

The keywords will be presented in the following format:

Keyword_Name
Value
AssociatedAttribute
(Type)

Where

• Keyword_Name: The keyword to set in the intermediate file.
• Value: A list of values or a description of possible values for the keyword.
• AssociatedAttribute: The name of the attribute associated with the keyword.
• (Type): The type of the associated keyword.

Keywords

The supported keywords for the global intermediate file are described below.

Value

Value

0 or 1

Associated Attribute

None

Description

Determines whether the driver attempts to Auto-Reconnect or not. The default value is 1 (Auto-Reconnect On).

Cache_Path

Value

Path to a valid directory

Associated Attribute

DF_DRIVER_CACHE_PATH

Description

Sets up a directory to store cache files. By default, cache files are stored in the same directory as the corresponding intermediate file.

Default_Default_ASCII

Value

Default specification

Associated Attribute

DF_DRIVER_DEFAULT_DEFAULT_ASCII

Description

Sets the default value that will be used when an ASCII field is created. Fields can be created during conversion or within a restructure operation.

This keyword can also be specified in the database-specific configuration file.

Default_Default_Binary

Value

Default specification

Associated Attribute

DF_DRIVER_DEFAULT_DEFAULT_BINARY

Description

Sets the default value that will be used when a Binary field is created. Fields can be created during conversion or within a restructure operation.

This keyword can also be specified in the database-specific configuration file.

Default_Default_Date

Value

Default specification

Associated Attribute

DF_DRIVER_DEFAULT_DEFAULT_DATE

Description

Sets the default value that will be used when a Date field is created. Fields can be created during conversion or within a restructure operation.

This keyword can also be specified in the database-specific configuration file.

Default_Default_DateTime

Value

Default specification

Associated Attribute

DF_DRIVER_DEFAULT_DEFAULT_DATETIME

Description

Sets the default value that will be used when a DateTime field is created. Fields can be created during conversion or within a restructure operation.

This keyword can also be specified in the database-specific configuration file.

Default_Default_Numeric

Value

Default specification

Associated Attribute

DF_DRIVER_DEFAULT_DEFAULT_NUMERIC

Description

Sets the default value that will be used when a Numeric field is created. Fields can be created during conversion or within a restructure operation.

This keyword can also be specified in the database-specific configuration file.

Default_Default_Text

Value

Default specification

Associated Attribute

DF_DRIVER_DEFAULT_DEFAULT_TEXT

Description

Sets the default value that will be used when a Text field is created. Fields can be created during conversion or within a restructure operation.

This keyword can also be specified in the database-specific configuration file.

Default_Nullable_ASCII

Value

Integer value

Associated Attribute

DF_DRIVER_DEFAULT_NULLABLE_ASCII

Description

Specifies if ASCII fields allow null values by default. Null values are not allowed if the attribute is set to 0 (zero); all other integer values will allow null values.

This keyword can also be specified in the database-specific configuration file.

Default_Nullable_Binary

Value

Integer value

Associated Attribute

DF_DRIVER_DEFAULT_NULLABLE_BINARY

Description

Specifies if Binary fields allow null values by default. Null values are not allowed if the attribute is set to 0 (zero); all other integer values will allow null values.

This keyword can also be specified in the database-specific configuration file.

Default_Nullable_Date

Value

Integer value

Associated Attribute

DF_DRIVER_DEFAULT_NULLABLE_DATE

Description

Specifies if Date fields allow null values by default. Null values are not allowed if the attribute is set to 0 (zero); all other integer values will allow null values.

This keyword can also be specified in the database-specific configuration file.

Default_Nullable_DateTime

Value

Integer value

Associated Attribute

DF_DRIVER_DEFAULT_NULLABLE_DATETIME

Description

Specifies if DateTime fields allow null values by default. Null values are not allowed if the attribute is set to 0 (zero); all other integer values will allow null values.

This keyword can also be specified in the database-specific configuration file.

Default_Nullable_Numeric

Value

Integer value

Associated Attribute

DF_DRIVER_DEFAULT_NULLABLE_NUMERIC

Description

Specifies if Numeric fields allow null values by default. Null values are not allowed if the attribute is set to 0 (zero); all other integer values will allow null values.

This keyword can also be specified in the database-specific configuration file.

Default_Nullable_Text

Value

Integer value

Associated Attribute

DF_DRIVER_DEFAULT_NULLABLE_TEXT

Description

Specifies if Text fields allow null values by default. Null values are not allowed if the attribute is set to 0 (zero); all other integer values will allow null values.

This keyword can also be specified in the database-specific configuration file.

Default_Record_Identity_Hiding

Value

Integer value

Associated Attribute

DF_DRIVER_DEFAULT_RECORD_IDENTITY_HIDING

Description

When old definition tables are opened — with a record identity column called DFRECNUM placed at the end of the record — this attribute determines if the record identity is visible or not. Setting the attribute to a non-zero value will hide every record identity column in every table.

Default_Table_Character_Format

Value

ANSI, OEM

Associated Attribute

DF_DRIVER_DEFAULT_TABLE_CHARACTER_FORMAT

Description

The default table character format to use when creating new tables.

Default_Use_Dummy_Zero_Date

Value

Integer value

Associated Attribute

DF_DRIVER_DEFAULT_USE_DUMMY_ZERO_DATE

Description

Sets the default value of the DF_FILE_USE_DUMMY_ZERO_DATE attribute for new tables created in a structure operation. Dummy zero dates will not be used if set to 0; all other integer values will use dummy zero dates.

DfConnectionId

Value

ID, ConnectString, Options

Associated Attributes

• DF_DRIVER_CONNECTION_ID
• DF_DRIVER_CONNECTION_ID_OPTIONS
• DF_DRIVER_CONNECTION_ID_STRING
• DF_DRIVER_NUMBER_CONNECTION_IDS

Description

Define a DataFlex Connection ID. Used to assign a logical name (Connection ID) to a database connect string.

Driver_Date_Format

Value

EUROPEAN, MILITARY, USA

Associated Attribute

DF_DRIVER_DRIVER_DATE_FORMAT

Description

ODBC demands that drivers use the military format (yyyy-mm-dd) in the supported SQL. Nevertheless, some drivers do not use this format but rather a format that depends on the country settings of the machine or the database client software. For those environments the driver date format can be set.

A configuration file that sets the date format to European would look like:

DRIVER_DATE_FORMAT EUROPEAN
DRIVER_DATE_SEPARATOR /

This keyword can also be specified in the database-specific configuration file.

Driver_Date_Separator

Value

Character

Associated Attribute

DF_DRIVER_DRIVER_DATE_SEPARATOR

Description

Sets the date separator used by the driver (for example, '/'). ODBC normally uses the military format (yyyy-mm-dd), but some environments require a different separator based on locale.

A configuration file that sets the date format to European would look like:

DRIVER_DATE_FORMAT EUROPEAN
DRIVER_DATE_SEPARATOR /

This keyword can also be specified in the database-specific configuration file.

Driver_Decimal_Separator

Value

Character

Associated Attribute

DF_DRIVER_DRIVER_DECIMAL_SEPARATOR

Description

ODBC demands that drivers use the US decimal separator in supported SQL. Some drivers follow locale-specific separators. For those environments, the driver decimal separator can be set.

A configuration file that sets the numeric format to European would look like:

DRIVER_DECIMAL_SEPARATOR ,
DRIVER_THOUSANDS_SEPARATOR .

This keyword can also be specified in the database-specific configuration file.

Driver_Thousands_Separator

Value

Character

Associated Attribute

DF_DRIVER_DRIVER_THOUSANDS_SEPARATOR

Description

ODBC demands that drivers use the US thousands separator in supported SQL. Some drivers follow locale-specific separators. For those environments, the driver thousands separator can be set.

A configuration file that sets the numeric format to European would look like:

DRIVER_DECIMAL_SEPARATOR ,
DRIVER_THOUSANDS_SEPARATOR .

This keyword can also be specified in the database-specific configuration file.

Dummy_Zero_Date_Value

Value

String value with dummy date value

Associated Attribute

DF_DRIVER_DUMMY_ZERO_DATE_VALUE

Description

Sets the value of the dummy zero date. This should be set to the lowest possible date value that the database supports. In most databases the default 0001-01-01 can be used. Some databases, however, support a different lowest possible date value.

This keyword can also be specified in the database-specific configuration file.

Error_Debug_Mode

Value

Integer value

Associated Attribute

DF_DRIVER_ERROR_DEBUG_MODE

Description

Sets the error debug mode OFF if the attribute is set to 0 (zero); all other integer values switch the error debug mode ON. When the error debug mode is ON, all errors generated by the database back-end are displayed in a message box. This mode can be used in procedural environments where the screen space reserved to show error messages is often too small to display the complete error text.

Find_Cache_Timeout

Value

Positive integer value (including zero)

Associated Attribute

DF_DRIVER_FIND_CACHE_TIMEOUT

Description

Sets the timeout (in milliseconds) for the find cache. The find cache timeout is the maximum time allowed between two find operations on records in memory from one table before they are considered outdated. The default value is 100 milliseconds.

Ignore_UCASE_Support

Value

Integer value

Associated Attribute

DF_DRIVER_IGNORE_UCASE_SUPPORT

Description

Turns on the check for an uppercase scalar function when case-insensitive index segments are used when set to 0 (zero); all other integer values will switch this check off. When switched off, case-insensitive index segments will be ignored. By default, the check for an uppercase scalar function is on.

This keyword can also be specified in the database-specific configuration file.

Ignore_Warnings

Value

Integer value

Associated Attribute

DF_DRIVER_IGNORE_WARNINGS

Description

Switches ignoring warnings ON or OFF. When set to 0 (zero), warnings are reported as errors; all other integer values cause the driver to ignore all warnings (nothing is reported). By default, warnings are reported as errors.

JIT_Treshold

Value

Positive integer value

Associated Attribute

DF_DRIVER_JIT_TRESHOLD

Description

Sets the native size (in megabytes) of a column that defines the column as a “JIT” column. Columns of this size, and those that are bigger, will be fetched using the JIT binding mechanism in tables that have JIT binding switched on. The default value is 10 megabytes.

Login_On_Open

Value

Integer value, 1 or 0

Associated Attribute

DF_DRIVER_LOGIN_ON_OPEN

Description

Controls whether a login will be attempted during an Open if the program is not already logged in on the connection.

• If LOGIN_ON_OPEN is 1 when opening a table and there is no connection, the driver will attempt an automatic login.
• If LOGIN_ON_OPEN is 0 when opening a table and there is no connection, the driver will not attempt to login, but will generate an error.

DFASCII to ODBC Type Mapping

Value

ODBC data type: char, varchar, nchar, nvarchar

Associated Attribute

• DF_DATABASE_MAP_DFASCII_TO_ODBCTYPE
• DF_DRIVER_MAP_DFASCII_TO_SQLTYPE

Description

Determines which ODBC data type the DataFlex ASCII data type is mapped to.

See Type Mappings for more information.

DFBINARY to ODBC Type Mapping

Value

ODBC data type: varbinary(max), image, binary

Associated Attribute

• DF_DATABASE_MAP_DFBINARY_TO_ODBCTYPE
• DF_DRIVER_MAP_DFBINARY_TO_SQLTYPE

Description

Determines which ODBC data type the DataFlex Binary data type is mapped to.

See Type Mappings for more information.

DFDATE to ODBC Type Mapping

Value

ODBC data type: datetime

Associated Attribute

• DF_DATABASE_MAP_DFDATE_TO_ODBCTYPE
• DF_DRIVER_MAP_DFDATE_TO_SQLTYPE

Description

Determines which ODBC data type the DataFlex Date data type is mapped to.

See Type Mappings for more information.

DFDATETIME to ODBC Type Mapping

Value

ODBC data type: datetime2, datetime

Associated Attribute

• DF_DATABASE_MAP_DFDATETIME_TO_ODBCTYPE
• DF_DRIVER_MAP_DFDATETIME_TO_SQLTYPE

Description

Determines which ODBC data type the DataFlex DateTime data type is mapped to.

See Type Mappings for more information.

DFTEXT to ODBC Type Mapping

Value

ODBC data type: varchar(max), text, ntext, nvarchar(max)

Associated Attribute

• DF_DATABASE_MAP_DFTEXT_TO_ODBCTYPE
• DF_DRIVER_MAP_DFTEXT_TO_SQLTYPE

Description

Determines which ODBC data type the DataFlex Text data type is mapped to.

See Type Mappings for more information.

Match_Client_Server_Version

Value

Boolean value

Associated Attribute

DF_DRIVER_MATCH_CLIENT_SERVER_VERSION

Description

If this keyword is set to True, the driver will check if the version of the database client and server software match. If the client version is less than the server version, an error will be raised when connecting to the server.

If the setting is False (the default), versions will not be checked.

Minimum_Driver_Version

Value

Integer value

Associated Attribute

DF_DRIVER_MINIMUM_CLIENT_VERSION

Description

In general it is best to use matching client and server versions. For this, the Match_Client_Server_Version driver configuration keyword can be used.

Using older clients with newer server versions may sometimes cause unpredictable results.

Max_Active_Statements

Value

Integer value

Associated Attribute

DF_DRIVER_MAX_ACTIVE_STATEMENTS

Description

The maximum number of concurrently active statements allowed per connection. 0 (zero) means there is no limit.

This attribute can be queried through ODBC, but some drivers do not return a reliable value. The value of the attribute is used by the driver to determine the size of the statement pool. The driver keeps track of the statements used per connection in a "Most Recently Used" sorted list. If the maximum number of statements is in use, the least recently used statement will be freed whenever an additional statement is required.

Some ODBC drivers return a value of 1 for this attribute. This will make the driver free and re-allocate statements frequently. For some drivers, the value is accurate (e.g., MS Jet Engine DataFlex ODBC Driver) but for others it is not (e.g., Oracle ODBC driver). In case the attribute value is not accurate you can overwrite it by setting the Max_Active_Statements keyword.

This keyword can also be specified in the database-specific configuration file.

Report_Active_Column_Errors

Value

Integer value

Associated Attribute

DF_DRIVER_REPORT_ACTIVE_COLUMN_ERRORS

Description

Switches error reporting on active columns ON or OFF. Reporting is OFF if the attribute is set to 0 (zero); all other integer values switch reporting ON. By default, active column errors are not reported.

Report_Cache_Errors

Value

Integer value

Associated Attribute

DF_DRIVER_REPORT_CACHE_ERRORS

Description

Switches reporting of cache read errors ON or OFF. Reporting is OFF if the attribute is set to 0 (zero); all other integer values switch reporting ON. By default, cache read errors are not reported.

Silent_Login

Value

Integer value

Associated Attribute

DF_DRIVER_SILENT_LOGIN

Description

Switches the login pop-up panel ON or OFF. The panel pops up if the attribute is set to 0 (zero); all other integer values ensure the panel does not pop up. By default the panel will pop up.

Trim_VarChar_Values

Value

Integer value (0 = False, 1 = True)

Associated Attribute

DF_DRIVER_TRIM_VARCHAR_VALUES

Description

Determines whether values are trimmed when stored in a SQL varchar column.

See Padding and Trimming in SQL Databases for further information.

Truncate_Binary_Zeroes

Value

Integer value

Associated Attribute

DF_DRIVER_TRUNCATE_BINARY_ZEROES

Description

Switches truncating of trailing binary zeroes ON or OFF. When set to 0 (zero) trailing binary zeroes are not truncated; any other integer value will truncate the trailing binary zeroes. By default trailing zeroes are not truncated.

Use_Cache

Value

Integer value

Associated Attribute

DF_DRIVER_USE_CACHE

Description

Switches the use of structure caching ON or OFF. Structure cache is OFF if the attribute is set to 0 (zero); all other integer values switch structure caching ON. By default, structure cache is ON.

Use_Cache_Expiration

Value

Integer value

Associated Attribute

DF_DRIVER_USE_CACHE_EXPIRATION

Description

Switches the structure caching intermediate file expiration checking ON or OFF. Expiration check is OFF if the attribute is set to 0 (zero); all other integer values will switch expiration checking ON. By default, expiration checking is ON.

Use_DF_LockError

Value

Integer value

Associated Attribute

DF_DRIVER_USE_DF_LOCKERROR

Description

Switches the translation of deadlock and lock timeout errors to DFERR_LOCK_TIMEOUT ON or OFF. Translation is OFF if set to 0 (zero); all other integer values switch translation ON. By default, the translation is ON.