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.
  • Full BSON Support: All MongoDB types including binData, regex, long, timestamp, and union types.
  • 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.4.4.tar.gz (36.0 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.4.4-py3-none-any.whl (38.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mongo_schematic-0.1.4.4.tar.gz
  • Upload date:
  • Size: 36.0 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.4.4.tar.gz
Algorithm Hash digest
SHA256 033662f3f6937bdd5b4f626a04e7a0f156c8d04a7c8339e6d74817266bb35b90
MD5 cdb77ce61f2cac62db806cd670abe6df
BLAKE2b-256 65c32e776b864fa9ac652f7855c1bdc56d37853c40e6dc39051c03e91bae7f84

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mongo_schematic-0.1.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8fa2e9b4ae113e9848a62fcf447fc0f1217d0677fea3aa4ef5bad5ef55730477
MD5 a8c0ab4424f709c4efb3e52ad963a63a
BLAKE2b-256 82de644a054ab246020236721d704aeab55db77439b3843ca0d926332b97f6a1

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