Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Save notanumber/373987 to your computer and use it in GitHub Desktop.
Save notanumber/373987 to your computer and use it in GitHub Desktop.
diff --git a/docs/installing_search_engines.rst b/docs/installing_search_engines.rst
index de219c7..3e866d7 100644
--- a/docs/installing_search_engines.rst
+++ b/docs/installing_search_engines.rst
@@ -128,8 +128,8 @@ package for it). Installation looks like::
make
sudo make install
-Xapian is a supported backend but is not included in Haystack proper due to
-licensing. You can download the source from
+Xapian is a third-party supported backend. It is not included in Haystack
+proper due to licensing. You can download the source from
http://github.com/notanumber/xapian-haystack/tree/master. Installation
instructions can be found on that page as well. The backend, written
by David Sauve (notanumber), fully implements the `SearchQuerySet` API and is
diff --git a/docs/backend_support.rst b/docs/backend_support.rst
index 3b6f384..a93f949 100644
--- a/docs/backend_support.rst
+++ b/docs/backend_support.rst
@@ -10,9 +10,11 @@ Supported Backends
* Solr_
* Whoosh_
+* Xapian_
.. _Solr: http://lucene.apache.org/solr/
.. _Whoosh: http://whoosh.ca/
+.. _Xapian: http://xapian.org/
Backend Capabilities
@@ -44,6 +46,21 @@ Whoosh
* Highlighting
* Requires: whoosh (0.3.15+)
+Xapian
+------
+
+**Complete & available as a third-party download.**
+
+* Full SearchQuerySet support
+* Automatic query building
+* "More Like This" functionality
+* Term Boosting
+* Faceting
+* Stored (non-indexed) fields
+* Highlighting
+* Requires: Xapian 1.0.5+ & python-xapian 1.0.5+
+* Backend can be downloaded here: `xapian-haystack <http://github.com/notanumber/xapian-haystack/>`_
+
+----------------+------------------------+---------------------+----------------+------------+----------+---------------+--------------+
| Backend | SearchQuerySet Support | Auto Query Building | More Like This | Term Boost | Faceting | Stored Fields | Highlighting |
@@ -52,6 +69,8 @@ Whoosh
+----------------+------------------------+---------------------+----------------+------------+----------+---------------+--------------+
| Whoosh | Yes | Yes | No | Yes | No | Yes | Yes |
+----------------+------------------------+---------------------+----------------+------------+----------+---------------+--------------+
+| Xapian | Yes | Yes | Yes | Yes | Yes | Yes | Yes (plugin) |
++----------------+------------------------+---------------------+----------------+------------+----------+---------------+--------------+
Wishlist
@@ -61,27 +80,12 @@ The following are search backends that would be nice to have in Haystack but are
licensed in a way that prevents them from being officially bundled. If the
community expresses interest in any of these, there may be future development.
-* Xapian_
* Sphinx_
* `Hyper Estraier`_
-.. _Xapian: http://xapian.org/
.. _Sphinx: http://www.sphinxsearch.com/
.. _Hyper Estraier: http://hyperestraier.sourceforge.net/
-Xapian
-------
-
-**Complete but not included with Haystack.**
-
-* Full SearchQuerySet support
-* Automatic query building
-* Term Boosting
-* "More Like This" functionality
-* Faceting
-* Stored (non-indexed) fields
-* Highlighting
-* Requires: xapian bindings included with Xapian
Sphinx
------
@@ -105,8 +109,6 @@ Hyper Estraier
+----------------+------------------------+---------------------+----------------+------------+----------+---------------+--------------+
| Backend | SearchQuerySet Support | Auto Query Building | More Like This | Term Boost | Faceting | Stored Fields | Highlighting |
+================+========================+=====================+================+============+==========+===============+==============+
-| Xapian | Yes | Yes | Yes | Yes | Yes | Yes | Yes (plugin) |
-+----------------+------------------------+---------------------+----------------+------------+----------+---------------+--------------+
| Sphinx | Yes | Yes | No | Yes | No | Yes | Yes |
+----------------+------------------------+---------------------+----------------+------------+----------+---------------+--------------+
| Hyper Estraier | Yes | Yes | Yes | No | No | No | Yes (plugin) |
diff --git a/docs/settings.rst b/docs/settings.rst
index 1b56625..470f35f 100644
--- a/docs/settings.rst
+++ b/docs/settings.rst
@@ -92,7 +92,7 @@ An example::
HAYSTACK_INCLUDE_SPELLING = True
-Works for the ``solr`` and ``whoosh`` backends.
+Works for the ``solr``, ``xapian``, and ``whoosh`` backends.
``HAYSTACK_SOLR_URL``
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment