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

Minimum macOS Version

The CData ODBC Driver for Cloudant 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 Cloudant/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.

Authenticating to Cloudant

There are two authentication methods available for connecting to Cloudant: IBM Cloudant Legacy and IBM Cloud IAM.

IBM Cloudant Legacy

Set the User and Password to your service credentials.

To create an IBM Cloudant service credential:

1. In the IBM Cloud dashboard, go to the Menu icon > Resource List, and open your IBM Cloudant service instance.
2. In the menu, click Service credentials.
3. Click New credential and enter a name for the new credential in the Add new credential window.
4. Click Add. This adds your credentials to the Service credentials table.
5. Click Actions > View credentials and extract the User and Password from the JSON file.

Local Instances

We support Local instances from version 1.1.0 and above.

To authenticate to your local instance:

1. Url: Set to the Url of your local instance. For example: http://localhost:8006
2. User: Set to your Username.
3. Password: Set to your Password.

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 Cloudant"
sudo ./uninstall.sh

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