Индексирование

Обработчики сигналов

wagtailsearch предоставляет некоторые обработчики сигналов, которые привязываются к сигналам сохранения/удаления всех индексируемых моделей. Это автоматически добавит и удалит их из всех зарегистрированных вами бэкэндов в WAGTAILSEARCH_BACKENDS. Эти обработчики сигналов автоматически регистрируются при загрузке приложения wagtail.search.

В некоторых случаях вы можете не захотеть, чтобы ваше содержимое автоматически переиндексировалось, и вместо этого полагаться на команду update_index для индексирования. Если вам нужно отключить эти обработчики сигналов, используйте один из следующих методов:

Команда update_index

Wagtail также предоставляет команду для перестроения индекса с нуля.

./manage.py update_index

Рекомендуется запускать эту команду один раз в неделю и в следующие моменты:

• в любое время, когда страницы были созданы через скрипт (например, после импорта)
• всякий раз, когда были внесены изменения в модели или конфигурацию поиска

Во время выполнения этой команды поиск может не возвращать результаты, поэтому избегайте запуска в пиковые часы.

Пример

Это создаёт модель EventPage с двумя полями: description и date. description индексируется как SearchField, а date — как FilterField.

from wagtail.search import index
from django.utils import timezone

class EventPage(Page):
    description = models.TextField()
    date = models.DateField()

    search_fields = Page.search_fields + [ # Inherit search_fields from Page
        index.SearchField('description'),
        index.FilterField('date'),
    ]


# Get future events which contain the string "Christmas" in the title or description
>>> EventPage.objects.filter(date__gt=timezone.now()).search("Christmas")

index.SearchField

Они используются для выполнения полнотекстового поиска по вашим моделям, обычно для текстовых полей.

index.AutocompleteField

Они используются для запросов автозаполнения, которые соответствуют частям слов. Например, страница с названием Hello World! будет найдена, если пользователь введёт только Hel в поле поиска.

Это принимает те же самые параметры, что и index.SearchField (за исключением partial_match, который не имеет эффекта).

index.FilterField

Они добавляются в индекс поиска, но не используются для полнотекстового поиска. Вместо этого они позволяют вам применять фильтры к результатам поиска.

index.RelatedFields

Это позволяет индексировать поля из связанных объектов. Это работает со всеми типами связанных полей, включая их обратные аксессоры.

Например, если у нас есть книга, связанная с автором, мы можем вложить поля ForeignKey и name автора в книгу:

from wagtail.search import index

class Book(models.Model, index.Indexed):
    ...

    search_fields = [
        index.SearchField('title'),
        index.FilterField('published_date'),

        index.RelatedFields('author', [
            index.SearchField('name'),
            index.FilterField('date_of_birth'),
        ]),
    ]

Это позволит искать книги по имени автора.

Это также работает в обратную сторону. Вы можете индексировать книги автора, что позволит искать автора по названиям опубликованных книг:

from wagtail.search import index

class Author(models.Model, index.Indexed):
    ...

    search_fields = [
        index.SearchField('name'),
        index.FilterField('date_of_birth'),

        index.RelatedFields('books', [
            index.SearchField('title'),
            index.FilterField('published_date'),
        ]),
    ]

Индексирование вызываемых функций и других атрибутов

Поля поиска/фильтра не обязательно должны быть полями модели Django. Они также могут быть любым методом или атрибутом вашего класса модели.

Одно из применений этого — индексирование методов get_*_display Django создаёт автоматически для полей с набором вариантов.

from wagtail.search import index

class EventPage(Page):
    IS_PRIVATE_CHOICES = (
        (False, "Public"),
        (True, "Private"),
    )

    is_private = models.BooleanField(choices=IS_PRIVATE_CHOICES)

    search_fields = Page.search_fields + [
        # Index the human-readable string for searching.
        index.SearchField('get_is_private_display'),

        # Index the boolean value for filtering.
        index.FilterField('is_private'),
    ]

Вызываемые функции также предоставляют способ индексирования полей из связанных моделей. В примере из Inline Panels and Model Clusters для индексации каждой BookPage по названиям её related_links:

class BookPage(Page):
    # ...
    def get_related_link_titles(self):
        # Get list of titles and concatenate them
        return '\n'.join(self.related_links.all().values_list('name', flat=True))

    search_fields = Page.search_fields + [
        # ...
        index.SearchField('get_related_link_titles'),
    ]