Databricks SQL with DBine
How to connect DBine to Databricks SQL and what you can do once it's connected. This page is written from what the Databricks SQL driver says about itself, so it matches the version of DBine you download.
Connect
- In DBine, open New connection.
- Pick Databricks SQL in the list of engines.
- Fill in the fields below, press Test connection and then Save.
Default port: 443.
General
| Field | Description |
|---|---|
| Workspace required | Example: dbc-a1b2c3d4-e5f6.cloud.databricks.com |
| SQL warehouse required | The warehouse's HTTP path or just its ID. Example: /sql/1.0/warehouses/abcdef1234567890 |
| Authentication | Options: Personal access token, Service principal OAuth Default: Personal access token |
| Personal access token | Kept in the system keychain, never in DBine's files. Only with Authentication: Personal access token. |
| Client ID (service principal) | Only with Authentication: Service principal OAuth. |
| Client secret | Kept in the system keychain, never in DBine's files. Only with Authentication: Service principal OAuth. |
| Database | |
| Default schema | Example: default |
| Read-only | On or off. |
SSH tunnel. The connection can go through an SSH server, even through a chain of bastions, with a password, a private key or the SSH agent. The server's fingerprint is checked against known_hosts or confirmed the first time.
What the explorer shows
Under the connection: Catalogs, each with its schemas. Inside each one:
- Tables
- Views
- Materialized views
- Functions
Query editor
The editor uses SQL, with completion for the connection's objects. Statements and commands run against the database selected in the tab.
Ready-made templates for new objects:
- New view
- New materialized view
- New SQL function
- New Python function
Tools for Databricks SQL
Available
- Graphical execution plans
- Live query profiler
- Server monitor
- Sessions and running queries
- Cancel another session's query from the sessions list
- Index usage
- Create databases
- Drop databases
- Database properties
- Relations in the ER diagram
- Visual designer for new objects
- Rename objects
- Compare and sync schemas
- Native bulk load when migrating data
- Users and permissions
- Backups
Not available for Databricks SQL
- End a session
- Locks: who blocks whom
- Manual transactions (commit and rollback)
- Clone tables
Why a tool doesn't apply to an engine, and the details of each one, are in the engine support reference.
Generated from the Databricks SQL driver 0.1.10, which DBine downloads the first time you connect to Databricks SQL.