Merge branch 'master' of github.com:barseghyanartur/django-elasticsearch-dsl-drf

Author: barseghyanartur

CHANGELOG.rst

@@ -15,6 +15,12 @@ are used for versioning (schema follows below):
   0.3.4 to 0.4).
 - All backwards incompatible changes are mentioned in this document.
 
+0.16.1
+------
+2018-09-18
+
+- Make it possible to control the size of the functional suggester queries.
+
 0.16
 ----
 2018-09-10

docs/advanced_usage_examples.rst

@@ -1975,6 +1975,10 @@ functionality). Thus, it might be written as short as:
                     FUNCTIONAL_SUGGESTER_COMPLETION_PREFIX,
                 ],
                 'default_suggester': FUNCTIONAL_SUGGESTER_COMPLETION_PREFIX,
+                'options': {
+                    'size': 25,
+                    'from': 0,
+                }
             },
             'title_suggest_match': {
                 'field': 'title.edge_ngram_completion',
@@ -1983,6 +1987,12 @@ functionality). Thus, it might be written as short as:
             }
         }
 
+.. note::
+
+    Note, that in ``functional_suggester_fields['title_suggest']['options']``
+    there are two params: ``size`` and ``from``. They control the query size
+    and the offset of the generated functional suggest query.
+
 Highlighting
 ------------
 Highlighters enable you to get highlighted snippets from one or more fields

docs/changelog.rst

@@ -15,6 +15,12 @@ are used for versioning (schema follows below):
   0.3.4 to 0.4).
 - All backwards incompatible changes are mentioned in this document.
 
+0.16.1
+------
+2018-09-18
+
+- Make it possible to control the size of the functional queries.
+
 0.16
 ----
 2018-09-10

docs_src/advanced_usage_examples.rst

@@ -1975,6 +1975,10 @@ functionality). Thus, it might be written as short as:
                     FUNCTIONAL_SUGGESTER_COMPLETION_PREFIX,
                 ],
                 'default_suggester': FUNCTIONAL_SUGGESTER_COMPLETION_PREFIX,
+                'options': {
+                    'size': 25,
+                    'from': 0,
+                }
             },
             'title_suggest_match': {
                 'field': 'title.edge_ngram_completion',
@@ -1983,6 +1987,12 @@ functionality). Thus, it might be written as short as:
             }
         }
 
+.. note::
+
+    Note, that in ``functional_suggester_fields['title_suggest']['options']``
+    there are two params: ``size`` and ``from``. They control the query size
+    and the offset of the generated functional suggest query.
+
 Highlighting
 ------------
 Highlighters enable you to get highlighted snippets from one or more fields

examples/simple/search_indexes/viewsets/book/functional_suggester.py

@@ -47,6 +47,10 @@ class BookFunctionalSuggesterDocumentViewSet(BaseBookDocumentViewSet,
                 FUNCTIONAL_SUGGESTER_COMPLETION_MATCH,
             ],
             'default_suggester': FUNCTIONAL_SUGGESTER_COMPLETION_PREFIX,
+            'options': {
+                'size': 100,
+                'from': 0,
+            }
             # 'serializer_field': 'title',
         },
         'title_suggest_match': {

setup.py

@@ -2,7 +2,7 @@
 
 from setuptools import find_packages, setup
 
-version = '0.16'
+version = '0.16.1'
 
 DOCS_TRANSFORMATIONS = (
     (

src/django_elasticsearch_dsl_drf/__init__.py

@@ -3,7 +3,7 @@
 """
 
 __title__ = 'django-elasticsearch-dsl-drf'
-__version__ = '0.16'
+__version__ = '0.16.1'
 __author__ = 'Artur Barseghyan <[email protected]>'
 __copyright__ = '2017-2018 Artur Barseghyan'
 __license__ = 'GPL 2.0/LGPL 2.1'

src/django_elasticsearch_dsl_drf/filter_backends/suggester/functional.py

@@ -130,7 +130,7 @@ class FunctionalSuggesterFilterBackend(BaseFilterBackend, FilterBackendMixin):
         >>>         FunctionalSuggesterFilterBackend,
         >>>     ]
         >>>     # Suggester fields
-        >>>     suggester_fields = {
+        >>>     functional_suggester_fields = {
         >>>         'name_suggest': {
         >>>             'field': 'name.suggest',
         >>>             'suggesters': [
@@ -231,6 +231,21 @@ def prepare_suggester_fields(cls, view):
     #         phrase={'field': options['field']}
     #     )
 
+    @classmethod
+    def apply_query_size(cls, queryset, options):
+        """Apply query size.
+
+        :param queryset:
+        :param options:
+        :return:
+        """
+        if 'size' in options['options']:
+            queryset = queryset.extra(
+                from_=options['options'].get('from', 0),
+                size=options['options']['size']
+            )
+        return queryset
+
     @classmethod
     def apply_suggester_completion_prefix(cls,
                                           suggester_name,
@@ -256,6 +271,7 @@ def apply_suggester_completion_prefix(cls,
             'prefix',
             **{options['field']: value}
         )
+        queryset = cls.apply_query_size(queryset, options)
         return queryset
 
     @classmethod
@@ -283,6 +299,7 @@ def apply_suggester_completion_match(cls,
             'match',
             **{options['field']: value}
         )
+        queryset = cls.apply_query_size(queryset, options)
         return queryset
 
     def get_suggester_query_params(self, request, view):
@@ -313,13 +330,18 @@ def get_suggester_query_params(self, request, view):
 
                 valid_suggesters = suggester_fields[field_name]['suggesters']
 
+                suggester_options = {}
+
                 # If we have default suggester given use it as a default and
                 # do not require further suffix specification.
                 default_suggester = None
                 if 'default_suggester' in suggester_fields[field_name]:
                     default_suggester = \
                         suggester_fields[field_name]['default_suggester']
 
+                if 'options' in suggester_fields[field_name]:
+                    suggester_options = suggester_fields[field_name]['options']
+
                 if suggester_param is None \
                         or suggester_param in valid_suggesters:
 
@@ -360,6 +382,7 @@ def get_suggester_query_params(self, request, view):
                             ),
                             'type': view.mapping,
                             'serializer_field': serializer_field,
+                            'options': suggester_options,
                         }
         return suggester_query_params