Connect to Mode

This article describes how to use Mode with a Databricks cluster or a Databricks SQL warehouse (formerly Databricks SQL endpoint).

Requirements

Before you connect to Mode manually, you need the following:

  • A cluster or SQL warehouse in your Databricks workspace.

  • The connection details for your cluster or SQL warehouse, specifically the Server Hostname, Port, and HTTP Path values.

  • A Databricks personal access token. To create a personal access token, do the following:

    1. In your Databricks workspace, click your Databricks username in the top bar, and then select Settings from the drop down.

    2. Click Developer.

    3. Next to Access tokens, click Manage.

    4. Click Generate new token.

    5. (Optional) Enter a comment that helps you to identify this token in the future, and change the token’s default lifetime of 90 days. To create a token with no lifetime (not recommended), leave the Lifetime (days) box empty (blank).

    6. Click Generate.

    7. Copy the displayed token to a secure location, and then click Done.

    Note

    Be sure to save the copied token in a secure location. Do not share your copied token with others. If you lose the copied token, you cannot regenerate that exact same token. Instead, you must repeat this procedure to create a new token. If you lose the copied token, or you believe that the token has been compromised, Databricks strongly recommends that you immediately delete that token from your workspace by clicking the trash can (Revoke) icon next to the token on the Access tokens page.

    If you are not able to create or use tokens in your workspace, this might be because your workspace administrator has disabled tokens or has not given you permission to create or use tokens. See your workspace administrator or the following topics:

    Note

    As a security best practice when you authenticate with automated tools, systems, scripts, and apps, Databricks recommends that you use OAuth tokens.

    If you use personal access token authentication, Databricks recommends using personal access tokens belonging to service principals instead of workspace users. To create tokens for service principals, see Manage tokens for a service principal.

Connect to Mode manually

To connect to Mode manually, do the following:

  1. Sign in to Mode.

  2. Click Definitions > Data > Manage Connections > Connect a database.

  3. In the list labelled Or choose from a list of databases we support, choose Databricks.

  4. On the Enter your Databricks credentials page, enter the following information:

    1. For Host, enter the Server Hostname value from the requirements.

    2. For Port, enter the Port value from the requirements.

    3. For Database name, enter the name of the database that you want to use.

    4. For Token, enter the personal access token from the requirements.

    5. For HTTP Path, enter the HTTP Path value from the requirements.

  5. Click Connect.