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

Cloudant supports three type of authentication:

• Auto (default): the driver decides how to authenticate you, based on the other connection properties you have set.
• Basic: Basic username/password authentication. Set AuthScheme to Basic.
• OAuth: Performs authentication based on the OAuth standard. Set AuthScheme to OAuth and supply the values for the Cloudant instance APIKey and URL.

IBM Cloudant Legacy

To connect via IBM Cloudant Legacy, ensure that you have a valid IBM Cloudant service credential.

To create an IBM Cloudant service credential:

1. Log in to the IBM Cloud dashboard.
2. Navigate to the Menu icon > Resource List, and open your IBM Cloudant service instance.
3. In the menu, click Service credentials.
4. Click New credential. Cloudant displays a Add new credential window.
5. Enter a name for the new credential.
6. Click Add. Your credentials are added to the Service credentials table.
7. Click Actions > View credentials.
8. Extract the values for User and Password from the JSON file.

Use the values you just obtained to set the User and Password.

Authenticating to a Local Instance

Cloudant supports authenticating to data in local instances from version 1.1.0 and above.

To authenticate to your local instance, set these parameters:

1. Url: The Url of your local instance. For example: http://localhost:8006
2. User: Your username.
3. Password: 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.