Skip to content

Latest commit

 

History

History
281 lines (189 loc) · 6.11 KB

filtering_usage_examples.rst

File metadata and controls

281 lines (189 loc) · 6.11 KB
Raw

Filter usage examples

Example usage of filtering backends.

Contents:

Table of Contents

Search

Query param name reserved for search is search. Make sure your models and documents do not have it as a field or attribute.

Multiple search terms are joined with OR.

Let's assume we have a number of Book items with fields title, description and summary.

Search in all fields

Search in all fields (name, address, city, state_province and country) for word "reilly".

http://127.0.0.1:8080/search/publisher/?search=reilly

Search a single term on specific field

In order to search in specific field (name) for term "reilly", add the field name separated with : to the search term.

http://127.0.0.1:8080/search/publisher/?search=name:reilly

Search for multiple terms

In order to search for multiple terms "reilly", "bloomsbury" add multiple search query params.

http://127.0.0.1:8080/search/publisher/?search=reilly&search=bloomsbury

Search for multiple terms in specific fields

In order to search for multiple terms "reilly", "bloomsbury" in specific fields add multiple search query params and field names separated with : to each of the search terms.

http://127.0.0.1:8080/search/publisher/?search=name:reilly&search=city:london

Filtering

Supported lookups

Native

The following native (to Elasticsearch) filters/lookups are implemented:

term

Find documents which contain the exact term specified in the field specified.

http://127.0.0.1:8080/search/books/?tags__term=education&tags__term=economy
terms

Find documents which contain any of the exact terms specified in the field specified. Note, that multiple values are separated with double underscores __.

http://localhost:8000/api/articles/?id=1&id=2&id=3
http://localhost:8000/api/articles/?id__terms=1__2__3
range

Find documents where the field specified contains values (dates, numbers, or strings) in the range specified.

From, to

http://localhost:8000/api/users/?age__range=16__67

From, to, boost

http://localhost:8000/api/users/?age__range=16__67__2.0
exists

Find documents where the field specified contains any non-null value.

http://localhost:8000/api/articles/?tags__exists=true
prefix

Find documents where the field specified contains terms which begin with the exact prefix specified.

http://localhost:8000/api/articles/?tags__prefix=bio
wildcard

Find documents where the field specified contains terms which match the pattern specified, where the pattern supports single character wildcards (?) and multi-character wildcards (*)

http://localhost:8000/api/articles/?title__wildcard=*elusional*
ids

Find documents with the specified type and IDs.

http://localhost:8000/api/articles/?ids=68__64__58
http://localhost:8000/api/articles/?ids=68&ids=64&ids=58

Functional

The following functional (non-native to Elasticsearch, but common in Django) filters/lookups are implemented:

contains

Case-insensitive containment test.

in

In a given list.

http://localhost:8000/api/articles/?id__in=1__2__3
gt

Greater than.

http://localhost:8000/api/users/?id__gt=10
gte

Greater than or equal to.

http://localhost:8000/api/users/?id__gte=10
lt

Less than.

http://localhost:8000/api/users/?id__lt=10
lte

Less than or equal to.

http://localhost:8000/api/users/?id__lte=10
startswith

Case-sensitive starts-with.

http://localhost:8000/api/articles/?tags__startswith=bio

endswith

Case-sensitive ends-with.

http://localhost:8000/api/articles/?state__endswith=lished
isnull

Takes either True or False.

True

http://localhost:8000/api/articles/?null_field__isnull=true

False

http://localhost:8000/api/articles/?tags__isnull=false
exclude

Returns a new query set of containing objects that do not match the given lookup parameters.

http://localhost:8000/api/articles/?tags__exclude=children
http://localhost:8000/api/articles/?tags__exclude=children__python

Usage examples

See the example project for sample models/views/serializers.

Additionally, see: