wagtail-pg-search-backend 1.2.0

Installation

PostgreSQL full text search in Wagtail requires PostgreSQL >= 9.2, Django >= 1.10 and Wagtail >= 1.8.

First, install the module using:

pip install wagtail-pg-search-backend

Then you’ll need to do a little bit of configuration.

Add the following to the project settings:

INSTALLED_APPS = [
    ...
    'wagtail_pgsearchbackend'
    ...
]

WAGTAILSEARCH_BACKENDS = {
    'default': {
        'BACKEND': 'wagtail_pgsearchbackend.backend',
        'SEARCH_CONFIG': 'english'
    }
}

Then run migrations to add the required database table:

./manage.py migrate wagtail_pgsearchbackend

Configuration

The SEARCH_CONFIG key takes a text search configuration name. This controls the stemming, stopwords etc. used when searching and indexing the database. To get a list of the available config names use this query:

SELECT cfgname FROM pg_catalog.pg_ts_config

Development

Install the package and dev requirements:

pip install -e . -r requirements-dev.txt

createdb -Upostgres wagtail_pgsearchbackend

django-admin makemigrations --settings=tests.settings

make unittests

make flaketest

make

tox

./runtests.py tests.test_module.TestClass.test_method