Workspace cluster requirements

To access a cluster, you must have Can Attach To permission.

If you connect to a terminated cluster and have Can Restart permission, the cluster is started.

SQL Analytics SQL endpoint requirements

To access a SQL endpoint, you must have Can Use permission.

If you connect to a stopped endpoint and have Can Use permission, the SQL endpoint is started.

Step 1: Download and install a JDBC or ODBC driver

For some BI tools you use a JDBC or ODBC driver to make a connection to Databricks compute resources.

1. Go to the Databricks JDBC or ODBC driver download page and download it. For ODBC, pick the right driver for your operating system.
2. Install the driver. For JDBC, a JAR is provided which does not require installation. For ODBC, an installation package is provided for your chosen platform.

Step 2: Collect JDBC or ODBC connection information

To configure a JDBC or ODBC driver, you must collect connection information from Databricks. Here are some of the parameters a JDBC or ODBC driver might require:

The following are usually specified in the httpPath for JDBC and the DSN conf for ODBC:

Get server hostname, port, HTTP path, and JDBC URL

The procedure for retrieving JDBC and ODBC parameters depends on whether you are using Databricks Workspace clusters and SQL Analytics SQL endpoints.

Workspace cluster

In the following URL, replace <personal-access-token> with the token you created in Username and password authentication. For example:

 

Copy

jdbc:spark://<server-hostname>:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/0/xxxx-xxxxxx-xxxxxxxx;AuthMech=3;UID=token;PWD=<personal-access-token>

SQL Analytics SQL endpoint

Replace <personal-access-token> with the token you created in Username and password authentication. For example:

 

Copy

jdbc:spark://<server-hostname>:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/0/xxxx-xxxxxx-xxxxxxxx;AuthMech=3;UID=token;PWD=<personal-access-token>

/etc/odbc.ini

1. Set the content of /etc/odbc.ini to:

   ini

   Copy

   [Databricks-Spark]
   Driver=Simba
   Server=<server-hostname>
   HOST=<server-hostname>
   PORT=<port>
   SparkServerType=3
   Schema=default
   ThriftTransport=2
   SSL=1
   AuthMech=3
   UID=token
   PWD=<personal-access-token>
   HTTPPath=<http-path>
   

2. Set <personal-access-token> to the token you retrieved in Username and password authentication.

3. Set the server, port, and HTTP parameters to the ones you retrieved in Get server hostname, port, HTTP path, and JDBC URL.

/etc/odbcinst.ini

Set the content of /etc/odbcinst.ini to:

ini

Copy

[ODBC Drivers]
Simba = Installed
[Simba Spark ODBC Driver 64-bit]
Driver = <driver-path>

Set <driver-path> according to the operating system you chose when you downloaded the driver in Step 1:

• MacOs /Library/simba/spark/lib/libsparkodbc_sbu.dylib
• Linux (64-bit) /opt/simba/spark/lib/64/libsparkodbc_sb64.so
• Linux (32-bit) /opt/simba/spark/lib/32/libsparkodbc_sb32.so

Configure paths of ODBC configuration files

Specify the paths of the two files in environment variables so that they can be used by the Driver Manager:

ini

Copy

export ODBCINI=/etc/odbc.ini
export ODBCSYSINI=/etc/odbcinst.ini
export SIMBASPARKINI=<simba-ini-path>/simba.sparkodbc.ini # (Contains the configuration for debugging the Simba driver)

where <simba-ini-path> is

• MacOS /Library/simba/spark/lib
• Linux (64-bit) /opt/simba/sparkodbc/lib/64
• Linux (32-bit) /opt/simba/sparkodbc/lib/32