Create an ODBC DSN for the Databricks ODBC Driver

This article describes how to create an ODBC Data Source Name (DSN) for the Databricks ODBC Driver.

Create your DSN as follows, depending on your operating system.

• Create an ODBC DSN with Windows

• Create an ODBC DSN with macOS

• Create an ODBC DSN with Linux

Create an ODBC DSN with Windows

1. From the Start menu, search for ODBC Data Sources to launch the ODBC Data Source Administrator.

2. Click the Drivers tab to verify that the ODBC Driver (Simba Spark ODBC Driver) is installed.

3. Click the User DSN or System DSN tab and then click the Add button.

4. Select Simba Spark ODBC Driver from the list of installed drivers and then click Finish.

5. Enter some name for the DSN and set the configuration settings for your target Databricks connection.

6. Click OK to finish creating the DSN.

To use your DSN with your target app, tool, client, SDK, or API, see Technology partners or your provider’s documentation.

Create an ODBC DSN with macOS

1. Install ODBC Manager for macOS in one of the following ways:

   • Install ODBC Manager by using Homebrew

   • Download ODBC Manager and then double-click on the downloaded .dmg file to install it.

2. Start ODBC Manager.

3. Click the Drivers tab to verify that the ODBC driver (Simba Spark ODBC Driver) is installed.

4. Click the User DSN or System DSN tab and then click the Add button.

5. Select Simba Spark ODBC Driver from the list of installed drivers and then click OK.

6. Enter some name for the DSN and set the configuration settings for your target Databricks connection.

7. Click OK to finish creating the DSN.

To use your DSN with your target app, tool, client, SDK, or API, see Technology partners or your provider’s documentation.

Create an ODBC DSN with Linux

1. Install unixODBC.

2. Locate the odbc.ini driver configuration file that corresponds to SYSTEM DATA SOURCES:

   odbcinst -j
   

3. In a text editor, open the odbc.ini configuration file.

4. Create an [ODBC Data Sources] section:

   [ODBC Data Sources]
   Databricks=Databricks ODBC Connector
   

5. Create another section with the same name as your DSN as follows:

   [Databricks]
   Driver=<path-to-driver>
   Host=<server-hostname>
   Port=443
   HTTPPath=<http-path>
   SSL=1
   ThriftTransport=2
   <setting1>=<value1>
   <setting2>=<value2>
   <settingN>=<valueN>
   

   • To get the value for <path-to-driver>, see Download and install the Databricks ODBC Driver.

   • To get the values for <server-hostname> and <http-path>, see Compute settings for the Databricks ODBC Driver.

   • <setting>=<value> is one or more pairs of authentication settings and any special or advanced driver capability settings for your target Databricks connection.

To use your DSN with your target app, tool, client, SDK, or API, see Technology partners or your provider’s documentation.