Databricks ConnectorHT
A lightweight VS Code extension for connecting to Databricks workspaces — browse files, edit notebooks, and run cells on remote clusters.
Features
- Workspace Browser — Browse your Databricks workspace files and notebooks from the sidebar
- Notebook Editor — Open and edit Databricks notebooks natively in VS Code
- Remote Execution — Run notebook cells on remote Databricks clusters
- Multi-language Support — Python, SQL, Scala, R, and shell cells
- Magic Commands — Supports
%sql, %python, %scala, %r, %sh prefixes
- Secure Authentication — Personal Access Token stored securely in OS keychain
Getting Started
Prerequisites
- A Databricks workspace with a running cluster
- A Personal Access Token (PAT) from your Databricks workspace
Setup
- Install the extension from the VS Code Marketplace
- Click the Databricks icon in the Activity Bar (left sidebar)
- Run
Databricks: Login from the Command Palette (Cmd+Shift+P / Ctrl+Shift+P)
- Enter your Databricks host URL (e.g.,
https://adb-1234567890.azuredatabricks.net)
- Enter your Personal Access Token
Usage
- Browse Workspace — Use the Databricks sidebar to navigate your workspace files
- Open a Notebook — Click any notebook in the workspace tree to open it
- Select a Cluster — Run
Databricks: Select Cluster to pick a running cluster
- Run Cells — Click the run button on any cell to execute it on the remote cluster
- Save Back — Run
Databricks: Save Notebook to Workspace to save changes back
Supported Cell Languages
| Magic Command |
Language |
%python |
Python |
%sql |
SQL |
%scala |
Scala |
%r |
R |
%sh |
Shell |
Commands
| Command |
Description |
Databricks: Login |
Connect to a Databricks workspace |
Databricks: Logout |
Disconnect from the workspace |
Databricks: Select Cluster |
Choose a running cluster for execution |
Databricks: Open Notebook |
Open a notebook from the workspace |
Databricks: Save Notebook to Workspace |
Save the current notebook back to Databricks |
Databricks: Refresh |
Refresh the workspace tree |
How to Get a Personal Access Token
- Log in to your Databricks workspace
- Click your profile icon (top-right) → Settings
- Go to Developer → Access Tokens
- Click Generate New Token, add a comment, and set expiry
- Copy the token — you'll need it during login
Requirements
- VS Code 1.85 or later
- Network access to your Databricks workspace
License
MIT
| |