django-haystack
#django-
haystack
Table of Contents
About 1
Chapter 1: Getting started with django-haystack 2
Remarks 2
Versions 2
Examples 2
Installation or Setup 2
Installing the haystack package 2
Configuration 3
Credits 5
About
You can share this PDF with anyone you feel could benefit from it, downloaded the latest version
from: django-haystack
It is an unofficial and free django-haystack ebook created for educational purposes. All the content
is extracted from Stack Overflow Documentation, which is written by many hardworking individuals
at Stack Overflow. It is neither affiliated with Stack Overflow nor official django-haystack.
The content is released under Creative Commons BY-SA, and the list of contributors to each
chapter are provided in the credits section at the end of this book. Images may be copyright of
their respective owners unless otherwise specified. All trademarks and registered trademarks are
the property of their respective company owners.
Use the content presented in this book at your own risk; it is not guaranteed to be correct nor
accurate, please send your feedback and corrections to [email protected]
https://riptutorial.com/ 1
Chapter 1: Getting started with django-
haystack
Remarks
This section provides an overview of what django-haystack is, and why a developer might want to
use it.
It should also mention any large subjects within django-haystack, and link out to the related topics.
Since the Documentation for django-haystack is new, you may need to create initial versions of
those related topics.
Versions
Version Release Date
2.5.1 2016-10-28
2.5.0 2016-07-12
2.4.1 2015-10-29
2.4.0 2015-06-09
2.3.2 2015-11-11
2.3.1 2014-09-22
2.3.0 2014-09-19
2.2.1 2014-09-03
2.2.0 2015-08-03
2.1.0 2013-07-28
2.0.0 2013-05-12
Examples
Installation or Setup
Installing the haystack package
https://riptutorial.com/ 2
pip install django-haystack
Configuration
Add haystack to your project's INSTALLED_APPS inside of your settings.py file:
# settings.py
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
# Put haystack with above your project's apps
'haystack',
'myproject_app',
]
Now add the settings for your search backend. Haystack currently supports: solr, elasticsearch,
whoosh, and xapian.
Solr:
HAYSTACK_CONNECTIONS = {
'default': {
'ENGINE': 'haystack.backends.solr_backend.SolrEngine',
'URL': 'http://127.0.0.1:8983/solr'
# ...or for multicore...
# 'URL': 'http://127.0.0.1:8983/solr/mysite',
},
}
Elasticsearch:
HAYSTACK_CONNECTIONS = {
'default': {
'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine',
'URL': 'http://127.0.0.1:9200/',
'INDEX_NAME': 'haystack',
},
}
Whoosh:
import os
HAYSTACK_CONNECTIONS = {
'default': {
'ENGINE': 'haystack.backends.whoosh_backend.WhooshEngine',
'PATH': os.path.join(os.path.dirname(__file__), 'whoosh_index'),
},
}
https://riptutorial.com/ 3
Xapian:
import os
HAYSTACK_CONNECTIONS = {
'default': {
'ENGINE': 'xapian_backend.XapianEngine',
'PATH': os.path.join(os.path.dirname(__file__), 'xapian_index'),
},
}
Read Getting started with django-haystack online: https://riptutorial.com/django-
haystack/topic/3145/getting-started-with-django-haystack
https://riptutorial.com/ 4
Credits
S.
Chapters Contributors
No
Getting started with
1 blackrobot, Community, MicroPyramid, Nathan Jones
django-haystack
https://riptutorial.com/ 5
