Search

ODBC

ODBC

This page outlines the steps to use the ODBC Driver for CData Connect Cloud.

Note: Before you can configure and use ODBC with CData Connect Cloud, you must first connect a data source to your CData Connect Cloud account. See Connections for more information.

Installing the Driver

Follow these steps to download and install the driver:

  1. Open the Client Tools page of CData Connect Cloud.

  2. In the Dev Tools section, click ODBC.

  3. Download and run the setup file for your operating system.

  4. After installation, follow the steps for your platform below.

Creating a DSN

The following guides show how to use the standard tools to configure data source names (DSN). You will need to configure the DSN to use the driver.

Windows

Follow these steps to edit the DSN configuration using the Microsoft ODBC Data Source Administrator:

  1. Open the Start menu and enter ODBC Data Sources in the Search box.

  2. Choose the version of the ODBC Administrator that corresponds to your application (32-bit or 64-bit).

  3. Click the System DSN tab.

  4. Select Connect Sys and click Configure.

  5. For the Auth Scheme, select OAuth.

  6. In the Misc section, enter the connection name of the data source you want to access in the Default Catalog field (e.g., Salesforce1).

  7. Click Test Connection to open the CData Connect Cloud sign-in window in your web browser.

  8. If you are not already signed in, sign in to your CData Connect Cloud account.

  9. When the OAuth Authorization Successful message appears, close the web browser and return to the ODBC Administrator.

  10. Click OK on the success message, OK in the DSN Configuration window, then OK in the ODBC Data Source Administrator window.

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

macOS

Note: The ODBC Driver for CData Connect Cloud requires macOS Sierra (10.12) or above.

On macOS, the ODBC Driver for CData Connect Cloud is pre-configured for use with the iODBC driver manager. You can find the latest version of iODBC on the iODBC site.

Follow these steps to configure the driver:

  1. Install iODBC and ODBC Driver for the CData Connect Cloud.

  2. Launch the iODBC Data Source Administrator.

    • Under most circumstances, the driver should automatically appear in the System DSN tab of the iODBC Data Source Administrator. If it does, continue to Logging In.

    • If the driver does not appear automatically, follow the steps under Manually Adding the Driver.

Logging In

Follow the steps below to connect the driver to your CData Connect Cloud account:

  1. In the iODBC Data Source Administrator, click on the driver entry on the User DSN or System DSN tab to select it.

  2. Click Test.

  3. A login prompt appears. Leave the fields blank and click OK.

  4. The CData Connect Cloud OAuth login page opens in your default web browser. If you are not already logged in, enter your credentials and sign in.

  5. When the OAuth success page appears, close the window and return to iODBC.

  6. Click OK on the success message, and click OK to close the iODBC Data Source Administrator.

You can now use the configured connection in any tools or applications that support ODBC connectivity.

Manually Adding the Driver

If the ODBC Driver for CData Connect Cloud does not automatically appear in the iODBC Data Source Administrator, first check if you have existing ODBC configuration files called odbc.ini and odbcinst.ini.

  • User DSN files appear in /Users/[myuser]/Library/ODBC/.
  • System DSN files appear in /Library/ODBC/.

Files Do Not Exist
If the files do not already exist in either of the directories above, follow these steps:

  1. Navigate to the driver install directory. By default, this is /Applications/CData ODBC Driver for CData Connect/.

  2. Open the etc folder and copy the odbc.ini and odbcinst.ini files.

  3. Copy the files to either the User DSN or System DSN directory.
    • The User DSN directory is /Users/[myuser]/Library/ODBC/. If you choose this option, you can only access your connection for the user you install it for.
    • The System DSN directory is /Library/ODBC/. If you choose this option, you can access the connection for all users, but copying the files may prompt you for elevated permissions.

  4. Quit and re-launch the iODBC Data Source Administrator.

  5. Follow the steps for Logging in to complete setup.

Files Already Exist
If you already have ODBC configuration files in one of the directories above, follow these steps:

  1. Navigate to the driver install directory. By default, this is /Applications/CData ODBC Driver for CData Connect/.

  2. Open the etc folder and then open the odbc.ini file. Copy the contents to your clipboard.

  3. Open the existing odbc.ini file in the DSN directory.
    • If it is in the User DSN directory (/Users/[myuser]/Library/ODBC/), you can open the file directly through Finder.
    • If it is in the System DSN directory (/Library/ODBC/), you will need to open the file with elevated permissions. Open a Terminal window and enter sudo nano /Library/ODBC/odbc.ini, providing your password when prompted.

  4. Paste the contents of the odbc.ini file from the Driver installation directory into the bottom of the existing odbc.ini file in the DSN directory.

  5. Save your changes. If you are in a terminal window, use the key combination Control ^+O.

  6. Repeat steps 2 through 5 above for the odbcinst.ini file.

  7. Quit and re-launch the iODBC Data Source Administrator.

  8. Follow the steps for Logging in to complete setup.

Linux

Click here for documentation on configuring a DSN on Linux.

Connect to a Workspace

To connect the ODBC client to a specific workspace, you specify the workspace name in the Advanced tab of the ODBC driver for CData Connect Cloud.

More Information

To learn more information about using the ODBC Driver for CData Connect Cloud, click here.