Skip to main content

MongoSchematic CLI for MongoDB schema analysis, drift detection, and migrations

Project description

MongoSchematic CLI

MongoSchematic is a modern, developer-first tool for MongoDB schema management. It helps you infer schemas from existing data, detect drift, generate code, and handle migrations with confidence.

License Python MongoDB

Features

  • 🔍 Schema Inference: Automatically infer schemas from your MongoDB collections.
  • 🚨 Drift Detection: Detect when your data deviates from your schema/models.
  • 🛠️ Code Generation: Generate Pydantic models (Python) and TypeScript interfaces.
  • 📄 Documentation: Build static HTML documentation for your database.
  • 🎲 Data Seeding: Populate your database with realistic dummy data.
  • 🔄 Migrations: Generate and execute versioned migration scripts.
  • 🛡️ Validation: Validate documents against your defined schemas.
  • 🤖 AI-Powered: Optional Gemini AI integration for schema recommendations.

Installation

pip install mongo-schematic

Quick Start

1. Initialize

Generate a default configuration file:

mschema init

2. Analyze a Collection

Infer the schema from an existing collection and save it:

mschema analyze --collection users --save schemas/users.v1.yml

3. Generate Code

Create a Pydantic model for your application:

mschema generate models --schema schemas/users.v1.yml --type pydantic --out models/user.py

4. Detect Drift

Check if your live data matches your schema:

mschema drift detect --schema schemas/users.v1.yml --collection users

Documentation

For full usage details including database-wide commands, CI/CD integration, and migration workflows, see the Usage Guide.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mongo_schematic-0.1.0.tar.gz (30.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mongo_schematic-0.1.0-py3-none-any.whl (33.6 kB view details)

Uploaded Python 3

File details

Details for the file mongo_schematic-0.1.0.tar.gz.

File metadata

  • Download URL: mongo_schematic-0.1.0.tar.gz
  • Upload date:
  • Size: 30.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for mongo_schematic-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6cd1bacdbe5e07cb3c7220993f595117816874511230e9ff5b3c5b87b6d30ba0
MD5 b28bc0394163a724e5c9092031099ac9
BLAKE2b-256 9f982937284f9f29e87b6ec09f9e73c7d7d04c3844ebedf594b3e58ad4504b33

See more details on using hashes here.

File details

Details for the file mongo_schematic-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mongo_schematic-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b43c2a712547c11d0ffb38929e5ce1b7ebeb6943fb948f26d355cef58da8d829
MD5 717efc83622cd37f64bdc18ef7b56586
BLAKE2b-256 8f74a52cea662c5ae27e07fcb2905b28d0fae08e38f604f2deebf5e9249b871e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page