1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
from abc import abstractmethod
from typing import Any, Dict, Optional, Type, TypeVar, Union, overload
from pydantic import BaseModel
from pymongo.asynchronous.client_session import AsyncClientSession
from beanie.odm.fields import ExpressionField
from beanie.odm.queries.aggregation import AggregationQuery
from beanie.odm.queries.find import FindMany
DocType = TypeVar("DocType", bound="AggregateInterface")
DocumentProjectionType = TypeVar("DocumentProjectionType", bound=BaseModel)
class AggregateInterface:
@classmethod
@abstractmethod
def find_all(cls) -> FindMany:
pass
@overload
@classmethod
def aggregate(
cls: Type[DocType],
aggregation_pipeline: list,
projection_model: None = None,
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
**pymongo_kwargs: Any,
) -> AggregationQuery[Dict[str, Any]]: ...
@overload
@classmethod
def aggregate(
cls: Type[DocType],
aggregation_pipeline: list,
projection_model: Type[DocumentProjectionType],
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
**pymongo_kwargs: Any,
) -> AggregationQuery[DocumentProjectionType]: ...
@classmethod
def aggregate(
cls: Type[DocType],
aggregation_pipeline: list,
projection_model: Optional[Type[DocumentProjectionType]] = None,
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
**pymongo_kwargs: Any,
) -> Union[
AggregationQuery[Dict[str, Any]],
AggregationQuery[DocumentProjectionType],
]:
"""
Aggregate over collection.
Returns [AggregationQuery](query.md#aggregationquery) query object
:param aggregation_pipeline: list - aggregation pipeline
:param projection_model: Type[BaseModel]
:param session: Optional[AsyncClientSession] - pymongo session.
:param ignore_cache: bool
:param **pymongo_kwargs: pymongo native parameters for aggregate operation
:return: [AggregationQuery](query.md#aggregationquery)
"""
return cls.find_all().aggregate(
aggregation_pipeline=aggregation_pipeline,
projection_model=projection_model,
session=session,
ignore_cache=ignore_cache,
**pymongo_kwargs,
)
@classmethod
async def sum(
cls,
field: Union[ExpressionField, float, int, str],
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
) -> Optional[float]:
"""
Sum of values of the given field over the entire collection.
Example:
```python
class Sample(Document):
price: int
sum_count = await Document.sum(Sample.price)
```
:param field: Union[ExpressionField, float, int, str]
:param session: Optional[AsyncClientSession] - pymongo session
:param ignore_cache: bool
:return: float - sum. None if there are no items.
"""
return await cls.find_all().sum(field, session, ignore_cache)
@classmethod
async def avg(
cls,
field: Union[ExpressionField, float, int, str],
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
) -> Optional[float]:
"""
Average of values of the given field over the entire collection.
Example:
```python
class Sample(Document):
price: int
avg_count = await Document.avg(Sample.price)
```
:param field: Union[ExpressionField, float, int, str]
:param session: Optional[AsyncClientSession] - pymongo session
:param ignore_cache: bool
:return: Optional[float] - avg. None if there are no items.
"""
return await cls.find_all().avg(field, session, ignore_cache)
@classmethod
async def max(
cls,
field: Union[ExpressionField, str, Any],
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
) -> Optional[Any]:
"""
Max of the values of the given field over the entire collection.
Example:
```python
class Sample(Document):
price: int
max_count = await Document.max(Sample.price)
```
:param field: Union[ExpressionField, str, Any]
:param session: Optional[AsyncClientSession] - pymongo session
:return: Any - max value. None if there are no items.
"""
return await cls.find_all().max(field, session, ignore_cache)
@classmethod
async def min(
cls,
field: Union[ExpressionField, str, Any],
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
) -> Optional[Any]:
"""
Min of the values of the given field over the entire collection.
Example:
```python
class Sample(Document):
price: int
min_count = await Document.min(Sample.price)
```
:param field: Union[ExpressionField, str, Any]
:param session: Optional[AsyncClientSession] - pymongo session
:return: Any - min value. None if there are no items.
"""
return await cls.find_all().min(field, session, ignore_cache)
|
