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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
|
from abc import abstractmethod
from enum import Enum
from typing import (
TYPE_CHECKING,
Any,
Callable,
Dict,
Generator,
List,
Mapping,
Optional,
Type,
Union,
)
from pymongo import ReturnDocument
from pymongo import UpdateMany as UpdateManyPyMongo
from pymongo import UpdateOne as UpdateOnePyMongo
from pymongo.asynchronous.client_session import AsyncClientSession
from pymongo.results import InsertOneResult, UpdateResult
from beanie.odm.bulk import BulkWriter
from beanie.odm.interfaces.clone import CloneInterface
from beanie.odm.interfaces.session import SessionMethods
from beanie.odm.interfaces.update import (
UpdateMethods,
)
from beanie.odm.operators.update import BaseUpdateOperator
from beanie.odm.operators.update.general import SetRevisionId
from beanie.odm.utils.encoder import Encoder
from beanie.odm.utils.parsing import parse_obj
if TYPE_CHECKING:
from beanie.odm.documents import DocType
class UpdateResponse(str, Enum):
UPDATE_RESULT = "UPDATE_RESULT" # PyMongo update result
OLD_DOCUMENT = "OLD_DOCUMENT" # Original document
NEW_DOCUMENT = "NEW_DOCUMENT" # Updated document
class UpdateQuery(UpdateMethods, SessionMethods, CloneInterface):
"""
Update Query base class
"""
def __init__(
self,
document_model: Type["DocType"],
find_query: Mapping[str, Any],
):
self.document_model = document_model
self.find_query = find_query
self.update_expressions: List[Mapping[str, Any]] = []
self.session = None
self.is_upsert = False
self.upsert_insert_doc: Optional["DocType"] = None
self.encoders: Dict[Any, Callable[[Any], Any]] = {}
self.bulk_writer: Optional[BulkWriter] = None
self.encoders = self.document_model.get_settings().bson_encoders
self.pymongo_kwargs: Dict[str, Any] = {}
@property
def update_query(self) -> Dict[str, Any]:
query: Union[Dict[str, Any], List[Dict[str, Any]], None] = None
for expression in self.update_expressions:
if isinstance(expression, BaseUpdateOperator):
if query is None:
query = {}
if isinstance(query, list):
raise TypeError("Wrong expression type")
query.update(expression.query)
elif isinstance(expression, dict):
if query is None:
query = {}
if isinstance(query, list):
raise TypeError("Wrong expression type")
query.update(expression)
elif isinstance(expression, SetRevisionId):
if query is None:
query = {}
if isinstance(query, list):
raise TypeError("Wrong expression type")
set_query = query.get("$set", {})
set_query.update(expression.query.get("$set", {}))
query["$set"] = set_query
elif isinstance(expression, list):
if query is None:
query = []
if isinstance(query, dict):
raise TypeError("Wrong expression type")
query.extend(expression)
else:
raise TypeError("Wrong expression type")
return Encoder(custom_encoders=self.encoders).encode(query)
@abstractmethod
async def _update(self) -> UpdateResult: ...
class UpdateMany(UpdateQuery):
"""
Update Many query class
"""
def update(
self,
*args: Mapping[str, Any],
session: Optional[AsyncClientSession] = None,
bulk_writer: Optional[BulkWriter] = None,
**pymongo_kwargs: Any,
) -> "UpdateQuery":
"""
Provide modifications to the update query.
:param args: *Union[dict, Mapping] - the modifications to apply.
:param session: Optional[AsyncClientSession] - pymongo session
:param bulk_writer: Optional[BulkWriter]
:param pymongo_kwargs: pymongo native parameters for update operation
:return: UpdateMany query
"""
self.set_session(session=session)
self.update_expressions += args
if bulk_writer:
self.bulk_writer = bulk_writer
self.pymongo_kwargs.update(pymongo_kwargs)
return self
def upsert(
self,
*args: Mapping[str, Any],
on_insert: "DocType",
session: Optional[AsyncClientSession] = None,
**pymongo_kwargs: Any,
) -> "UpdateQuery":
"""
Provide modifications to the upsert query.
:param args: *Union[dict, Mapping] - the modifications to apply.
:param on_insert: DocType - document to insert if there is no matched
document in the collection
:param session: Optional[AsyncClientSession] - pymongo session
:param **pymongo_kwargs: pymongo native parameters for update operation
:return: UpdateMany query
"""
self.upsert_insert_doc = on_insert # type: ignore
self.update(*args, session=session, **pymongo_kwargs)
return self
def update_many(
self,
*args: Mapping[str, Any],
session: Optional[AsyncClientSession] = None,
bulk_writer: Optional[BulkWriter] = None,
**pymongo_kwargs: Any,
):
"""
Provide modifications to the update query
:param args: *Union[dict, Mapping] - the modifications to apply.
:param session: Optional[AsyncClientSession] - pymongo session
:param bulk_writer: "BulkWriter" - Beanie bulk writer
:param pymongo_kwargs: pymongo native parameters for update operation
:return: UpdateMany query
"""
return self.update(
*args, session=session, bulk_writer=bulk_writer, **pymongo_kwargs
)
async def _update(self):
if self.bulk_writer is None:
return (
await self.document_model.get_pymongo_collection().update_many(
self.find_query,
self.update_query,
session=self.session,
**self.pymongo_kwargs,
)
)
else:
self.bulk_writer.add_operation(
self.document_model,
UpdateManyPyMongo(
self.find_query, self.update_query, **self.pymongo_kwargs
),
)
def __await__(
self,
) -> Generator[
Any, None, Union[UpdateResult, InsertOneResult, Optional["DocType"]]
]:
"""
Run the query
:return:
"""
update_result = yield from self._update().__await__()
if self.upsert_insert_doc is None:
return update_result
if update_result is not None and update_result.matched_count == 0:
return (
yield from self.document_model.insert_one(
document=self.upsert_insert_doc,
session=self.session,
bulk_writer=self.bulk_writer,
).__await__()
)
return update_result
class UpdateOne(UpdateQuery):
"""
Update One query class
"""
def __init__(self, *args: Any, **kwargs: Any):
super(UpdateOne, self).__init__(*args, **kwargs)
self.response_type = UpdateResponse.UPDATE_RESULT
def update(
self,
*args: Mapping[str, Any],
session: Optional[AsyncClientSession] = None,
bulk_writer: Optional[BulkWriter] = None,
response_type: Optional[UpdateResponse] = None,
**pymongo_kwargs: Any,
) -> "UpdateQuery":
"""
Provide modifications to the update query.
:param args: *Union[dict, Mapping] - the modifications to apply.
:param session: Optional[AsyncClientSession] - pymongo session
:param bulk_writer: Optional[BulkWriter]
:param response_type: UpdateResponse
:param pymongo_kwargs: pymongo native parameters for update operation
:return: UpdateMany query
"""
self.set_session(session=session)
self.update_expressions += args
if response_type is not None:
self.response_type = response_type
if bulk_writer:
self.bulk_writer = bulk_writer
self.pymongo_kwargs.update(pymongo_kwargs)
return self
def upsert(
self,
*args: Mapping[str, Any],
on_insert: "DocType",
session: Optional[AsyncClientSession] = None,
response_type: Optional[UpdateResponse] = None,
**pymongo_kwargs: Any,
) -> "UpdateQuery":
"""
Provide modifications to the upsert query.
:param args: *Union[dict, Mapping] - the modifications to apply.
:param on_insert: DocType - document to insert if there is no matched
document in the collection
:param session: Optional[AsyncClientSession] - pymongo session
:param response_type: Optional[UpdateResponse]
:param pymongo_kwargs: pymongo native parameters for update operation
:return: UpdateMany query
"""
self.upsert_insert_doc = on_insert # type: ignore
self.update(
*args,
response_type=response_type,
session=session,
**pymongo_kwargs,
)
return self
def update_one(
self,
*args: Mapping[str, Any],
session: Optional[AsyncClientSession] = None,
bulk_writer: Optional[BulkWriter] = None,
response_type: Optional[UpdateResponse] = None,
**pymongo_kwargs: Any,
):
"""
Provide modifications to the update query. The same as `update()`
:param args: *Union[dict, Mapping] - the modifications to apply.
:param session: Optional[AsyncClientSession] - pymongo session
:param bulk_writer: "BulkWriter" - Beanie bulk writer
:param response_type: Optional[UpdateResponse]
:param pymongo_kwargs: pymongo native parameters for update operation
:return: UpdateMany query
"""
return self.update(
*args,
session=session,
bulk_writer=bulk_writer,
response_type=response_type,
**pymongo_kwargs,
)
async def _update(self):
if not self.bulk_writer:
if self.response_type == UpdateResponse.UPDATE_RESULT:
return await self.document_model.get_pymongo_collection().update_one(
self.find_query,
self.update_query,
session=self.session,
**self.pymongo_kwargs,
)
else:
result = await self.document_model.get_pymongo_collection().find_one_and_update(
self.find_query,
self.update_query,
session=self.session,
return_document=(
ReturnDocument.BEFORE
if self.response_type == UpdateResponse.OLD_DOCUMENT
else ReturnDocument.AFTER
),
**self.pymongo_kwargs,
)
if result is not None:
result = parse_obj(self.document_model, result)
return result
else:
self.bulk_writer.add_operation(
self.document_model,
UpdateOnePyMongo(
self.find_query, self.update_query, **self.pymongo_kwargs
),
)
def __await__(
self,
) -> Generator[
Any, None, Union[UpdateResult, InsertOneResult, Optional["DocType"]]
]:
"""
Run the query
:return:
"""
update_result = yield from self._update().__await__()
if self.upsert_insert_doc is None:
return update_result
if (
self.response_type == UpdateResponse.UPDATE_RESULT
and update_result is not None
and update_result.matched_count == 0
) or (
self.response_type != UpdateResponse.UPDATE_RESULT
and update_result is None
):
return (
yield from self.document_model.insert_one(
document=self.upsert_insert_doc,
session=self.session,
bulk_writer=self.bulk_writer,
).__await__()
)
return update_result
|
