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

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

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'),
    ]

Вызываемые функции также обеспечивают способ индексирования полей из связанных моделей. В примере из Встроенных панелей и кластеров моделей, для индексирования каждой 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'),
    ]