BaseQuery
Immutable query base with filtering, pagination, loading, and execution.
Usage
BaseQuery(
backend,
*,
context,
model=None,
filters=None,
predicates=None,
orderings=None,
preloads=None,
limit=None,
offset=None,
property_filters=None,
parent_resource_id=None,
parameter_filters=None,
include_archived=False,
local_metadata_filters=None,
effective_metadata_filters=None,
load_mode=None,
on_unloaded=None
)Methods
| Name | Description |
|---|---|
| all() | Execute query and return all matching models or references. |
| count() | Return matching row count without materializing rows. |
| export() | Export one materialized query result through a registered exporter. |
| filter() | Return clone with equality filters merged. |
| first() |
Execute query and return first match, or None.
|
| include() | Return clone requesting relation preloads. |
| include_archived() | Return clone including archived entities. |
| limit() |
Return clone constrained to at most value rows.
|
| offset() |
Return clone skipping value rows.
|
| order_by() | Return clone with orderings appended. |
| where() | Return clone with predicates appended using AND semantics. |
all()
Execute query and return all matching models or references.
Usage
all()count()
Return matching row count without materializing rows.
Usage
count()export()
Export one materialized query result through a registered exporter.
Usage
export(format, destination=None)filter()
Return clone with equality filters merged.
Usage
filter(**kwargs)first()
Execute query and return first match, or None.
Usage
first()include()
Return clone requesting relation preloads.
Usage
include(relation_names)include_archived()
Return clone including archived entities.
Usage
include_archived()limit()
Return clone constrained to at most value rows.
Usage
limit(value)offset()
Return clone skipping value rows.
Usage
offset(value)order_by()
Return clone with orderings appended.
Usage
order_by(*orderings)where()
Return clone with predicates appended using AND semantics.
Usage
where(*predicates)