Navigation
index
next
|
Haystack 1.2.7 documentation
»
Table Of Contents
¶
Welcome to Haystack!
Getting Started
Advanced Uses
Reference
Developing
Requirements
Getting Started with Haystack
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
Wishlist
Installing Search Engines
Solr
Whoosh
Xapian
Haystack Settings
HAYSTACK_DEFAULT_OPERATOR
HAYSTACK_SITECONF
HAYSTACK_SEARCH_ENGINE
HAYSTACK_SEARCH_RESULTS_PER_PAGE
HAYSTACK_INCLUDE_SPELLING
HAYSTACK_SOLR_URL
HAYSTACK_SOLR_TIMEOUT
HAYSTACK_WHOOSH_PATH
HAYSTACK_WHOOSH_STORAGE
HAYSTACK_WHOOSH_POST_LIMIT
HAYSTACK_XAPIAN_PATH
HAYSTACK_BATCH_SIZE
HAYSTACK_CUSTOM_HIGHLIGHTER
HAYSTACK_ENABLE_REGISTRATIONS
HAYSTACK_ITERATOR_LOAD_PER_QUERY
HAYSTACK_LIMIT_TO_REGISTERED_MODELS
HAYSTACK_SILENTLY_FAIL
HAYSTACK_ID_FIELD
HAYSTACK_DJANGO_CT_FIELD
HAYSTACK_DJANGO_ID_FIELD
(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?
Sites Using Haystack
LJWorld/Lawrence.com/KUSports
AltWeeklies
Trapeze
Eldarion
Sunlight Labs
NASA
AllForLocal
HUGE
Brick Design
Winding Road
Reddit
Pegasus News
Rampframe
Forkinit
Structured Abstraction
CustomMade
University of the Andes, Dept. of Political Science
Christchurch Art Gallery
DevCheatSheet.com
TodasLasRecetas
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’”
“Import errors on start-up mentioning ‘handle_registrations’”
“Failed to add documents to Solr: [Reason: None]”
“Got an unexpected keyword argument ‘boost’”
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
Boost
Term Boost
Document Boost
Field Boost
Advanced Topics
Swapping Backends
SearchQuerySet
API
Why Follow
QuerySet
?
Quick Start
SearchQuerySet
The
content
Shortcut
SearchQuerySet
Methods
EmptySearchQuerySet
RelatedSearchQuerySet
SearchIndex
API
Quick Start
Background
Keeping The Index Fresh
Advanced Data Preparation
Adding New Fields
Search
Index
RealTimeSearchIndex
ModelSearchIndex
SearchField
API
Subclasses
Usage
Field Options
Method Reference
SearchResult
API
Attribute Reference
Method Reference
SearchSite
API
Autodiscovery
Usage
Method Reference
SearchQuery
API
SQ
Objects
Backend-Specific Methods
Inheritable Methods
SearchBackend
API
Method Reference
Running Tests
Core Haystack Functionality
Backends
Creating New Backends
SearchBackend
SearchQuery
Utilities
get_identifier
Indices and tables
¶
Search Page
Project Versions
master
latest
1.0.X
v1.2.7
v1.2.6
v1.2.5
v1.2.4
v1.2.2
v1.2.1
v1.2.0
v1.1
RTD Search
Full-text doc search.
Table Of Contents
Table Of Contents
Indices and tables
Next topic
Welcome to Haystack!
This Page
Show Source
Quick search
Enter search terms or a module, class or function name.
Navigation
index
next
|
Haystack 1.2.7 documentation
»