Interface: DatabricksFileSystemOptions

Options for DatabricksFileSystem.

Properties

client?

optional client?: WorkspaceClient

Databricks workspace client. Defaults to tryGetWorkspaceClient(), otherwise a default WorkspaceClient from env / profile auth.

---

createRoot?

optional createRoot?: boolean

Create root (and parents) during init. Defaults to false (volume and workspace roots are usually provisioned out of band).

---

id?

optional id?: string

Unique identifier. Defaults to a stable hash of the normalized root.

---

readOnly?

optional readOnly?: boolean

Block all write operations. Defaults to false.

---

root

root: string

Filesystem root. Accepts:

• /Volumes/catalog/schema/volume (also /Volume/...)
• catalog.schema.volume
• ~ / ~/... → /Workspace/Users/<userName>/... (needs userName, or use DatabricksFileSystem.create)
• /Workspace/..., /Users/..., /Repos/..., /Shared/...
• /dbfs/...

---

userName?

optional userName?: string

Username for expanding ~. When omitted and root is home-relative, prefer DatabricksFileSystem.create which resolves it via getCurrentUserName.