django-haystack · acdha · May 24, 2017 · Apr 6, 2017 · Apr 6, 2017 · Apr 8, 2017
diff --git a/.travis.yml b/.travis.yml
@@ -1,4 +1,5 @@
-sudo: true
+sudo: required
+dist: trusty
 language: python
 python:
     - 2.7
@@ -11,6 +12,8 @@ cache:
     pip: true
     directories:
         - $HOME/download-cache
+jdk:
+    - oraclejdk8
 
 addons:
     apt_packages:
@@ -59,6 +62,7 @@ env:
         - DJANGO_VERSION=">=1.8,<1.9" VERSION_ES=">=2.0.0,<3.0.0"
         - DJANGO_VERSION=">=1.9,<1.10" VERSION_ES=">=2.0.0,<3.0.0"
         - DJANGO_VERSION=">=1.10,<1.11" VERSION_ES=">=2.0.0,<3.0.0"
+        - DJANGO_VERSION=">=1.11,<1.12" VERSION_ES=">=2.0.0,<3.0.0"
 
 matrix:
     allow_failures:

diff --git a/docs/backend_support.rst b/docs/backend_support.rst
@@ -9,12 +9,12 @@ Supported Backends
 ==================
 
 * Solr_
-* Elasticsearch_
+* ElasticSearch_
 * Whoosh_
 * Xapian_
 
 .. _Solr: http://lucene.apache.org/solr/
-.. _Elasticsearch: http://elasticsearch.org/
+.. _ElasticSearch: http://elasticsearch.org/
 .. _Whoosh: https://bitbucket.org/mchaput/whoosh/
 .. _Xapian: http://xapian.org/
 
@@ -37,7 +37,7 @@ Solr
 * Spatial search
 * Requires: pysolr (2.0.13+) & Solr 3.5+
 
-Elasticsearch
+ElasticSearch
 -------------
 
 **Complete & included with Haystack.**
@@ -50,7 +50,7 @@ Elasticsearch
 * Stored (non-indexed) fields
 * Highlighting
 * Spatial search
-* Requires: `elasticsearch <https://pypi.python.org/pypi/elasticsearch>`_ 1.x or 2.x. Elasticsearch 5.X is currently unsupported: see `#1383 <https://github.com/django-haystack/django-haystack/issues/1383>`_.
+* Requires: `elasticsearch-py <https://pypi.python.org/pypi/elasticsearch>`_ 1.x or 2.x. ElasticSearch 5.X is currently unsupported: see `#1383 <https://github.com/django-haystack/django-haystack/issues/1383>`_.
 
 Whoosh
 ------
@@ -88,7 +88,7 @@ Backend Support Matrix
 +================+========================+=====================+================+============+==========+===============+==============+=========+
 | Solr           | Yes                    | Yes                 | Yes            | Yes        | Yes      | Yes           | Yes          | Yes     |
 +----------------+------------------------+---------------------+----------------+------------+----------+---------------+--------------+---------+
-| Elasticsearch  | Yes                    | Yes                 | Yes            | Yes        | Yes      | Yes           | Yes          | Yes     |
+| ElasticSearch  | Yes                    | Yes                 | Yes            | Yes        | Yes      | Yes           | Yes          | Yes     |
 +----------------+------------------------+---------------------+----------------+------------+----------+---------------+--------------+---------+
 | Whoosh         | Yes                    | Yes                 | Yes            | Yes        | No       | Yes           | Yes          | No      |
 +----------------+------------------------+---------------------+----------------+------------+----------+---------------+--------------+---------+

diff --git a/docs/installing_search_engines.rst b/docs/installing_search_engines.rst
@@ -11,30 +11,46 @@ Official Download Location: http://www.apache.org/dyn/closer.cgi/lucene/solr/
 
 Solr is Java but comes in a pre-packaged form that requires very little other
 than the JRE and Jetty. It's very performant and has an advanced featureset.
