PostgreSQL full text search backend for Wagtail CMS
Project description
A PostgreSQL full text search backend for Wagtail CMS.
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
Creating migrations
First create a database:
createdb -Upostgres wagtail_pgsearchbackend
Then call makemigrations using the test settings:
django-admin makemigrations --settings=tests.settings
Testing
To run the unittests for the current environment’s Python version and Wagtail run:
make unittests
To check the code for style errors run:
make flaketest
To combine these tasks run:
make
To run the unittest against all supported versions of Python and Wagtail run:
tox
The tox run will also create a coverage report combining the results of all runs. This report is located in htmlcov/index.html.
To run individual tests by name use the runtests.py script and give the dotted path the the test module(s), class(es) or method(s) that you want to test e.g.:
./runtests.py tests.test_module.TestClass.test_method
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for wagtail-pg-search-backend-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2992d81ccde024e2a4f8422a6d6e022d8ce40547f939928e29508a3598085f31 |
|
MD5 | 6059c15dc1123f0fce2107692e898dda |
|
BLAKE2b-256 | fd4ec7c57246ec29a48e86f181702c8563b7be44024e23e1818a51f3ffaa0ebd |