motormongo

Description	Badge
PyPI - Version
Downloads
PyPI License
GitHub Contributors
Code Coverage
Code Style
Documentation

motormongo is an Object Document Mapper (ODM) for MongoDB built on top of motor, the MongoDB recommended asynchronous Python driver for MongoDB Python applications, designed to work with Tornado or asyncio and enable non-blocking access to MongoDB.

Asynchronous operations in a backend system, built using FastAPI for example, enhances performance and scalability by enabling non-blocking, concurrent handling of multiple I/O requests, leading to more efficient use of server resources, by forcing the CPU usage on the backend server’s main thread to be maximized across concurrent requests. For more low-level details on the advantages of asynchronous motormongo over existing MongoDB ODMs, such as mongoengine see here.

The interface for instantiating Document classes follows similar logic to mongoengine, enabling ease-of-transition and migration from mongoengine to the asynchronous motormongo.

Installation

To install motormongo, you can use pip inside your virtual environment:

python -m pip install motormongo

Alternatively, to install motormongo into your poetry environment:

poetry add motormongo

• 1. Quickstart
  • 1.1. Create a motormongo client:
  • 1.2. Define a motormongo Document:
  • 1.3. Create a MongoDB document using the User class
  • 1.4. Validate user was created in your MongoDB collection
  • 1.5. Put all the code above into one file and run it
  • 1.6. Congratulations 🎉
• 2. Why use motormongo?
  • 2.1. Understanding the Efficiency of Asynchronous Operations
  • 2.2. Maximizing Performance with Multiple FastAPI Workers
• 3. motormongo Fields
  • 3.1. Defaults for all fields
  • 3.2. BinaryField
  • 3.3. BooleanField
  • 3.4. DateTimeField
  • 3.5. EmbeddedDocumentField
  • 3.6. EnumField
  • 3.7. FloatField
  • 3.8. GeoJSONField
  • 3.9. IntegerField
  • 3.10. ListField
  • 3.11. ReferenceField
  • 3.12. StringField
• 4. CRUD classmethods
  • 4.1. Operations
  • 4.2. Create
  • 4.3. Read
  • 4.4. Update
  • 4.5. Delete
  • 4.6. Mixed
• 5. Aggregation
• 6. CRUD instance methods
  • 6.1. Operations
  • 6.2. Delete
• 7. Polymorphism and Inheritance
  • 7.1. Base Model: Item
  • 7.2. Subclass Models
  • 7.3. Usage
  • 7.4. Polymorphic Behavior
• 8. Pooling Options & Configuration
  • 8.1. Configuration Parameters
  • 8.2. Example Configuration
• 9. FastAPI integration