prepare 0.17.4

Author: barseghyanartur

CHANGELOG.rst

@@ -17,7 +17,7 @@ are used for versioning (schema follows below):
 
 0.17.4
 ------
-2019-03-12
+2019-03-13
 
 - Source backend.
 

README.rst

@@ -88,6 +88,7 @@ Main features and highlights
 - :doc:`Simple search query search filter backend <search_backends>`.
 - :doc:`More-like-this support (detail action) <more_like_this>`.
 - :doc:`Global aggregations support <global_aggregations>`.
+- :doc:`Source filter backend <source_backend>`.
 
 Installation
 ============

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.17.4
+------
+2019-03-13
+
+- Source backend.
+
 0.17.3
 ------
 2019-02-08

docs/documentation.rst.distrib

@@ -19,6 +19,7 @@ Contents:
    more_like_this
    global_aggregations
    configuration_tweaks
+   source_backend
    demo
    frontend_demo
    changelog

docs/index.rst

@@ -88,6 +88,7 @@ Main features and highlights
 - :doc:`Simple search query search filter backend <search_backends>`.
 - :doc:`More-like-this support (detail action) <more_like_this>`.
 - :doc:`Global aggregations support <global_aggregations>`.
+- :doc:`Source filter backend <source_backend>`.
 
 Installation
 ============
@@ -243,6 +244,7 @@ Contents:
    more_like_this
    global_aggregations
    configuration_tweaks
+   source_backend
    demo
    frontend_demo
    changelog

docs/source_backend.rst

@@ -0,0 +1,67 @@
+========================
+Source filtering backend
+========================
+Allows to control how the `_source` field is returned with every hit.
+
+By default operations return the contents of the _source field unless you have
+used the `stored_fields` parameter or if the `_source` field is disabled.
+
+You can turn off `_source` retrieval by using the `source` parameter:
+
+.. code-block:: python
+
+        from django_elasticsearch_dsl_drf.filter_backends import (
+            SourceBackend
+        )
+        from django_elasticsearch_dsl_drf.viewsets import (
+            BaseDocumentViewSet,
+        )
+
+        # Local article document definition
+        from .documents import ArticleDocument
+
+        # Local article document serializer
+        from .serializers import ArticleDocumentSerializer
+
+        class ArticleDocumentView(BaseDocumentViewSet):
+
+            document = ArticleDocument
+            serializer_class = ArticleDocumentSerializer
+            filter_backends = [SourceBackend,]
+            source = ["title"]
+
+
+To disable `_source` retrieval set to False:
+
+.. code-block:: python
+
+        # ...
+        source = False
+        # ...
+
+
+The `source` also accepts one or more wildcard patterns to control what parts
+of the `_source` should be returned:
+
+.. code-block:: python
+
+        # ...
+        source = ["title", "author.*"]
+        # ...
+
+Finally, for complete control, you can specify both `includes` and `excludes`
+patterns:
+
+.. code-block:: python
+
+        # ...
+        source = {
+            "includes": ["title", "author.*"],
+            "excludes": [ "*.description" ]
+        }
+        # ...
+
+.. note::
+
+    Source can make queries lighter. However, it can break current
+    functionality. Use it with caution.

docs_src/source_backend.rst

@@ -0,0 +1,67 @@
+========================
+Source filtering backend
+========================
+Allows to control how the `_source` field is returned with every hit.
+
+By default operations return the contents of the _source field unless you have
+used the `stored_fields` parameter or if the `_source` field is disabled.
+
+You can turn off `_source` retrieval by using the `source` parameter:
+
+.. code-block:: python
+
+        from django_elasticsearch_dsl_drf.filter_backends import (
+            SourceBackend
+        )
+        from django_elasticsearch_dsl_drf.viewsets import (
+            BaseDocumentViewSet,
+        )
+
+        # Local article document definition
+        from .documents import ArticleDocument
+
+        # Local article document serializer
+        from .serializers import ArticleDocumentSerializer
+
+        class ArticleDocumentView(BaseDocumentViewSet):
+
+            document = ArticleDocument
+            serializer_class = ArticleDocumentSerializer
+            filter_backends = [SourceBackend,]
+            source = ["title"]
+
+
+To disable `_source` retrieval set to False:
+
+.. code-block:: python
+
+        # ...
+        source = False
+        # ...
+
+
+The `source` also accepts one or more wildcard patterns to control what parts
+of the `_source` should be returned:
+
+.. code-block:: python
+
+        # ...
+        source = ["title", "author.*"]
+        # ...
+
+Finally, for complete control, you can specify both `includes` and `excludes`
+patterns:
+
+.. code-block:: python
+
+        # ...
+        source = {
+            "includes": ["title", "author.*"],
+            "excludes": [ "*.description" ]
+        }
+        # ...
+
+.. note::
+
+    Source can make queries lighter. However, it can break current
+    functionality. Use it with caution.

examples/simple/search_indexes/documents/book.py

@@ -168,7 +168,7 @@ class Meta(object):
 
     def prepare_summary(self, instance):
         """Prepare summary."""
-        return instance.summary[:32766]
+        return instance.summary[:32766] if instance.summary else None
 
     def prepare_authors(self, instance):
         """Prepare authors."""

scripts/prepare_docs.sh

@@ -9,6 +9,7 @@ cat docs_src/advanced_usage_examples.rst > docs/advanced_usage_examples.rst
 cat docs_src/nested_fields_usage_examples.rst > docs/nested_fields_usage_examples.rst
 cat docs_src/filtering_usage_examples.rst > docs/filtering_usage_examples.rst
 cat docs_src/more_like_this.rst > docs/more_like_this.rst
+cat docs_src/source_backend.rst > docs/source_backend.rst
 cat docs_src/configuration_tweaks.rst > docs/configuration_tweaks.rst
 cat docs_src/global_aggregations.rst > docs/global_aggregations.rst
 cat examples/frontend/README.rst > docs/frontend_demo.rst

setup.py

@@ -139,6 +139,13 @@
         'global_aggregations.html'
         '>`_'.format(version)
     ),
+    (
+        ':doc:`Source filter backend <source_backend>`',
+        '`Source filter backend <'
+        'http://django-elasticsearch-dsl-drf.readthedocs.io/en/{}/'
+        'source_backend.html'
+        '>`_'.format(version)
+    ),
 )
 
 try: