wehub-resource-sync
bcbd1bdb22
Integ / changes (push) Has been skipped
Pre-commit / pre-commit (push) Failing after 1s
CLI exit codes / changes (push) Has been skipped
Test (Install) / changes (push) Has been skipped
Test (Python) / changes (push) Has been skipped
Test (TypeScript) / changes (push) Has been skipped
CLI exit codes / cli-gate (push) Has been cancelled
Test (Install) / test-install-gate (push) Has been cancelled
Integ / integ-gate (push) Has been cancelled
Test (Python) / test-python-gate (push) Has been cancelled
Test (TypeScript) / test-typescript-gate (push) Has been cancelled
Test (Install) / python-minimal (3.12) (push) Has been cancelled
Test (Install) / python-minimal (3.11) (push) Has been cancelled
Test (Install) / python-extra (agno, mirage.agents.agno) (push) Has been cancelled
Test (Install) / python-extra (chroma, mirage.resource.chroma) (push) Has been cancelled
Test (Install) / python-extra (pdf, mirage.core.filetype.pdf) (push) Has been cancelled
Integ / integ (push) Has been cancelled
Integ / integ-database (push) Has been cancelled
Integ / integ-database-ts (push) Has been cancelled
Integ / integ-data (push) Has been cancelled
Integ / integ-ssh (push) Has been cancelled
Integ / integ-ssh-ts (push) Has been cancelled
Test (Python) / audit (push) Has been cancelled
Test (TypeScript) / test (push) Has been cancelled
Test (TypeScript) / python-fs-shim (push) Has been cancelled
CLI exit codes / Python CLI (push) Has been cancelled
CLI exit codes / TypeScript CLI (push) Has been cancelled
CLI exit codes / Cross-language snapshot interop (push) Has been cancelled
Test (Python) / test (push) Has been cancelled
Test (Python) / import-isolation (deepagents, openai, mirage.agents.openai_agents) (push) Has been cancelled
Test (Python) / import-isolation (deepagents, pydantic-ai, mirage.agents.pydantic_ai) (push) Has been cancelled
Integ / integ-ts (push) Has been cancelled
Integ / integ-fuse (push) Has been cancelled
Test (Install) / python-extra (databricks, mirage.resource.databricks_volume) (push) Has been cancelled
Test (Install) / python-extra (deepagents, mirage.agents.langchain) (push) Has been cancelled
Test (Install) / python-extra (email, mirage.resource.email) (push) Has been cancelled
Test (Install) / python-extra (fuse, mirage.fuse.mount) (push) Has been cancelled
Test (Install) / python-extra (hdf5, mirage.core.filetype.hdf5) (push) Has been cancelled
Test (Install) / python-extra (hf, mirage.resource.hf_buckets) (push) Has been cancelled
Test (Install) / python-extra (lancedb, mirage.resource.lancedb) (push) Has been cancelled
Test (Install) / python-extra (langfuse, mirage.resource.langfuse) (push) Has been cancelled
Test (Install) / python-extra (mongodb, mirage.resource.mongodb) (push) Has been cancelled
Test (Install) / python-extra (nextcloud, mirage.resource.nextcloud) (push) Has been cancelled
Test (Install) / python-extra (openai, mirage.agents.openai_agents) (push) Has been cancelled
Test (Install) / python-extra (openhands, mirage.agents.openhands, 3.12) (push) Has been cancelled
Test (Install) / python-extra (parquet, mirage.core.filetype.parquet) (push) Has been cancelled
Test (Install) / python-extra (postgres, mirage.resource.postgres) (push) Has been cancelled
Test (Install) / python-extra (pydantic-ai, mirage.agents.pydantic_ai) (push) Has been cancelled
Test (Install) / python-extra (qdrant, mirage.resource.qdrant) (push) Has been cancelled
Test (Install) / python-extra (redis, mirage.resource.redis) (push) Has been cancelled
Test (Install) / python-extra (s3, mirage.resource.s3) (push) Has been cancelled
Test (Install) / python-extra (ssh, mirage.resource.ssh) (push) Has been cancelled
Test (Install) / ts-minimal (push) Has been cancelled
84 lines
2.1 KiB
Plaintext
84 lines
2.1 KiB
Plaintext
---
|
|
title: Databricks Volume
|
|
icon: folder-open
|
|
description: Set up the Databricks Unity Catalog volume resource in Python.
|
|
---
|
|
|
|
## Dependencies
|
|
|
|
```bash
|
|
uv add 'mirage-ai[databricks]'
|
|
```
|
|
|
|
For credential setup, see the [Databricks Volume Setup](/home/setup/databricks)
|
|
guide.
|
|
|
|
## Configuration
|
|
|
|
### Databricks Apps or SDK-default auth
|
|
|
|
```python
|
|
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
|
|
|
|
```python
|
|
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
|
|
|
|
```python
|
|
config = DatabricksVolumeConfig(
|
|
catalog="main",
|
|
schema="default",
|
|
volume="agent_files",
|
|
profile="DEV",
|
|
)
|
|
resource = DatabricksVolumeResource(config=config)
|
|
ws = Workspace({"/dbx/": resource}, mode=MountMode.READ)
|
|
```
|
|
|
|
## Config Reference
|
|
|
|
| Field | Required | Default | Description |
|
|
| --- | --- | --- | --- |
|
|
| `catalog` | Yes | | Unity Catalog catalog name. |
|
|
| `schema` | Yes | | Unity Catalog schema name. |
|
|
| `volume` | Yes | | Unity Catalog volume name. |
|
|
| `root_path` | No | `/` | Subdirectory inside the volume to expose. |
|
|
| `host` | No | | Databricks workspace host. |
|
|
| `token` | No | | Databricks personal access token. Redacted in snapshots. |
|
|
| `profile` | No | | Databricks SDK profile name. |
|
|
| `timeout` | No | `30` | Request timeout in seconds. |
|
|
|
|
## Notes
|
|
|
|
- Supports both read and write mount modes (`MountMode.READ` / `MountMode.WRITE`).
|
|
- Auth falls through to the Databricks SDK defaults when `host`, `token`, and `profile` are omitted.
|
|
- `root_path` is normalized and cannot contain `..`.
|