Moved EXCLUDED_INDEXES to a per-backend setting.

Author: toastdriven

docs/migration_from_1_to_2.rst

@@ -30,15 +30,15 @@ look like::
     HAYSTACK_SOLR_TIMEOUT = 60 * 5
     HAYSTACK_INCLUDE_SPELLING = True
     HAYSTACK_BATCH_SIZE = 100
-    
+
     # Or...
     HAYSTACK_SEARCH_ENGINE = 'whoosh'
     HAYSTACK_WHOOSH_PATH = '/home/search/whoosh_index'
     HAYSTACK_WHOOSH_STORAGE = 'file'
     HAYSTACK_WHOOSH_POST_LIMIT = 128 * 1024 * 1024
     HAYSTACK_INCLUDE_SPELLING = True
     HAYSTACK_BATCH_SIZE = 100
-    
+
     # Or...
     HAYSTACK_SEARCH_ENGINE = 'xapian'
     HAYSTACK_XAPIAN_PATH = '/home/search/xapian_index'
@@ -125,35 +125,35 @@ A Haystack 1.X index might've looked like::
     from haystack.indexes import *
     from haystack import site
     from myapp.models import Note
-    
-    
+
+
     class NoteIndex(SearchIndex):
         text = CharField(document=True, use_template=True)
         author = CharField(model_attr='user')
         pub_date = DateTimeField(model_attr='pub_date')
-        
+
         def get_queryset(self):
             """Used when the entire index for model is updated."""
             return Note.objects.filter(pub_date__lte=datetime.datetime.now())
-    
-    
+
+
     site.register(Note, NoteIndex)
 
 A converted Haystack 2.X index should look like::
 
     import datetime
     from haystack import indexes
     from myapp.models import Note
-    
-    
+
+
     class NoteIndex(indexes.SearchIndex, indexes.Indexable):
         text = indexes.CharField(document=True, use_template=True)
         author = indexes.CharField(model_attr='user')
         pub_date = indexes.DateTimeField(model_attr='pub_date')
-        
+
         def get_model(self):
             return Note
-        
+
         def index_queryset(self):
             """Used when the entire index for model is updated."""
             return self.get_model().objects.filter(pub_date__lte=datetime.datetime.now())
@@ -180,15 +180,21 @@ method. This was present in the Haystack 1.2.X series (with a deprecation warnin
 in 1.2.4+) but has been removed in Haystack v2.
 
 Finally, if you were unregistering other indexes before, you should make use of
-the new ``HAYSTACK_EXCLUDED_INDEXES`` setting. It should be a list of strings
-that contain the Python import path to the indexes that should not be loaded &
-used. For example::
+the new ``EXCLUDED_INDEXES`` setting available in each backend's settings. It
+should be a list of strings that contain the Python import path to the indexes
+that should not be loaded & used. For example::
 
-    HAYSTACK_EXCLUDED_INDEXES = [
-        # Imagine that these indexes exist. They don't.
-        'django.contrib.auth.search_indexes.UserIndex',
-        'third_party_blog_app.search_indexes.EntryIndex',
-    ]
+    HAYSTACK_CONNECTIONS = {
+        'default': {
+            'ENGINE': 'haystack.backends.solr_backend.SolrEngine',
+            'URL': 'http://localhost:9001/solr/default',
+            'EXCLUDED_INDEXES': [
+                # Imagine that these indexes exist. They don't.
+                'django.contrib.auth.search_indexes.UserIndex',
+                'third_party_blog_app.search_indexes.EntryIndex',
+            ]
+        }
+    }
 
 This allows for reliable swapping of the index that handles a model without
 relying on correct import order.
@@ -239,9 +245,9 @@ that the classes are defined above it) and should look like::
 
     from haystack.backends import BaseEngine
     from haystack.backends.solr_backend import SolrSearchQuery
-    
+
     # Code then...
-    
+
     class MyCustomSolrEngine(BaseEngine):
         # Use our custom backend.
         backend = MySolrBackend

docs/settings.rst

@@ -40,6 +40,7 @@ dictionary of dictionaries resembling the following (complete) example::
             'TIMEOUT': 60 * 5,
             'INCLUDE_SPELLING': True,
             'BATCH_SIZE': 100,
+            'EXCLUDED_INDEXES': ['thirdpartyapp.search_indexes.BarIndex'],
         },
         'autocomplete': {
             'ENGINE': 'haystack.backends.whoosh_backend.WhooshEngine',
@@ -48,15 +49,18 @@ dictionary of dictionaries resembling the following (complete) example::
             'POST_LIMIT': 128 * 1024 * 1024,
             'INCLUDE_SPELLING': True,
             'BATCH_SIZE': 100,
+            'EXCLUDED_INDEXES': ['thirdpartyapp.search_indexes.BarIndex'],
         },
         'slave': {
             'ENGINE': 'xapian_backend.XapianEngine',
             'PATH': '/home/search/xapian_index',
             'INCLUDE_SPELLING': True,
             'BATCH_SIZE': 100,
+            'EXCLUDED_INDEXES': ['thirdpartyapp.search_indexes.BarIndex'],
         },
         'db': {
             'ENGINE': 'haystack.backends.simple_backend.SimpleEngine',
+            'EXCLUDED_INDEXES': ['thirdpartyapp.search_indexes.BarIndex'],
         }
     }
 
@@ -96,30 +100,39 @@ The following options are optional:
 * ``POST_LIMIT`` - (Whoosh-only) How large the file sizes can be. Default is
   ``128 * 1024 * 1024``.
 * ``FLAGS`` - (Xapian-only) A list of flags to use when querying the index.
+* ``EXCLUDED_INDEXES`` - A list of strings (as Python import paths) to indexes
+  you do **NOT** want included. Useful for omitting third-party things you
+  don't want indexed or for when you want to replace an index.
 
 
 ``HAYSTACK_ROUTERS``
 ====================
 
 **Optional**
 
+This setting controls how routing is performed to allow different backends to
+handle updates/deletes/reads.
 
+An example::
 
+    HAYSTACK_ROUTERS = ['search_routers.MasterSlaveRouter', 'haystack.routers.DefaultRouter']
 
-``HAYSTACK_EXCLUDED_INDEXES``
-=============================
-
-**Optional**
-
-
+Defaults to ``['haystack.routers.DefaultRouter']``.
 
 
 ``HAYSTACK_DOCUMENT_FIELD``
 ===========================
 
 **Optional**
 
+This setting controls what fieldname Haystack relies on as the default field
+for searching within.
+
+An example::
+
+    HAYSTACK_DOCUMENT_FIELD = 'wall_o_text'
 
+Defaults to ``text``.
 
 
 ``HAYSTACK_SEARCH_RESULTS_PER_PAGE``

haystack/backends/__init__.py

@@ -763,6 +763,6 @@ def reset_queries(self):
 
     def get_unified_index(self):
         if self._index is None:
-            self._index = self.unified_index()
+            self._index = self.unified_index(self.options.get('EXCLUDED_INDEXES', []))
 
         return self._index