rest_framework.filters.SearchFilter

class documentation

class SearchFilter(BaseFilterBackend): (source)

View In Hierarchy

Undocumented

Method construct_search Undocumented
Method filter_queryset Return a filtered queryset.
Method get_schema_fields Undocumented
Method get_schema_operation_parameters Undocumented
Method get_search_fields Search fields are obtained from the view, but the request is always passed to this method. Sub-classes can override this method to dynamically change the search fields based on request content.
Method get_search_terms Search terms are set by a ?search=... query parameter, and may be comma and/or whitespace delimited.
Method must_call_distinct Return True if 'distinct()' should be used to query the given lookups.
Method to_html Undocumented
Class Variable lookup_prefixes Undocumented
Class Variable search_description Undocumented
Class Variable search_title Undocumented
Class Variable template Undocumented
def construct_search(self, field_name): (source)

Undocumented

def filter_queryset(self, request, queryset, view): (source)
overrides rest_framework.filters.BaseFilterBackend.filter_queryset

Return a filtered queryset.

def get_schema_fields(self, view): (source)
overrides rest_framework.filters.BaseFilterBackend.get_schema_fields

Undocumented

def get_schema_operation_parameters(self, view): (source)
overrides rest_framework.filters.BaseFilterBackend.get_schema_operation_parameters

Undocumented

def get_search_fields(self, view, request): (source)

Search fields are obtained from the view, but the request is always passed to this method. Sub-classes can override this method to dynamically change the search fields based on request content.

def get_search_terms(self, request): (source)

Search terms are set by a ?search=... query parameter, and may be comma and/or whitespace delimited.

def must_call_distinct(self, queryset, search_fields): (source)

Return True if 'distinct()' should be used to query the given lookups.

def to_html(self, request, queryset, view): (source)

Undocumented

lookup_prefixes: dict[str, str] = (source)

Undocumented

search_description = (source)

Undocumented

search_title = (source)

Undocumented

template: str = (source)

Undocumented