-Haystack suggests using Solr 3.5+, though it's possible to get it working on
-Solr 1.4 with a little effort. Installation is relatively simple::
+Haystack suggests using Solr 6.x, though it's possible to get it working on
+Solr 4.x+ with a little effort. Installation is relatively simple:
+
+For Solr 6.X::
+
+    curl -LO https://archive.apache.org/dist/lucene/solr/x.Y.0/solr-X.Y.0.tgz
+    tar -C solr -xf solr-X.Y.0.tgz --strip-components=1
+    cd solr
+    ./bin/solr create -c tester -n basic_config
+
+By default this will create a core with a managed schema.  This setup is dynamic
+but not useful for haystack, and we'll need to configure solr to use a static
+(classic) schema.  Haystack can generate a viable schema.xml and solrconfig.xml
+for you from your application and reload the core for you (once Haystack is
+installed and setup).  To do this run:
+``./manage.py build_solr_schema --configure-directory=<CoreConfigDif>
+--reload-core``. In this example CoreConfigDir is something like
+``../solr-6.5.0/server/solr/tester/conf``, and ``--reload-core``
+is what triggers reloading of the core.  Please refer to ``build_solr_schema``
+in the :doc:`management-commands` for required configuration.
+
+For Solr 4.X::
 
     curl -LO https://archive.apache.org/dist/lucene/solr/4.10.2/solr-4.10.2.tgz
     tar xvzf solr-4.10.2.tgz
     cd solr-4.10.2
     cd example
     java -jar start.jar
 
-You'll need to revise your schema. You can generate this from your application
+You’ll need to revise your schema. You can generate this from your application
 (once Haystack is installed and setup) by running
 ``./manage.py build_solr_schema``. Take the output from that command and place
-it in ``solr-4.10.2/example/solr/collection1/conf/schema.xml``. Then restart Solr.
-
-.. note::
-    ``build_solr_schema`` uses a template to generate ``schema.xml``. Haystack
-    provides a default template using some sensible defaults. If you would like
-    to provide your own template, you will need to place it in
-    ``search_configuration/solr.xml``, inside a directory specified by your app's
-    ``TEMPLATE_DIRS`` setting. Examples::
+it in ``solr-4.10.2/example/solr/collection1/conf/schema.xml``. Then restart
+Solr.
 
-        /myproj/myapp/templates/search_configuration/solr.xml
-        # ...or...
-        /myproj/templates/search_configuration/solr.xml
+.. warning::
+    Please note; the template filename, the file YOU supply under
+    TEMPLATE_DIR/search_configuration has changed to schema.xml from solr.xml.
+    The previous template name solr.xml was a legacy holdover from older
+    versions of solr.
 
 You'll also need a Solr binding, ``pysolr``. The official ``pysolr`` package,
 distributed via PyPI, is the best version to use (2.1.0+). Place ``pysolr.py``
@@ -43,7 +59,8 @@ somewhere on your ``PYTHONPATH``.
 .. note::
 
     ``pysolr`` has its own dependencies that aren't covered by Haystack. See
-    https://pypi.python.org/pypi/pysolr for the latest documentation.
+    https://pypi.python.org/pypi/pysolr for the latest documentation.  Simplest
+    approach is to install using ``pip install pysolr``
 
 More Like This
 --------------

diff --git a/docs/management_commands.rst b/docs/management_commands.rst
@@ -13,11 +13,11 @@ easier.
 
 The ``clear_index`` command wipes out your entire search index. Use with
 caution. In addition to the standard management command options, it accepts the
-following arguments::
+following arguments:
 
     ``--noinput``:
         If provided, the interactive prompts are skipped and the index is
-        uncerimoniously wiped out.
+        unceremoniously wiped out.
     ``--verbosity``:
         Accepted but ignored.
     ``--using``:
@@ -55,7 +55,7 @@ wish to delete the entire index.
 The ``update_index`` command will freshen all of the content in your index. It
 iterates through all indexed models and updates the records in the index. In
 addition to the standard management command options, it accepts the following
-arguments::
+arguments:
 
     ``--age``:
         Number of hours back to consider objects new. Useful for nightly
@@ -95,7 +95,7 @@ arguments::
 
 .. note::
 
-    The ``--nocommit`` argument is only supported by the Solr and Elasticsearch backends.
+    The ``--nocommit`` argument is only supported by the Solr and ElasticSearch backends.
 
 Examples::
 
@@ -136,7 +136,7 @@ Examples::
 =================
 
 A shortcut for ``clear_index`` followed by ``update_index``. It accepts any/all
-of the arguments of the following arguments::
+of the arguments of the following arguments:
 
     ``--age``:
         Number of hours back to consider objects new. Useful for nightly
