interfaces.md

beanie.odm.interfaces.update

UpdateMethods Objects

class UpdateMethods()

Update methods

set

 | set(expression: Dict[Union[ExpressionField, str], Any], session: Optional[ClientSession] = None)

Set values

Example:

class Sample(Document):
    one: int

await Document.find(Sample.one == 1).set({Sample.one: 100})

Uses Set operator

Arguments:

• expression: Dict[Union[ExpressionField, str], Any] - keys and values to set
• session: Optional[ClientSession] - pymongo session

Returns:

self

current_date

 | current_date(expression: Dict[Union[ExpressionField, str], Any], session: Optional[ClientSession] = None)

Set current date

Uses CurrentDate operator

Arguments:

• expression: Dict[Union[ExpressionField, str], Any]
• session: Optional[ClientSession] - pymongo session

Returns:

self

inc

 | inc(expression: Dict[Union[ExpressionField, str], Any], session: Optional[ClientSession] = None)

Increment

Example:

class Sample(Document):
    one: int

await Document.find(Sample.one == 1).inc({Sample.one: 100})

Uses Inc operator

Arguments:

• expression: Dict[Union[ExpressionField, str], Any]
• session: Optional[ClientSession] - pymongo session

Returns:

self

beanie.odm.interfaces.aggregate

AggregateMethods Objects

class AggregateMethods()

Aggregate methods

sum

 | async sum(field: Union[str, ExpressionField], session: Optional[ClientSession] = None) -> float

Sum of values of the given field

Example:

class Sample(Document):
    price: int
    count: int

sum_count = await Document.find(Sample.price <= 100).sum(Sample.count)

Arguments:

• field: Union[str, ExpressionField]
• session: Optional[ClientSession] - pymongo session

Returns:

float - sum

avg

 | async avg(field, session: Optional[ClientSession] = None) -> float

Average of values of the given field

Example:

class Sample(Document):
    price: int
    count: int

avg_count = await Document.find(Sample.price <= 100).avg(Sample.count)

Arguments:

• field: Union[str, ExpressionField]
• session: Optional[ClientSession] - pymongo session

Returns:

float - avg

max

 | async max(field: Union[str, ExpressionField], session: Optional[ClientSession] = None) -> Any

Max of the values of the given field

Example:

class Sample(Document):
    price: int
    count: int

max_count = await Document.find(Sample.price <= 100).max(Sample.count)

Arguments:

• field: Union[str, ExpressionField]
• session: Optional[ClientSession] - pymongo session

Returns:

float - max

min

 | async min(field: Union[str, ExpressionField], session: Optional[ClientSession] = None) -> Any

Min of the values of the given field

Example:

class Sample(Document):
    price: int
    count: int

min_count = await Document.find(Sample.price <= 100).min(Sample.count)

Arguments:

• field: Union[str, ExpressionField]
• session: Optional[ClientSession] - pymongo session

Returns:

float - max

beanie.odm.interfaces.session

SessionMethods Objects

class SessionMethods()

Session methods

set_session

 | set_session(session: Optional[ClientSession] = None)

Set pymongo session

Arguments:

• session: Optional[ClientSession] - pymongo session

Returns: