mongodb-odm 0.1.0a3

MongoDB-ODM, NOSQL databases in Python, designed for simplicity, compatibility, and robustness.

ODM

MongoDB-ODM, NOSQL databases in Python, designed for simplicity, compatibility, and robustness.

---

Introduction

The purpose of this module is to do provide easy access to the database with the python object feature with MongoDB and pymongo. With pymongo that was very easy to make spelling mistakes of a collection name when you are doing database operation. This module provides you minimal ODM with a modeling feature so that you don’t have to look up the MongoDB dashboard(Mongo Compass) to know about field names or data types.

MongoDb-ODM is based on Python type annotations, and powered by PyMongo and Pydantic.

The key features are:

• Intuitive to write: Great editor support. Completion everywhere. Less time debugging. Designed to be easy to use and learn. Less time reading docs.
• Easy to use: It has sensible defaults and does a lot of work underneath to simplify the code you write.
• Compatible: It is designed to be compatible with FastAPI, Pydantic, and PyMongo.
• Extensible: You have all the power of PyMongo and Pydantic underneath.
• Short: Minimize code duplication. A single type annotation does a lot of work. No need to duplicate models in PyMongo and Pydantic.

---

Requirement

MongoDb-ODM will work on Python 3.7 and above

This MongoDb-ODM is build top of PyMongo and Pydantic. Those package are required and will auto install while MongoDb-ODM was installed.

Example

Define model

from datetime import datetime
from pydantic import Field
from pymongo import IndexModel, ASCENDING
from typing import Optional

from mongodb_odm import Document


class User(Document):
    username: str = Field(...)
    email: Optional[str] = Field(default=None)
    full_name: str = Field(...)

    is_active: bool = True
    date_joined: datetime = Field(default_factory=datetime.utcnow)

    last_login: datetime = Field(default_factory=datetime.utcnow)
    password: Optional[str] = Field(default=None)
    image: Optional[str] = Field(default=None)

    created_at: datetime = Field(default_factory=datetime.utcnow)
    updated_at: datetime = Field(default_factory=datetime.utcnow)

    class Config:
        collection_name = "user"
        indexes = (
            IndexModel([("username", ASCENDING)], unique=True),
            IndexModel([("email", ASCENDING)]),
        )

Create Document

user = User(
    email="[e-mail]",
    full_name="Example Name",
    password="hash-password",
).create()

Retrive Document

• Filter data from collection

for user in find({"is_active": True}):
    print(user)

• Find first object with filter

user = User.find_first({"is_active": True})

Update Data

user = User.find_first({"is_active": True})
user.full_name = "New Name"

Delete Data

user = User.find_first({"is_active": True})
if user:
    user.delete()

Apply Indexes

from mongodb_odm import apply_indexes, ASCENDING, Document, IndexModel


class User(Document):
    ...

    class Config:
        indexes = (
            IndexModel([("username", ASCENDING)], unique=True),
            IndexModel([("email", ASCENDING)]),
        )

• To create indexes in database diclare IndexModel and assign in indexes array in Config class. IndexModel module that are directly imported from pymongo.
• Call apply_indexes function from your CLI. You can use Typer to implement CLI.