Table Of Contents

• Welcome to Haystack!
  • Getting Started
  • Advanced Uses
  • Reference
  • Developing
  • Requirements
• Getting Started with Haystack
  • Installation
  • Configuration
  • Handling Data
  • Setting Up The Views
  • Complete!
  • What’s Next?
• Glossary
• Views & Forms
  • Forms
  • Views
• Template Tags
  • highlight
  • more_like_this
• Management Commands
  • clear_index
  • update_index
  • rebuild_index
  • build_solr_schema
  • haystack_info
• Architecture Overview
  • SearchQuerySet
  • SearchQuery
  • SearchBackend
  • SearchSite
  • SearchIndex
• Backend Support
  • Supported Backends
  • Backend Capabilities
  • Backend Support Matrix
  • Unsupported Backends & Alternatives
• Installing Search Engines
  • Solr
  • Elasticsearch
  • Whoosh
  • Xapian
• Haystack Settings
  • HAYSTACK_DEFAULT_OPERATOR
  • HAYSTACK_CONNECTIONS
  • HAYSTACK_ROUTERS
  • HAYSTACK_SIGNAL_PROCESSOR
  • HAYSTACK_DOCUMENT_FIELD
  • HAYSTACK_SEARCH_RESULTS_PER_PAGE
  • HAYSTACK_CUSTOM_HIGHLIGHTER
  • HAYSTACK_ITERATOR_LOAD_PER_QUERY
  • HAYSTACK_LIMIT_TO_REGISTERED_MODELS
  • HAYSTACK_ID_FIELD
  • HAYSTACK_DJANGO_CT_FIELD
  • HAYSTACK_DJANGO_ID_FIELD
  • HAYSTACK_IDENTIFIER_METHOD
  • HAYSTACK_FUZZY_MIN_SIM
  • HAYSTACK_FUZZY_MAX_EXPANSIONS
• (In)Frequently Asked Questions
  • What is Haystack?
  • Why should I consider using Haystack?
  • When should I not be using Haystack?
  • Why was Haystack created when there are so many other search options?
  • What’s the history behind Haystack?
  • Why doesn’t <search engine X> have a backend included in Haystack?
• Haystack-Related Applications
  • Sub Apps
  • Haystack-Enabled Apps
• Debugging Haystack
  • “No module named haystack.”
  • “No results found.” (On the web page)
  • “LockError: [Errno 17] File exists: ‘/path/to/whoosh_index/_MAIN_LOCK’”
  • “Failed to add documents to Solr: [Reason: None]”
  • “Got an unexpected keyword argument ‘boost’”
• Migrating From Haystack 1.X to Haystack 2.X
  • Settings
  • Backends
  • Indexes
  • Removal of RealTimeSearchIndex
  • Done!
  • Advanced Uses
• Python 3 Support
  • Supported Backends
  • Notes
• Contributing
  • Philosophy
  • Guidelines For Reporting An Issue/Feature
  • Guidelines For Contributing Code
  • Guidelines For Core Contributors
• Best Practices
  • Good Search Needs Good Content
  • Avoid Hitting The Database
  • Content-Type Specific Templates
  • Real-Time Search
  • Use Of A Queue For A Better User Experience
• Highlighting
  • Highlighter
• Faceting
  • What Is Faceting?
  • 1. Determine Facets And SearchQuerySet
  • 2. Switch to the FacetedSearchView and FacetedSearchForm
  • 3. Display The Facets In The Template
  • 4. Narrowing The Search
• Autocomplete
  • Step 1. Setup The Data
  • Step 2. Performing The Query
  • Example Implementation
• Boost
  • Term Boost
  • Document Boost
  • Field Boost
• Signal Processors
  • Default - BaseSignalProcessor
  • Realtime - RealtimeSignalProcessor
  • Custom SignalProcessors
• Multiple Indexes
  • Specifying Available Connections
  • Management Commands
  • Automatic Routing
  • Manually Selecting
  • Custom Index Selection
• Rich Content Extraction
  • Extracting Content
  • Indexing Extracted Content
• Spatial Search
  • Additional Requirements
  • Support
  • Geospatial Assumptions
  • Indexing
  • Querying
  • Ordering
  • Caveats
• SearchQuerySet API
  • SearchQuerySet
  • Why Follow QuerySet?
  • Quick Start
  • SearchQuerySet
  • The content Shortcut
  • SearchQuerySet Methods
  • EmptySearchQuerySet
  • RelatedSearchQuerySet
• SearchIndex API
  • SearchIndex
  • Quick Start
  • Background
  • Keeping The Index Fresh
  • Advanced Data Preparation
  • Adding New Fields
  • Search Index
  • ModelSearchIndex
• Input Types
  • Available Input Types
  • Creating Your Own Input Types
• SearchField API
  • SearchField
  • Subclasses
  • Usage
  • Field Options
  • Method Reference
• SearchResult API
  • SearchResult
  • Attribute Reference
  • Method Reference
• SearchQuery API
  • SearchQuery
  • SQ Objects
  • Backend-Specific Methods
  • Inheritable Methods
• SearchBackend API
  • SearchBackend
  • Method Reference
• Running Tests
  • Everything
  • Cherry-Picked
  • Configuring Solr
  • Configuring Elasticsearch
• Creating New Backends
  • SearchBackend
  • SearchQuery
• Utilities
  • get_identifier

Indices and tables

• Search Page