xapian-haystack
xapian-haystack copied to clipboard
A Xapian backend for Haystack
Xapian backend for Django-Haystack
.. image:: https://github.com/notanumber/xapian-haystack/actions/workflows/test.yml/badge.svg :target: https://github.com/notanumber/xapian-haystack/actions :alt: GitHub Actions .. image:: https://coveralls.io/repos/notanumber/xapian-haystack/badge.svg?branch=master&service=github :target: https://coveralls.io/github/notanumber/xapian-haystack?branch=master .. image:: https://img.shields.io/pypi/v/xapian-haystack.svg :target: https://pypi.org/project/xapian-haystack/ :alt: PyPI version
Xapian-haystack is a backend of Django-Haystack <http://haystacksearch.org/>
__
for the Xapian <https://xapian.org>
__ search engine.
Thanks for checking it out.
You can find more information about Xapian here <https://getting-started-with-xapian.readthedocs.io>
__.
Features
Xapian-Haystack provides all the standard features of Haystack:
- Weighting
- Faceted search (date, query, etc.)
- Sorting
- Spelling suggestions
- EdgeNGram and Ngram (for autocomplete)
Limitations
The endswith
search operation is not supported by Xapian-Haystack.
Requirements
- Python 3+
- Django 2.2+
- Django-Haystack 2.8.0
- Xapian 1.4+
Installation
First, install Xapian in your machine e.g. with the script provided,
install_xapian.sh
. Call it after activating the virtual environment to install::
source <path>/bin/activate
./install_xapian.sh <version>
<version>
must be >=1.4.0. This takes around 10 minutes.
Finally, install Xapian-Haystack by running::
pip install xapian-haystack
Configuration
Xapian is configured as other backends of Haystack. You have to define the connection to the database, which is done to a path to a directory, e.g::
HAYSTACK_CONNECTIONS = {
'default': {
'ENGINE': 'xapian_backend.XapianEngine',
'PATH': os.path.join(os.path.dirname(__file__), 'xapian_index')
},
}
The backend has the following optional settings:
-
HAYSTACK_XAPIAN_LANGUAGE
: the stemming language; the default isenglish
and the list of available languages can be foundhere <http://xapian.org/docs/apidoc/html/classXapian_1_1Stem.html>
__. -
HAYSTACK_XAPIAN_WEIGHTING_SCHEME
: a tuple with parameters to be passed to the weighting schemeBM25 <https://en.wikipedia.org/wiki/Okapi_BM25>
__. By default, it uses the same parameters as Xapian recommends; this setting allows you to change them. -
HAYSTACK_XAPIAN_FLAGS
: the options used to parseAutoQueries
; the default isFLAG_PHRASE | FLAG_BOOLEAN | FLAG_LOVEHATE | FLAG_WILDCARD | FLAG_PURE_NOT
Seehere <http://xapian.org/docs/apidoc/html/classXapian_1_1QueryParser.html>
__ for more information on what they mean. -
HAYSTACK_XAPIAN_STEMMING_STRATEGY
: This option lets you chose the stemming strategy used by Xapian. Possible values areSTEM_NONE
,STEM_SOME
,STEM_ALL
,STEM_ALL_Z
, whereSTEM_SOME
is the default. Seehere <http://xapian.org/docs/apidoc/html/classXapian_1_1QueryParser.html#ac7dc3b55b6083bd3ff98fc8b2726c8fd>
__ for more information about the different strategies. -
XAPIAN_NGRAM_MIN_LENGTH
,XAPIAN_NGRAM_MAX_LENGTH
: options for custom configuration of ngrams (phrases) length. -
HAYSTACK_XAPIAN_USE_LOCKFILE
: Use a lockfile to prevent database locking errors when running management commands with multiple workers. Defaults toTrue
.
Testing
Xapian-Haystack has a test suite in continuous deployment with GitHub Actions. The file
.github/workflows/test.yml
contains the steps required to run the test suite.
Source
The source code can be found in github <https://github.com/notanumber/xapian-haystack/>
_.
Credits
Xapian-Haystack is maintained by Jorge C. Leitão <http://jorgecarleitao.net>
;
David Sauve <mailto:[email protected]>
was the main contributor of Xapian-Haystack and
Xapian-Haystack was originally funded by Trapeze <http://www.trapeze.com>
.
Claude Paroz <https://www.2xlibre.net>
is a frequent contributor.
ANtlord <https://github.com/ANtlord>
__ implemented support for EdgeNgram and Ngram.
License
Xapian-haystack is free software licenced under GNU General Public Licence v2 and Copyright (c) 2009, 2010, 2011, 2012 David Sauve, 2009, 2010 Trapeze, 2014 Jorge C. Leitão. It may be redistributed under the terms specified in the LICENSE file.
Questions, Comments, Concerns:
Feel free to open an issue here <https://github.com/notanumber/xapian-haystack/issues>
__
or pull request your work.
You can ask questions on the django-haystack mailing list <https://groups.google.com/group/django-haystack/>
_:
or in the irc #haystack
.