QuerySet¶
QuerySet is Saffier's lazy query builder and execution API.
Managers return querysets, queryset methods clone and refine query state, and
terminal operations such as get(), all(), create(), update(), and
delete() finally touch the database.
Mental model¶
Think of a queryset as an immutable query plan:
filter()andexclude()add predicatesselect_related()changes how related rows are joined and hydratedonly()anddefer()change projectionorder_by(),limit(), andoffset()shape the final result set- terminal methods execute the plan
Practical example¶
recent_users = (
User.query
.filter(is_active=True, email__icontains="@example.com")
.select_related("team")
.order_by("-created_at")
.limit(20)
)
rows = await recent_users.all()
Performance notes¶
Use select_related() for foreign-key joins you know you will dereference.
Use prefetch_related() for collections or fan-out paths where one giant join
would duplicate too many rows.
Use only() or defer() when you want to reduce transfer size but still keep
model instances.
saffier.QuerySet
¶
QuerySet(
model_class=None,
database=None,
filter_clauses=None,
or_clauses=None,
select_related=None,
filter_related=None,
prefetch_related=None,
limit_count=None,
limit_offset=None,
order_by=None,
group_by=None,
distinct_on=None,
only_fields=None,
defer_fields=None,
m2m_related=None,
using_schema=None,
table=None,
exclude_secrets=False,
for_update=None,
batch_size=None,
extra_select=None,
reference_select=None,
embed_parent=None,
)
Bases: BaseQuerySet, QuerySetProtocol
Public queryset API exposed through Saffier managers.
QuerySets are lazy, chainable builders. Every call such as filter(),
select_related(), or order_by() returns a cloned queryset with updated
query state, and execution only happens when the queryset is awaited,
iterated, or one of the terminal methods such as all() or get() is
called.
Source code in saffier/core/db/querysets/base.py
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 | |
filter_clauses
instance-attribute
¶
filter_clauses = (
[] if filter_clauses is None else filter_clauses
)
_select_related
instance-attribute
¶
_select_related = (
[] if select_related is None else select_related
)
_filter_related
instance-attribute
¶
_filter_related = (
[] if filter_related is None else filter_related
)
_prefetch_related
instance-attribute
¶
_prefetch_related = (
[] if prefetch_related is None else prefetch_related
)
_reference_select
instance-attribute
¶
_reference_select = (
{} if reference_select is None else reference_select
)
bulk_select_or_insert
class-attribute
instance-attribute
¶
bulk_select_or_insert = bulk_get_or_create
execute
async
¶
execute()
Source code in saffier/core/db/querysets/protocols.py
16 17 | |
_update_auto_now_fields
¶
_update_auto_now_fields(values, fields)
Refresh auto_now date and datetime fields inside a payload.
| RETURNS | DESCRIPTION |
|---|---|
Any
|
Updated payload dictionary.
TYPE:
|
Source code in saffier/core/utils/models.py
29 30 31 32 33 34 35 36 37 38 | |
_resolve_value
¶
_resolve_value(value)
Normalize one value for storage or query generation.
Dictionaries are JSON-encoded, enums are converted to their member names, and every other value is returned unchanged.
| PARAMETER | DESCRIPTION |
|---|---|
value
|
Raw value supplied by model or queryset code.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Any
|
typing.Any: Normalized value suitable for downstream processing. |
Source code in saffier/core/utils/models.py
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | |
prefetch_related
¶
prefetch_related(*prefetch)
Performs a reverse lookup for the foreignkeys. This is different from the select_related. Select related performs a follows the SQL foreign relation whereas the prefetch_related follows the python relations.
Source code in saffier/core/db/querysets/prefetch.py
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | |
using
¶
using(
_positional=_sentinel,
*,
database=_undefined,
schema=_undefined,
)
Source code in saffier/core/db/querysets/mixins.py
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 | |
using_with_db
¶
using_with_db(connection_name, schema=_undefined)
Source code in saffier/core/db/querysets/mixins.py
125 126 127 128 129 130 131 132 133 | |
_clear_cache
¶
_clear_cache(
*, keep_result_cache=False, keep_cached_selected=False
)
Source code in saffier/core/db/querysets/base.py
119 120 121 122 123 124 125 126 127 128 129 130 131 132 | |
_cache_or_return_result
¶
_cache_or_return_result(result)
Source code in saffier/core/db/querysets/base.py
134 135 136 137 138 139 | |
_build_order_by_expression
¶
_build_order_by_expression(
order_by, expression, tables_and_models
)
Apply ordering expressions to a SQLAlchemy selectable.
| PARAMETER | DESCRIPTION |
|---|---|
order_by
|
Raw order-by field paths.
TYPE:
|
expression
|
Selectable being modified.
TYPE:
|
tables_and_models
|
Join map used to resolve relationship paths.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Any
|
Updated selectable.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | |
_build_group_by_expression
¶
_build_group_by_expression(
group_by, expression, tables_and_models
)
Apply group-by expressions to a SQLAlchemy selectable.
| PARAMETER | DESCRIPTION |
|---|---|
group_by
|
Raw group-by field paths.
TYPE:
|
expression
|
Selectable being modified.
TYPE:
|
tables_and_models
|
Join map used to resolve relationship paths.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Any
|
Updated selectable.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 | |
_build_filter_clauses_expression
¶
_build_filter_clauses_expression(
filter_clauses, expression
)
Apply AND-combined filter clauses to a selectable.
| RETURNS | DESCRIPTION |
|---|---|
Any
|
Updated selectable.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
181 182 183 184 185 186 187 188 189 190 191 192 | |
_build_or_clauses_expression
¶
_build_or_clauses_expression(or_clauses, expression)
Apply OR-combined clauses to a selectable.
| RETURNS | DESCRIPTION |
|---|---|
Any
|
Updated selectable.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
194 195 196 197 198 199 200 201 202 | |
_build_select_distinct
¶
_build_select_distinct(
distinct_on, expression, tables_and_models
)
Apply DISTINCT or DISTINCT ON semantics to a selectable.
| RETURNS | DESCRIPTION |
|---|---|
Any
|
Updated selectable.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 | |
_is_multiple_foreign_key
¶
_is_multiple_foreign_key(model_class)
Checks if the table has multiple foreign keys to the same table. Iterates through all fields of type ForeignKey and OneToOneField and checks if there are multiple FKs to the same destination table.
Returns a tuple of bool, list of tuples
Source code in saffier/core/db/querysets/base.py
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 | |
_resolve_many_to_many_join_fields
¶
_resolve_many_to_many_join_fields(
previous_model_class, related_field
)
Source code in saffier/core/db/querysets/base.py
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 | |
_primary_join_columns
staticmethod
¶
_primary_join_columns(table, model_class)
Source code in saffier/core/db/querysets/base.py
301 302 303 304 305 306 307 308 309 310 311 | |
_relation_join_columns
staticmethod
¶
_relation_join_columns(table, field_name, field)
Source code in saffier/core/db/querysets/base.py
313 314 315 316 317 318 319 320 | |
_target_relation_columns
staticmethod
¶
_target_relation_columns(table, field)
Source code in saffier/core/db/querysets/base.py
322 323 324 325 | |
_build_join_condition
staticmethod
¶
_build_join_condition(left_columns, right_columns)
Source code in saffier/core/db/querysets/base.py
327 328 329 330 331 332 333 334 335 336 337 338 339 | |
_dedupe_related_paths
¶
_dedupe_related_paths(paths)
Source code in saffier/core/db/querysets/base.py
341 342 343 344 345 346 347 | |
_collect_related_paths
¶
_collect_related_paths(fields)
Source code in saffier/core/db/querysets/base.py
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 | |
_build_tables_select_from_relationship
¶
_build_tables_select_from_relationship(related_paths=None)
Builds the tables relationships and joins. When a table contains more than one foreign key pointing to the same destination table, a lookup for the related field is made to understand from which foreign key the table is looked up from.
Source code in saffier/core/db/querysets/base.py
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 | |
_should_include_selected_column
¶
_should_include_selected_column(
field_name, model_class, prefix=""
)
Source code in saffier/core/db/querysets/base.py
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 | |
_build_select_columns
¶
_build_select_columns(
tables_and_models, selectable_related
)
Source code in saffier/core/db/querysets/base.py
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 | |
_build_where_clause
¶
_build_where_clause(
outer_tables_and_models, outer_select_paths
)
Source code in saffier/core/db/querysets/base.py
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 | |
_validate_only_and_defer
¶
_validate_only_and_defer()
Source code in saffier/core/db/querysets/base.py
644 645 646 | |
_secret_recursive_names
¶
_secret_recursive_names(model_class, columns=None)
Collect non-secret field names across a model graph.
Foreign-key targets are traversed recursively so secret filtering can be applied consistently to nested serialization shapes.
| PARAMETER | DESCRIPTION |
|---|---|
model_class
|
Model whose fields should be inspected.
TYPE:
|
columns
|
Internal accumulator used during recursion.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[str]
|
list[str]: Distinct field names that are not marked as secret. |
Source code in saffier/core/db/querysets/base.py
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 | |
_build_select_with_tables
¶
_build_select_with_tables()
Build the main select statement together with its join map.
The method resolves every relationship path needed by filtering,
ordering, grouping, or explicit select_related(), applies WHERE,
ORDER BY, GROUP BY, DISTINCT, pagination, and row-locking options,
then caches the resulting expression for reuse.
| RETURNS | DESCRIPTION |
|---|---|
Any
|
tuple[Any, dict[str, tuple[Any, Any]]]: SQLAlchemy select expression |
dict[str, tuple[Any, Any]]
|
plus the table/model map used to hydrate rows. |
Source code in saffier/core/db/querysets/base.py
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 | |
_build_select
¶
_build_select()
Source code in saffier/core/db/querysets/base.py
760 761 | |
_hydrate_row
async
¶
_hydrate_row(
queryset,
row,
tables_and_models,
*,
is_only_fields,
is_defer_fields,
)
Source code in saffier/core/db/querysets/base.py
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 | |
_filter_query
¶
_filter_query(exclude=False, or_=False, **kwargs)
Source code in saffier/core/db/querysets/base.py
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 | |
_validate_kwargs
¶
_validate_kwargs(**kwargs)
Source code in saffier/core/db/querysets/base.py
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 | |
_normalize_many_to_many_values
¶
_normalize_many_to_many_values(field, value)
Source code in saffier/core/db/querysets/base.py
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 | |
_prepare_order_by
¶
_prepare_order_by(order_by, tables_and_models)
Source code in saffier/core/db/querysets/base.py
909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 | |
_prepare_group_by
¶
_prepare_group_by(group_by, tables_and_models)
Source code in saffier/core/db/querysets/base.py
927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 | |
_prepare_fields_for_distinct
¶
_prepare_fields_for_distinct(
distinct_on, tables_and_models
)
Source code in saffier/core/db/querysets/base.py
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 | |
_clone
¶
_clone()
Return a copy of the current QuerySet that's ready for another operation.
Source code in saffier/core/db/querysets/base.py
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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 | |
__aiter__
async
¶
__aiter__()
Source code in saffier/core/db/querysets/base.py
1052 1053 1054 | |
_set_query_expression
¶
_set_query_expression(expression)
Store the current SQL expression on the queryset and model class.
| PARAMETER | DESCRIPTION |
|---|---|
expression
|
SQLAlchemy expression representing the current query.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1056 1057 1058 1059 1060 1061 1062 1063 | |
_filter_or_exclude
¶
_filter_or_exclude(
clause=None, exclude=False, or_=False, **kwargs
)
Shared implementation for filter(), exclude(), and boolean variants.
| PARAMETER | DESCRIPTION |
|---|---|
clause
|
Optional explicit
TYPE:
|
exclude
|
Whether the resulting predicate should be negated.
TYPE:
|
or_
|
Whether the predicate belongs to the OR clause bucket.
TYPE:
|
**kwargs
|
Lookup kwargs using Saffier's double-underscore syntax.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset containing the new predicate state.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 | |
filter
¶
filter(clause=None, or_=False, **kwargs)
Return a cloned queryset filtered by lookup kwargs and optional Q clause.
| PARAMETER | DESCRIPTION |
|---|---|
clause
|
Optional explicit
TYPE:
|
or_
|
Whether the lookup should be appended to the OR-clause bucket.
TYPE:
|
**kwargs
|
Field lookups using Saffier's double-underscore syntax.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset carrying the additional filters.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 | |
or_
¶
or_(clause=None, **kwargs)
Append filters to the queryset OR-clause bucket.
| PARAMETER | DESCRIPTION |
|---|---|
clause
|
Optional explicit
TYPE:
|
**kwargs
|
Field lookups using Saffier's double-underscore syntax.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset with OR predicates applied.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 | |
local_or
¶
local_or(clause=None, **kwargs)
Compatibility alias for or_() using Saffier's historical name.
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset with OR predicates applied.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 | |
and_
¶
and_(clause=None, **kwargs)
Compatibility alias for filter() used in explicit boolean flows.
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset with AND predicates applied.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 | |
not_
¶
not_(clause=None, **kwargs)
Compatibility alias for exclude().
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset with negated predicates applied.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 | |
exclude
¶
exclude(clause=None, or_=False, **kwargs)
Return a queryset excluding rows matched by the supplied predicates.
| PARAMETER | DESCRIPTION |
|---|---|
clause
|
Optional explicit
TYPE:
|
or_
|
Whether excluded lookups should be appended to the OR-clause bucket.
TYPE:
|
**kwargs
|
Lookup kwargs using Saffier's double-underscore syntax.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset carrying the exclusion.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 | |
exclude_secrets
¶
exclude_secrets(enabled=True, clause=None, **kwargs)
Hide secret fields from hydrated model results.
| PARAMETER | DESCRIPTION |
|---|---|
enabled
|
Whether secret filtering should be enabled.
TYPE:
|
clause
|
Optional initial filter clause to apply at the same time.
TYPE:
|
**kwargs
|
Optional lookup kwargs to apply.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset configured to omit secret fields on
TYPE:
|
QuerySet
|
hydration. |
Source code in saffier/core/db/querysets/base.py
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 | |
lookup
¶
lookup(term)
Search all text-like fields using a broad case-insensitive match.
| PARAMETER | DESCRIPTION |
|---|---|
term
|
Search term to wrap in
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset with appended search clauses.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 | |
order_by
¶
order_by(*order_by)
Return a queryset ordered by the supplied field paths.
| PARAMETER | DESCRIPTION |
|---|---|
*order_by
|
Field names or relationship paths, optionally prefixed
with
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset with ordering applied.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 | |
reverse
¶
reverse()
Reverse the current ordering direction.
When the queryset has no explicit ordering, primary-key ordering is added first so the reversal remains deterministic.
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset with reversed ordering.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 | |
batch_size
¶
batch_size(batch_size=None)
Set the batch size used by async iteration.
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset with updated iteration chunk size.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1297 1298 1299 1300 1301 1302 1303 1304 1305 | |
extra_select
¶
extra_select(*extra)
Add raw SQLAlchemy expressions to the SELECT list.
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset with extra select expressions.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1307 1308 1309 1310 1311 1312 1313 1314 1315 | |
reference_select
¶
reference_select(references)
Map extra selected expressions back onto model attributes.
| PARAMETER | DESCRIPTION |
|---|---|
references
|
Mapping from attribute name to selected SQL label.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset with reference mapping configured.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 | |
paginator
¶
paginator(
page_size, *, next_item_attr="", previous_item_attr=""
)
Return a numbered paginator bound to the current queryset.
| RETURNS | DESCRIPTION |
|---|---|
Any
|
Numbered paginator instance.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 | |
cursor_paginator
¶
cursor_paginator(
page_size, *, next_item_attr="", previous_item_attr=""
)
Return a cursor paginator bound to the current queryset.
| RETURNS | DESCRIPTION |
|---|---|
Any
|
Cursor paginator instance.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 | |
limit
¶
limit(limit_count)
Return a queryset with a SQL LIMIT applied.
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset with limit applied.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1372 1373 1374 1375 1376 1377 1378 1379 1380 | |
offset
¶
offset(offset)
Return a queryset with a SQL OFFSET applied.
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset with offset applied.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1382 1383 1384 1385 1386 1387 1388 1389 1390 | |
group_by
¶
group_by(*group_by)
Return a queryset grouped by the supplied field paths.
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset with grouping applied.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1392 1393 1394 1395 1396 1397 1398 1399 1400 | |
distinct
¶
distinct(first=True, *distinct_on)
Return a queryset with DISTINCT or DISTINCT ON semantics applied.
| PARAMETER | DESCRIPTION |
|---|---|
first
|
TYPE:
|
*distinct_on
|
Additional field paths for
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset with distinct configuration applied.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 | |
only
¶
only(*fields)
Load only the given fields plus the primary-key columns.
Primary-key columns are always retained so Saffier can still identify and cache hydrated model instances correctly.
Source code in saffier/core/db/querysets/base.py
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 | |
defer
¶
defer(*fields)
Defer loading of the given fields until attribute access time.
Deferred attributes trigger lazy loading when accessed on a hydrated model instance.
Source code in saffier/core/db/querysets/base.py
1437 1438 1439 1440 1441 1442 1443 1444 1445 | |
select_related
¶
select_related(related)
Eager-load foreign-key relationships in the same SQL query.
| PARAMETER | DESCRIPTION |
|---|---|
related
|
One relation path or an iterable of relation paths.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset configured to join and hydrate the related
TYPE:
|
QuerySet
|
objects. |
Source code in saffier/core/db/querysets/base.py
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 | |
values
async
¶
values(
fields=None,
exclude=None,
exclude_none=False,
flatten=False,
**kwargs,
)
Return queryset results as dictionaries or tuples.
| PARAMETER | DESCRIPTION |
|---|---|
fields
|
Optional field whitelist.
TYPE:
|
exclude
|
Optional field blacklist.
TYPE:
|
exclude_none
|
Whether
TYPE:
|
flatten
|
When tuple output is requested, flatten a single selected field into a list of scalar values.
TYPE:
|
**kwargs
|
Internal compatibility flags.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[Any]
|
list[Any]: Serialized rows. |
Source code in saffier/core/db/querysets/base.py
1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 | |
values_list
async
¶
values_list(
fields=None,
exclude=None,
exclude_none=False,
flat=False,
)
Return queryset results as tuples or flattened scalar values.
| PARAMETER | DESCRIPTION |
|---|---|
fields
|
Fields to include in the output.
TYPE:
|
exclude
|
Fields to exclude from the output.
TYPE:
|
exclude_none
|
Whether
TYPE:
|
flat
|
Whether to flatten the result to a single scalar column.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[Any]
|
list[Any]: Tuple rows or flattened values. |
Source code in saffier/core/db/querysets/base.py
1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 | |
exists
async
¶
exists(**kwargs)
Return whether at least one row matches the queryset.
| PARAMETER | DESCRIPTION |
|---|---|
**kwargs
|
Optional extra lookup kwargs to apply before evaluation.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
bool
|
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 | |
count
async
¶
count(**kwargs)
Return the number of rows matched by the queryset.
The implementation falls back to distinct primary-key counting when the query shape could otherwise duplicate rows, such as joins introduced by related filtering or ordering.
| PARAMETER | DESCRIPTION |
|---|---|
**kwargs
|
Optional extra lookup kwargs to apply before counting.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
int
|
Number of matched rows.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 | |
get_or_none
async
¶
get_or_none(**kwargs)
Fetch one row or return None instead of raising.
| RETURNS | DESCRIPTION |
|---|---|
SaffierModel | None
|
SaffierModel | None: Matching model instance or |
Source code in saffier/core/db/querysets/base.py
1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 | |
_all
async
¶
_all(**kwargs)
Execute the queryset and hydrate the full result list.
| PARAMETER | DESCRIPTION |
|---|---|
**kwargs
|
Optional lookup kwargs applied before evaluation.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[SaffierModel]
|
list[SaffierModel]: Hydrated result set. |
Source code in saffier/core/db/querysets/base.py
1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 | |
all
¶
all(clear_cache=False, **kwargs)
Return a clone ready for full evaluation.
| PARAMETER | DESCRIPTION |
|---|---|
clear_cache
|
Whether result caches should be cleared on the current queryset.
TYPE:
|
**kwargs
|
Deferred lookup kwargs applied during evaluation.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Queryset ready for evaluation.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 | |
get
async
¶
get(**kwargs)
Return exactly one row matched by the queryset or lookup kwargs.
| RAISES | DESCRIPTION |
|---|---|
ObjectNotFound
|
If no row matches. |
MultipleObjectsReturned
|
If more than one row matches. |
Source code in saffier/core/db/querysets/base.py
1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 | |
first
async
¶
first(**kwargs)
Return the first row for the queryset.
| RETURNS | DESCRIPTION |
|---|---|
SaffierModel | None
|
SaffierModel | None: First matching model instance or |
Source code in saffier/core/db/querysets/base.py
1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 | |
last
async
¶
last(**kwargs)
Return the last row for the queryset.
| RETURNS | DESCRIPTION |
|---|---|
SaffierModel | None
|
SaffierModel | None: Last matching model instance or |
Source code in saffier/core/db/querysets/base.py
1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 | |
_filter_lookup_kwargs
¶
_filter_lookup_kwargs(payload)
Source code in saffier/core/db/querysets/base.py
1859 1860 1861 1862 1863 1864 | |
_extract_model_reference_kwargs
¶
_extract_model_reference_kwargs(payload)
Source code in saffier/core/db/querysets/base.py
1866 1867 1868 1869 1870 1871 1872 | |
_persist_model_reference_kwargs
async
¶
_persist_model_reference_kwargs(instance, payload)
Source code in saffier/core/db/querysets/base.py
1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 | |
create
async
¶
create(*model_refs, **kwargs)
Create one model instance and persist any staged many-to-many values.
| PARAMETER | DESCRIPTION |
|---|---|
*model_refs
|
Positional
TYPE:
|
**kwargs
|
Field payload used to construct the instance.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
SaffierModel
|
The newly created model instance.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 | |
bulk_create
async
¶
bulk_create(objs)
Insert multiple rows in one bulk operation.
| PARAMETER | DESCRIPTION |
|---|---|
objs
|
List of logical field payloads to validate and insert.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 | |
bulk_update
async
¶
bulk_update(objs, fields)
Bulk updates records in a table.
A similar solution was suggested here: https://github.com/encode/orm/pull/148
It is thought to be a clean approach to a simple problem so it was added here and refactored to be compatible with Saffier.
Source code in saffier/core/db/querysets/base.py
1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 | |
raw_delete
async
¶
raw_delete(use_models=False, remove_referenced_call=False)
Source code in saffier/core/db/querysets/base.py
2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 | |
delete
async
¶
delete(use_models=False)
Delete rows matched by the queryset and emit delete signals.
| PARAMETER | DESCRIPTION |
|---|---|
use_models
|
Whether deletion should materialize model instances to honor model-based cleanup logic.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
int
|
Number of deleted rows.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 | |
update
async
¶
update(**kwargs)
Update rows matched by the queryset with the provided field values.
| PARAMETER | DESCRIPTION |
|---|---|
**kwargs
|
Logical field payload to normalize, validate, and persist.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 | |
get_or_create
async
¶
get_or_create(*model_refs, defaults=None, **kwargs)
Fetch one row or create it when missing.
| PARAMETER | DESCRIPTION |
|---|---|
*model_refs
|
Positional
TYPE:
|
defaults
|
Extra values applied only during creation.
TYPE:
|
**kwargs
|
Lookup payload and creation payload.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
SaffierModel
|
tuple[SaffierModel, bool]: Instance and a flag indicating whether it |
bool
|
was created. |
Source code in saffier/core/db/querysets/base.py
2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 | |
bulk_get_or_create
async
¶
bulk_get_or_create(objs, unique_fields=None)
Bulk gets or creates records.
When unique_fields is provided, existing records are fetched by those fields.
Missing records are created. Duplicate lookup payloads inside objs are collapsed.
Source code in saffier/core/db/querysets/base.py
2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 | |
update_or_create
async
¶
update_or_create(*model_refs, defaults=None, **kwargs)
Fetch one row and update it, or create it when missing.
| RETURNS | DESCRIPTION |
|---|---|
SaffierModel
|
tuple[SaffierModel, bool]: Instance and a flag indicating whether it |
bool
|
was created. |
Source code in saffier/core/db/querysets/base.py
2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 | |
contains
async
¶
contains(instance)
Return whether the queryset contains the provided persisted object.
| PARAMETER | DESCRIPTION |
|---|---|
instance
|
Persisted model instance to test.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
bool
|
TYPE:
|
Source code in saffier/core/db/querysets/base.py
2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 | |
_combine
¶
_combine(other, op, *, all_=False)
Source code in saffier/core/db/querysets/base.py
2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 | |
union
¶
union(other, *, all=False)
Combine two querysets using SQL UNION.
| RETURNS | DESCRIPTION |
|---|---|
CombinedQuerySet
|
Combined queryset wrapper.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
2318 2319 2320 2321 2322 2323 2324 | |
union_all
¶
union_all(other)
Combine two querysets using SQL UNION ALL.
Unlike union(), duplicate rows are preserved.
Source code in saffier/core/db/querysets/base.py
2326 2327 2328 2329 2330 2331 | |
intersect
¶
intersect(other, *, all=False)
Combine two querysets using SQL INTERSECT.
Only rows present in both querysets are returned.
Source code in saffier/core/db/querysets/base.py
2333 2334 2335 2336 2337 2338 | |
intersect_all
¶
intersect_all(other)
Combine two querysets using SQL INTERSECT ALL.
Duplicate row counts from both sides are preserved where supported.
Source code in saffier/core/db/querysets/base.py
2340 2341 2342 2343 2344 2345 | |
except_
¶
except_(other, *, all=False)
Combine two querysets using SQL EXCEPT.
Rows produced by other are removed from the left-hand queryset.
Source code in saffier/core/db/querysets/base.py
2347 2348 2349 2350 2351 2352 | |
except_all
¶
except_all(other)
Combine two querysets using SQL EXCEPT ALL.
Duplicate row counts are considered where the backend supports it.
Source code in saffier/core/db/querysets/base.py
2354 2355 2356 2357 2358 2359 | |
select_for_update
¶
select_for_update(
*,
nowait=False,
skip_locked=False,
read=False,
key_share=False,
of=None,
)
Request row-level locks via SELECT ... FOR UPDATE.
| RETURNS | DESCRIPTION |
|---|---|
QuerySet
|
Cloned queryset configured with lock options.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 | |
transaction
¶
transaction(*, force_rollback=False, **kwargs)
Return a transaction context manager bound to the queryset database.
This is a convenience pass-through to the underlying database object.
Source code in saffier/core/db/querysets/base.py
2387 2388 2389 2390 2391 2392 | |
_embed_parent_in_result
¶
_embed_parent_in_result(result)
Return the embedded parent target for relation-originated querysets.
When a reverse relation requested embedded-parent behavior, the hydrated result is traversed down to the related object that should be exposed to the caller. The through or child object can optionally be attached back onto that exposed parent.
| PARAMETER | DESCRIPTION |
|---|---|
result
|
Hydrated result produced from the base queryset.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
SaffierModel
|
Exposed result object.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 | |
as_select_with_tables
async
¶
as_select_with_tables()
Return the SQLAlchemy select expression together with the table map.
| RETURNS | DESCRIPTION |
|---|---|
Any
|
tuple[Any, dict[str, tuple[Any, Any]]]: Select expression and join |
dict[str, tuple[Any, Any]]
|
table/model mapping. |
Source code in saffier/core/db/querysets/base.py
2422 2423 2424 2425 2426 2427 2428 2429 | |
as_select
async
¶
as_select()
Return only the SQLAlchemy select expression for the queryset.
| RETURNS | DESCRIPTION |
|---|---|
Any
|
SQLAlchemy select expression.
TYPE:
|
Source code in saffier/core/db/querysets/base.py
2431 2432 2433 2434 2435 2436 2437 | |
_execute
async
¶
_execute()
Source code in saffier/core/db/querysets/base.py
2439 2440 2441 | |
_execute_iterate
async
¶
_execute_iterate(fetch_all_at_once=False)
Source code in saffier/core/db/querysets/base.py
2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 | |