Skip to main content

Asynchronous Python ODM for MongoDB

Project description

Beanie

shields badge pypi

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

Example

import asyncio
from typing import Optional

from motor.motor_asyncio import AsyncIOMotorClient
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 Motor async client under the hood 
    client = AsyncIOMotorClient("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

Articles

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

JetBrains

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

beanie-1.19.0.tar.gz (51.5 kB view details)

Uploaded Source

Built Distribution

beanie-1.19.0-py3-none-any.whl (75.9 kB view details)

Uploaded Python 3

File details

Details for the file beanie-1.19.0.tar.gz.

File metadata

  • Download URL: beanie-1.19.0.tar.gz
  • Upload date:
  • Size: 51.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.9 Linux/5.15.0-1036-azure

File hashes

Hashes for beanie-1.19.0.tar.gz
Algorithm Hash digest
SHA256 31a95a17b3059f232510279f09ebb1221c5fa5d71e28368752f600bc05a10046
MD5 2da996c276c5e19997ef837b72ada5c7
BLAKE2b-256 d1925e8977e2ff39bbd20902b302e3279d56ffe2884aa6a357098a58f6aee418

See more details on using hashes here.

File details

Details for the file beanie-1.19.0-py3-none-any.whl.

File metadata

  • Download URL: beanie-1.19.0-py3-none-any.whl
  • Upload date:
  • Size: 75.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.9 Linux/5.15.0-1036-azure

File hashes

Hashes for beanie-1.19.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b8f61c1e15eac43e0fe62b01d1b5f520b8f69ece5ca5b8672c0bfeb560ca873c
MD5 b3c487b9da162c449d2914e28eeedf0d
BLAKE2b-256 be8fccd7ec6d776c6c2c1d4c7b4fda4eae35850a5b695d5fbefdb1ddecdf7366

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page