Skip to main content

​
Dependencies

uv add 'mirage-ai[databricks]'
For credential setup, see the Databricks Volume Setup guide.

​
Configuration

​
Databricks Apps or SDK-default auth

from mirage import Workspace, MountMode
from mirage.resource.databricks_volume import (
    DatabricksVolumeConfig,
    DatabricksVolumeResource,
)

config = DatabricksVolumeConfig(
    catalog="main",
    schema="default",
    volume="agent_files",
)
resource = DatabricksVolumeResource(config=config)
ws = Workspace({"/dbx/": resource}, mode=MountMode.READ)

​
Explicit host and token

import os

config = DatabricksVolumeConfig(
    catalog="main",
    schema="default",
    volume="agent_files",
    host=os.environ["DATABRICKS_HOST"],
    token=os.environ["DATABRICKS_TOKEN"],
    root_path="/reports",
)
resource = DatabricksVolumeResource(config=config)
ws = Workspace({"/dbx/": resource}, mode=MountMode.READ)

​
Profile-based auth

config = DatabricksVolumeConfig(
    catalog="main",
    schema="default",
    volume="agent_files",
    profile="DEV",
)
resource = DatabricksVolumeResource(config=config)
ws = Workspace({"/dbx/": resource}, mode=MountMode.READ)

​
Config Reference

FieldRequiredDefaultDescription
catalogYesUnity Catalog catalog name.
schemaYesUnity Catalog schema name.
volumeYesUnity Catalog volume name.
root_pathNo/Subdirectory inside the volume to expose.
hostNoDatabricks workspace host.
tokenNoDatabricks personal access token. Redacted in snapshots.
profileNoDatabricks SDK profile name.
timeoutNo30Request timeout in seconds.

​
Notes

  • The resource is read-only in this branch.
  • Auth falls through to the Databricks SDK defaults when host, token, and profile are omitted.
  • root_path is normalized and cannot contain ...