Solr implementation using Django-Haystack

Post Views: 14,471


Implement Apache Solr in Django for rich Web search options. We can integrate Apache Solr with django using Haystack. In this first setup we need to following in django.

  1. Create search indexes for models in Django.
  2. Create schema using django and move it to Solr.
  3. Configure Apache Solr.

Django-Haystack Setup:


  1. 1.8 <=     Django     >= 1.6
  2. Django-haystack.
  3. Pysolr.

using pip install requirements.

Add following to your


‘default’: {

‘ENGINE’: ‘haystack.backends.solr_backend.SolrEngine’,
‘URL’: ‘’


Add searchView to project
(r’^search/’, include(‘haystack.urls’)),

Django Initial setup is finished. Now we need to create search indexes for our data’s in database. We need not to create search index for all items in database. We only need to create search index for corresponding models only.

Creating SearchIndexes

Search Index objects are the way Haystack determines what data should be placed in the search index and handles the flow of data in. You can think of them as being similar to Django Models or Forms in that they are field-based and manipulate/store data.

Create SearchIntexes with

if having models like this

class Mobile(models.Model):

name = models.CharField(max_length=100)
manufacture = models.CharField(max_length=100)
description = models.CharField(max_length=1000) for above model is

from haystack import indexes
from .models import Mobile

class MobileIndex(indexes.SearchIndex, indexes.Indexable):

text = indexes.CharField(document=True, use_template=True)
name = indexes.CharField(model_attr=’name’)
manufacture =indexes.CharField(model_attr=’manufacture’)
description = indexes.CharField(model_attr=’description’)

name_auto = indexes.EdgeNgramField(model_attr=’name’)
manufacture_auto = indexes.EdgeNgramField(model_attr=’manufacture’)
description_auto = indexes.EdgeNgramField(model_attr=’description’)
suggestions = indexes.FacetCharField()

def get_model(self):

return Mobile

def index_queryset(self, using=None):

“””Used when the entire index for model is updated.”””
return self.get_model().objects.all()

def prepare(self, obj):

prepared_data = super(MobileIndex, self).prepare(obj)
prepared_data[‘suggestions’] = prepared_data[‘text’] return prepared_data

Additionally, we’re providing use_template=True on the text field. This allows us to use a data template (rather than error-prone concatenation) to build the document the search engine will index. You’ll need to create a new template inside your template directory called search/indexes/myapp/note_text.txt and place the following inside:

{{ }}
{{ object.manufacture }}
{{ object.description }}

Now search indexes are created successfully. Now we need to setup Apache Solr Search Engine.

Apache Solr Setup:


  1. Solr 4.10.2 ( Haystack suggests using Solr 3.5+)
  2. Java

Download Solr from

Only in solr need to modify following files for django integration.

  1. schema.xml
  2. solrconfig.xml

Create Schema For your Project:

You’ll need to revise your schema in solr with respect to your django project. It is very simple, just run
python build_solr_schema
Take the output from that command and place it in solr4.10.2/example/solr/collection1/conf/schema.xml

solrconfig file setup:

In solrconfig file we can add following functionality also

More Like This

To enable the “More Like This” functionality in Haystack, you’ll need to enable theMoreLikeThisHandler. Add the following line to your solrconfig.xml file within the config tag:

<requestHandler name=”/mlt” class=”solr.MoreLikeThisHandler” />

Spelling Suggestions

Add the following line to your solrconfig.xml file within the config tag:

<searchComponent name=”spellcheck” class=”solr.SpellCheckComponent”>

<str name=”queryAnalyzerFieldType”>textSpell</str>
<lst name=”spellchecker”>

<str name=”name”>default</str>
<str name=”field”>suggestions</str>
<str name=”spellcheckIndexDir”>./spellchecker1</str>
<str name=”buildOnCommit”>true</str>



Then change your default handler from:

<requestHandler name=”standard” class=”solr.StandardRequestHandler” default=”true” />
… to …:
<requestHandler name=”standard” class=”solr.StandardRequestHandler” default=”true”>

<arr name=”last-components”>




After setting up run server as following

cd solr-4.10.2
cd example
java -jar start.jar

go to the following link in browsher,


Default port for Solr is 8983. In Screenshot, we running in 8080 port.

After Run solr server, using following comments to update server indexes

python build_solr_schema –> create schema for solr schema.xml
python update_index — > update new indexes to solr server
python rebuild_index — > remove old indexes update all as new

haystack QuerySest:

from haystack.query import SearchQuerySet

Haystack queryset help us to get data from Solr search engine.

search_keyword = request.POST[‘q’] data = SearchQuerySet().auto_query(search_keyword)

returns all similar to search keywork

Solr Search Engine

spelling = data.spelling_suggestion()
returns correct spelling for incorrect spelling, below example i just typed noka for nokia but it return value for nokia.

Solr Search Engine - Keyword Suggestion

Similarly following haystack queryset help as make search in better.
hello_results = SearchQuerySet().filter(content=’hello’)
hello_world_results = SearchQuerySet().filter(content=’hello world’)
unfriendly_results = SearchQuerySet().exclude(content=’hello’).filter(content=’world’)
recent_results = SearchQuerySet().order_by(‘-pub_date’)[:5]

sqs = SearchQuerySet().filter(content=’foo’).highlight()
result = sqs[0] result.highlighted[‘text’][0]

Deployment of Solr inTocamt:


Tomcat >= 6
We can setup solr in tomcat using 2 methods

Step 1 is follow the steps:

  1. sudo apt-get install tomcat7 tomcat7-admin
  2. sudo mv solr-4.10.2 /usr/share/solr
  3. sudo cp /usr/share/solr/example/webapps/solr.war /usr/share/solr/example/multicore/solr.war
  4. sudo cp -r solr/example/lib/ext/* /usr/share/tomcat7/lib
  5. sudo cp -r solr/example/resources/ /usr/share/tomcat7/lib
  6. Edit /usr/share/tomcat7/lib/ and set your log path by setting
  7. Now add solr to the Catalina config
    cd /etc/tomcat7/Catalina/localhost
    sudo gedit solr.xmladd the following to solr.xml<Context docBase=”/usr/share/solr/example/multicore/solr.war” debug=”0″ crossContext=”true”>
    <Environment name=”solr/home” type=”java.lang.String” value=”/usr/share/solr/example/multicore” override=”true” />   </Context>

Setup Tomcat Manager
sudo gedit /etc/tomcat7/tomcat-users.xml

add the tomcat user within the users block:


<role rolename=”manager-gui”/>
<user username=”giluxe” password=”giluxe” roles=”manager-gui”/>


sudo chown -R tomcat7 /usr/share/solr/example/multicore

sudo service tomcat7 restart

Step 2:

After installing Tomcat, open your tomcat manager webapp and add your war file to war file to deploy.

War file is in /solr-4.10.2/example/webapps/solr.war