Google
Cloud Platform
Amazon Web Services
Microsoft AzureWhat are workspace files?
A workspace file is any file in the Databricks workspace that is not a Databricks notebook. Workspace files can be any file type. Common examples include:
.pyfiles used in custom modules..mdfiles, such asREADME.md..csvor other small data files..txtfiles..whllibraries.Log files.
Workspace files include files formerly referred to as “Files in Repos.”
Important
Workspace files are enabled everywhere by default in Databricks Runtime version 11.2, but can be disabled by admins using the REST API. For production workloads, use Databricks Runtime 11.3 LTS or above. Contact your workspace administrator if you cannot access this functionality.
What you can do with workspace files
Databricks provides functionality similar to local development for many workspace file types, including a built-in file editor. Not all use cases for all file types are supported. For example, while you can include images in an imported directory or repository, you cannot embed images in notebooks.
You can create, edit, and manage access to workspace files using familiar patterns from notebook interactions. You can use relative paths for library imports from workspace files, similar to local development. For more details, see:
Init scripts stored in workspace files have special behavior. You can use workspace files to store and reference init scripts in any Databricks Runtime versions. See Store init scripts in workspace files.
Note
In Databricks Runtime 14.0 and above, the the default current working directory (CWD) for code executed locally is the directory containing the notebook or script being run. This is a change in behavior from Databricks Runtime 13.3 LTS and below. See What is the default current working directory?.
Limitations
A complete list of workspace files limitations is found in Workspace files limitations.
Enable workspace files
To enable support for non-notebook files in your Databricks workspace, call the /api/2.0/workspace-conf REST API from a notebook or other environment with access to your Databricks workspace. Workspace files are enabled by default.
To enable or re-enable support for non-notebook files in your Databricks workspace, call the /api/2.0/workspace-conf and get the value of the enableWorkspaceFileSystem key. If it is set to true, non-notebook files are already enabled for your workspace.
The following example demonstrates how you can call this API from a notebook to check if workspace files are disabled and if so, re-enable them. To disable workspace files, set enableWorkspaceFilesystem to false with the /api/2.0/workspace-conf API.
