Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mirage.strukto.ai/llms.txt

Use this file to discover all available pages before exploring further.

Dependencies

uv add motor
The motor package provides async MongoDB driver support built on pymongo. For credential setup, see the MongoDB Setup guide.

Configuration

Mount all databases

import os
from mirage import Workspace, MountMode
from mirage.resource.mongodb import MongoDBConfig, MongoDBResource

config = MongoDBConfig(uri=os.environ["MONGODB_URI"])
resource = MongoDBResource(config=config)
ws = Workspace({"/mongodb/": resource}, mode=MountMode.READ)

Mount specific databases

config = MongoDBConfig(
    uri=os.environ["MONGODB_URI"],
    databases=["sample_mflix", "sample_analytics"],
)
resource = MongoDBResource(config=config)
ws = Workspace({"/mongodb/": resource}, mode=MountMode.READ)

Mount a single database (flat layout)

config = MongoDBConfig(
    uri=os.environ["MONGODB_URI"],
    databases=["sample_mflix"],
)
resource = MongoDBResource(config=config)
ws = Workspace({"/mongodb/": resource}, mode=MountMode.READ)

Config Reference

FieldRequiredDescription
uriYesMongoDB connection URI
databasesNoList of database names (omit to mount all)