forked from tortoise/tortoise-orm
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathqueryset.py
More file actions
1989 lines (1723 loc) · 72.4 KB
/
queryset.py
File metadata and controls
1989 lines (1723 loc) · 72.4 KB
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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from __future__ import annotations
import types
from collections.abc import AsyncIterator, Callable, Collection, Generator, Iterable
from copy import copy
from typing import TYPE_CHECKING, Any, Generic, Optional, TypeVar, cast, overload
from pypika_tortoise import JoinType, Order, Table
from pypika_tortoise.analytics import Count
from pypika_tortoise.functions import Cast
from pypika_tortoise.queries import QueryBuilder
from pypika_tortoise.terms import Case, Field, Star, Term, ValueWrapper
from typing_extensions import Literal, Protocol
from tortoise.backends.base.client import BaseDBAsyncClient, Capabilities
from tortoise.exceptions import (
DoesNotExist,
FieldError,
IntegrityError,
MultipleObjectsReturned,
ParamsError,
)
from tortoise.expressions import Expression, Q, RawSQL, ResolveContext, ResolveResult
from tortoise.fields.relational import (
ForeignKeyFieldInstance,
OneToOneFieldInstance,
RelationalField,
)
from tortoise.filters import FilterInfoDict
from tortoise.query_utils import (
Prefetch,
QueryModifier,
TableCriterionTuple,
get_joins_for_related_field,
)
from tortoise.router import router
from tortoise.utils import chunk
# Empty placeholder - Should never be edited.
QUERY: QueryBuilder = QueryBuilder()
if TYPE_CHECKING: # pragma: nocoverage
from tortoise.models import Model
MODEL = TypeVar("MODEL", bound="Model")
T_co = TypeVar("T_co", covariant=True)
SINGLE = TypeVar("SINGLE", bound=bool)
class QuerySetSingle(Protocol[T_co]):
"""
Awaiting on this will resolve a single instance of the Model object, and not a sequence.
"""
# pylint: disable=W0104
def __await__(self) -> Generator[Any, None, T_co]: ... # pragma: nocoverage
def prefetch_related(
self, *args: str | Prefetch
) -> QuerySetSingle[T_co]: ... # pragma: nocoverage
def select_related(self, *args: str) -> QuerySetSingle[T_co]: ... # pragma: nocoverage
def annotate(
self, **kwargs: Expression | Term
) -> QuerySetSingle[T_co]: ... # pragma: nocoverage
def only(self, *fields_for_select: str) -> QuerySetSingle[T_co]: ... # pragma: nocoverage
def values_list(
self, *fields_: str, flat: bool = False
) -> ValuesListQuery[Literal[True]]: ... # pragma: nocoverage
def values(
self, *args: str, **kwargs: str
) -> ValuesQuery[Literal[True]]: ... # pragma: nocoverage
class AwaitableQuery(Generic[MODEL]):
__slots__ = (
"query",
"model",
"_joined_tables",
"_db",
"capabilities",
"_annotations",
"_custom_filters",
"_q_objects",
)
def __init__(self, model: type[MODEL]) -> None:
self._joined_tables: list[Table] = []
self.model: type[MODEL] = model
self.query: QueryBuilder = QUERY
self._db: BaseDBAsyncClient = None # type: ignore
self.capabilities: Capabilities = model._meta.db.capabilities
self._annotations: dict[str, Expression | Term] = {}
self._custom_filters: dict[str, FilterInfoDict] = {}
self._q_objects: list[Q] = []
def _choose_db(self, for_write: bool = False) -> BaseDBAsyncClient:
"""
Return the connection that will be used if this query is executed now.
:return: BaseDBAsyncClient:
"""
if self._db:
return self._db
if for_write:
db = router.db_for_write(self.model)
else:
db = router.db_for_read(self.model)
return db or self.model._meta.db
def _choose_db_if_not_chosen(self, for_write: bool = False) -> None:
if self._db is None:
self._db = self._choose_db(for_write) # type: ignore
def resolve_filters(self) -> None:
"""Builds the common filters for a QuerySet."""
has_aggregate = self._resolve_annotate()
modifier = QueryModifier()
for node in self._q_objects:
modifier &= node.resolve(
ResolveContext(
model=self.model,
table=self.model._meta.basetable,
annotations=self._annotations,
custom_filters=self._custom_filters,
)
)
for join in modifier.joins:
if join[0] not in self._joined_tables:
self.query = self.query.join(join[0], how=JoinType.left_outer).on(join[1])
self._joined_tables.append(join[0])
self.query._havings = modifier.having_criterion
self.query._wheres = modifier.where_criterion
if has_aggregate and (self._joined_tables or self.query._havings or self.query._orderbys):
self.query = self.query.groupby(
*[self.model._meta.basetable[field] for field in self.model._meta.db_fields]
)
def _join_table_by_field(
self, table: Table, related_field_name: str, related_field: RelationalField
) -> Table:
joins = get_joins_for_related_field(table, related_field, related_field_name)
for join in joins:
self._join_table(join)
return joins[-1][0]
def _join_table(self, table_criterio_tuple: TableCriterionTuple) -> None:
if table_criterio_tuple[0] not in self._joined_tables:
self.query = self.query.join(table_criterio_tuple[0], how=JoinType.left_outer).on(
table_criterio_tuple[1]
)
self._joined_tables.append(table_criterio_tuple[0])
@staticmethod
def _resolve_ordering_string(ordering: str, reverse: bool = False) -> tuple[str, Order]:
order_type = Order.asc
if ordering[0] == "-":
field_name = ordering[1:]
order_type = Order.desc
else:
field_name = ordering
if reverse:
order_type = Order.desc if order_type == Order.asc else Order.asc
return field_name, order_type
def resolve_ordering(
self,
model: type[Model],
table: Table,
orderings: Iterable[tuple[str, str | Order]],
annotations: dict[str, Term | Expression],
fields_for_select: Collection[str] | None = None,
) -> None:
"""
Applies standard ordering to QuerySet.
:param model: The Model this queryset is based on.
:param table: ``pypika_tortoise.Table`` to keep track of the virtual SQL table
(to allow self referential joins)
:param orderings: What columns/order to order by
:param annotations: Annotations that may be ordered on
:param fields_for_select: Contains fields that are selected in the SELECT clause if
.only(), .values() or .values_list() are used.
:raises FieldError: If a field provided does not exist in model.
"""
# Do not apply default ordering for annotated queries to not mess them up
if not orderings and self.model._meta.ordering and not annotations:
orderings = self.model._meta.ordering
for ordering in orderings:
field_name = ordering[0]
if field_name in model._meta.fetch_fields:
raise FieldError(
"Filtering by relation is not possible. Filter by nested field of related model"
)
related_field_name, __, forwarded = field_name.partition("__")
if related_field_name in model._meta.fetch_fields:
related_field = cast(RelationalField, model._meta.fields_map[related_field_name])
related_table = self._join_table_by_field(table, related_field_name, related_field)
self.resolve_ordering(
related_field.related_model,
related_table,
[(forwarded, ordering[1])],
{},
)
elif field_name in annotations:
term: Term
if not fields_for_select or field_name in fields_for_select:
# The annotation is SELECTed, we can just reference it in the following cases:
# - Empty fields_for_select means that all columns and annotations are selected,
# hence we can reference the annotation.
# - The annotation is in fields_for_select, hence we can reference it.
term = Field(field_name)
else:
# The annotation is not in SELECT, resolve it
annotation = annotations[field_name]
if isinstance(annotation, Term):
term = annotation
else:
term = annotation.resolve(
ResolveContext(
model=self.model,
table=table,
annotations=annotations,
custom_filters={},
)
).term
self.query = self.query.orderby(term, order=ordering[1])
else:
field_object = model._meta.fields_map.get(field_name)
if not field_object:
raise FieldError(f"Unknown field {field_name} for model {model.__name__}")
field_name = field_object.source_field or field_name
field = table[field_name]
func = field_object.get_for_dialect(
model._meta.db.capabilities.dialect, "function_cast"
)
if func:
field = func(field_object, field)
self.query = self.query.orderby(field, order=ordering[1])
def _resolve_annotate(self) -> bool:
if not self._annotations:
return False
annotation_info: dict[str, ResolveResult] = {}
for key, annotation in self._annotations.items():
if isinstance(annotation, Term):
annotation_info[key] = ResolveResult(term=annotation)
else:
annotation_info[key] = annotation.resolve(
ResolveContext(
model=self.model,
table=self.model._meta.basetable,
annotations=self._annotations,
custom_filters=self._custom_filters,
)
)
for key, info in annotation_info.items():
for join in info.joins:
self._join_table(join)
if key in self._annotations:
self.query._select_other(info.term.as_(key)) # type:ignore[arg-type]
return any(info.term.is_aggregate for info in annotation_info.values())
def sql(self, params_inline=False) -> str:
"""
Returns the SQL query that will be executed. By default, it will return the query with
placeholders, but if you set `params_inline=True`, it will inline the parameters.
:param params_inline: Whether to inline the parameters
"""
self._choose_db_if_not_chosen()
self._make_query()
if params_inline:
sql = self.query.get_sql()
else:
sql, _ = self.query.get_parameterized_sql()
return sql
def _make_query(self) -> None:
raise NotImplementedError() # pragma: nocoverage
async def _execute(self) -> Any:
raise NotImplementedError() # pragma: nocoverage
class QuerySet(AwaitableQuery[MODEL]):
__slots__ = (
"fields",
"_prefetch_map",
"_prefetch_queries",
"_single",
"_raise_does_not_exist",
"_db",
"_limit",
"_offset",
"_fields_for_select",
"_filter_kwargs",
"_orderings",
"_distinct",
"_having",
"_group_bys",
"_select_for_update",
"_select_for_update_nowait",
"_select_for_update_skip_locked",
"_select_for_update_of",
"_select_related",
"_select_related_idx",
"_use_indexes",
"_force_indexes",
)
def __init__(self, model: type[MODEL]) -> None:
super().__init__(model)
self.fields: set[str] = model._meta.db_fields
self._prefetch_map: dict[str, set[str | Prefetch]] = {}
self._prefetch_queries: dict[str, list[tuple[str | None, QuerySet]]] = {}
self._single: bool = False
self._raise_does_not_exist: bool = False
self._limit: int | None = None
self._offset: int | None = None
self._filter_kwargs: dict[str, Any] = {}
self._orderings: list[tuple[str, Any]] = []
self._distinct: bool = False
self._having: dict[str, Any] = {}
self._fields_for_select: tuple[str, ...] = ()
self._group_bys: tuple[str, ...] = ()
self._select_for_update: bool = False
self._select_for_update_nowait: bool = False
self._select_for_update_skip_locked: bool = False
self._select_for_update_of: set[str] = set()
self._select_related: set[str] = set()
self._select_related_idx: list[
tuple[type[Model], int, Table | str, type[Model], Iterable[str | None]]
] = [] # format with: model,idx,model_name,parent_model
self._force_indexes: set[str] = set()
self._use_indexes: set[str] = set()
def _clone(self) -> QuerySet[MODEL]:
queryset = self.__class__.__new__(self.__class__)
queryset.fields = self.fields
queryset.model = self.model
queryset.query = self.query
queryset.capabilities = self.capabilities
queryset._prefetch_map = copy(self._prefetch_map)
queryset._prefetch_queries = copy(self._prefetch_queries)
queryset._single = self._single
queryset._raise_does_not_exist = self._raise_does_not_exist
queryset._db = self._db
queryset._limit = self._limit
queryset._offset = self._offset
queryset._fields_for_select = self._fields_for_select
queryset._filter_kwargs = copy(self._filter_kwargs)
queryset._orderings = copy(self._orderings)
queryset._joined_tables = copy(self._joined_tables)
queryset._q_objects = copy(self._q_objects)
queryset._distinct = self._distinct
queryset._annotations = copy(self._annotations)
queryset._having = copy(self._having)
queryset._custom_filters = copy(self._custom_filters)
queryset._group_bys = copy(self._group_bys)
queryset._select_for_update = self._select_for_update
queryset._select_for_update_nowait = self._select_for_update_nowait
queryset._select_for_update_skip_locked = self._select_for_update_skip_locked
queryset._select_for_update_of = self._select_for_update_of
queryset._select_related = self._select_related
queryset._select_related_idx = self._select_related_idx
queryset._force_indexes = self._force_indexes
queryset._use_indexes = self._use_indexes
return queryset
def _filter_or_exclude(self, *args: Q, negate: bool, **kwargs: Any) -> QuerySet[MODEL]:
queryset = self._clone()
for arg in args:
if not isinstance(arg, Q):
raise TypeError("expected Q objects as args")
if negate:
queryset._q_objects.append(~arg)
else:
queryset._q_objects.append(arg)
for key, value in kwargs.items():
if negate:
queryset._q_objects.append(~Q(**{key: value}))
else:
queryset._q_objects.append(Q(**{key: value}))
return queryset
def filter(self, *args: Q, **kwargs: Any) -> QuerySet[MODEL]:
"""
Filters QuerySet by given kwargs. You can filter by related objects like this:
.. code-block:: python3
Team.filter(events__tournament__name='Test')
You can also pass Q objects to filters as args.
"""
return self._filter_or_exclude(negate=False, *args, **kwargs)
def exclude(self, *args: Q, **kwargs: Any) -> QuerySet[MODEL]:
"""
Same as .filter(), but with appends all args with NOT
"""
return self._filter_or_exclude(negate=True, *args, **kwargs)
def _parse_orderings(
self, orderings: tuple[str, ...], reverse=False
) -> list[tuple[str, Order]]:
"""
Convert ordering from strings to standard items for queryset.
:param orderings: What columns/order to order by
:param reverse: Whether reverse order
:return: standard ordering for QuerySet.
"""
new_ordering = []
for ordering in orderings:
field_name, order_type = self._resolve_ordering_string(ordering, reverse=reverse)
if not (
field_name.split("__")[0] in self.model._meta.fields
or field_name in self._annotations
):
raise FieldError(f"Unknown field {field_name} for model {self.model.__name__}")
new_ordering.append((field_name, order_type))
return new_ordering
def order_by(self, *orderings: str) -> QuerySet[MODEL]:
"""
Accept args to filter by in format like this:
.. code-block:: python3
.order_by('name', '-tournament__name')
Supports ordering by related models too.
A '-' before the name will result in descending sort order, default is ascending.
:raises FieldError: If unknown field has been provided.
"""
queryset = self._clone()
queryset._orderings = self._parse_orderings(orderings)
return queryset
def _as_single(self) -> QuerySetSingle[MODEL | None]:
self._single = True
self._limit = 1
return cast(QuerySetSingle[Optional[MODEL]], self)
def latest(self, *orderings: str) -> QuerySetSingle[MODEL | None]:
"""
Returns the most recent object by ordering descending on the providers fields.
:params orderings: Fields to order by.
:raises FieldError: If unknown or no fields has been provided.
"""
if not orderings:
raise FieldError("No fields passed")
queryset = self._clone()
queryset._orderings = self._parse_orderings(orderings, reverse=True)
return queryset._as_single()
def earliest(self, *orderings: str) -> QuerySetSingle[MODEL | None]:
"""
Returns the earliest object by ordering ascending on the specified field.
:params orderings: Fields to order by.
:raises FieldError: If unknown or no fields has been provided.
"""
if not orderings:
raise FieldError("No fields passed")
queryset = self._clone()
queryset._orderings = self._parse_orderings(orderings)
return queryset._as_single()
def limit(self, limit: int) -> QuerySet[MODEL]:
"""
Limits QuerySet to given length.
:raises ParamsError: Limit should be non-negative number.
"""
if limit < 0:
raise ParamsError("Limit should be non-negative number")
queryset = self._clone()
queryset._limit = limit
return queryset
def offset(self, offset: int) -> QuerySet[MODEL]:
"""
Query offset for QuerySet.
:raises ParamsError: Offset should be non-negative number.
"""
if offset < 0:
raise ParamsError("Offset should be non-negative number")
queryset = self._clone()
queryset._offset = offset
if self.capabilities.requires_limit and queryset._limit is None:
queryset._limit = 1000000
return queryset
def __getitem__(self, key: slice) -> QuerySet[MODEL]:
"""
Query offset and limit for Queryset.
:raises ParamsError: QuerySet indices must be slices.
:raises ParamsError: Slice steps should be 1 or None.
:raises ParamsError: Slice start should be non-negative number or None.
:raises ParamsError: Slice stop should be non-negative number greater that slice start,
or None.
"""
if not isinstance(key, slice):
raise ParamsError("QuerySet indices must be slices.")
if not (key.step is None or (isinstance(key.step, int) and key.step == 1)):
raise ParamsError("Slice steps should be 1 or None.")
start = key.start if key.start is not None else 0
if not isinstance(start, int) or start < 0:
raise ParamsError("Slice start should be non-negative number or None.")
if key.stop is not None and (not isinstance(key.stop, int) or key.stop <= start):
raise ParamsError(
"Slice stop should be non-negative number greater that slice start, or None.",
)
queryset = self.offset(start)
if key.stop:
queryset = queryset.limit(key.stop - start)
return queryset
def distinct(self) -> QuerySet[MODEL]:
"""
Make QuerySet distinct.
Only makes sense in combination with a ``.values()`` or ``.values_list()`` as it
precedes all the fetched fields with a distinct.
"""
queryset = self._clone()
queryset._distinct = True
return queryset
def select_for_update(
self, nowait: bool = False, skip_locked: bool = False, of: tuple[str, ...] = ()
) -> QuerySet[MODEL]:
"""
Make QuerySet select for update.
Returns a queryset that will lock rows until the end of the transaction,
generating a SELECT ... FOR UPDATE SQL statement on supported databases.
"""
if self.capabilities.support_for_update:
queryset = self._clone()
queryset._select_for_update = True
queryset._select_for_update_nowait = nowait
queryset._select_for_update_skip_locked = skip_locked
queryset._select_for_update_of = set(of)
return queryset
return self
def annotate(self, **kwargs: Expression | Term) -> QuerySet[MODEL]:
"""
Annotate result with aggregation or function result.
:raises TypeError: Value of kwarg is expected to be a ``Function`` instance.
"""
from tortoise.models import get_filters_for_field
queryset = self._clone()
for key, annotation in kwargs.items():
# if not isinstance(annotation, (Function, Term)):
# raise TypeError("value is expected to be Function/Term instance")
queryset._annotations[key] = annotation
queryset._custom_filters.update(get_filters_for_field(key, None, key))
return queryset
def group_by(self, *fields: str) -> QuerySet[MODEL]:
"""
Make QuerySet returns list of dict or tuple with group by.
Must call before .values() or .values_list()
"""
queryset = self._clone()
queryset._group_bys = fields
return queryset
def values_list(self, *fields_: str, flat: bool = False) -> ValuesListQuery[Literal[False]]:
"""
Make QuerySet returns list of tuples for given args instead of objects.
If call after `.get()`, `.get_or_none()` or `.first()` return tuples for given args instead of object.
If ```flat=True`` and only one arg is passed can return flat list or just scalar.
If no arguments are passed it will default to a tuple containing all fields
in order of declaration.
"""
fields_for_select_list = fields_ or [
field for field in self.model._meta.fields_map if field in self.model._meta.db_fields
] + list(self._annotations.keys())
return ValuesListQuery(
db=self._db,
model=self.model,
q_objects=self._q_objects,
single=self._single,
raise_does_not_exist=self._raise_does_not_exist,
flat=flat,
fields_for_select_list=fields_for_select_list,
distinct=self._distinct,
limit=self._limit,
offset=self._offset,
orderings=self._orderings,
annotations=self._annotations,
custom_filters=self._custom_filters,
group_bys=self._group_bys,
force_indexes=self._force_indexes,
use_indexes=self._use_indexes,
)
def values(self, *args: str, **kwargs: str) -> ValuesQuery[Literal[False]]:
"""
Make QuerySet return dicts instead of objects.
If call after `.get()`, `.get_or_none()` or `.first()` return dict instead of object.
Can pass names of fields to fetch, or as a ``field_name='name_in_dict'`` kwarg.
If no arguments are passed it will default to a dict containing all fields.
:raises FieldError: If duplicate key has been provided.
"""
if args or kwargs:
fields_for_select: dict[str, str] = {}
for field in args:
if field in fields_for_select:
raise FieldError(f"Duplicate key {field}")
fields_for_select[field] = field
for return_as, field in kwargs.items():
if return_as in fields_for_select:
raise FieldError(f"Duplicate key {return_as}")
fields_for_select[return_as] = field
else:
_fields = [
field
for field in self.model._meta.fields_map.keys()
if field in self.model._meta.fields_db_projection.keys()
] + list(self._annotations.keys())
fields_for_select = {field: field for field in _fields}
return ValuesQuery(
db=self._db,
model=self.model,
q_objects=self._q_objects,
single=self._single,
raise_does_not_exist=self._raise_does_not_exist,
fields_for_select=fields_for_select,
distinct=self._distinct,
limit=self._limit,
offset=self._offset,
orderings=self._orderings,
annotations=self._annotations,
custom_filters=self._custom_filters,
group_bys=self._group_bys,
force_indexes=self._force_indexes,
use_indexes=self._use_indexes,
)
def delete(self) -> DeleteQuery:
"""
Delete all objects in QuerySet.
"""
return DeleteQuery(
db=self._db,
model=self.model,
q_objects=self._q_objects,
annotations=self._annotations,
custom_filters=self._custom_filters,
limit=self._limit,
orderings=self._orderings,
)
def update(self, **kwargs: Any) -> UpdateQuery:
"""
Update all objects in QuerySet with given kwargs.
.. admonition: Example:
.. code-block:: py3
await Employee.filter(occupation='developer').update(salary=5000)
Will instead of returning a resultset, update the data in the DB itself.
"""
return UpdateQuery(
db=self._db,
model=self.model,
update_kwargs=kwargs,
q_objects=self._q_objects,
annotations=self._annotations,
custom_filters=self._custom_filters,
limit=self._limit,
orderings=self._orderings,
)
def count(self) -> CountQuery:
"""
Return count of objects in queryset instead of objects.
"""
return CountQuery(
db=self._db,
model=self.model,
q_objects=self._q_objects,
annotations=self._annotations,
custom_filters=self._custom_filters,
limit=self._limit,
offset=self._offset,
force_indexes=self._force_indexes,
use_indexes=self._use_indexes,
)
def exists(self) -> ExistsQuery:
"""
Return True/False whether queryset exists.
"""
return ExistsQuery(
db=self._db,
model=self.model,
q_objects=self._q_objects,
annotations=self._annotations,
custom_filters=self._custom_filters,
force_indexes=self._force_indexes,
use_indexes=self._use_indexes,
)
def all(self) -> QuerySet[MODEL]:
"""
Return the whole QuerySet.
Essentially a no-op except as the only operation.
"""
return self._clone()
def raw(self, sql: str) -> RawSQLQuery:
"""
Return the QuerySet from raw SQL
"""
return RawSQLQuery(model=self.model, db=self._db, sql=sql)
def first(self) -> QuerySetSingle[MODEL | None]:
"""
Limit queryset to one object and return one object instead of list.
"""
queryset = self._clone()
return queryset._as_single()
def last(self) -> QuerySetSingle[MODEL | None]:
"""
Limit queryset to one object and return the last object instead of list.
"""
queryset = self._clone()
if queryset._orderings:
new_ordering = [
(field, Order.desc if order_type == Order.asc else Order.asc)
for field, order_type in queryset._orderings
]
elif pk := self.model._meta.pk:
new_ordering = [(pk.model_field_name, Order.desc)]
else:
raise FieldError(
f"QuerySet has no ordering and model {self.model.__name__} has no pk defined"
)
queryset._orderings = new_ordering
return queryset._as_single()
def get(self, *args: Q, **kwargs: Any) -> QuerySetSingle[MODEL]:
"""
Fetch exactly one object matching the parameters.
"""
queryset = self.filter(*args, **kwargs)
queryset._limit = 2
queryset._single = True
queryset._raise_does_not_exist = True
return queryset # type: ignore
async def in_bulk(self, id_list: Iterable[str | int], field_name: str) -> dict[str, MODEL]:
"""
Return a dictionary mapping each of the given IDs to the object with
that ID. If `id_list` isn't provided, evaluate the entire QuerySet.
:param id_list: A list of field values
:param field_name: Must be a unique field
"""
objs = await self.filter(**{f"{field_name}__in": id_list})
return {getattr(obj, field_name): obj for obj in objs}
def bulk_create(
self,
objects: Iterable[MODEL],
batch_size: int | None = None,
ignore_conflicts: bool = False,
update_fields: Iterable[str] | None = None,
on_conflict: Iterable[str] | None = None,
) -> BulkCreateQuery[MODEL]:
"""
This method inserts the provided list of objects into the database in an efficient manner
(generally only 1 query, no matter how many objects there are).
:param on_conflict: On conflict index name
:param update_fields: Update fields when conflicts
:param ignore_conflicts: Ignore conflicts when inserting
:param objects: List of objects to bulk create
:param batch_size: How many objects are created in a single query
:raises ValueError: If params do not meet specifications
"""
if ignore_conflicts and update_fields:
raise ValueError(
"ignore_conflicts and update_fields are mutually exclusive.",
)
if not ignore_conflicts:
if (update_fields and not on_conflict) or (on_conflict and not update_fields):
raise ValueError("update_fields and on_conflict need set in same time.")
return BulkCreateQuery(
db=self._db,
model=self.model,
objects=objects,
batch_size=batch_size,
ignore_conflicts=ignore_conflicts,
update_fields=update_fields,
on_conflict=on_conflict,
)
def bulk_update(
self,
objects: Iterable[MODEL],
fields: Iterable[str],
batch_size: int | None = None,
) -> BulkUpdateQuery[MODEL]:
"""
Update the given fields in each of the given objects in the database.
:param objects: List of objects to bulk create
:param fields: The fields to update
:param batch_size: How many objects are created in a single query
:raises ValueError: If objects have no primary key set
"""
if any(obj.pk is None for obj in objects):
raise ValueError("All bulk_update() objects must have a primary key set.")
return BulkUpdateQuery(
db=self._db,
model=self.model,
q_objects=self._q_objects,
annotations=self._annotations,
custom_filters=self._custom_filters,
limit=self._limit,
orderings=self._orderings,
objects=objects,
fields=fields,
batch_size=batch_size,
)
def get_or_none(self, *args: Q, **kwargs: Any) -> QuerySetSingle[MODEL | None]:
"""
Fetch exactly one object matching the parameters.
"""
queryset = self.filter(*args, **kwargs)
queryset._limit = 2
queryset._single = True
return queryset # type: ignore
def only(self, *fields_for_select: str) -> QuerySet[MODEL]:
"""
Fetch ONLY the specified fields to create a partial model.
Persisting changes on the model is allowed only when:
* All the fields you want to update is specified in ``<model>.save(update_fields=[...])``
* You included the Model primary key in the `.only(...)``
To protect against common mistakes we ensure that errors get raised:
* If you access a field that is not specified, you will get an ``AttributeError``.
* If you do a ``<model>.save()`` a ``IncompleteInstanceError`` will be raised as the model is, as requested, incomplete.
* If you do a ``<model>.save(update_fields=[...])`` and you didn't include the primary key in the ``.only(...)``,
then ``IncompleteInstanceError`` will be raised indicating that updates can't be done without the primary key being known.
* If you do a ``<model>.save(update_fields=[...])`` and one of the fields in ``update_fields`` was not in the ``.only(...)``,
then ``IncompleteInstanceError`` as that field is not available to be updated.
"""
queryset = self._clone()
queryset._fields_for_select = fields_for_select
return queryset
def select_related(self, *fields: str) -> QuerySet[MODEL]:
"""
Return a new QuerySet instance that will select related objects.
If fields are specified, they must be ForeignKey fields and only those
related objects are included in the selection.
"""
queryset = self._clone()
for field in fields:
queryset._select_related.add(field)
return queryset
def force_index(self, *index_names: str) -> QuerySet[MODEL]:
"""
The FORCE INDEX hint acts like USE INDEX (index_list),
with the addition that a table scan is assumed to be very expensive.
"""
if self.capabilities.support_index_hint:
queryset = self._clone()
for index_name in index_names:
queryset._force_indexes.add(index_name)
return queryset
return self
def use_index(self, *index_names: str) -> QuerySet[MODEL]:
"""
The USE INDEX (index_list) hint tells MySQL to use only one of the named indexes to find rows in the table.
"""
if self.capabilities.support_index_hint:
queryset = self._clone()
for index_name in index_names:
queryset._use_indexes.add(index_name)
return queryset
return self
def prefetch_related(self, *args: str | Prefetch) -> QuerySet[MODEL]:
"""
Like ``.fetch_related()`` on instance, but works on all objects in QuerySet.
:raises FieldError: If the field to prefetch on is not a relation, or not found.
"""
queryset = self._clone()
queryset._prefetch_map = {}
for relation in args:
if isinstance(relation, Prefetch):
relation.resolve_for_queryset(queryset)
continue
first_level_field, __, forwarded_prefetch = relation.partition("__")
if first_level_field not in self.model._meta.fetch_fields:
if first_level_field in self.model._meta.fields:
raise FieldError(
f"Field {first_level_field} on {self.model._meta.full_name} is not a relation"
)
raise FieldError(
f"Relation {first_level_field} for {self.model._meta.full_name} not found"
)
if first_level_field not in queryset._prefetch_map.keys():
queryset._prefetch_map[first_level_field] = set()
if forwarded_prefetch:
queryset._prefetch_map[first_level_field].add(forwarded_prefetch)
return queryset
async def explain(self) -> Any:
"""Fetch and return information about the query execution plan.
This is done by executing an ``EXPLAIN`` query whose exact prefix depends
on the database backend, as documented below.
- PostgreSQL: ``EXPLAIN (FORMAT JSON, VERBOSE) ...``
- SQLite: ``EXPLAIN QUERY PLAN ...``
- MySQL: ``EXPLAIN FORMAT=JSON ...``
.. note::