Added an settings override on HAYSTACK_LIMIT_TO_REGISTERED_MODELS as a possible performance optimization.

Author: toastdriven

docs/searchbackend_api.rst

@@ -56,7 +56,7 @@ specific to each one.
 ``search``
 ----------
 
-.. method:: SearchBackend.search(self, query_string, sort_by=None, start_offset=0, end_offset=None, fields='', highlight=False, facets=None, date_facets=None, query_facets=None, narrow_queries=None, spelling_query=None, limit_to_registered_models=True, **kwargs)
+.. method:: SearchBackend.search(self, query_string, sort_by=None, start_offset=0, end_offset=None, fields='', highlight=False, facets=None, date_facets=None, query_facets=None, narrow_queries=None, spelling_query=None, limit_to_registered_models=None, **kwargs)
 
 Takes a query to search on and returns dictionary.
 

docs/settings.rst

@@ -280,3 +280,22 @@ An example::
     HAYSTACK_ITERATOR_LOAD_PER_QUERY = 100
 
 The default is 10 results at a time.
+
+
+``HAYSTACK_LIMIT_TO_REGISTERED_MODELS``
+=======================================
+
+**Optional**
+
+This setting allows you to control whether or not Haystack will limit the
+search results seen to just the models registered. It should be a boolean.
+
+If your search index is never used for anything other than the models
+registered with Haystack, you can turn this off and get a small to moderate
+performance boost.
+
+An example::
+
+    HAYSTACK_LIMIT_TO_REGISTERED_MODELS = False
+
+Default is ``True``.

haystack/backends/__init__.py

