Add raw_query_parameters method to QuerySet

parasolr/query.py

@@ -38,6 +38,7 @@ class SolrQuerySet:
     field_list = []
     highlight_field = None
     highlight_opts = {}
+    raw_params = {}
 
     #: by default, combine search queries with AND
     default_search_operator = 'AND'
@@ -79,6 +80,7 @@ def query_opts(self) -> Dict[str, str]:
         query_opts = {
             'start': self.start,
         }
+
         if self.filter_qs:
             query_opts['fq'] = self.filter_qs
         if self.stop:
@@ -103,6 +105,9 @@ def query_opts(self) -> Dict[str, str]:
             for key, val in self.highlight_opts.items():
                 query_opts['hl.%s' % key] = val
 
+        # include any raw query parameters
+        query_opts.update(self.raw_params)
+
         return query_opts
 
     def count(self) -> int:
@@ -219,6 +224,14 @@ def highlight(self, field: str, **kwargs):
         qs_copy.highlight_opts = kwargs
         return qs_copy
 
+    def raw_query_parameters(self, **kwargs):
+        """Add abritrary raw parameters to be included in the query
+        request, e.g. for variables referenced in join or field queries.
+        Analogous to the input of the same name in the Solr web interface."""
+        qs_copy = self._clone()
+        qs_copy.raw_params.update(kwargs)
+        return qs_copy
+
     def get_highlighting(self):
         """Return the highlighting portion of the Solr response."""
         if not self._result_cache:
@@ -255,6 +268,7 @@ def _clone(self):
         qs_copy.sort_options = list(self.sort_options)
         qs_copy.field_list = list(self.field_list)
         qs_copy.highlight_opts = dict(self.highlight_opts)
+        qs_copy.raw_params = dict(self.raw_params)
 
         return qs_copy
 

parasolr/tests/test_query.py

@@ -208,6 +208,22 @@ def test_highlight(self):
         assert sqs.highlight_field is None
         assert sqs.highlight_opts == {}
 
+    def test_raw_query_parameters(self):
+        mocksolr = Mock(spec=SolrClient)
+        sqs = SolrQuerySet(mocksolr)
+        raw_q = {'extra_query': 'foobar'}
+        raw_sqs = sqs.raw_query_parameters(**raw_q)
+        # raw query stored
+        assert raw_sqs.raw_params == raw_q
+        # included in query opts
+        assert raw_q['extra_query'] in raw_sqs.query_opts()['extra_query']
+        # original unchanged
+        assert sqs.raw_params == {}
+
+        # additional raw params add rather than replace
+        rawer_sqs = raw_sqs.raw_query_parameters(another='two')
+        assert len(rawer_sqs.raw_params) == 2
+
     def test_get_highlighting(self):
         mocksolr = Mock(spec=SolrClient)
         sqs = SolrQuerySet(mocksolr)