RunQL Databricks Connector
Optional Databricks connector for the RunQL VS Code extension. Install alongside RunQL to query Databricks SQL warehouses with RunQL's SQL workflows, results panel, schema introspection, and ERD tooling.
This extension is maintained separately so users who do not need Databricks are not required to install its SQL driver dependencies.
Installation
- Install RunQL (required, declared as an extension dependency).
- Install RunQL Databricks Connector from the VS Code Marketplace.
RunQL will detect the connector on activation and register Databricks as an available connection provider.
Usage
- Open the RunQL explorer view.
- Click Add Connection and choose Databricks.
- Enter your Databricks workspace host.
- Enter the SQL warehouse HTTP path.
- Optionally enter a Unity Catalog catalog and schema.
- On the Auth tab, enter a personal access token.
- Save and test the connection.
Requirements
- VS Code
^1.96.0
- RunQL extension
- A Databricks workspace with a SQL warehouse or cluster SQL endpoint
- A Databricks personal access token with access to the target warehouse and metadata
Authentication
The connector currently supports Databricks personal access token authentication.
How it works
On activation, this extension acquires the RunQL extension API and calls:
registerProvider(databricksProvider) to add Databricks to the connection form.registerAdapter('databricks', () => new DatabricksAdapter()) to wire the dialect to its implementation.
The adapter uses the @databricks/sql Node package. Schema introspection uses Databricks SQL metadata operations for catalogs, schemas, tables, and columns, plus best-effort Unity Catalog information_schema queries for keys, foreign keys, routines, and parameters where the workspace exposes that metadata.
Building from source
git clone https://github.com/DVCodeLabs/RunQL-Databricks.git
cd RunQL-Databricks
npm install
npm run package
To produce a local VSIX for testing:
npm install -g @vscode/vsce
vsce package
License
MIT, see LICENSE.