@@ -114,7 +114,7 @@ def clear(self, models=[], commit=True):
     def search(self, query_string, sort_by=None, start_offset=0, end_offset=None,
                fields='', highlight=False, facets=None, date_facets=None, query_facets=None,
                narrow_queries=None, spelling_query=None,
-               limit_to_registered_models=True, **kwargs):
+               limit_to_registered_models=None, **kwargs):
         """
         Takes a query to search on and returns dictionary.
         

haystack/backends/dummy_backend.py

@@ -43,7 +43,7 @@ def clear(self, models=[], commit=True):
     def search(self, query_string, sort_by=None, start_offset=0, end_offset=None,
                fields='', highlight=False, facets=None, date_facets=None, query_facets=None,
                narrow_queries=None, spelling_query=None,
-               limit_to_registered_models=True, **kwargs):
+               limit_to_registered_models=None, **kwargs):
         if query_string == '(content__exact hello AND content__exact world)':
             return {
                 'results': [DummySearchResult('haystack', 'dummymodel', 1, 1.5)],
@@ -60,7 +60,7 @@ def prep_value(self, db_field, value):
 
     def more_like_this(self, model_instance, additional_query_string=None,
                        start_offset=0, end_offset=None,
-                       limit_to_registered_models=True, **kwargs):
+                       limit_to_registered_models=None, **kwargs):
         return {
             'results': [],
             'hits': 0

haystack/backends/simple_backend.py

@@ -47,7 +47,7 @@ def clear(self, models=[], commit=True):
     def search(self, query_string, sort_by=None, start_offset=0, end_offset=None,
                fields='', highlight=False, facets=None, date_facets=None, query_facets=None,
                narrow_queries=None, spelling_query=None,
-               limit_to_registered_models=True, **kwargs):
+               limit_to_registered_models=None, **kwargs):
         hits = 0
         results = []
 
@@ -74,7 +74,7 @@ def prep_value(self, db_field, value):
 
     def more_like_this(self, model_instance, additional_query_string=None,
                        start_offset=0, end_offset=None,
-                       limit_to_registered_models=True, **kwargs):
+                       limit_to_registered_models=None, **kwargs):
         return {
             'results': [],
             'hits': 0

haystack/backends/solr_backend.py

@@ -106,7 +106,7 @@ def clear(self, models=[], commit=True):
     def search(self, query_string, sort_by=None, start_offset=0, end_offset=None,
                fields='', highlight=False, facets=None, date_facets=None, query_facets=None,
                narrow_queries=None, spelling_query=None,
-               limit_to_registered_models=True, **kwargs):
+               limit_to_registered_models=None, **kwargs):
         if len(query_string) == 0:
             return {
                 'results': [],
@@ -165,6 +165,9 @@ def search(self, query_string, sort_by=None, start_offset=0, end_offset=None,
             kwargs['facet'] = 'on'
             kwargs['facet.query'] = ["%s:%s" % (field, value) for field, value in query_facets]
 
+        if limit_to_registered_models is None:
+            limit_to_registered_models = getattr(settings, 'HAYSTACK_LIMIT_TO_REGISTERED_MODELS', True)
+        
         if limit_to_registered_models:
             # Using narrow queries, limit the results to only models registered
             # with the current site.
@@ -189,7 +192,7 @@ def search(self, query_string, sort_by=None, start_offset=0, end_offset=None,
 
     def more_like_this(self, model_instance, additional_query_string=None,
                        start_offset=0, end_offset=None,
-                       limit_to_registered_models=True, **kwargs):
+                       limit_to_registered_models=None, **kwargs):
         # Handle deferred models.
         if get_proxied_model and hasattr(model_instance, '_deferred') and model_instance._deferred:
             model_klass = get_proxied_model(model_instance._meta)
@@ -210,6 +213,9 @@ def more_like_this(self, model_instance, additional_query_string=None,
 
         narrow_queries = set()
 
+        if limit_to_registered_models is None:
+            limit_to_registered_models = getattr(settings, 'HAYSTACK_LIMIT_TO_REGISTERED_MODELS', True)
+        
         if limit_to_registered_models:
             # Using narrow queries, limit the results to only models registered
             # with the current site.

haystack/backends/whoosh_backend.py

@@ -219,7 +219,7 @@ def optimize(self):
     def search(self, query_string, sort_by=None, start_offset=0, end_offset=None,
                fields='', highlight=False, facets=None, date_facets=None, query_facets=None,
                narrow_queries=None, spelling_query=None,
-               limit_to_registered_models=True, **kwargs):
+               limit_to_registered_models=None, **kwargs):
         if not self.setup_complete:
             self.setup()
 
@@ -282,6 +282,9 @@ def search(self, query_string, sort_by=None, start_offset=0, end_offset=None,
         narrowed_results = None
         self.index = self.index.refresh()
 
+        if limit_to_registered_models is None:
+            limit_to_registered_models = getattr(settings, 'HAYSTACK_LIMIT_TO_REGISTERED_MODELS', True)
+        
         if limit_to_registered_models:
             # Using narrow queries, limit the results to only models registered
             # with the current site.
@@ -342,7 +345,7 @@ def search(self, query_string, sort_by=None, start_offset=0, end_offset=None,
 
     def more_like_this(self, model_instance, additional_query_string=None,
                        start_offset=0, end_offset=None,
-                       limit_to_registered_models=True, **kwargs):
+                       limit_to_registered_models=None, **kwargs):
         warnings.warn("Whoosh does not handle More Like This.", Warning, stacklevel=2)
         return {
             'results': [],

tests/core/tests/mocks.py

@@ -35,7 +35,7 @@ def clear(self, models=[], commit=True):
     def search(self, query_string, sort_by=None, start_offset=0, end_offset=None,
                fields='', highlight=False, facets=None, date_facets=None, query_facets=None,
                narrow_queries=None, spelling_query=None,
-               limit_to_registered_models=True, **kwargs):
+               limit_to_registered_models=None, **kwargs):
         from haystack import site
         results = []
         hits = len(MOCK_SEARCH_RESULTS)

tests/solr_tests/tests/solr_backend.py

@@ -232,6 +232,22 @@ def test_search(self):
         self.assertEqual(self.sb.search('', narrow_queries=set(['name:daniel1'])), {'hits': 0, 'results': []})
         results = self.sb.search('Index', narrow_queries=set(['name:daniel1']))
         self.assertEqual(results['hits'], 1)
+        
+        # Check the use of ``limit_to_registered_models``.
+        self.assertEqual(self.sb.search('', limit_to_registered_models=False), {'hits': 0, 'results': []})
+        self.assertEqual(self.sb.search('*:*', limit_to_registered_models=False)['hits'], 3)
+        self.assertEqual([result.pk for result in self.sb.search('*:*', limit_to_registered_models=False)['results']], ['1', '2', '3'])
+        
+        # Stow.
+        old_limit_to_registered_models = getattr(settings, 'HAYSTACK_LIMIT_TO_REGISTERED_MODELS', True)
+        settings.HAYSTACK_LIMIT_TO_REGISTERED_MODELS = False
+        
+        self.assertEqual(self.sb.search(''), {'hits': 0, 'results': []})
+        self.assertEqual(self.sb.search('*:*')['hits'], 3)
+        self.assertEqual([result.pk for result in self.sb.search('*:*')['results']], ['1', '2', '3'])
+        
+        # Restore.
+        settings.HAYSTACK_LIMIT_TO_REGISTERED_MODELS = old_limit_to_registered_models
 
     def test_more_like_this(self):
         self.sb.update(self.smmi, self.sample_objs)

tests/whoosh_tests/tests/whoosh_backend.py

@@ -174,6 +174,22 @@ def test_search(self):
         # self.assertEqual(self.sb.search('', narrow_queries=set(['name:daniel1'])), {'hits': 0, 'results': []})
         # results = self.sb.search('Index*', narrow_queries=set(['name:daniel1']))
         # self.assertEqual(results['hits'], 1)
+        
+        # Check the use of ``limit_to_registered_models``.
+        self.assertEqual(self.sb.search(u'', limit_to_registered_models=False), {'hits': 0, 'results': []})
+        self.assertEqual(self.sb.search(u'*', limit_to_registered_models=False)['hits'], 23)
+        self.assertEqual([result.pk for result in self.sb.search(u'*', limit_to_registered_models=False)['results']], [u'23', u'22', u'21', u'20', u'19', u'18', u'17', u'16', u'15', u'14', u'13', u'12', u'11', u'10', u'9', u'8', u'7', u'6', u'5', u'4', u'3', u'2', u'1'])
+        
+        # Stow.
+        old_limit_to_registered_models = getattr(settings, 'HAYSTACK_LIMIT_TO_REGISTERED_MODELS', True)
+        settings.HAYSTACK_LIMIT_TO_REGISTERED_MODELS = False
+        
+        self.assertEqual(self.sb.search(u''), {'hits': 0, 'results': []})
+        self.assertEqual(self.sb.search(u'*')['hits'], 23)
+        self.assertEqual([result.pk for result in self.sb.search(u'*')['results']], [u'23', u'22', u'21', u'20', u'19', u'18', u'17', u'16', u'15', u'14', u'13', u'12', u'11', u'10', u'9', u'8', u'7', u'6', u'5', u'4', u'3', u'2', u'1'])
+        
+        # Restore.
+        settings.HAYSTACK_LIMIT_TO_REGISTERED_MODELS = old_limit_to_registered_models
 
     def test_more_like_this(self):
         self.sb.update(self.smmi, self.sample_objs)