Asynchronous Python ODM for MongoDB
pip install beanie
📢 Important Update 📢
We are excited to announce that Beanie is transitioning from solo development to a team-based approach! This move will help us enhance the project with new features and more collaborative development.
At this moment we are establishing a board of members that will decide all the future steps of the project. We are looking for contributors and maintainers to join the board.
Join Us
If you are interested in contributing or want to stay updated, please join our Discord channel. We're looking forward to your ideas and contributions!
Let’s make Beanie better, together!
Overview
Beanie - is an asynchronous Python object-document mapper (ODM) for MongoDB. Data models are based on Pydantic.
When using Beanie each database collection has a corresponding Document that
is used to interact with that collection. In addition to retrieving data,
Beanie allows you to add, update, or delete documents from the collection as
well.
Beanie saves you time by removing boilerplate code, and it helps you focus on the parts of your app that actually matter.
Data and schema migrations are supported by Beanie out of the box.
There is a synchronous version of Beanie ODM - Bunnet
Installation
PIP
pip install beanie
Poetry
poetry add beanie
For more installation options (eg: aws, gcp, srv ...) you can look in the getting started
Example
import asyncio
from typing import Optional
from pymongo import AsyncMongoClient
from pydantic import BaseModel
from beanie import Document, Indexed, init_beanie
class Category(BaseModel):
name: str
description: str
class Product(Document):
name: str # You can use normal types just like in pydantic
description: Optional[str] = None
price: Indexed(float) # You can also specify that a field should correspond to an index
category: Category # You can include pydantic models as well
# This is an asynchronous example, so we will access it from an async function
async def example():
# Beanie uses PyMongo async client under the hood
client = AsyncMongoClient("mongodb://user:pass@host:27017")
# Initialize beanie with the Product document class
await init_beanie(database=client.db_name, document_models=[Product])
chocolate = Category(name="Chocolate", description="A preparation of roasted and ground cacao seeds.")
# Beanie documents work just like pydantic models
tonybar = Product(name="Tony's", price=5.95, category=chocolate)
# And can be inserted into the database
await tonybar.insert()
# You can find documents with pythonic syntax
product = await Product.find_one(Product.price < 10)
# And update them
await product.set({Product.name:"Gold bar"})
if __name__ == "__main__":
asyncio.run(example())
Links
Documentation
- Doc - Tutorial, API documentation, and development guidelines.
Example Projects
- Activity Log & Notification Service - Real-time event ingestion with FastAPI, Beanie ODM, and DocumentDB (MongoDB-compatible), an async backend for high-volume activity events with aggregation statistics and WebSocket alerts by Khelan Modi
- fastapi-beanie-jwt - Sample FastAPI server with JWT auth and Beanie ODM by Michael duPont
- fastapi-cosmos-beanie - FastAPI + Beanie ODM + Azure Cosmos Demo Application by Anthony Shaw
- LCCN Predictor - Leetcode contest rating predictor (FastAPI + Beanie ODM + React) by L. Bao
- Shortify - URL shortener RESTful API (FastAPI + Beanie ODM + JWT & OAuth2) by Iliya Hosseini
Articles
- Announcing Beanie - MongoDB ODM
- Build a Cocktail API with Beanie and MongoDB
- MongoDB indexes with Beanie
- Beanie Projections. Reducing network and database load.
- Beanie 1.0 - Query Builder
- Beanie 1.8 - Relations, Cache, Actions and more!
Resources
- GitHub - GitHub page of the project
- Changelog - list of all the valuable changes
- Discord - ask your questions, share
ideas or just say
Hello!!
Supported by JetBrains
