Initialization

Bunnet uses PyMongo as database engine for sync cases. To initialize previously created documents, you should provide a PyMongo database instance and a list of your document models to the init_bunnet(...) function, as it is shown in the example:

from bunnet import init_bunnet, Document
from pymongo import MongoClient

class Sample(Document):
    name: str

def init():
    # Create PyMongo client
    client = MongoClient(
        "mongodb://user:pass@host:27017"
    )

    # Initialize bunnet with the Product document class and a database
    init_bunnet(database=client.db_name, document_models=[Sample])

This creates the collection (if necessary) and sets up any indexes that are defined.

init_bunnet supports not only a list of classes as the document_models argument, but also strings with dot-separated paths:

init_bunnet(
    database=client.db_name,
    document_models=[
        "app.models.DemoDocument",
    ],
)

Warning

init_bunnet supports the parameter named allow_index_dropping that will drop indexes from your collections. allow_index_dropping is by default set to False. If you set this to True, ensure that you are not managing your indexes in another manner. If you are, these will be deleted when setting allow_index_dropping=True.