Configuring TCP Keepalives

By default, the Simba Amazon Redshift ODBC Connector is configured to use TCP keepalives to prevent connections from timing out. Settings such as how frequently the connector sends TCP keepalive packets are based on the operating system defaults. You can configure the TCP keepalive settings or disable the feature by modifying the appropriate values in the Windows Registry.

Important:

Important:

Editing the Windows Registry incorrectly can potentially cause serious, system-wide problems that may require re-installing Windows to correct.

To configure TCP keepalives:

  1. On the Start screen, type regedit, and then click the regedit search result.
  2. Select the appropriate registry key for the bitness of your connector:
    • If you are using the 32-bit connector on a 64-bit machine, then select the following registry key, where [YourDSN] is the DSN for which you want to configure keepalives:

      • HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\ODBC\ODBC.INI\[YourDSN]

    • Otherwise, select the following registry key, where [YourDSN] is the DSN for which you want to configure keepalives:

      • HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI\[YourDSN]

  3. To specify the interval of inactivity before the connector sends a TCP keepalive packet, configure the KeepAliveIdle value by doing the following:
    1. If the KeepAliveIdle value does not already exist, create it. Select Edit > New > String Value, type KeepAliveIdle as the name of the value, and then press Enter.
    2. Select the KeepAliveIdle value, and then Select Edit > Modify.
    3. In the Edit String dialog box, in the Value Data field, type the number of seconds of inactivity before the connector sends a TCP keepalive packet.

      4. Note:

      To use the system default, in the Value Data field, type 0.

    4. Click OK.
  4. To specify the number of TCP keepalive packets that can be lost before the connection is considered broken, configure the KeepAliveCount value. To do this, follow the procedure above, but type KeepAliveCount for the value name, and in the Value Data field, type the number of keepalive packets that can be lost.

    5. Note:

    To use the system default, in the Value Data field, type 0.

  5. To specify the interval of time between each retransmission of a keepalive packet, configure the KeepAliveInterval value. To do this, follow the procedure above, but type KeepAliveInterval for the value name, and in the Value Data field, type the number of seconds to wait between each retransmission.

    6. Note:

    To use the system default, in the Value Data field, type 0.

  6. Close the Registry Editor.

To disable TCP keepalives:

  1. On the Start screen, type regedit, and then click the regedit search result.
  2. Select the appropriate registry key for the bitness of your connector:
    • If you are using the 32-bit connector on a 64-bit machine, then select the following registry key, where [YourDSN] is the DSN for which you want to configure keepalives:

      • HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\ODBC\ODBC.INI\[YourDSN]

    • Otherwise, select the following registry key, where [YourDSN] is the DSN for which you want to configure keepalives:

      • HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI\[YourDSN]

  3. If the KeepAlive value does not already exist, create it. Select Edit > New > String Value, then type KeepAlive as the name of the value, and then press Enter.
  4. Select the KeepAlive value, and then click Edit > Modify.
  5. In the Edit String dialog box, in the Value Data field, type 0.
  6. Click OK.
  7. Close the Registry Editor.

    8. Note:

    To enable TCP keepalives after disabling them, set KeepAlive to 1.

Related topics