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.3.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.3-py3-none-any.whl (38.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mongo_schematic-0.1.4.3.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.3.tar.gz
Algorithm Hash digest
SHA256 9d602b89006d4510d7cca980e856f4d8cc5b4e4b1e54b745f63300b962ffbc1b
MD5 3beb2f2f0b099b690e7afd09fb81b67d
BLAKE2b-256 48cef266f0ce1100991662df3fedb8b42b854413e724570614dade068dced267

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mongo_schematic-0.1.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 877fbc0fd2b78254aad0d6f87f3f20347df395a5fa0e22e6b9d93b3787cbc7a2
MD5 47063ccf4ac87a79d69386d6891703ce
BLAKE2b-256 f7fff1f05867cbed306c5c44065dc677fa940ea745f298a4fa157b4552dffb30

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