cancel
Showing results for 
Search instead for 
Did you mean: 
Data Engineering
Join discussions on data engineering best practices, architectures, and optimization strategies within the Databricks Community. Exchange insights and solutions with fellow data engineers.
cancel
Showing results for 
Search instead for 
Did you mean: 

VSCode Integration for Data Science Analysts

Austin1
New Contributor

Probably not posting this in the right forum, but can't find a good fit.

This is a bit convuluted because we make things hard at work. I have access to a single LLM via VSCode (Amazon Q).  Since I can't use that within Databricks but I want my team to be able to use it, I'm trying to leverage asset bundles to find an "easy" way for people to both collaborate on notebooks AND use the LLM we have access into.

That said, there is nothing simple about using asset bundles compared to just loging into the databricks UI and opening a workspace folder and doing work. But I feel like I'm close enough that it's worth asking. So we have IT configured shared "workspace folder" with my team (a databricks group of 120 people). I'd like people to be able to open the workspace folder in VSCode and see the notebooks/templates stored there. 

What I'm running into is the docs seem to only like if the extension created the folder and it only creates folders in your user space and not in this shared collaborative folder. The closest documentation i've found is this page: https://docs.databricks.com/en/dev-tools/vscode-ext/configure.html#workspace-folder

But its pretty specific in that you cannot do what I'm trying to do, I think.

The Databricks extension for Visual Studio Code works only with workspace directories that it creates. You cannot use an existing workspace directory in your project unless it was created by the extension.

So that's why I'm here - am I wasting my time? I made a test project with the vs code tools and it created a ton of artifacts in the project folder. I was going to maybe manually modify those and put them in this shared workspace folder, but feel like I might be wasting my time and why I'm here asking before I start trying stuff.

1 REPLY 1

mark_ott
Databricks Employee
Databricks Employee

It’s a smart move to raise this question before investing lots of time—because with the Databricks VSCode extension, there are indeed specific limitations when it comes to accessing shared workspace folders that weren't originally created by the extension.

Core Limitation: VSCode Extension Folder Access

According to Databricks' own documentation, the VSCode extension only supports workspace folders it creates itself. Existing shared workspace folders or directories—especially those created directly in the Databricks UI or by IT for collaboration—are currently not supported for direct access/editing through the extension. The extension enforces this restriction for compatibility and stability reasons, and there’s no officially documented workaround for "adopting" a pre-existing shared folder into the VSCode workflow.

What Happens If You Try to Bypass?

  • Manual artifact modification (trying to mimic what the extension does by copying project scaffolding/artifacts into your shared workspace folder) generally won't work. The extension expects to manage the workspace's metadata and structure itself, which means "hacking" it is likely to result in sync issues or errors.

  • This could introduce inconsistency, data loss, or break future extension compatibility.

  • The overwhelming consensus in user forums and the official documentation is that, at the moment, you cannot use the extension to collaboratively edit shared workspace folders unless they originate from the extension itself.

Potential Workarounds

While there isn’t a perfect out-of-the-box solution, here are your practical options:

1. Clone/Sync Notebooks Locally

  • One approach is to export notebooks from the shared folder via the Databricks UI to your local machine.

  • Then, work on them in VSCode with the Databricks extension (in a project folder it creates).

  • Later, manually or via script, re-import updated notebooks back into the shared workspace folder in Databricks.

  • This isn't seamless but is safe and officially supported.

2. Use Git Repos as a Mediator

  • Set up a Git repo (e.g., on GitHub or an internal Git service) to hold your notebook templates and assets.

  • Colleagues use VSCode’s Git integration to collaborate on notebooks. Changes can be merged and tracked outside of the Databricks workspace.

  • Periodically, push changes to the Databricks workspace—for example, with a scheduled notebook/script, or via direct import.

3. Wait for Feature Support/Submit Feedback

  • If collaborative workspace folder access via VSCode is essential, consider submitting feedback to Databricks; the product team is known to prioritize highly requested features.

Summary Table

Approach Pros Cons
Use extension-created folders only Seamless VSCode/extension support No direct shared folder collaboration
Manual copy/export/import Works within existing restrictions Manual, clunky, risk of overwrites
Git-mediated workflow Industry-standard collaboration, audit trail Requires extra setup, learning curve
Wait/submit feedback Could influence future extension capabilities No timeline guarantee
 
 

Final Verdict

You are not wasting your time by exploring, but you are likely to hit an immovable wall trying to force the extension to operate outside its intended scope. The safest productivity boost, in your case, is to use the Git-integrated workflow for now, and to monitor Databricks' roadmap for more collaborative VSCode extension support for shared folders in the future.