Skip to main contentSkip to search
Powered by Zoomin Software. For more details please contactZoomin
Progress DocumentationProgress Documentation
Progress Documentation
  • Home
  • Home
  • EnglishČeštinaDeutsch (Germany)Español (Spain)ФранцузскийItaliano (Italy)Português (Brasil)日本語Русский (Russia)中文 (简体) (China)中文 (繁體, 台灣) (Taiwan)ar-AR
  • Login

Progress DataDirect for ODBC Drivers Reference March 2026

Summary of failover-related options

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
Table of Contents
  • Welcome to the Progress DataDirect for ODBC Drivers Reference
    • What is ODBC?
      • How does it work?
      • Why do application developers need ODBC?
  • Troubleshooting
    • Diagnostic tools
      • ODBC trace
        • Creating a trace Log
        • Enabling tracing
          • Windows ODBC Administrator
          • System information (odbc.ini) file
      • Configuration Manager Portal trace
      • Packet logging
      • Test loading tool
      • ODBC Test
      • Logging for Java components
        • Loggers and logging levels
          • Driver to SQL communication logger
          • SQL engine logger
          • Wire protocol adapter logger
        • Configuring logging
          • Using the JVM
          • Using the driver
      • The demoodbc Application
      • The example application
      • Enabling debug record mode
      • Other tools
    • Error messages
    • Troubleshooting issues
      • Setup/connection issues
        • Troubleshooting the issue
      • Interoperability issues
        • Troubleshooting the issue
      • Performance issues
  • Failover
    • Connection failover
    • Extended connection failover
    • Select connection failover
    • Guidelines for primary and alternate servers
    • Using client load balancing
    • Using connection retry
    • Summary of failover-related options
      • A connection string example
      • An odbc.ini file example
  • Client information
    • How databases store client information
    • Storing client information
  • Code page values
    • IANAAppCodePage values
    • IBM to IANA code page values
    • Teradata code page values
  • ODBC API and scalar functions
    • API functions
    • Scalar functions
      • String functions
      • Numeric functions
      • Date and time functions
      • System functions
  • Internationalization, localization, and Unicode
    • Internationalization and Localization
      • Locale
      • Language
      • Country
      • Variant
    • Unicode character encoding
      • Background
      • Unicode support in databases
      • Unicode support in ODBC
    • Unicode and non-Unicode ODBC drivers
      • Function calls
        • Unicode application with a non-Unicode driver
        • Unicode application with a Unicode driver
      • Data
        • Unicode driver
        • ANSI driver
      • Default Unicode mapping
        • Connection attribute for Unicode
    • Driver Manager and Unicode encoding on UNIX/Linux
      • References
    • Character encoding in the odbc.ini and odbcinst.ini files
  • Designing ODBC applications for performance optimization
    • Using catalog functions
      • Caching information to minimize the use of catalog functions
      • Avoiding search patterns
      • Using a dummy query to determine table characteristics
    • Retrieving data
      • Retrieving long data
      • Reducing the size of data retrieved
      • Using bound columns
      • Using SQLExtendedFetch instead of SQLFetch
      • Choosing the right data type
    • Selecting ODBC functions
      • Using SQLPrepare/SQLExecute and SQLExecDirect
      • Using arrays of parameters
      • Using the cursor library
    • Managing connections and updates
      • Managing connections
      • Managing commits in transactions
      • Choosing the right transaction model
      • Using positioned updates and deletes
      • Using SQLSpecialColumns
  • Security best practices for ODBC applications
    • Secure connection option settings
    • Protect data buffered to disk
    • Encrypt transferred data
    • Secure your driver configuration
    • Use advanced authentication methods
    • Protect against SQL injection attacks
    • Use HTTP proxies
    • Secure log files
    • Security considerations for the SQL engine server
  • Using indexes
    • Introduction
    • Improving row selection performance
    • Indexing multiple fields
    • Deciding which indexes to create
    • Improving join performance
  • Locking and isolation levels
    • Locking
    • Isolation levels
    • Locking modes and levels
  • SSL encryption cipher suites
  • DataDirect Bulk Load
    • DataDirect Bulk Load functions
    • Utility functions
      • GetBulkDiagRec and GetBulkDiagRecW
    • Export, validate, and load functions
      • ExportTableToFile and ExportTableToFileW
      • ValidateTableFromFile and ValidateTableFromFileW
      • LoadTableFromFile and LoadTableFromFileW
      • Using the TableName parameter with the Salesforce driver
      • SetBulkOperation (Salesforce driver only)
      • GetBulkOperation (Salesforce driver only)
    • DataDirect Bulk Load statement attributes
      • SQL_BULK_EXPORT_PARAMS
      • SQL_BULK_EXPORT
  • DataDirect connection pooling
    • Creating a connection pool
    • Adding connections to a pool
    • Removing connections from a pool
    • Handling dead connections in a pool
    • Connection pool statistics
    • Summary of pooling-related options
  • Threading
  • WorkAround options
  • Copyright
