Query

Base class: Part

Declare a query language. Example:

class AlbumQuery(Query):
    year = Filter.integer()
    name = Filter()

query_set = Album.objects.filter(
    AlbumQuery().bind(request=request).get_q()
)

Refinable members

advanced

Type: Namespace

after     (evaluated)

Type: Union[int, str]

See after

assets

Type: Namespace

See assets

auto

Type: QueryAutoConfig

See auto

endpoints

Type: Namespace

extra

Type: Dict[str, Any]

See extra

extra_evaluated

Type: Dict[str, Any]

See extra

extra_params

filter

filters

Type: Namespace

form

Type: Namespace

Cookbook:

How do I set an initial filter to a table?

form_class

form_container     (evaluated)

Type: Fragment

include     (evaluated)

Type: bool

See include

iommi_style

Type: str

member_class

model     (evaluated)

Type: Type[django.db.models.base.Model]

postprocess

rows

template     (evaluated)

Type: Union[str, iommi._web_compat.Template]

Methods

get_advanced_query_param

get_q

Create a query set based on the data in the request.

get_query_string

Based on the data in the request, return the equivalent query string that you can use with parse_query_string() to create a query set.

on_bind

on_refine_done

own_evaluate_parameters

parse_query_string

Class methods

filters_from_model