Settings for the Databricks extension for Visual Studio Code

  • Article

This article lists extension settings for the Databricks extension for Visual Studio Code. See What is the Databricks extension for Visual Studio Code?

The Databricks extension for Visual Studio Code adds the following settings to Visual Studio Code. See also Settings editor and settings.json in the Visual Studio Code documentation.

Settings editor (Extensions > Databricks) settings.json Description
Clusters: Only Show Accessible Clusters databricks.clusters.onlyShowAccessibleClusters Checked or set to true to enable filtering for only those clusters that you can run code on. The default is unchecked or false (do not enable filtering for those clusters).
Experiments: Opt Into databricks.experiments.optInto Enables or disables experimental features for the extension. Available features include:

* views.cluster: Shows or hides the Clusters pane. See Select a cluster for the Databricks extension for Visual Studio Code.
* views.workspace: Shows or hides the Workspace Explorer pane. See Select a workspace directory for the Databricks extension for Visual Studio Code.
Logs: Enabled databricks.logs.enabled Checked or set to true (default) to enable logging. Reload your window for any change to take effect.
Logs: Max Array Length databricks.logs.maxArrayLength The maximum number of items to show for array fields. The default is 2.
Logs: Max Field Length databricks.logs.maxFieldLength The maximum length of each field displayed in the logs output panel. The default is 40.
Logs: Truncation Depth databricks.logs.truncationDepth The maximum depth of logs to show without truncation. The default is 2.
Override Databricks Config File databricks.overrideDatabricksConfigFile An alternate location for the .databrickscfg file that the extension uses for authentication.
Python: Env File databricks.python.envFile The absolute path to your custom Python environment variable definitions (.env) file.
Sync: Destination Type databricks.sync.destinationType Whether to use a directory in the workspace (workspace, default starting with version 0.3.15) or Git folders in the workspace (repo, default before version 0.3.15) as the sync destination.

Setting this to workspace displays the Workspace Explorer pane, which enables you to browse available sync destinations within the workspace. This behavior works only with workspaces that are enabled with the ability to create arbitrary files within the workspace, and the selected cluster must have Databricks Runtime 11.3 LTS or higher installed. See What are workspace files?.

Reload your window for any change to take effect.

See Using Git folders with Databricks extension for Visual Studio Code.