Table of Contents

Summary of failover-related options

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
  • Last Updated: October 7, 2020
  • 3 minute read
    • DataDirect Connectors
    • ODBC
    • Aha! 8.0
    • Amazon Redshift 8.0
    • Apache Cassandra 8.0
    • Apache Hive 8.0
    • Apache Spark SQL 8.0
    • Autonomous Rest Connector 8.0
    • Cloudera Impala 7.1
    • dBase 7.1
    • + 24
      • Flat files/Text 7.1
      • GitHub 8.0
      • Google Bigquery 8.0
      • HubSpot 8.0
      • IBM Db2 8.0
      • IBM Informix Wire Protocol 8.0
      • Microsoft Dynamics 365 8.0
      • Microsoft SharePoint 8.0
      • Microsoft SQL Server 8.0
      • MongoDB 8.0
      • MySQL 8.0
      • MySQL 7.1
      • Oracle Database Wire Protocol 8.0
      • Oracle Service Cloud 7.1
      • Pervasive (Btrieve) 7.1
      • Greenplum 8.0
      • PostgreSQL 8.0
      • Progress Openedge 8.0
      • Salesforce 8.0
      • SAP S/4HANA 8.0
      • Snowflake 8.0
      • Teamcity 8.0
      • XML 7.1
      • Documentation

The following table summarizes how failover-related connection options work with the drivers. See "Connection Option Descriptions" in the user's guide for your driver for further details. Not all options are available in every failover-enabled driver. The step numbers in the table refer the procedure that follows the table

Table 1. Summary: Failover and Related Connection Options
Option Characteristic
Alternate Servers

(See step 1)

One or multiple alternate database servers. An IP address or server name identifying each server is required.
Connection Retry Count

(See step 5)

Number of times the driver retries the primary database server, and if specified, alternate servers until a successful connection is established.
Connection Retry Delay

(See step 6)

Wait interval, in seconds, between connection retry attempts when the Connection Retry Count option is set to a positive integer.
Failover Granularity

(See step 3)

The type of behavior that the driver exhibits when errors are detected during the failover process.
Failover Mode

(See step 2)

The type of failover that the driver attempts.
Failover Preconnect

(See step 4)

Determines whether the driver makes a connection attempt to the next server in the Alternate Servers list at the time of the initial connection.
Load Balancing

(See step 7)

Determines whether the driver uses client load balancing in its attempts to connect to primary and alternate database servers. If enabled, the driver attempts to connect to the database servers in random order.
  1. To configure connection failover, you must specify one or more alternate database servers that are tried at connection time if the primary server is not accepting connections. To do this, use the Alternate Servers connection option. Connection attempts continue until a connection is successfully established or until all the database servers in the list have been tried once (the default).
  2. Choose a failover method by setting the Failover Mode connection option. The default method is Connection (FailoverMode=0).
  3. If Failover Mode is Extended Connection (FailoverMode=1) or Select (FailoverMode=2), set the Failover Granularity connection option to specify how you want the driver to behave if errors occur while trying to reestablish a lost connection. The default behavior of the driver is Non-Atomic (FailoverGranularity=0), which continues with the failover process and posts any errors on the statement on which they occur. Other values are:

    Atomic (FailoverGranularity=1): the driver fails the entire failover process if an error is generated as the result of anything other than executing and repositioning a Select statement. If an error is generated as a result of repositioning a result set to the last row position, the driver continues with the failover process, but generates a warning that the Select statement must be reissued.

    Atomic including Repositioning (FailoverGranularity=2): the driver fails the entire failover process if any error is generated as the result of restoring the state of the connection or the state of work in progress.

    Disable Integrity Check (FailoverGranularity=3: the driver does not verify that the rows restored during the failover process match the original rows. This value applies only when Failover Mode is set to Select (FailoverMode=2).

  4. Optionally, enable the Failover Preconnect connection option (FailoverPreconnect=1) if you want the driver to establish a connection with the primary and an alternate server at the same time. This value applies only when Failover Mode is set to Extended Connection (FailoverMode=1) or Select (FailoverMode=2). The default behavior is to connect to an alternate server only when failover is caused by an unsuccessful connection attempt or a lost connection (FailoverPreconnect=0).
  5. Optionally, specify the number of times the driver attempts to connect to the primary and alternate database servers after the initial unsuccessful connection attempt. By default, the driver does not retry. To set this feature, use the Connection Retry Count connection option.
  6. Optionally, specify the wait interval, in seconds, between attempts to connect to the primary and alternate database servers. The default interval is 3 seconds. To set this feature, use the Connection Retry Delay connection option.
  7. Optionally, specify whether the driver will use client load balancing in its attempts to connect to primary and alternate database servers. If load balancing is enabled, the driver uses a random pattern instead of a sequential pattern in its attempts to connect. The default value is not to use load balancing. To set this feature, use the Load Balancing connection option.
Contents
  • A connection string example
  • An odbc.ini file example
TitleResults for “How to create a CRG?”Also Available inAlert