@@ -148,7 +148,7 @@ of the arguments of the following arguments::
         The site object to use when reindexing (like `search_sites.mysite`).
     ``--noinput``:
         If provided, the interactive prompts are skipped and the index is
-        uncerimoniously wiped out.
+        unceremoniously wiped out.
     ``--remove``:
         Remove objects from the index that are no longer present in the
         database.
@@ -175,22 +175,61 @@ For when you really, really want a completely rebuilt index.
 =====================
 
 Once all of your ``SearchIndex`` classes are in place, this command can be used
-to generate the XML schema Solr needs to handle the search data. It accepts the
-following arguments::
+to generate the XML schema Solr needs to handle the search data.  Generates a
+Solr schema and solrconfig file that reflects the indexes using templates under
+a Django template dir 'search_configuration/\*.xml'. If none are found, then
+provides defaults suitable for Solr 6.4.
+
+It accepts the following arguments:
 
     ``--filename``:
-        If provided, directs output to a file instead of stdout.
+        If provided, renders schema.xml from the template directory directly to
+        a file instead of stdout. Does not render solrconfig.xml
     ``--using``:
         Update only the named backend (can be used multiple times). By default
         all backends will be updated.
+    ``--configure-directory``:
+        If provided, attempts to configure a core located in the given directory
+        by removing the ``managed-schema.xml`` (renaming if it exists), configuring
+        the core by rendering the ``schema.xml`` and ``solrconfig.xml`` templates
+        provided in the Django project's ``TEMPLATE_DIR/search_configuration``
+        directories.
+    ``--reload-core``:
+        If provided, attempts to automatically reload the solr core via the urls
+        in the ``URL`` and ``ADMIN_URL`` settings of the Solr entry in
+        ``HAYSTACK_CONNECTIONS``. Both *must* be provided.
 
-.. warning::
+.. note::
+   ``build_solr_schema --configure-directory=<dir>`` can be used in isolation to
+   drop configured files anywhere one might want for staging to one or more solr
+   instances through arbitrary means.  It will render all template files in the
+   directory into the ``configure-directory``
+
+   ``build_solr_schema --configure-directory=<dir> --reload-core`` can be used
+   together to reconfigure and reload a core located on a filesystem accessible
+   to Django in a one-shot mechanism with no further requirements (assuming
+   there are no errors in the template or configuration)
 
-    This command does NOT update the ``schema.xml`` file for you. You either
-    have to specify a ``filename`` flag or have to
-    copy-paste (or redirect) the output to the correct file. Haystack has no
-    way of knowing where your Solr is setup (or if it's even on the same
-    machine), hence the manual step.
+.. note::
+    ``build_solr_schema`` uses templates to generate the output files. Haystack
+    provides default templates for ``schema.xml`` and ``solrconfig.xml`` that
+    are solr 6.5 compatible using some sensible defaults. If you would like to
+    provide your own template, you will need to place it in
+    ``search_configuration/`` inside a directory specified by your app's
+    template directories settings. Examples::
+
+        /myproj/myapp/templates/search_configuration/schema.xml
+        /myproj/myapp/templates/search_configuration/sorlconfig.xml
+        /myproj/myapp/templates/search_configuration/otherfile.xml
+        # ...or...
+        /myproj/templates/search_configuration/schema.xml
+        /myproj/templates/search_configuration/sorlconfig.xml
+        /myproj/myapp/templates/search_configuration/otherfile.xml
+
+.. warning::
+    This command does NOT automatically update the ``schema.xml`` file for you
+    all by itself.  You must use --filename or --configure-directory to achieve
+    this.
 
 
 ``haystack_info``

diff --git a/docs/settings.rst b/docs/settings.rst
@@ -78,7 +78,9 @@ Additionally, each backend may have additional options it requires:
 
 * Solr
 
-  * ``URL`` - The URL to the Solr core.
+  * ``URL`` - The URL to the Solr core. e.g. http://localhost:9001/solr/collection1
+  * ``ADMIN_URL`` - The URL to the administrative functions. e.g.
+    http://localhost:9001/solr/admin/cores
 
 * Whoosh
 

diff --git a/haystack/__init__.py b/haystack/__init__.py
@@ -54,7 +54,8 @@
 # DEBUG = True.
 def reset_search_queries(**kwargs):
     for conn in connections.all():
-        conn.reset_queries()
+        if conn:
+            conn.reset_queries()
 
 
 if settings.DEBUG: