ODBC Driver for HarperDB

Build 24.0.9060

Windows DSN Configuration

Using the Microsoft ODBC Data Source Administrator

You can use the Microsoft ODBC Data Source Administrator to edit the DSN configuration. Note that the DSN is created during the installation process.

Complete the following steps to edit the DSN configuration:

  1. Select Start > Search, and enter ODBC Data Sources in the Search box.
  2. Choose the version of the ODBC Administrator that corresponds to the bitness of your application (32-bit or 64-bit).
  3. Click the System DSN tab.
  4. Select the system data source and click Configure.
  5. Edit the information on the Connection tab and click OK.

Note: For .NET Framework 4.0, the driver distributes Microsoft Visual C++ 2015-2022 Redistributable. For .NET Framework 3.5, the driver distributes Microsoft Visual C++ 2008 Redistributable.

Ensuring Registry Access

The driver stores connection information in the Windows registry. To ensure that the driver can write to the registry, perform either of the following actions:

  1. Run the calling application as an administrator.
  2. Connect via a User DSN instead of a System DSN.

Connecting to HarperDB

Set the Server connection property to the hostname or IP address of your HarperDB instance. Set UseSSL to secure connections with TLS/SSL.

Authenticating to HarperDB

The driver supports Basic authentication and token authentication. To authenticate, select the desired authentication method in the AuthScheme property, and set the necessary credentials described below.

Basic

Set AuthScheme to Basic. Set User and Password to a HarperDB user and password.

Token

Set AuthScheme to Token. The driver supports Token authentication through the following schemes:

  • Driver managed: Set User and Password to a HarperDB user and password. The driver handles obtaining and refreshing OperationToken and RefreshToken. Encrypted token credentials are stored at CredentialsLocation.
  • User managed: Directly specify OperationToken and RefreshToken. The driver does not attempt to refresh or reacquire token credentials after the supplied tokens expire. The supplied tokens are located at CredentialsLocation but do not persist across connections.

The driver also offers the following properties to govern token management in the Driver managed scheme:

  • OperationTokenTimeout: this governs how long the driver attempts to use a supplied OperationToken before refreshing it. It should match the setting for operation_token lifetimes in HarperDB. It defaults to the default operation_token lifetime for HarperDB.
  • RefreshTokenTimeout: this governs how long the driver attempts to use a supplied RefreshToken before refreshing it. It should match the setting for refresh_token lifetimes in HarperDB. It defaults to the default refresh_token lifetime for HarperDB.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060