Skip to content

Latest commit

 

History

History
43 lines (24 loc) · 1.6 KB

index.rst

File metadata and controls

43 lines (24 loc) · 1.6 KB

Search

Wagtail provides a comprehensive and extensible search interface. In addition, it provides ways to promote search results through "Editor's Picks". Wagtail also collects simple statistics on queries made through the search interface.

indexing searching backends

Indexing

To make objects searchable, they must first be added to the search index. This involves configuring the models and fields that you would like to index (which is done for you for Pages, Images and Documents), and then actually inserting them into the index.

See wagtailsearch_indexing_update for information on how to keep the objects in your search index in sync with the objects in your database.

If you have created some extra fields in a subclass of Page or Image, you may want to add these new fields to the search index, so a user's search query can match the Page or Image's extra content. See wagtailsearch_indexing_fields.

If you have a custom model which doesn't derive from Page or Image that you would like to make searchable, see wagtailsearch_indexing_models.

Searching

Wagtail provides an API for performing search queries on your models. You can also perform search queries on Django QuerySets.

See wagtailsearch_searching.

Backends

Wagtail provides three backends for storing the search index and performing search queries: Elasticsearch, the database, and PostgreSQL (Django >=1.10 required). It's also possible to roll your own search backend.

See wagtailsearch_backends