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.1.tar.gz (35.8 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.1-py3-none-any.whl (38.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mongo_schematic-0.1.4.1.tar.gz
  • Upload date:
  • Size: 35.8 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.1.tar.gz
Algorithm Hash digest
SHA256 412f181523e3f18c3d28d5798ddabba61e3228fae5cfe95dff9e2f1c5fe30848
MD5 2669ec685d81a43920e0c8eb416bd43a
BLAKE2b-256 fca42daa961898a7d7297a27b2a09081e95a6195bd2553fb40ae1b9a81e38b86

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mongo_schematic-0.1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2b144946be97127d993b39341b108467911ffe5ca7044afc7a43d91f999c6bfc
MD5 0a21251a344338dfa58384c616539040
BLAKE2b-256 a0dd7cd827f896797a6047c548c05e4f43eb2c6bebe84f30d7c6685897b0be5e

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