Skip to content

Latest commit

 

History

History
179 lines (122 loc) · 5.44 KB

how_to_setup_solr.rst

File metadata and controls

179 lines (122 loc) · 5.44 KB
Raw
.. spelling::

    Solr

How to setup Solr with Oscar

Apache Solr is Oscar's recommended production-grade search backend. This how-to describes how to get Solr running, and integrated with Oscar. The instructions below are tested on an Debian/Ubuntu machine, but should be applicable for similar environments. A working Java or OpenJDK version 8 installation are necessary.

Python Package

You will need to install the pysolr Python package. Or add it to your requirements.txt:

$ pip install pysolr

Installing Solr

You first need to fetch and extract Solr. The schema included with Oscar is tested with Solr 6.6.6:

$ wget -O ${HOME}/solr-6.6.6.tgz https://archive.apache.org/dist/lucene/solr/6.6.6/solr-6.6.6.tgz
$ tar xzf ${HOME}/solr-6.6.6.tgz --directory=${HOME}
$ ln -s ${HOME}/solr-6.6.6 ${HOME}/solr

Note

For development this will presume the solr directory is in the users HOME directory. (For an actual deployment this may be better placed in /opt).

Start Solr and Create a Core

Next start up Solr and create a core named sandbox this name will be used through out this howto, change sandbox to something that suits your installation. This step also sets up up the directory structure and a basic configuration.

$ cd ${HOME}/solr
$ ./bin/solr start
$ ./bin/solr create -c sandbox -n basic_config

Integrating with Haystack

Haystack provides an abstraction layer on top of different search backends and integrates with Django. The Haystack connection settings in your settings.py for the config above will look like this:

# Solr 6.x
HAYSTACK_CONNECTIONS = {
    'default': {
        'ENGINE': 'haystack.backends.solr_backend.SolrEngine',
        'URL': 'http://127.0.0.1:8983/solr/sandbox',
        'ADMIN_URL': 'http://127.0.0.1:8983/solr/admin/cores',
        'INCLUDE_SPELLING': True,
    },
}

To use Solr with the Sandbox locally comment out the HAYSTACK_CONNECTIONS section using the WhooshEngine and uncomment the Solr 6.x section like this one.

Build Solr schema

Next, get Oscar to generate the schema.xml and solrconfig.xml for Solr.

$ ./manage.py build_solr_schema --configure-directory=${HOME}/solr/server/solr/sandbox/conf
$ ./manage.py build_solr_schema --reload-core sandbox

Note

If using this Solr install with the Sandbox locally ensure the steps up to this point have been done prior to running make sandbox in the Run the sandbox locally instructions.

Rebuild search index

If all is well, you should now be able to rebuild the search index.

$ ./manage.py rebuild_index --noinput
Removing all documents from your index because you said so.
All documents removed.
Indexing 201 Products

If the indexing succeeded, search in Oscar will be working. Search for any term in the search box on your Oscar site, and you should get results.

Add custom product attributes in faceted search

Fork Oscar's search app and add the additional fields to your search index:

$ ./manage.py fork_app search <yourapp>
$ touch <yourapp>/search/search_indexes.py

Edit <yourapp>/search/search_indexes.py, create a subclass of Oscar's ProductIndex with your additional fields:

from oscar.apps.search import ProductIndex as OscarProductIndex

class ProductIndex(OscarProductIndex):

    format = indexes.CharField(null=True, faceted=True)
    color = indexes.CharField(null=True, faceted=True)

    def prepare_format(self, obj):
        return obj.attribute_values.get(attribute__code="format").value_text

    def prepare_color(self, obj):
        return obj.attribute_values.get(attribute__code="color").value_text

Add the new fields to your schema.xml:

<field name="format" type="text" indexed="true" stored="true" multiValued="false" />
<field name="format_exact" type="string" indexed="true" stored="true" multiValued="false" />

<field name="color" type="text" indexed="true" stored="true" multiValued="false" />
<field name="color_exact" type="string" indexed="true" stored="true" multiValued="false" />

Reload your new schema.xml & restart solr:

$ curl http://localhost:8983/solr/admin/cores?action=RELOAD&core=sandbox
$ cd ${HOME}/solr
$ ./bin/solr restart

Rebuild the search index with the new fields:

$ cd <path to your app>
$ ./manage.py rebuild_index --noinput

Add the new fields in settings.py to OSCAR_SEARCH_FACETS:

OSCAR_SEARCH_FACETS = {
    "fields": OrderedDict(
        [
            # ....
            ("format", {"name": "Format", "field": "format"}),
            ("color", {"name": "Color", "field": "color"}),
        ],
    ),
    # ...
}

The new fields will appear automatically in the left column below your category tree in the search facets.