Skip to content

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() and exclude() add predicates
  • select_related() changes how related rows are joined and hydrated
  • only() and defer() change projection
  • order_by(), limit(), and offset() 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
def __init__(
    self,
    model_class: type["Model"] | None = None,
    database: Union["Database", None] = None,
    filter_clauses: Any = None,
    or_clauses: Any = None,
    select_related: Any = None,
    filter_related: Any = None,
    prefetch_related: Any = None,
    limit_count: Any = None,
    limit_offset: Any = None,
    order_by: Any = None,
    group_by: Any = None,
    distinct_on: Any = None,
    only_fields: Any = None,
    defer_fields: Any = None,
    m2m_related: Any = None,
    using_schema: Any = None,
    table: Any = None,
    exclude_secrets: Any = False,
    for_update: Any = None,
    batch_size: int | None = None,
    extra_select: Any = None,
    reference_select: Any = None,
    embed_parent: Any = None,
) -> None:
    super().__init__(model_class=model_class)
    self.model_class = cast("type[Model]", model_class)
    self.filter_clauses = [] if filter_clauses is None else filter_clauses
    self.or_clauses = [] if or_clauses is None else or_clauses
    self.limit_count = limit_count
    self._select_related = [] if select_related is None else select_related
    self._filter_related = [] if filter_related is None else filter_related
    self._prefetch_related = [] if prefetch_related is None else prefetch_related
    self._offset = limit_offset
    self._order_by = [] if order_by is None else order_by
    self._group_by = [] if group_by is None else group_by
    self.distinct_on = distinct_on
    self._only = [] if only_fields is None else only_fields
    self._defer = [] if defer_fields is None else defer_fields
    self._expression = None
    cache_attrs = tuple(getattr(self.model_class, "pkcolumns", ())) if model_class else ()
    self._cache = QueryModelResultCache(attrs=cache_attrs)
    self._cached_select_with_tables = None
    self._cached_select_related_expression = None
    self._source_queryset = self
    self._m2m_related = m2m_related  # type: ignore
    self.using_schema = using_schema
    self._exclude_secrets = exclude_secrets or False
    self.extra: dict[str, Any] = {}
    self._for_update = for_update
    self._batch_size = batch_size
    self._extra_select = [] if extra_select is None else extra_select
    self._reference_select = {} if reference_select is None else reference_select
    self.embed_parent = embed_parent
    self.embed_parent_filters = None

    if self.is_m2m and not self._m2m_related:
        self._m2m_related = self.model_class.meta.multi_related[0]

    if table is not None:
        self.table = table
    if database is not None:
        self.database = database

    self._clear_cache(keep_result_cache=False)

model_class instance-attribute

model_class = cast('type[Model]', model_class)

database instance-attribute

database = database

table instance-attribute

table = table

pkcolumns property

pkcolumns

is_m2m property

is_m2m

filter_clauses instance-attribute

filter_clauses = (
    [] if filter_clauses is None else filter_clauses
)

or_clauses instance-attribute

or_clauses = [] if or_clauses is None else or_clauses

limit_count instance-attribute

limit_count = limit_count
_select_related = (
    [] if select_related is None else select_related
)
_filter_related = (
    [] if filter_related is None else filter_related
)
_prefetch_related = (
    [] if prefetch_related is None else prefetch_related
)

_offset instance-attribute

_offset = limit_offset

_order_by instance-attribute

_order_by = [] if order_by is None else order_by

_group_by instance-attribute

_group_by = [] if group_by is None else group_by

distinct_on instance-attribute

distinct_on = distinct_on

_only instance-attribute

_only = [] if only_fields is None else only_fields

_defer instance-attribute

_defer = [] if defer_fields is None else defer_fields

_expression instance-attribute

_expression = None

_cache instance-attribute

_cache = QueryModelResultCache(attrs=cache_attrs)

_cached_select_with_tables instance-attribute

_cached_select_with_tables = None
_cached_select_related_expression = None

_source_queryset instance-attribute

_source_queryset = self

using_schema instance-attribute

using_schema = using_schema

_exclude_secrets instance-attribute

_exclude_secrets = exclude_secrets or False

extra instance-attribute

extra = {}

_for_update instance-attribute

_for_update = for_update

_batch_size instance-attribute

_batch_size = batch_size

_extra_select instance-attribute

_extra_select = [] if extra_select is None else extra_select

_reference_select instance-attribute

_reference_select = (
    {} if reference_select is None else reference_select
)

embed_parent instance-attribute

embed_parent = embed_parent

embed_parent_filters instance-attribute

embed_parent_filters = None

_has_dynamic_clauses property

_has_dynamic_clauses

sql property writable

sql

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
async def execute(self) -> typing.Any:
    raise NotImplementedError()

_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: Any

Source code in saffier/core/utils/models.py
29
30
31
32
33
34
35
36
37
38
def _update_auto_now_fields(self, values: Any, fields: Any) -> Any:
    """Refresh `auto_now` date and datetime fields inside a payload.

    Returns:
        Any: Updated payload dictionary.
    """
    for k, v in fields.items():
        if isinstance(v, (DateField, DateTimeField)) and v.auto_now:
            values[k] = v.validator.get_default_value()  # type: ignore
    return values

_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: Any

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
def _resolve_value(self, value: typing.Any) -> typing.Any:
    """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.

    Args:
        value (typing.Any): Raw value supplied by model or queryset code.

    Returns:
        typing.Any: Normalized value suitable for downstream processing.
    """
    if isinstance(value, dict):
        return dumps(
            value,
            option=OPT_SERIALIZE_NUMPY | OPT_OMIT_MICROSECONDS,
        ).decode("utf-8")
    elif isinstance(value, Enum):
        return value.name
    return value
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
def prefetch_related(self, *prefetch: Prefetch) -> "QuerySet":
    """
    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.
    """
    queryset: QuerySet = self._clone()

    if not isinstance(prefetch, (list, tuple)):
        prefetch = cast("list[Prefetch]", [prefetch])  # type: ignore

    if isinstance(prefetch, tuple):
        prefetch = list(prefetch)  # type: ignore

    if any(not isinstance(value, Prefetch) for value in prefetch):
        raise QuerySetError("The prefetch_related must have Prefetch type objects only.")

    prefetch = list(self._prefetch_related) + prefetch  # type: ignore
    queryset._prefetch_related = prefetch
    return queryset

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
def using(
    self,
    _positional: Any = _sentinel,
    *,
    database: str | Database | None | Any = _undefined,
    schema: str | None | bool | Any = _undefined,
) -> QuerySet:
    if _positional is not _sentinel:
        warnings.warn(
            "Passing positional arguments to using is deprecated. Use schema= instead.",
            DeprecationWarning,
            stacklevel=2,
        )
        schema = _positional

    queryset = cast("QuerySet", self._clone())

    if database is not _undefined:
        if isinstance(database, Database):
            queryset.database = database
        elif database is None:
            queryset.database = self.model_class.meta.registry.database
        else:
            assert database in self.model_class.meta.registry.extra, (
                f"`{database}` is not in the connections extra of the model"
                f"`{self.model_class.__name__}` registry"
            )
            queryset.database = self.model_class.meta.registry.extra[database]

    if schema is not _undefined:
        queryset.using_schema = None if schema is False else schema
        if schema is False:
            queryset.table = self.model_class.table
        else:
            queryset.table = self.model_class.table_schema(
                cast("str | None", queryset.using_schema)
            )

    return queryset

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
def using_with_db(
    self, connection_name: str, schema: str | None | bool | Any = _undefined
) -> QuerySet:
    warnings.warn(
        "'using_with_db' is deprecated in favor of 'using' with schema, database arguments.",
        DeprecationWarning,
        stacklevel=2,
    )
    return self.using(database=connection_name, schema=schema)

_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
def _clear_cache(
    self,
    *,
    keep_result_cache: bool = False,
    keep_cached_selected: bool = False,
) -> None:
    if not keep_result_cache:
        self._cache.clear()
    if not keep_cached_selected:
        self._cached_select_with_tables = None
    self._cache_count: int | None = None
    self._cache_first: SaffierModel | None = None
    self._cache_last: SaffierModel | None = None
    self._cache_fetch_all = False

_cache_or_return_result

_cache_or_return_result(result)
Source code in saffier/core/db/querysets/base.py
134
135
136
137
138
139
def _cache_or_return_result(self, result: SaffierModel) -> SaffierModel:
    cached = self._cache.get(self.model_class, result)
    if cached is not None:
        return cast("SaffierModel", cached)
    self._cache.update(self.model_class, [result])
    return result

_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: Any

expression

Selectable being modified.

TYPE: Any

tables_and_models

Join map used to resolve relationship paths.

TYPE: dict[str, tuple[Any, Any]]

RETURNS DESCRIPTION
Any

Updated selectable.

TYPE: Any

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
def _build_order_by_expression(
    self,
    order_by: Any,
    expression: Any,
    tables_and_models: dict[str, tuple[Any, Any]],
) -> Any:
    """Apply ordering expressions to a SQLAlchemy selectable.

    Args:
        order_by: Raw order-by field paths.
        expression: Selectable being modified.
        tables_and_models: Join map used to resolve relationship paths.

    Returns:
        Any: Updated selectable.
    """
    order_by = [self._prepare_order_by(value, tables_and_models) for value in order_by]
    expression = expression.order_by(*order_by)
    return expression

_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: Any

expression

Selectable being modified.

TYPE: Any

tables_and_models

Join map used to resolve relationship paths.

TYPE: dict[str, tuple[Any, Any]]

RETURNS DESCRIPTION
Any

Updated selectable.

TYPE: Any

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
def _build_group_by_expression(
    self,
    group_by: Any,
    expression: Any,
    tables_and_models: dict[str, tuple[Any, Any]],
) -> Any:
    """Apply group-by expressions to a SQLAlchemy selectable.

    Args:
        group_by: Raw group-by field paths.
        expression: Selectable being modified.
        tables_and_models: Join map used to resolve relationship paths.

    Returns:
        Any: Updated selectable.
    """
    group_by = [self._prepare_group_by(value, tables_and_models) for value in group_by]
    expression = expression.group_by(*group_by)
    return expression

_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: Any

Source code in saffier/core/db/querysets/base.py
181
182
183
184
185
186
187
188
189
190
191
192
def _build_filter_clauses_expression(self, filter_clauses: Any, expression: Any) -> Any:
    """Apply AND-combined filter clauses to a selectable.

    Returns:
        Any: Updated selectable.
    """
    if len(filter_clauses) == 1:
        clause = filter_clauses[0]
    else:
        clause = sqlalchemy.sql.and_(*filter_clauses)
    expression = expression.where(clause)
    return expression

_build_or_clauses_expression

_build_or_clauses_expression(or_clauses, expression)

Apply OR-combined clauses to a selectable.

RETURNS DESCRIPTION
Any

Updated selectable.

TYPE: Any

Source code in saffier/core/db/querysets/base.py
194
195
196
197
198
199
200
201
202
def _build_or_clauses_expression(self, or_clauses: Any, expression: Any) -> Any:
    """Apply OR-combined clauses to a selectable.

    Returns:
        Any: Updated selectable.
    """
    clause = or_clauses[0] if len(or_clauses) == 1 else sqlalchemy.sql.or_(*or_clauses)
    expression = expression.where(clause)
    return expression

_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: Any

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
def _build_select_distinct(
    self,
    distinct_on: Any,
    expression: Any,
    tables_and_models: dict[str, tuple[Any, Any]],
) -> Any:
    """Apply `DISTINCT` or `DISTINCT ON` semantics to a selectable.

    Returns:
        Any: Updated selectable.
    """
    if not distinct_on:
        expression = expression.distinct()
    else:
        distinct_on = [
            self._prepare_fields_for_distinct(value, tables_and_models)
            for value in distinct_on
        ]
        expression = expression.distinct(*distinct_on)
    return expression

_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
def _is_multiple_foreign_key(
    self, model_class: type["Model"] | type["ReflectModel"]
) -> tuple[bool, list[tuple[str, str, str]]]:
    """
    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
    """
    fields = model_class.fields  # type: ignore
    foreign_keys = []
    has_many = False

    counter = 0

    for key, value in fields.items():
        tablename = None

        if counter > 1:
            has_many = True

        if isinstance(value, (saffier.ForeignKey, saffier.OneToOneField)):
            tablename = value.to if isinstance(value.to, str) else value.to.__name__

            if tablename not in foreign_keys:
                foreign_keys.append((key, tablename, value.related_name))
                counter += 1
            else:
                counter += 1

    return has_many, foreign_keys  # type: ignore

_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
def _resolve_many_to_many_join_fields(
    self,
    previous_model_class: type["Model"] | type["ReflectModel"],
    related_field: saffier_fields.ManyToManyField,
) -> tuple[type["Model"] | type["ReflectModel"], str, str]:
    through_model = related_field.through
    if isinstance(through_model, str):
        registry = getattr(previous_model_class.meta, "registry", None)
        if registry is not None:
            through_model = registry.models.get(through_model) or registry.reflected.get(
                through_model
            )
            related_field.through = through_model

    if through_model is None or isinstance(through_model, str):
        raise QuerySetError(
            detail=(
                "Unable to resolve through model for select_related path "
                f"'{previous_model_class.__name__}.{related_field.name}'."
            )
        )

    from_field: str | None = None
    to_field: str | None = None
    for field_name, field in through_model.fields.items():
        if not isinstance(field, (saffier_fields.ForeignKey, saffier_fields.OneToOneField)):
            continue
        if field.target is previous_model_class and from_field is None:
            from_field = field_name
            continue
        if field.target is related_field.target and to_field is None:
            to_field = field_name

    if from_field is None or to_field is None:
        raise QuerySetError(
            detail=(
                "Unable to resolve many-to-many join fields for "
                f"'{previous_model_class.__name__}.{related_field.name}'."
            )
        )

    return cast("type[Model] | type[ReflectModel]", through_model), from_field, to_field

_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
@staticmethod
def _primary_join_columns(
    table: Any, model_class: type["Model"] | type["ReflectModel"]
) -> list[Any]:
    columns = [
        getattr(table.c, pk_name, None) for pk_name in getattr(model_class, "pkcolumns", ())
    ]
    resolved = [column for column in columns if column is not None]
    if resolved:
        return resolved
    return list(table.primary_key)

_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
@staticmethod
def _relation_join_columns(table: Any, field_name: str, field: Any) -> list[Any]:
    column_names = (
        field.get_column_names(field_name)
        if hasattr(field, "get_column_names")
        else (field_name,)
    )
    return [getattr(table.c, column_name, None) for column_name in column_names]

_target_relation_columns staticmethod

_target_relation_columns(table, field)
Source code in saffier/core/db/querysets/base.py
322
323
324
325
@staticmethod
def _target_relation_columns(table: Any, field: Any) -> list[Any]:
    related_columns = getattr(field, "related_columns", {})
    return [getattr(table.c, column_name, None) for column_name in related_columns]

_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
@staticmethod
def _build_join_condition(left_columns: Sequence[Any], right_columns: Sequence[Any]) -> Any:
    pairs = [
        (left_column, right_column)
        for left_column, right_column in zip(left_columns, right_columns, strict=False)
        if left_column is not None and right_column is not None
    ]
    if not pairs or len(pairs) != len(left_columns) or len(pairs) != len(right_columns):
        raise QuerySetError(detail="Unable to resolve join columns for relationship.")
    clauses = [left_column == right_column for left_column, right_column in pairs]
    if len(clauses) == 1:
        return clauses[0]
    return sqlalchemy.and_(*clauses)
_dedupe_related_paths(paths)
Source code in saffier/core/db/querysets/base.py
341
342
343
344
345
346
347
def _dedupe_related_paths(self, paths: Sequence[str]) -> list[str]:
    related_paths = list(dict.fromkeys(path for path in paths if path))
    return [
        path
        for path in related_paths
        if not any(other != path and other.startswith(f"{path}__") for other in 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
def _collect_related_paths(self, fields: Sequence[str]) -> list[str]:
    from saffier.core.db.relationships.utils import crawl_relationship

    related_paths: list[str] = []
    for value in fields:
        if not isinstance(value, str):
            continue
        crawl_result = crawl_relationship(
            self.model_class,
            value.lstrip("-"),
            model_database=self.database,
        )
        if crawl_result.forward_path:
            related_paths.append(crawl_result.forward_path)
    return self._dedupe_related_paths(related_paths)

_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
def _build_tables_select_from_relationship(
    self,
    related_paths: Sequence[str] | None = None,
) -> Any:
    """
    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.
    """
    queryset: QuerySet = self._clone()

    tables = [queryset.table]
    select_from = queryset.table
    tables_and_models: dict[str, tuple[Any, Any]] = {
        "": (queryset.table, queryset.model_class)
    }

    select_related = self._dedupe_related_paths(
        queryset._select_related if related_paths is None else related_paths
    )

    # Select related
    for item in select_related:
        # For m2m relationships
        model_class = queryset.model_class
        current_table = queryset.table
        prefix = ""

        for part in item.split("__"):
            has_many_fk_same_table = False
            keys: list[tuple[str, str, str]] = []
            previous_model_class = model_class
            previous_table = current_table
            join_lookup_field: str | None = None
            reverse_join = False
            current_related_field: Any = None
            through_model: Any = None
            through_table = None
            through_from_field: str | None = None
            through_to_field: str | None = None
            try:
                current_related_field = model_class.fields[part]
                model_class = current_related_field.target
                if isinstance(
                    current_related_field,
                    (saffier_fields.ForeignKey, saffier_fields.OneToOneField),
                ):
                    join_lookup_field = part
                elif isinstance(current_related_field, saffier_fields.ManyToManyField):
                    through_model, through_from_field, through_to_field = (
                        self._resolve_many_to_many_join_fields(
                            previous_model_class,
                            current_related_field,
                        )
                    )
                    through_table = (
                        through_model.table_schema(queryset.using_schema)
                        if queryset.using_schema is not None
                        else through_model.table
                    )
            except (KeyError, AttributeError):
                # Check related fields
                model_class = getattr(model_class, part).related_from
                reverse_join = True
                join_lookup_field = previous_model_class.meta.related_names_mapping.get(part)
                has_many_fk_same_table, keys = self._is_multiple_foreign_key(model_class)

            next_prefix = part if not prefix else f"{prefix}__{part}"

            if queryset.using_schema is not None:
                table = model_class.table_schema(queryset.using_schema)
            else:
                table = model_class.table
            if model_class is previous_model_class or next_prefix in tables_and_models:
                table = table.alias(
                    hash_tablekey(tablekey=model_class.meta.tablename, prefix=next_prefix)
                )

            if isinstance(current_related_field, saffier_fields.ManyToManyField):
                assert through_table is not None
                assert through_model is not None
                through_from_relation = through_model.fields[through_from_field]
                through_to_relation = through_model.fields[through_to_field]
                through_prefix = f"{next_prefix}__through"
                if (
                    through_model is previous_model_class
                    or through_prefix in tables_and_models
                ):
                    through_table = through_table.alias(
                        hash_tablekey(
                            tablekey=through_model.meta.tablename,
                            prefix=through_prefix,
                        )
                    )
                left_columns = self._primary_join_columns(previous_table, previous_model_class)
                through_left_columns = self._relation_join_columns(
                    through_table,
                    through_from_field,
                    through_from_relation,
                )
                through_right_columns = self._relation_join_columns(
                    through_table,
                    through_to_field,
                    through_to_relation,
                )
                right_columns = self._primary_join_columns(table, model_class)
                select_from = sqlalchemy.sql.join(
                    select_from,
                    through_table,
                    self._build_join_condition(left_columns, through_left_columns),
                )
                select_from = sqlalchemy.sql.join(
                    select_from,
                    table,
                    self._build_join_condition(through_right_columns, right_columns),
                )
                prefix = next_prefix
                tables_and_models[prefix] = (table, model_class)
                current_table = table
                tables.append(table)
                continue

            # If there is multiple FKs to the same table
            if not has_many_fk_same_table:
                if join_lookup_field is not None:
                    if reverse_join:
                        relation_field = model_class.fields[join_lookup_field]
                        left_columns = self._target_relation_columns(
                            previous_table,
                            relation_field,
                        )
                        right_columns = self._relation_join_columns(
                            table,
                            join_lookup_field,
                            relation_field,
                        )
                    else:
                        relation_field = current_related_field
                        left_columns = self._relation_join_columns(
                            previous_table,
                            join_lookup_field,
                            relation_field,
                        )
                        right_columns = self._target_relation_columns(table, relation_field)

                    select_from = sqlalchemy.sql.join(
                        select_from,
                        table,
                        self._build_join_condition(left_columns, right_columns),
                    )
                else:
                    select_from = sqlalchemy.sql.join(select_from, table)
            else:
                lookup_field = None

                # Extract the table field from the related
                # Assign to a lookup_field
                for values in keys:
                    field, _, related_name = values
                    if related_name == part:
                        lookup_field = field
                        break

                if lookup_field is None:
                    select_from = sqlalchemy.sql.join(select_from, table)
                else:
                    relation_field = model_class.fields[lookup_field]
                    left_columns = self._target_relation_columns(
                        previous_table, relation_field
                    )
                    right_columns = self._relation_join_columns(
                        table,
                        lookup_field,
                        relation_field,
                    )
                    select_from = sqlalchemy.sql.join(
                        select_from,
                        table,
                        self._build_join_condition(left_columns, right_columns),
                    )

            prefix = next_prefix
            tables_and_models[prefix] = (table, model_class)
            current_table = table
            tables.append(table)
    return tables, select_from, tables_and_models

_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
def _should_include_selected_column(
    self,
    field_name: str,
    model_class: Any,
    prefix: str = "",
) -> bool:
    if self._only:
        if not prefix and field_name not in self._only:
            return False
        if prefix and prefix not in self._only and f"{prefix}__{field_name}" not in self._only:
            return False

    if self._defer:
        if not prefix and field_name in self._defer:
            return False
        if prefix and (prefix in self._defer or f"{prefix}__{field_name}" in self._defer):
            return False

    return not (
        self._exclude_secrets
        and field_name in model_class.meta.fields
        and model_class.meta.fields[field_name].secret
    )

_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
def _build_select_columns(
    self,
    tables_and_models: dict[str, tuple[Any, Any]],
    selectable_related: set[str],
) -> list[Any]:
    columns: list[Any] = [*self._extra_select]

    for prefix, (table, model_class) in tables_and_models.items():
        if prefix and not any(
            related_path == prefix or related_path.startswith(f"{prefix}__")
            for related_path in selectable_related
        ):
            continue

        for column_key, column in table.columns.items():
            field_name = model_class.meta.columns_to_field.get(column_key, column_key)
            if not self._should_include_selected_column(field_name, model_class, prefix):
                continue

            columns.append(column)

    if not columns:
        raise QuerySetError("No columns selected for queryset.")
    return columns

_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
def _build_where_clause(
    self,
    outer_tables_and_models: dict[str, tuple[Any, Any]],
    outer_select_paths: Sequence[str],
) -> Any:
    where_clauses: list[Any] = []
    if self.or_clauses:
        clause = (
            self.or_clauses[0]
            if len(self.or_clauses) == 1
            else sqlalchemy.sql.or_(*self.or_clauses)
        )
        where_clauses.append(clause)
    if self.filter_clauses:
        where_clauses.extend(self.filter_clauses)
    if not where_clauses:
        return None

    full_select_paths = self._dedupe_related_paths(
        [*outer_select_paths, *self._filter_related]
    )
    _, full_select_from, full_tables_and_models = self._build_tables_select_from_relationship(
        full_select_paths
    )

    if len(full_tables_and_models) == 1:
        return (
            where_clauses[0]
            if len(where_clauses) == 1
            else sqlalchemy.sql.and_(*where_clauses)
        )

    outer_table, outer_model = outer_tables_and_models[""]
    pk_columns = [getattr(outer_table.c, column) for column in outer_model.pkcolumns]
    subquery = (
        sqlalchemy.select(*pk_columns).select_from(full_select_from).where(*where_clauses)
    )

    if len(pk_columns) == 1:
        return pk_columns[0].in_(subquery)
    return sqlalchemy.tuple_(*pk_columns).in_(subquery)

_validate_only_and_defer

_validate_only_and_defer()
Source code in saffier/core/db/querysets/base.py
644
645
646
def _validate_only_and_defer(self) -> None:
    if self._only and self._defer:
        raise QuerySetError("You cannot use .only() and .defer() at the same time.")

_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: Any

columns

Internal accumulator used during recursion.

TYPE: list[str] | None DEFAULT: None

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
def _secret_recursive_names(
    self, model_class: Any, columns: list[str] | None = None
) -> list[str]:
    """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.

    Args:
        model_class: Model whose fields should be inspected.
        columns: Internal accumulator used during recursion.

    Returns:
        list[str]: Distinct field names that are not marked as secret.
    """
    if columns is None:
        columns = []

    for name, field in model_class.fields.items():
        if isinstance(field, saffier_fields.ForeignKey):
            # Making sure the foreign key is always added unless is a secret
            if not field.secret:
                columns.append(name)
                columns.extend(
                    self._secret_recursive_names(model_class=field.target, columns=columns)
                )
            continue
        if not field.secret:
            columns.append(name)

    columns = list(set(columns))
    return columns

_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
def _build_select_with_tables(self) -> tuple[Any, dict[str, tuple[Any, Any]]]:
    """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:
        tuple[Any, dict[str, tuple[Any, Any]]]: SQLAlchemy select expression
        plus the table/model map used to hydrate rows.
    """
    if self._cached_select_with_tables is not None:
        return self._cached_select_with_tables

    queryset = self

    queryset._validate_only_and_defer()
    outer_select_paths = queryset._dedupe_related_paths(
        [
            *queryset._select_related,
            *queryset._collect_related_paths(queryset._order_by),
            *queryset._collect_related_paths(queryset._group_by),
        ]
    )
    _, select_from, tables_and_models = queryset._build_tables_select_from_relationship(
        outer_select_paths
    )
    selectable_related = set(queryset._select_related)
    columns = queryset._build_select_columns(tables_and_models, selectable_related)
    expression = sqlalchemy.sql.select(*columns).select_from(select_from)

    where_clause = queryset._build_where_clause(tables_and_models, outer_select_paths)
    if where_clause is not None:
        expression = expression.where(where_clause)

    if queryset._order_by:
        expression = queryset._build_order_by_expression(
            queryset._order_by,
            expression=expression,
            tables_and_models=tables_and_models,
        )

    if queryset.limit_count:
        expression = expression.limit(queryset.limit_count)

    if queryset._offset:
        expression = expression.offset(queryset._offset)

    if queryset._group_by:
        expression = queryset._build_group_by_expression(
            queryset._group_by,
            expression=expression,
            tables_and_models=tables_and_models,
        )

    if queryset.distinct_on is not None:
        expression = queryset._build_select_distinct(
            queryset.distinct_on,
            expression=expression,
            tables_and_models=tables_and_models,
        )

    if queryset._for_update:
        for_update = dict(queryset._for_update)
        of = for_update.get("of")
        if of:
            for_update["of"] = tuple(
                getattr(model, "table", model) for model in cast("tuple[Any, ...]", of)
            )
        expression = expression.with_for_update(**for_update)

    queryset._expression = expression  # type: ignore
    if queryset._select_related:
        queryset._cached_select_related_expression = expression
        queryset._source_queryset._cached_select_related_expression = expression
    queryset._cached_select_with_tables = (expression, tables_and_models)
    return queryset._cached_select_with_tables

_build_select

_build_select()
Source code in saffier/core/db/querysets/base.py
760
761
def _build_select(self) -> Any:
    return self._build_select_with_tables()[0]

_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
async def _hydrate_row(
    self,
    queryset: "QuerySet",
    row: Any,
    tables_and_models: dict[str, tuple[Any, Any]],
    *,
    is_only_fields: bool,
    is_defer_fields: bool,
) -> SaffierModel:
    result = queryset.model_class.from_query_result(
        row,
        select_related=queryset._select_related,
        prefetch_related=[],
        is_only_fields=is_only_fields,
        only_fields=queryset._only,
        is_defer_fields=is_defer_fields,
        using_schema=queryset.using_schema,
        exclude_secrets=queryset._exclude_secrets,
        reference_select=queryset._reference_select,
        tables_and_models=tables_and_models,
    )
    if queryset._prefetch_related:
        result = await queryset.model_class.apply_prefetch_related(
            row=row,
            model=result,
            prefetch_related=queryset._prefetch_related,
        )
    return result

_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
def _filter_query(self, exclude: bool = False, or_: bool = False, **kwargs: Any) -> "QuerySet":
    clauses: list[Any] = []
    filter_clauses = self.filter_clauses
    or_clauses = self.or_clauses
    select_related = list(self._select_related)
    filter_related = list(self._filter_related)
    prefetch_related = list(self._prefetch_related)

    # Making sure for queries we use the main class and not the proxy
    # And enable the parent
    if self.model_class.is_proxy_model:
        self.model_class = self.model_class.parent

    clauses, implied_select_related = build_lookup_clauses(
        self.model_class,
        self.table,
        kwargs,
        escape_characters=tuple(self.ESCAPE_CHARACTERS),
        using_schema=self.using_schema,
        embed_parent=self.embed_parent_filters,
        model_database=self.database,
    )
    for related_path in implied_select_related:
        if related_path not in filter_related:
            filter_related.append(related_path)

    if exclude:
        if clauses:
            if not or_:
                filter_clauses.append(sqlalchemy.not_(sqlalchemy.sql.and_(*clauses)))
            else:
                or_clauses.append(sqlalchemy.not_(sqlalchemy.sql.and_(*clauses)))
    else:
        if not or_:
            filter_clauses += clauses
        else:
            or_clauses += clauses

    return cast(
        "QuerySet",
        self.__class__(
            model_class=self.model_class,
            database=self._database,
            filter_clauses=filter_clauses,
            or_clauses=or_clauses,
            select_related=select_related,
            filter_related=filter_related,
            prefetch_related=prefetch_related,
            limit_count=self.limit_count,
            limit_offset=self._offset,
            order_by=self._order_by,
            only_fields=self._only,
            defer_fields=self._defer,
            m2m_related=self.m2m_related,
            exclude_secrets=self._exclude_secrets,
            table=self.table,
            using_schema=self.using_schema,
            for_update=self._for_update,
            batch_size=self._batch_size,
            extra_select=self._extra_select,
            reference_select=self._reference_select,
            embed_parent=self.embed_parent,
        ),
    )

_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
def _validate_kwargs(self, **kwargs: Any) -> Any:
    original_kwargs = dict(kwargs)
    fields = self.model_class.fields
    for key, field in fields.items():
        field.modify_input(key, kwargs)
    schema_fields = {}
    for key, value in fields.items():
        if not value.has_column():
            continue
        field_validator = value.validator
        if key in kwargs and field_validator.read_only:
            field_validator = copy.copy(field_validator)
            field_validator.read_only = False
        schema_fields[key] = field_validator
    validator = Schema(fields=schema_fields)
    kwargs = validator.check(kwargs)
    for key, value in original_kwargs.items():
        field = fields.get(key)
        if field is not None and not field.has_column():
            kwargs[key] = value
    for key, value in fields.items():
        if not value.has_column():
            continue
        if value.validator.read_only and value.validator.has_default():
            kwargs[key] = value.validator.get_default_value()
    return kwargs

_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
def _normalize_many_to_many_values(
    self,
    field: saffier_fields.ManyToManyField,
    value: Any,
) -> list[Any]:
    if value is None:
        return []

    values: Sequence[Any]
    if isinstance(value, Sequence) and not isinstance(value, (str, bytes, bytearray)):
        values = value
    else:
        values = [value]

    target = field.target
    normalized = []
    for item in values:
        if item is None:
            continue
        if isinstance(item, target):
            normalized.append(item)
        else:
            normalized.append(target(pk=item))
    return normalized

_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
def _prepare_order_by(
    self,
    order_by: str,
    tables_and_models: dict[str, tuple[Any, Any]],
) -> Any:
    from saffier.core.db.relationships.utils import crawl_relationship

    reverse = order_by.startswith("-")
    order_by = order_by.lstrip("-")
    crawl_result = crawl_relationship(
        self.model_class,
        order_by,
        model_database=self.database,
    )
    table = tables_and_models[crawl_result.forward_path][0]
    order_col = table.columns[crawl_result.field_name]
    return order_col.desc() if reverse else order_col

_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
def _prepare_group_by(
    self,
    group_by: str,
    tables_and_models: dict[str, tuple[Any, Any]],
) -> Any:
    from saffier.core.db.relationships.utils import crawl_relationship

    group_by = group_by.lstrip("-")
    crawl_result = crawl_relationship(
        self.model_class,
        group_by,
        model_database=self.database,
    )
    table = tables_and_models[crawl_result.forward_path][0]
    group_col = table.columns[crawl_result.field_name]
    return group_col

_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
def _prepare_fields_for_distinct(
    self,
    distinct_on: str,
    tables_and_models: dict[str, tuple[Any, Any]],
) -> Any:
    from saffier.core.db.relationships.utils import crawl_relationship

    crawl_result = crawl_relationship(
        self.model_class,
        distinct_on,
        model_database=self.database,
    )
    table = tables_and_models[crawl_result.forward_path][0]
    _distinct_on: sqlalchemy.Column = table.columns[crawl_result.field_name]
    return _distinct_on

_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
def _clone(self) -> Any:
    """
    Return a copy of the current QuerySet that's ready for another
    operation.
    """
    queryset = self.__class__.__new__(self.__class__)
    queryset.model_class = self.model_class

    # Making sure the registry schema takes precendent with
    # Any provided using
    effective_schema = self.using_schema
    if not self.model_class.meta.registry.db_schema:
        schema = get_schema()
        if effective_schema is None and schema is not None:
            effective_schema = schema

    queryset.filter_clauses = copy.copy(self.filter_clauses)
    queryset.or_clauses = copy.copy(self.or_clauses)
    queryset.limit_count = self.limit_count
    queryset._select_related = copy.copy(self._select_related)
    queryset._filter_related = copy.copy(self._filter_related)
    queryset._prefetch_related = copy.copy(self._prefetch_related)
    queryset._offset = self._offset
    queryset._order_by = copy.copy(self._order_by)
    queryset._group_by = copy.copy(self._group_by)
    queryset.distinct_on = copy.copy(self.distinct_on)
    queryset._expression = self._expression
    queryset._cache = QueryModelResultCache(attrs=self._cache.attrs, prefix=self._cache.prefix)
    queryset._cached_select_with_tables = None
    queryset._cached_select_related_expression = self._cached_select_related_expression
    queryset._source_queryset = getattr(self, "_source_queryset", self)
    queryset._m2m_related = self._m2m_related
    queryset._only = copy.copy(self._only)
    queryset._defer = copy.copy(self._defer)
    queryset._database = self.database
    if effective_schema is not None:
        queryset.table = self.model_class.table_schema(effective_schema)
    elif getattr(self.model_class, "_table", None) is None:
        queryset.table = self.model_class.table
    else:
        queryset.table = self.table
    queryset.extra = copy.copy(self.extra)
    queryset._exclude_secrets = self._exclude_secrets
    queryset.using_schema = effective_schema
    queryset._for_update = copy.copy(self._for_update)
    queryset._batch_size = self._batch_size
    queryset._extra_select = copy.copy(self._extra_select)
    queryset._reference_select = copy.copy(self._reference_select)
    queryset.embed_parent = self.embed_parent
    queryset.embed_parent_filters = self.embed_parent_filters
    queryset._cache_count = None
    queryset._cache_first = None
    queryset._cache_last = None
    queryset._cache_fetch_all = False

    return queryset

__aiter__ async

__aiter__()
Source code in saffier/core/db/querysets/base.py
1052
1053
1054
async def __aiter__(self) -> AsyncIterator[SaffierModel]:
    async for value in self._execute_iterate():
        yield value

_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: Any

Source code in saffier/core/db/querysets/base.py
1056
1057
1058
1059
1060
1061
1062
1063
def _set_query_expression(self, expression: Any) -> None:
    """Store the current SQL expression on the queryset and model class.

    Args:
        expression: SQLAlchemy expression representing the current query.
    """
    self.sql = expression
    self.model_class.raw_query = self.sql

_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 Q object or SQLAlchemy clause.

TYPE: Any DEFAULT: None

exclude

Whether the resulting predicate should be negated.

TYPE: bool DEFAULT: False

or_

Whether the predicate belongs to the OR clause bucket.

TYPE: bool DEFAULT: False

**kwargs

Lookup kwargs using Saffier's double-underscore syntax.

TYPE: Any DEFAULT: {}

RETURNS DESCRIPTION
QuerySet

Cloned queryset containing the new predicate state.

TYPE: QuerySet

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
def _filter_or_exclude(
    self,
    clause: Any = None,
    exclude: bool = False,
    or_: bool = False,
    **kwargs: Any,
) -> "QuerySet":
    """Shared implementation for `filter()`, `exclude()`, and boolean variants.

    Args:
        clause: Optional explicit `Q` object or SQLAlchemy clause.
        exclude: Whether the resulting predicate should be negated.
        or_: Whether the predicate belongs to the OR clause bucket.
        **kwargs: Lookup kwargs using Saffier's double-underscore syntax.

    Returns:
        QuerySet: Cloned queryset containing the new predicate state.
    """
    queryset: QuerySet = self._clone()

    if clause is None:
        return queryset._filter_query(exclude=exclude, or_=or_, **kwargs)

    if kwargs:
        queryset = queryset._filter_query(exclude=exclude, or_=or_, **kwargs)

    if isinstance(clause, Q):
        clause, implied_select_related = clause.resolve(queryset)
        for related_path in implied_select_related:
            if related_path not in queryset._filter_related:
                queryset._filter_related.append(related_path)

    if exclude and isinstance(clause, Q):
        clause = sqlalchemy.not_(clause)

    if or_:
        queryset.or_clauses.append(clause)
    else:
        queryset.filter_clauses.append(clause)

    return queryset

filter

filter(clause=None, or_=False, **kwargs)

Return a cloned queryset filtered by lookup kwargs and optional Q clause.

PARAMETER DESCRIPTION
clause

Optional explicit Q object or SQL clause.

TYPE: Any DEFAULT: None

or_

Whether the lookup should be appended to the OR-clause bucket.

TYPE: bool DEFAULT: False

**kwargs

Field lookups using Saffier's double-underscore syntax.

TYPE: Any DEFAULT: {}

RETURNS DESCRIPTION
QuerySet

Cloned queryset carrying the additional filters.

TYPE: QuerySet

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
def filter(
    self,
    clause: Any = None,
    or_: bool = False,
    **kwargs: Any,
) -> "QuerySet":
    """Return a cloned queryset filtered by lookup kwargs and optional `Q` clause.

    Args:
        clause: Optional explicit `Q` object or SQL clause.
        or_: Whether the lookup should be appended to the OR-clause bucket.
        **kwargs: Field lookups using Saffier's double-underscore syntax.

    Returns:
        QuerySet: Cloned queryset carrying the additional filters.
    """
    return self._filter_or_exclude(clause=clause, or_=or_, **kwargs)

or_

or_(clause=None, **kwargs)

Append filters to the queryset OR-clause bucket.

PARAMETER DESCRIPTION
clause

Optional explicit Q object or SQL clause.

TYPE: Any DEFAULT: None

**kwargs

Field lookups using Saffier's double-underscore syntax.

TYPE: Any DEFAULT: {}

RETURNS DESCRIPTION
QuerySet

Cloned queryset with OR predicates applied.

TYPE: QuerySet

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
def or_(
    self,
    clause: Any = None,
    **kwargs: Any,
) -> "QuerySet":
    """Append filters to the queryset OR-clause bucket.

    Args:
        clause: Optional explicit `Q` object or SQL clause.
        **kwargs: Field lookups using Saffier's double-underscore syntax.

    Returns:
        QuerySet: Cloned queryset with OR predicates applied.
    """
    queryset: QuerySet = self._clone()
    queryset = self.filter(clause=clause, or_=True, **kwargs)
    return queryset

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: QuerySet

Source code in saffier/core/db/querysets/base.py
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
def local_or(
    self,
    clause: Any = None,
    **kwargs: Any,
) -> "QuerySet":
    """Compatibility alias for `or_()` using Saffier's historical name.

    Returns:
        QuerySet: Cloned queryset with OR predicates applied.
    """
    queryset: QuerySet = self._clone()
    queryset = self.filter(clause=clause, or_=True, **kwargs)
    return queryset

and_

and_(clause=None, **kwargs)

Compatibility alias for filter() used in explicit boolean flows.

RETURNS DESCRIPTION
QuerySet

Cloned queryset with AND predicates applied.

TYPE: QuerySet

Source code in saffier/core/db/querysets/base.py
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
def and_(
    self,
    clause: Any = None,
    **kwargs: Any,
) -> "QuerySet":
    """Compatibility alias for `filter()` used in explicit boolean flows.

    Returns:
        QuerySet: Cloned queryset with AND predicates applied.
    """
    queryset: QuerySet = self._clone()
    queryset = self.filter(clause=clause, **kwargs)
    return queryset

not_

not_(clause=None, **kwargs)

Compatibility alias for exclude().

RETURNS DESCRIPTION
QuerySet

Cloned queryset with negated predicates applied.

TYPE: QuerySet

Source code in saffier/core/db/querysets/base.py
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
def not_(
    self,
    clause: Any = None,
    **kwargs: Any,
) -> "QuerySet":
    """Compatibility alias for `exclude()`.

    Returns:
        QuerySet: Cloned queryset with negated predicates applied.
    """
    queryset: QuerySet = self._clone()
    queryset = queryset.exclude(clause=clause, **kwargs)
    return queryset

exclude

exclude(clause=None, or_=False, **kwargs)

Return a queryset excluding rows matched by the supplied predicates.

PARAMETER DESCRIPTION
clause

Optional explicit Q object or SQLAlchemy clause.

TYPE: Any DEFAULT: None

or_

Whether excluded lookups should be appended to the OR-clause bucket.

TYPE: bool DEFAULT: False

**kwargs

Lookup kwargs using Saffier's double-underscore syntax.

TYPE: Any DEFAULT: {}

RETURNS DESCRIPTION
QuerySet

Cloned queryset carrying the exclusion.

TYPE: QuerySet

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
def exclude(
    self,
    clause: Any = None,
    or_: bool = False,
    **kwargs: Any,
) -> "QuerySet":
    """Return a queryset excluding rows matched by the supplied predicates.

    Args:
        clause: Optional explicit `Q` object or SQLAlchemy clause.
        or_: Whether excluded lookups should be appended to the OR-clause
            bucket.
        **kwargs: Lookup kwargs using Saffier's double-underscore syntax.

    Returns:
        QuerySet: Cloned queryset carrying the exclusion.
    """
    queryset: QuerySet = self._clone()
    queryset = self._filter_or_exclude(clause=clause, exclude=True, or_=or_, **kwargs)
    return queryset

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: bool DEFAULT: True

clause

Optional initial filter clause to apply at the same time.

TYPE: Any DEFAULT: None

**kwargs

Optional lookup kwargs to apply.

TYPE: Any DEFAULT: {}

RETURNS DESCRIPTION
QuerySet

Cloned queryset configured to omit secret fields on

TYPE: QuerySet

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
def exclude_secrets(
    self,
    enabled: bool = True,
    clause: Any = None,
    **kwargs: Any,
) -> "QuerySet":
    """Hide secret fields from hydrated model results.

    Args:
        enabled: Whether secret filtering should be enabled.
        clause: Optional initial filter clause to apply at the same time.
        **kwargs: Optional lookup kwargs to apply.

    Returns:
        QuerySet: Cloned queryset configured to omit secret fields on
        hydration.
    """
    queryset: QuerySet = self._clone()
    queryset._exclude_secrets = enabled
    queryset = queryset.filter(clause=clause, **kwargs)
    return queryset

lookup

lookup(term)

Search all text-like fields using a broad case-insensitive match.

PARAMETER DESCRIPTION
term

Search term to wrap in %...%.

TYPE: Any

RETURNS DESCRIPTION
QuerySet

Cloned queryset with appended search clauses.

TYPE: QuerySet

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
def lookup(self, term: Any) -> "QuerySet":
    """Search all text-like fields using a broad case-insensitive match.

    Args:
        term: Search term to wrap in `%...%`.

    Returns:
        QuerySet: Cloned queryset with appended search clauses.
    """
    queryset: QuerySet = self._clone()
    if not term:
        return queryset

    filter_clauses = list(queryset.filter_clauses)
    value = f"%{term}%"

    search_fields = [
        name
        for name, field in queryset.model_class.fields.items()
        if isinstance(field, (CharField, TextField))
    ]
    search_clauses = [queryset.table.columns[name].ilike(value) for name in search_fields]

    if len(search_clauses) > 1:
        filter_clauses.append(sqlalchemy.sql.or_(*search_clauses))
    else:
        filter_clauses.extend(search_clauses)

    return queryset

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 - for descending order.

TYPE: str DEFAULT: ()

RETURNS DESCRIPTION
QuerySet

Cloned queryset with ordering applied.

TYPE: QuerySet

Source code in saffier/core/db/querysets/base.py
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
def order_by(self, *order_by: str) -> "QuerySet":
    """Return a queryset ordered by the supplied field paths.

    Args:
        *order_by: Field names or relationship paths, optionally prefixed
            with `-` for descending order.

    Returns:
        QuerySet: Cloned queryset with ordering applied.
    """
    queryset: QuerySet = self._clone()
    queryset._order_by = order_by
    return queryset

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: QuerySet

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
def reverse(self) -> "QuerySet":
    """Reverse the current ordering direction.

    When the queryset has no explicit ordering, primary-key ordering is
    added first so the reversal remains deterministic.

    Returns:
        QuerySet: Cloned queryset with reversed ordering.
    """
    queryset: QuerySet = self._clone()
    if not queryset._order_by:
        queryset = queryset.order_by(*queryset.model_class.pknames)

    queryset._order_by = tuple(
        value[1:] if value.startswith("-") else f"-{value}" for value in queryset._order_by
    )
    queryset._cache_first = self._cache_last
    queryset._cache_last = self._cache_first
    queryset._cache_count = self._cache_count
    if self._cache_fetch_all:
        values = list(reversed(tuple(self._cache.get_category(self.model_class).values())))
        queryset._cache.update(queryset.model_class, values)
        queryset._cache_fetch_all = True
    return queryset

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: QuerySet

Source code in saffier/core/db/querysets/base.py
1297
1298
1299
1300
1301
1302
1303
1304
1305
def batch_size(self, batch_size: int | None = None) -> "QuerySet":
    """Set the batch size used by async iteration.

    Returns:
        QuerySet: Cloned queryset with updated iteration chunk size.
    """
    queryset: QuerySet = self._clone()
    queryset._batch_size = batch_size
    return queryset

extra_select

extra_select(*extra)

Add raw SQLAlchemy expressions to the SELECT list.

RETURNS DESCRIPTION
QuerySet

Cloned queryset with extra select expressions.

TYPE: QuerySet

Source code in saffier/core/db/querysets/base.py
1307
1308
1309
1310
1311
1312
1313
1314
1315
def extra_select(self, *extra: Any) -> "QuerySet":
    """Add raw SQLAlchemy expressions to the `SELECT` list.

    Returns:
        QuerySet: Cloned queryset with extra select expressions.
    """
    queryset: QuerySet = self._clone()
    queryset._extra_select.extend(extra)
    return queryset

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: dict[str, Any]

RETURNS DESCRIPTION
QuerySet

Cloned queryset with reference mapping configured.

TYPE: QuerySet

Source code in saffier/core/db/querysets/base.py
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
def reference_select(self, references: dict[str, Any]) -> "QuerySet":
    """Map extra selected expressions back onto model attributes.

    Args:
        references: Mapping from attribute name to selected SQL label.

    Returns:
        QuerySet: Cloned queryset with reference mapping configured.
    """
    queryset: QuerySet = self._clone()
    queryset._reference_select.update(references)
    return queryset

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: Any

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
def paginator(
    self,
    page_size: int,
    *,
    next_item_attr: str = "",
    previous_item_attr: str = "",
) -> Any:
    """Return a numbered paginator bound to the current queryset.

    Returns:
        Any: Numbered paginator instance.
    """
    from saffier.contrib.pagination import NumberedPaginator

    return NumberedPaginator(
        queryset=self._clone(),
        page_size=page_size,
        next_item_attr=next_item_attr,
        previous_item_attr=previous_item_attr,
    )

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: Any

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
def cursor_paginator(
    self,
    page_size: int,
    *,
    next_item_attr: str = "",
    previous_item_attr: str = "",
) -> Any:
    """Return a cursor paginator bound to the current queryset.

    Returns:
        Any: Cursor paginator instance.
    """
    from saffier.contrib.pagination import CursorPaginator

    return CursorPaginator(
        queryset=self._clone(),
        page_size=page_size,
        next_item_attr=next_item_attr,
        previous_item_attr=previous_item_attr,
    )

limit

limit(limit_count)

Return a queryset with a SQL LIMIT applied.

RETURNS DESCRIPTION
QuerySet

Cloned queryset with limit applied.

TYPE: QuerySet

Source code in saffier/core/db/querysets/base.py
1372
1373
1374
1375
1376
1377
1378
1379
1380
def limit(self, limit_count: int) -> "QuerySet":
    """Return a queryset with a SQL `LIMIT` applied.

    Returns:
        QuerySet: Cloned queryset with limit applied.
    """
    queryset: QuerySet = self._clone()
    queryset.limit_count = limit_count
    return queryset

offset

offset(offset)

Return a queryset with a SQL OFFSET applied.

RETURNS DESCRIPTION
QuerySet

Cloned queryset with offset applied.

TYPE: QuerySet

Source code in saffier/core/db/querysets/base.py
1382
1383
1384
1385
1386
1387
1388
1389
1390
def offset(self, offset: int) -> "QuerySet":
    """Return a queryset with a SQL `OFFSET` applied.

    Returns:
        QuerySet: Cloned queryset with offset applied.
    """
    queryset: QuerySet = self._clone()
    queryset._offset = offset
    return queryset

group_by

group_by(*group_by)

Return a queryset grouped by the supplied field paths.

RETURNS DESCRIPTION
QuerySet

Cloned queryset with grouping applied.

TYPE: QuerySet

Source code in saffier/core/db/querysets/base.py
1392
1393
1394
1395
1396
1397
1398
1399
1400
def group_by(self, *group_by: str) -> "QuerySet":
    """Return a queryset grouped by the supplied field paths.

    Returns:
        QuerySet: Cloned queryset with grouping applied.
    """
    queryset: QuerySet = self._clone()
    queryset._group_by = group_by
    return queryset

distinct

distinct(first=True, *distinct_on)

Return a queryset with DISTINCT or DISTINCT ON semantics applied.

PARAMETER DESCRIPTION
first

True for plain DISTINCT, False to clear distinct state, or the first field path for DISTINCT ON.

TYPE: bool | str DEFAULT: True

*distinct_on

Additional field paths for DISTINCT ON.

TYPE: str DEFAULT: ()

RETURNS DESCRIPTION
QuerySet

Cloned queryset with distinct configuration applied.

TYPE: QuerySet

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
def distinct(self, first: bool | str = True, *distinct_on: str) -> "QuerySet":
    """Return a queryset with `DISTINCT` or `DISTINCT ON` semantics applied.

    Args:
        first: `True` for plain `DISTINCT`, `False` to clear distinct state,
            or the first field path for `DISTINCT ON`.
        *distinct_on: Additional field paths for `DISTINCT ON`.

    Returns:
        QuerySet: Cloned queryset with distinct configuration applied.
    """
    queryset: QuerySet = self._clone()
    if first is False:
        queryset.distinct_on = None
    elif first is True:
        queryset.distinct_on = []
    else:
        queryset.distinct_on = [first, *distinct_on]
    return queryset

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
def only(self, *fields: Sequence[str]) -> "QuerySet":
    """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.
    """
    only_fields = list(fields)
    for pkcolumn in reversed(tuple(self.model_class.pkcolumns)):
        if pkcolumn not in only_fields:
            only_fields.insert(0, pkcolumn)

    queryset: QuerySet = self._clone()
    queryset._only = only_fields
    return queryset

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
def defer(self, *fields: Sequence[str]) -> "QuerySet":
    """Defer loading of the given fields until attribute access time.

    Deferred attributes trigger lazy loading when accessed on a hydrated
    model instance.
    """
    queryset: QuerySet = self._clone()
    queryset._defer = fields
    return queryset
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: Any

RETURNS DESCRIPTION
QuerySet

Cloned queryset configured to join and hydrate the related

TYPE: QuerySet

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
def select_related(self, related: Any) -> "QuerySet":
    """Eager-load foreign-key relationships in the same SQL query.

    Args:
        related: One relation path or an iterable of relation paths.

    Returns:
        QuerySet: Cloned queryset configured to join and hydrate the related
        objects.
    """
    queryset: QuerySet = self._clone()
    if not isinstance(related, (list, tuple)):
        related = [related]

    queryset._select_related = queryset._dedupe_related_paths(
        [*queryset._select_related, *related]
    )
    return queryset

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: Sequence[str] | str | None DEFAULT: None

exclude

Optional field blacklist.

TYPE: Sequence[str] | set[str] DEFAULT: None

exclude_none

Whether None values should be omitted.

TYPE: bool DEFAULT: False

flatten

When tuple output is requested, flatten a single selected field into a list of scalar values.

TYPE: bool DEFAULT: False

**kwargs

Internal compatibility flags.

TYPE: Any DEFAULT: {}

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
async def values(
    self,
    fields: Sequence[str] | str | None = None,
    exclude: Sequence[str] | set[str] = None,
    exclude_none: bool = False,
    flatten: bool = False,
    **kwargs: Any,
) -> list[Any]:
    """Return queryset results as dictionaries or tuples.

    Args:
        fields: Optional field whitelist.
        exclude: Optional field blacklist.
        exclude_none: Whether `None` values should be omitted.
        flatten: When tuple output is requested, flatten a single selected
            field into a list of scalar values.
        **kwargs: Internal compatibility flags.

    Returns:
        list[Any]: Serialized rows.
    """
    fields = fields or []
    queryset: QuerySet = self._clone()
    rows: list[type[Model]] = await queryset.all()

    if not isinstance(fields, list):
        raise QuerySetError(detail="Fields must be an iterable.")

    if not fields:
        rows = [row.model_dump(exclude=exclude, exclude_none=exclude_none) for row in rows]  # type: ignore
    else:
        rows = [
            row.model_dump(exclude=exclude, exclude_none=exclude_none, include=fields)  # type: ignore
            for row in rows
        ]

    as_tuple = kwargs.pop("__as_tuple__", False)

    if not as_tuple:
        return rows

    if not flatten:
        rows = [tuple(row.values()) for row in rows]  # type: ignore
    else:
        try:
            rows = [row[fields[0]] for row in rows]  # type: ignore
        except KeyError:
            raise QuerySetError(detail=f"{fields[0]} does not exist in the results.") from None
    return rows

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: Sequence[str] | str | None DEFAULT: None

exclude

Fields to exclude from the output.

TYPE: Sequence[str] | set[str] DEFAULT: None

exclude_none

Whether None values should be omitted.

TYPE: bool DEFAULT: False

flat

Whether to flatten the result to a single scalar column.

TYPE: bool DEFAULT: False

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
async def values_list(
    self,
    fields: Sequence[str] | str | None = None,
    exclude: Sequence[str] | set[str] = None,
    exclude_none: bool = False,
    flat: bool = False,
) -> list[Any]:
    """Return queryset results as tuples or flattened scalar values.

    Args:
        fields: Fields to include in the output.
        exclude: Fields to exclude from the output.
        exclude_none: Whether `None` values should be omitted.
        flat: Whether to flatten the result to a single scalar column.

    Returns:
        list[Any]: Tuple rows or flattened values.
    """
    fields = fields or []
    if flat and len(fields) > 1:
        raise QuerySetError(
            detail=f"Maximum of 1 in fields when `flat` is enables, got {len(fields)} instead."
        ) from None

    if flat and isinstance(fields, str):
        fields = [fields]

    if isinstance(fields, str):
        fields = [fields]

    return await self.values(
        fields=fields,
        exclude=exclude,
        exclude_none=exclude_none,
        flatten=flat,
        __as_tuple__=True,
    )

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: Any DEFAULT: {}

RETURNS DESCRIPTION
bool

True when the queryset matches at least one row.

TYPE: bool

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
async def exists(self, **kwargs: Any) -> bool:
    """Return whether at least one row matches the queryset.

    Args:
        **kwargs: Optional extra lookup kwargs to apply before evaluation.

    Returns:
        bool: `True` when the queryset matches at least one row.
    """
    if kwargs:
        cached = self._cache.get(self.model_class, kwargs)
        if cached is not None:
            return True
    elif self._cache_count is not None:
        return self._cache_count > 0

    queryset: QuerySet = self.filter(**kwargs) if kwargs else self._clone()
    expression = queryset._build_select()
    expression = sqlalchemy.exists(expression).select()
    queryset._set_query_expression(expression)
    check_db_connection(queryset.database)
    async with queryset.database as database:
        _exists = await database.fetch_val(expression)
    return cast("bool", _exists)

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: Any DEFAULT: {}

RETURNS DESCRIPTION
int

Number of matched rows.

TYPE: int

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
async def count(self, **kwargs: Any) -> int:
    """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.

    Args:
        **kwargs: Optional extra lookup kwargs to apply before counting.

    Returns:
        int: Number of matched rows.
    """
    if not kwargs and self._cache_count is not None:
        return self._cache_count

    queryset: QuerySet = self.filter(**kwargs) if kwargs else self._clone()
    base_select = queryset._build_select()
    subquery = base_select.subquery("subquery_for_count")

    needs_distinct = bool(
        queryset.or_clauses
        or queryset._select_related
        or queryset._filter_related
        or queryset._group_by
        or queryset._collect_related_paths(queryset._order_by)
    )
    if needs_distinct:
        pk_columns = [subquery.c[column] for column in queryset.model_class.pkcolumns]
        if len(pk_columns) == 1:
            expression = sqlalchemy.select(
                sqlalchemy.func.count(sqlalchemy.distinct(pk_columns[0]))
            )
        else:
            expression = sqlalchemy.select(
                sqlalchemy.func.count(sqlalchemy.distinct(sqlalchemy.tuple_(*pk_columns)))
            )
    else:
        expression = sqlalchemy.select(sqlalchemy.func.count()).select_from(subquery)
    queryset._set_query_expression(expression)
    check_db_connection(queryset.database)
    async with queryset.database as database:
        _count = await database.fetch_val(expression)
    if not kwargs:
        self._cache_count = cast("int", _count)
    return cast("int", _count)

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 None.

Source code in saffier/core/db/querysets/base.py
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
async def get_or_none(self, **kwargs: Any) -> SaffierModel | None:
    """Fetch one row or return `None` instead of raising.

    Returns:
        SaffierModel | None: Matching model instance or `None`.
    """
    try:
        return await self.get(**kwargs)
    except ObjectNotFound:
        return None

_all async

_all(**kwargs)

Execute the queryset and hydrate the full result list.

PARAMETER DESCRIPTION
**kwargs

Optional lookup kwargs applied before evaluation.

TYPE: Any DEFAULT: {}

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
async def _all(self, **kwargs: Any) -> list[SaffierModel]:
    """Execute the queryset and hydrate the full result list.

    Args:
        **kwargs: Optional lookup kwargs applied before evaluation.

    Returns:
        list[SaffierModel]: Hydrated result set.
    """
    if kwargs:
        queryset = self.filter(**kwargs)
        queryset._cache = self._cache
        return await queryset._all()

    if self._cache_fetch_all:
        return list(self._cache.get_category(self.model_class).values())

    queryset = self
    if queryset.is_m2m:
        queryset = queryset.distinct(queryset.m2m_related)

    expression, tables_and_models = queryset._build_select_with_tables()
    queryset._set_query_expression(expression)
    self._set_query_expression(expression)
    if queryset._select_related:
        self._cached_select_related_expression = expression

    check_db_connection(queryset.database)
    async with queryset.database as database:
        rows = await database.fetch_all(expression)

    is_only_fields = bool(queryset._only)
    is_defer_fields = bool(queryset._defer)

    # Attach the raw query to the object
    queryset.model_class.raw_query = queryset.sql

    results: list[SaffierModel] = []
    for row in rows:
        result = await queryset._hydrate_row(
            queryset,
            row,
            tables_and_models,
            is_only_fields=is_only_fields,
            is_defer_fields=is_defer_fields,
        )
        if not queryset.is_m2m:
            results.append(
                queryset._cache_or_return_result(queryset._embed_parent_in_result(result))
            )
        else:
            related_result = getattr(result, queryset.m2m_related)
            results.append(queryset._cache_or_return_result(related_result))

    queryset._cache_count = len(results)
    queryset._cache_first = results[0] if results else None
    queryset._cache_last = results[-1] if results else None
    queryset._cache_fetch_all = True

    return results

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: bool DEFAULT: False

**kwargs

Deferred lookup kwargs applied during evaluation.

TYPE: Any DEFAULT: {}

RETURNS DESCRIPTION
QuerySet

Queryset ready for evaluation.

TYPE: QuerySet

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
def all(self, clear_cache: bool = False, **kwargs: Any) -> "QuerySet":
    """Return a clone ready for full evaluation.

    Args:
        clear_cache: Whether result caches should be cleared on the current
            queryset.
        **kwargs: Deferred lookup kwargs applied during evaluation.

    Returns:
        QuerySet: Queryset ready for evaluation.
    """
    if clear_cache:
        self._clear_cache(keep_cached_selected=not self._has_dynamic_clauses)
        return self
    queryset: QuerySet = self._clone()
    queryset.extra = kwargs
    return queryset

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
async def get(self, **kwargs: Any) -> SaffierModel:
    """Return exactly one row matched by the queryset or lookup kwargs.

    Raises:
        ObjectNotFound: If no row matches.
        MultipleObjectsReturned: If more than one row matches.
    """
    if kwargs:
        cached = self._cache.get(self.model_class, kwargs)
        if cached is not None:
            return cast("SaffierModel", cached)
        queryset = self.filter(**kwargs)
        queryset._cache = self._cache
        return await queryset.get()

    if self._cache_count == 1 and self._cache_first is not None:
        return self._cache_first
    if self._cache_count == 0:
        raise ObjectNotFound()
    if self._cache_fetch_all and self._cache_count and self._cache_count > 1:
        raise MultipleObjectsReturned()

    queryset = self

    expression, tables_and_models = queryset._build_select_with_tables()
    expression = expression.limit(2)
    check_db_connection(queryset.database)
    async with queryset.database as database:
        rows = await database.fetch_all(expression)
    queryset._set_query_expression(expression)
    if queryset._select_related:
        self._cached_select_related_expression = expression

    is_only_fields = bool(queryset._only)
    is_defer_fields = bool(queryset._defer)

    if not rows:
        raise ObjectNotFound()
    if len(rows) > 1:
        raise MultipleObjectsReturned()
    result = await queryset._hydrate_row(
        queryset,
        rows[0],
        tables_and_models,
        is_only_fields=is_only_fields,
        is_defer_fields=is_defer_fields,
    )
    result = queryset._cache_or_return_result(queryset._embed_parent_in_result(result))
    queryset._cache_count = 1
    queryset._cache_first = result
    queryset._cache_last = result
    return result

first async

first(**kwargs)

Return the first row for the queryset.

RETURNS DESCRIPTION
SaffierModel | None

SaffierModel | None: First matching model instance or None.

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
async def first(self, **kwargs: Any) -> SaffierModel | None:
    """Return the first row for the queryset.

    Returns:
        SaffierModel | None: First matching model instance or `None`.
    """
    if not kwargs:
        if self._cache_count == 0:
            return None
        if self._cache_first is not None:
            return self._cache_first

    queryset: QuerySet = self._clone()
    if kwargs:
        queryset = queryset.filter(**kwargs)

    if not queryset._order_by:
        queryset = queryset.order_by(*queryset.pknames)

    queryset = queryset.limit(1)
    expression, tables_and_models = queryset._build_select_with_tables()
    queryset._set_query_expression(expression)
    if queryset._select_related:
        self._cached_select_related_expression = expression

    check_db_connection(queryset.database)
    async with queryset.database as database:
        rows = await database.fetch_all(expression)
    if not rows:
        return None

    result = await queryset._hydrate_row(
        queryset,
        rows[0],
        tables_and_models,
        is_only_fields=bool(queryset._only),
        is_defer_fields=bool(queryset._defer),
    )
    result = queryset._cache_or_return_result(queryset._embed_parent_in_result(result))
    if queryset.is_m2m:
        return getattr(result, queryset.m2m_related)
    if not kwargs:
        self._cache_first = result
    return result

last async

last(**kwargs)

Return the last row for the queryset.

RETURNS DESCRIPTION
SaffierModel | None

SaffierModel | None: Last matching model instance or None.

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
async def last(self, **kwargs: Any) -> SaffierModel | None:
    """Return the last row for the queryset.

    Returns:
        SaffierModel | None: Last matching model instance or `None`.
    """
    if not kwargs:
        if self._cache_count == 0:
            return None
        if self._cache_last is not None:
            return self._cache_last

    queryset: QuerySet = self._clone()
    if kwargs:
        queryset = queryset.filter(**kwargs)

    if not queryset._order_by:
        queryset = queryset.order_by(*queryset.pknames)

    queryset = queryset.reverse().limit(1)
    expression, tables_and_models = queryset._build_select_with_tables()
    queryset._set_query_expression(expression)
    if queryset._select_related:
        self._cached_select_related_expression = expression

    check_db_connection(queryset.database)
    async with queryset.database as database:
        rows = await database.fetch_all(expression)
    if not rows:
        return None

    result = await queryset._hydrate_row(
        queryset,
        rows[0],
        tables_and_models,
        is_only_fields=bool(queryset._only),
        is_defer_fields=bool(queryset._defer),
    )
    result = queryset._cache_or_return_result(queryset._embed_parent_in_result(result))
    if queryset.is_m2m:
        return getattr(result, queryset.m2m_related)
    if not kwargs:
        self._cache_last = result
    return result

_filter_lookup_kwargs

_filter_lookup_kwargs(payload)
Source code in saffier/core/db/querysets/base.py
1859
1860
1861
1862
1863
1864
def _filter_lookup_kwargs(self, payload: dict[str, Any]) -> dict[str, Any]:
    return {
        key: value
        for key, value in payload.items()
        if key in self.model_class.fields and self.model_class.fields[key].has_column()
    }

_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
def _extract_model_reference_kwargs(self, payload: dict[str, Any]) -> dict[str, Any]:
    return {
        key: value
        for key, value in payload.items()
        if key in self.model_class.fields
        and getattr(self.model_class.fields[key], "is_model_reference", False)
    }

_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
async def _persist_model_reference_kwargs(
    self,
    instance: SaffierModel,
    payload: dict[str, Any],
) -> None:
    if not payload:
        return
    for key, value in payload.items():
        setattr(instance, key, value)
    await instance._persist_model_references(set(payload))

create async

create(*model_refs, **kwargs)

Create one model instance and persist any staged many-to-many values.

PARAMETER DESCRIPTION
*model_refs

Positional ModelRef objects consumed by RefForeignKey fields.

TYPE: Any DEFAULT: ()

**kwargs

Field payload used to construct the instance.

TYPE: Any DEFAULT: {}

RETURNS DESCRIPTION
SaffierModel

The newly created model instance.

TYPE: SaffierModel

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
async def create(self, *model_refs: Any, **kwargs: Any) -> SaffierModel:
    """Create one model instance and persist any staged many-to-many values.

    Args:
        *model_refs: Positional `ModelRef` objects consumed by
            `RefForeignKey` fields.
        **kwargs: Field payload used to construct the instance.

    Returns:
        SaffierModel: The newly created model instance.
    """
    queryset: QuerySet = self._clone()
    check_db_connection(queryset.database)
    explicit_input = queryset.model_class.normalize_field_kwargs(dict(kwargs))
    explicit_input = queryset.model_class.merge_model_refs(model_refs, explicit_input)
    many_to_many_values: dict[str, list[Any]] = {}
    for field_name, field in queryset.model_class.fields.items():
        if not isinstance(field, saffier_fields.ManyToManyField):
            continue
        if field_name not in kwargs:
            continue
        many_to_many_values[field_name] = queryset._normalize_many_to_many_values(
            field,
            kwargs.pop(field_name),
        )

    kwargs = queryset._validate_kwargs(**kwargs)
    kwargs = queryset.model_class.merge_model_refs(model_refs, kwargs)
    instance_kwargs = {
        key: value
        for key, value in kwargs.items()
        if key in explicit_input
        or key not in queryset.model_class.fields
        or not queryset.model_class.fields[key].has_column()
    }
    instance = queryset.model_class(**instance_kwargs)
    instance.table = queryset.table
    instance = await instance.save(force_save=True, values=set(explicit_input.keys()))

    for field_name, related_values in many_to_many_values.items():
        relation = getattr(instance, field_name)
        for related_value in related_values:
            if getattr(related_value, "pk", None) is None:
                raise QuerySetError(
                    detail=(
                        f"Cannot assign unsaved related object to '{field_name}' while creating "
                        f"'{queryset.model_class.__name__}'."
                    )
                )
            await relation.add(related_value)

    self._clear_cache(keep_result_cache=True, keep_cached_selected=True)
    self._cache.update(self.model_class, [instance])
    return instance

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: list[dict]

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
async def bulk_create(self, objs: list[dict]) -> None:
    """Insert multiple rows in one bulk operation.

    Args:
        objs: List of logical field payloads to validate and insert.
    """
    queryset: QuerySet = self._clone()
    new_objs = []
    for obj in objs:
        validated_obj = queryset._validate_kwargs(**obj)
        db_values = queryset.model_class.extract_column_values(
            validated_obj,
            phase="prepare_insert",
            instance=queryset,
            evaluate_values=True,
        )
        new_objs.append(db_values)

    if not new_objs:
        return
    expression = queryset.table.insert()
    queryset._set_query_expression(expression)
    check_db_connection(queryset.database)
    async with queryset.database as database:
        await database.execute_many(expression, new_objs)

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
async def bulk_update(self, objs: list[SaffierModel], fields: list[str]) -> None:
    """
    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.
    """
    queryset: QuerySet = self._clone()

    new_fields = {}
    for key, field in queryset.model_class.fields.items():
        if key in fields and field.has_column():
            field_validator = field.validator
            if field_validator.read_only:
                field_validator = copy.copy(field_validator)
                field_validator.read_only = False
            new_fields[key] = field_validator

    validator = Schema(fields=new_fields)

    new_objs = []
    for obj in objs:
        new_obj = {}
        for key, value in obj.__dict__.items():
            if key in fields and key in queryset.model_class.fields:
                if not queryset.model_class.fields[key].has_column():
                    continue
                new_obj[key] = value
        new_objs.append(new_obj)

    new_objs = [
        queryset.model_class.extract_column_values(
            queryset._update_auto_now_fields(
                validator.check(obj), queryset.model_class.fields
            ),
            is_update=True,
            is_partial=True,
            phase="prepare_update",
            instance=queryset,
        )
        for obj in new_objs
    ]

    pk_bind_names = {pk_name: f"__pk_{pk_name}" for pk_name in queryset.pknames}
    expression = queryset.table.update().where(
        sqlalchemy.and_(
            *[
                getattr(queryset.table.c, pk_name)
                == sqlalchemy.bindparam(pk_bind_names[pk_name])
                for pk_name in queryset.pknames
            ]
        )
    )
    kwargs: dict[str, Any] = {
        field: sqlalchemy.bindparam(field) for obj in new_objs for field in obj
    }
    pks = [
        {pk_bind_names[pk_name]: getattr(obj, pk_name) for pk_name in queryset.pknames}
        for obj in objs
    ]

    query_list = []
    for pk, value in zip(pks, new_objs):  # noqa
        query_list.append({**pk, **value})

    expression = expression.values(kwargs)
    queryset._set_query_expression(expression)
    check_db_connection(queryset.database)
    async with queryset.database as database:
        await database.execute_many(expression, query_list)

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
async def raw_delete(
    self,
    use_models: bool = False,
    remove_referenced_call: str | bool = False,
) -> int:
    queryset: QuerySet = self._clone()
    if getattr(queryset.model_class, "__require_model_based_deletion__", False):
        use_models = True

    if use_models:
        row_count = 0
        for model in await queryset.all():
            row_count += await model.raw_delete(
                skip_post_delete_hooks=False,
                remove_referenced_call=remove_referenced_call,
            )
        return row_count

    count_expression = sqlalchemy.func.count().select().select_from(queryset.table)
    if queryset.filter_clauses:
        count_expression = queryset._build_filter_clauses_expression(
            queryset.filter_clauses, expression=count_expression
        )

    if queryset.or_clauses:
        count_expression = queryset._build_or_clauses_expression(
            queryset.or_clauses, expression=count_expression
        )

    check_db_connection(queryset.database)
    async with queryset.database as database:
        row_count = cast("int", await database.fetch_val(count_expression) or 0)
    expression = queryset.table.delete()

    if queryset.filter_clauses:
        expression = queryset._build_filter_clauses_expression(
            queryset.filter_clauses, expression=expression
        )

    if queryset.or_clauses:
        expression = queryset._build_or_clauses_expression(queryset.or_clauses, expression)

    queryset._set_query_expression(expression)
    check_db_connection(queryset.database)
    async with queryset.database as database:
        await database.execute(expression)
    return row_count

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: bool DEFAULT: False

RETURNS DESCRIPTION
int

Number of deleted rows.

TYPE: int

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
async def delete(self, use_models: bool = False) -> int:
    """Delete rows matched by the queryset and emit delete signals.

    Args:
        use_models: Whether deletion should materialize model instances to
            honor model-based cleanup logic.

    Returns:
        int: Number of deleted rows.
    """
    queryset: QuerySet = self._clone()
    if getattr(queryset.model_class, "__require_model_based_deletion__", False):
        use_models = True
    await self.model_class.signals.pre_delete.send(
        sender=self.__class__,
        instance=self,
        model_instance=None,
    )

    row_count = await queryset.raw_delete(
        use_models=use_models,
        remove_referenced_call=False,
    )

    await self.model_class.signals.post_delete.send(
        sender=self.__class__,
        instance=self,
        model_instance=None,
        row_count=row_count,
    )
    return row_count

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: Any DEFAULT: {}

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
async def update(self, **kwargs: Any) -> None:
    """Update rows matched by the queryset with the provided field values.

    Args:
        **kwargs: Logical field payload to normalize, validate, and persist.
    """
    queryset: QuerySet = self._clone()
    normalized_kwargs = queryset.model_class.normalize_field_kwargs(kwargs)
    db_kwargs = {
        key: value
        for key, value in normalized_kwargs.items()
        if key in queryset.model_class.fields and queryset.model_class.fields[key].has_column()
    }
    fields = {
        key: (
            copy.copy(field.validator)
            if key in db_kwargs and field.validator.read_only
            else field.validator
        )
        for key, field in queryset.model_class.fields.items()
        if key in db_kwargs
    }
    for field_validator in fields.values():
        if field_validator.read_only:
            field_validator.read_only = False

    validator = Schema(fields=fields)
    db_kwargs = queryset.model_class.extract_column_values(
        validator.check(db_kwargs),
        is_update=True,
        is_partial=True,
        phase="prepare_update",
        instance=queryset,
    )
    db_kwargs = queryset._update_auto_now_fields(db_kwargs, queryset.model_class.fields)

    await self.model_class.signals.pre_update.send(
        sender=self.__class__, instance=self, kwargs=db_kwargs
    )

    if not db_kwargs:
        await self.model_class.signals.post_update.send(sender=self.__class__, instance=self)
        return

    expression = queryset.table.update().values(**db_kwargs)

    for filter_clause in queryset.filter_clauses:
        expression = expression.where(filter_clause)

    queryset._set_query_expression(expression)
    check_db_connection(queryset.database)
    async with queryset.database as database:
        await database.execute(expression)

    await self.model_class.signals.post_update.send(sender=self.__class__, instance=self)

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 ModelRef objects for reference fields.

TYPE: Any DEFAULT: ()

defaults

Extra values applied only during creation.

TYPE: dict[str, Any] | None DEFAULT: None

**kwargs

Lookup payload and creation payload.

TYPE: Any DEFAULT: {}

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
async def get_or_create(
    self,
    *model_refs: Any,
    defaults: dict[str, Any] | None = None,
    **kwargs: Any,
) -> tuple[SaffierModel, bool]:
    """Fetch one row or create it when missing.

    Args:
        *model_refs: Positional `ModelRef` objects for reference fields.
        defaults: Extra values applied only during creation.
        **kwargs: Lookup payload and creation payload.

    Returns:
        tuple[SaffierModel, bool]: Instance and a flag indicating whether it
        was created.
    """
    queryset: QuerySet = self._clone()
    defaults = defaults or {}
    lookup_kwargs = queryset._filter_lookup_kwargs(kwargs)
    ref_payload = dict(kwargs)
    ref_payload.update(defaults)
    ref_kwargs = queryset._extract_model_reference_kwargs(
        queryset.model_class.merge_model_refs(model_refs, ref_payload)
    )
    try:
        instance = await queryset.get(**lookup_kwargs)
        await queryset._persist_model_reference_kwargs(instance, ref_kwargs)
        return instance, False
    except ObjectNotFound:
        kwargs.update(defaults)
        instance = await queryset.create(*model_refs, **kwargs)
        return instance, True

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
async def bulk_get_or_create(
    self,
    objs: list[dict[str, Any] | SaffierModel],
    unique_fields: list[str] | None = None,
) -> list[SaffierModel]:
    """
    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.
    """
    queryset: QuerySet = self._clone()
    instances: list[SaffierModel] = []
    seen_lookups: set[tuple[tuple[str, Any], ...]] = set()

    for obj in objs:
        values = obj if isinstance(obj, dict) else obj.extract_db_fields()

        if unique_fields:
            lookup = {}
            for field in unique_fields:
                if field not in values:
                    raise QuerySetError(
                        detail=f"Field '{field}' is required in unique_fields lookups."
                    )
                lookup[field] = values[field]

            lookup_key = tuple(sorted(lookup.items()))
            if lookup_key in seen_lookups:
                continue
            seen_lookups.add(lookup_key)

            instance = await queryset.get_or_none(**lookup)
            if instance is not None:
                instances.append(instance)
                continue

        instance = await queryset.create(**values)
        instances.append(instance)

    return instances

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
async def update_or_create(
    self,
    *model_refs: Any,
    defaults: dict[str, Any] | None = None,
    **kwargs: Any,
) -> tuple[SaffierModel, bool]:
    """Fetch one row and update it, or create it when missing.

    Returns:
        tuple[SaffierModel, bool]: Instance and a flag indicating whether it
        was created.
    """
    queryset: QuerySet = self._clone()
    defaults = defaults or {}
    lookup_kwargs = queryset._filter_lookup_kwargs(kwargs)
    ref_payload = dict(kwargs)
    ref_payload.update(defaults)
    ref_kwargs = queryset._extract_model_reference_kwargs(
        queryset.model_class.merge_model_refs(model_refs, ref_payload)
    )
    try:
        instance = await queryset.get(**lookup_kwargs)
        await instance.update(**defaults)
        await queryset._persist_model_reference_kwargs(instance, ref_kwargs)
        return instance, False
    except ObjectNotFound:
        kwargs.update(defaults)
        instance = await queryset.create(*model_refs, **kwargs)
        return instance, True

contains async

contains(instance)

Return whether the queryset contains the provided persisted object.

PARAMETER DESCRIPTION
instance

Persisted model instance to test.

TYPE: SaffierModel

RETURNS DESCRIPTION
bool

True if a row with the same primary key matches the queryset.

TYPE: bool

Source code in saffier/core/db/querysets/base.py
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
async def contains(self, instance: SaffierModel) -> bool:
    """Return whether the queryset contains the provided persisted object.

    Args:
        instance: Persisted model instance to test.

    Returns:
        bool: `True` if a row with the same primary key matches the queryset.
    """
    queryset: QuerySet = self._clone()
    if getattr(instance, "pk", None) is None:
        raise ValueError("'obj' must be a model or reflect model instance.")
    return await queryset.filter(pk=instance.pk).exists()

_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
def _combine(
    self,
    other: "QuerySet",
    op: str,
    *,
    all_: bool = False,
) -> "CombinedQuerySet":
    if not isinstance(other, QuerySet):
        raise TypeError("other must be a QuerySet")

    if self.model_class is not other.model_class:
        raise QuerySetError(detail="Both querysets must have the same model_class to combine.")

    if self.database is not other.database and str(self.database.url) != str(
        other.database.url
    ):
        raise QuerySetError(detail="Both querysets must use the same database.")

    op_name = f"{op}_all" if all_ else op
    return CombinedQuerySet(left=self, right=other, op=op_name)

union

union(other, *, all=False)

Combine two querysets using SQL UNION.

RETURNS DESCRIPTION
CombinedQuerySet

Combined queryset wrapper.

TYPE: CombinedQuerySet

Source code in saffier/core/db/querysets/base.py
2318
2319
2320
2321
2322
2323
2324
def union(self, other: "QuerySet", *, all: bool = False) -> "CombinedQuerySet":
    """Combine two querysets using SQL `UNION`.

    Returns:
        CombinedQuerySet: Combined queryset wrapper.
    """
    return self._combine(other, "union", all_=all)

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
def union_all(self, other: "QuerySet") -> "CombinedQuerySet":
    """Combine two querysets using SQL `UNION ALL`.

    Unlike `union()`, duplicate rows are preserved.
    """
    return self._combine(other, "union", all_=True)

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
def intersect(self, other: "QuerySet", *, all: bool = False) -> "CombinedQuerySet":
    """Combine two querysets using SQL `INTERSECT`.

    Only rows present in both querysets are returned.
    """
    return self._combine(other, "intersect", all_=all)

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
def intersect_all(self, other: "QuerySet") -> "CombinedQuerySet":
    """Combine two querysets using SQL `INTERSECT ALL`.

    Duplicate row counts from both sides are preserved where supported.
    """
    return self._combine(other, "intersect", all_=True)

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
def except_(self, other: "QuerySet", *, all: bool = False) -> "CombinedQuerySet":
    """Combine two querysets using SQL `EXCEPT`.

    Rows produced by `other` are removed from the left-hand queryset.
    """
    return self._combine(other, "except", all_=all)

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
def except_all(self, other: "QuerySet") -> "CombinedQuerySet":
    """Combine two querysets using SQL `EXCEPT ALL`.

    Duplicate row counts are considered where the backend supports it.
    """
    return self._combine(other, "except", all_=True)

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: QuerySet

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
def select_for_update(
    self,
    *,
    nowait: bool = False,
    skip_locked: bool = False,
    read: bool = False,
    key_share: bool = False,
    of: Sequence[type["Model"]] | None = None,
) -> "QuerySet":
    """Request row-level locks via `SELECT ... FOR UPDATE`.

    Returns:
        QuerySet: Cloned queryset configured with lock options.
    """
    queryset: QuerySet = self._clone()
    payload: dict[str, Any] = {
        "nowait": bool(nowait),
        "skip_locked": bool(skip_locked),
        "read": bool(read),
        "key_share": bool(key_share),
    }
    if of:
        payload["of"] = tuple(of)
    queryset._for_update = payload
    return queryset

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
def transaction(self, *, force_rollback: bool = False, **kwargs: Any) -> Any:
    """Return a transaction context manager bound to the queryset database.

    This is a convenience pass-through to the underlying database object.
    """
    return self.database.transaction(force_rollback=force_rollback, **kwargs)

_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: SaffierModel

RETURNS DESCRIPTION
SaffierModel

Exposed result object.

TYPE: SaffierModel

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
def _embed_parent_in_result(self, result: SaffierModel) -> SaffierModel:
    """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.

    Args:
        result: Hydrated result produced from the base queryset.

    Returns:
        SaffierModel: Exposed result object.
    """
    if not self.embed_parent:
        return result

    new_result: Any = result
    for part in self.embed_parent[0].split("__"):
        new_result = getattr(new_result, part)

    if self.embed_parent[1]:
        try:
            setattr(new_result, self.embed_parent[1], result)
        except AttributeError:
            object.__setattr__(new_result, self.embed_parent[1], result)
    return cast("SaffierModel", new_result)

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
async def as_select_with_tables(self) -> tuple[Any, dict[str, tuple[Any, Any]]]:
    """Return the SQLAlchemy select expression together with the table map.

    Returns:
        tuple[Any, dict[str, tuple[Any, Any]]]: Select expression and join
        table/model mapping.
    """
    return self._build_select_with_tables()

as_select async

as_select()

Return only the SQLAlchemy select expression for the queryset.

RETURNS DESCRIPTION
Any

SQLAlchemy select expression.

TYPE: Any

Source code in saffier/core/db/querysets/base.py
2431
2432
2433
2434
2435
2436
2437
async def as_select(self) -> Any:
    """Return only the SQLAlchemy select expression for the queryset.

    Returns:
        Any: SQLAlchemy select expression.
    """
    return (await self.as_select_with_tables())[0]

_execute async

_execute()
Source code in saffier/core/db/querysets/base.py
2439
2440
2441
async def _execute(self) -> Any:
    records = await self._all(**self.extra)
    return records

_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
async def _execute_iterate(
    self,
    fetch_all_at_once: bool = False,
) -> AsyncIterator[SaffierModel]:
    queryset: QuerySet = self._clone()

    if queryset.is_m2m:
        queryset.distinct_on = [queryset.m2m_related]

    if queryset.extra:
        queryset = queryset.filter(**queryset.extra)

    expression, tables_and_models = queryset._build_select_with_tables()
    queryset._set_query_expression(expression)

    is_only_fields = bool(queryset._only)
    is_defer_fields = bool(queryset._defer)
    queryset.model_class.raw_query = queryset.sql

    if not fetch_all_at_once and bool(getattr(queryset.database, "force_rollback", False)):
        warnings.warn(
            'Using queryset iterations with "Database"-level force_rollback set is risky. '
            "Deadlocks can occur because only one connection is used.",
            UserWarning,
            stacklevel=3,
        )
    if queryset._prefetch_related:
        fetch_all_at_once = True

    check_db_connection(queryset.database)
    if fetch_all_at_once:
        async with queryset.database as database:
            rows = await database.fetch_all(expression)

        for row in rows:
            result = await queryset._hydrate_row(
                queryset,
                row,
                tables_and_models,
                is_only_fields=is_only_fields,
                is_defer_fields=is_defer_fields,
            )

            if not queryset.is_m2m:
                yield queryset._embed_parent_in_result(result)
            else:
                yield getattr(result, queryset.m2m_related)
        return

    async with queryset.database as database:
        async for row in database.iterate(expression, chunk_size=queryset._batch_size):
            result = await queryset._hydrate_row(
                queryset,
                row,
                tables_and_models,
                is_only_fields=is_only_fields,
                is_defer_fields=is_defer_fields,
            )

            if not queryset.is_m2m:
                yield queryset._embed_parent_in_result(result)
            else:
                yield getattr(result, queryset.m2m_related)