mongodb-schema 0.1.1

A Python SDK for exporting MongoDB schema metadata

mongodb-schema

A Python SDK for exporting MongoDB schema metadata without copying the actual data.

Installation

pip install mongodb-schema

Dependencies

Requirements.txt Setup

Update your requirements.txt to include:

pymongo>=4.10.1

Note: Do not include the standalone bson package as it conflicts with pymongo.

To regenerate requirements:

pip freeze > requirements.txt

To reinstall dependencies:

pip install --force-reinstall -r requirements.txt

BSON Troubleshooting

If you encounter BSON-related errors, run:

pip uninstall bson pymongo
pip install pymongo

Usage

Command Line Interface

mongodb-schema --uri mongodb://user:[e-mail]:27017/admin --databases test2,testIgnore --output schema.json

Python API

from mongodb-schema.exporter import MongoSchemaExporter

# Initialize the exporter with MongoDB connection details
exporter = MongoSchemaExporter(uri="mongodb://localhost:27017", database="test_db")

# Export the schema metadata for the specified database
result = exporter.export_schema(sample_size=10)

# Print the result
print(result)

Arguments

• --uri: MongoDB connection string
• --databases: Comma-separated list of databases to export
• --output: Output file path for schema (e.g., schema.json)

Example Output

Schema exported to schema.json

Permissions

Ensure your user has appropriate read permissions for the specified databases.