This section shows how to set up ODBC connectivity and configure DSNs on macOS.

Minimum macOS Version

The CData ODBC Driver for HarperDB driver requires macOS Sierra (10.12) or above.

Licensing the Driver

In a terminal, run the following commands to license the driver. To activate a trial, omit the <key> input.

cd "/Applications/CData ODBC Driver for HarperDB/bin"
sudo ./install-license.sh <key>

You'll be prompted for a name and password. These refer to your name and your machine's password.

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.

Uninstalling the Driver

The easiest way to uninstall the driver is to open a terminal and run the included uninstall.sh script, located in the installation directory. For example:

cd "/Applications/CData ODBC Driver for HarperDB"
sudo ./uninstall.sh

Note: The script needs to be run from the installation directory.