Some doc, examples and formating fix

Author: sabricot

HISTORY.rst

@@ -3,6 +3,17 @@
 History
 -------
 
+0.5.0 (2018-04-22)
+~~~~~~~~~~~~~~~~~~
+* Add Support for Elasticsearch 6 thanks to HansAdema
+
+Breaking Change:
+~~~~~~~~~~~~~~~~
+Django string fields now point to ES text field by default.
+Nothing should change for ES 2.X but if you are using ES 5.X,
+you may need to rebuild and/or update some of your documents.
+
+
 0.4.5 (2018-04-22)
 ~~~~~~~~~~~~~~~~~~
 * Fix prepare with related models when deleted (See PR #99)

README.rst

@@ -220,7 +220,7 @@ like this:
     class CarDocument(DocType):
         # add a string field to the Elasticsearch mapping called type, the
         # value of which is derived from the model's type_to_string attribute
-        type = fields.StringField(attr="type_to_string")
+        type = fields.TextField(attr="type_to_string")
 
         class Meta:
             model = Car
@@ -252,7 +252,7 @@ needs to be saved.
     class CarDocument(DocType):
         # ... #
 
-        foo = StringField()
+        foo = TextField()
 
         def prepare_foo(self, instance):
             return " ".join(instance.foos)
@@ -304,12 +304,12 @@ You can use an ObjectField or a NestedField.
     @car.doc_type
     class CarDocument(DocType):
         manufacturer = fields.ObjectField(properties={
-            'name': fields.StringField(),
-            'country_code': fields.StringField(),
+            'name': fields.TextField(),
+            'country_code': fields.TextField(),
         })
         ads = fields.NestedField(properties={
-            'description': fields.StringField(analyzer=html_strip),
-            'title': fields.StringField(),
+            'description': fields.TextField(analyzer=html_strip),
+            'title': fields.TextField(),
             'pk': fields.IntegerField(),
         })
 
@@ -368,9 +368,9 @@ So for example you can use a custom analyzer_:
 
     @car.doc_type
     class CarDocument(DocType):
-        description = fields.StringField(
+        description = fields.TextField(
             analyzer=html_strip,
-            fields={'raw': fields.StringField(index='not_analyzed')}
+            fields={'raw': fields.KeywordField()}
         )
 
         class Meta:
@@ -405,7 +405,7 @@ Available Fields
     - ObjectField(properties, attr=None, \*\*elasticsearch_properties)
     - NestedField(properties, attr=None, \*\*elasticsearch_properties)
 
-- Elasticsearch 5 Fields
+- Elasticsearch >=5 Fields
 
     - TextField(attr=None, \*\*elasticsearch_properties)
     - KeywordField(attr=None, \*\*elasticsearch_properties)
@@ -457,7 +457,7 @@ want to put in this Elasticsearch index.
             fields = [
                 'name', # If a field as the same name in multiple DocType of
                         # the same Index, the field type must be identical
-                        # (here fields.StringField)
+                        # (here fields.TextField)
                 'country_code',
             ]
 

django_elasticsearch_dsl/fields.py

@@ -207,7 +207,7 @@ def get_value_from_instance(self, instance, field_value_to_ignore=None):
 
         if isinstance(_file, FieldFile):
             return _file.url if _file else ''
-        return _file
+        return _file if _file else ''
 
 
 # ES5+ has text types Keyword and Text, ES2 has type String.

example/example/settings.py

@@ -22,7 +22,7 @@
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
 
-ALLOWED_HOSTS = ['*']
+ALLOWED_HOSTS = []
 
 # Application definition
 
@@ -84,7 +84,7 @@
 
 ELASTICSEARCH_DSL = {
     'default': {
-        'hosts': '192.168.99.100:9200'
+        'hosts': 'localhost:9200'
     },
 }
 

example/test_app/documents.py

@@ -22,19 +22,19 @@
 @car.doc_type
 class CarDocument(DocType):
     manufacturer = fields.ObjectField(properties={
-        'name': fields.StringField(),
-        'country': fields.StringField(),
+        'name': fields.TextField(),
+        'country': fields.TextField(),
         'logo': fields.FileField(),
     })
 
     ads = fields.NestedField(properties={
-        'description': fields.StringField(analyzer=html_strip),
-        'title': fields.StringField(),
+        'description': fields.TextField(analyzer=html_strip),
+        'title': fields.TextField(),
         'pk': fields.IntegerField(),
     })
 
     categories = fields.NestedField(properties={
-        'title': fields.StringField(),
+        'title': fields.TextField(),
     })
 
     class Meta:
@@ -73,6 +73,46 @@ class Meta:
         ]
 
 
+class CarWithPrepareDocument(DocType):
+    manufacturer = fields.ObjectField(properties={
+        'name': fields.TextField(),
+        'country': fields.TextField(),
+    })
+
+    manufacturer_short = fields.ObjectField(properties={
+        'name': fields.TextField(),
+    })
+
+    class Meta:
+        model = Car
+        related_models = [Manufacturer]
+        index = 'car_with_prepare_index'
+        fields = [
+            'name',
+            'launched',
+            'type',
+        ]
+
+    def prepare_manufacturer_with_related(self, car, related_to_ignore):
+        if (car.manufacturer is not None and car.manufacturer !=
+                related_to_ignore):
+            return {
+                'name': car.manufacturer.name,
+                'country': car.manufacturer.country(),
+            }
+        return {}
+
+    def prepare_manufacturer_short(self, car):
+        if car.manufacturer is not None:
+            return {
+                'name': car.manufacturer.name,
+            }
+        return {}
+
+    def get_instances_from_related(self, related_instance):
+        return related_instance.car_set.all()
+
+
 class AdDocument(DocType):
     description = fields.TextField(
         analyzer=html_strip,
@@ -96,7 +136,7 @@ def __init__(self, *args, **kwargs):
 
     class Meta:
         model = Ad
-        index = 'test_ads'
+        index = 'test_ads2'
         fields = [
             'title',
         ]

requirements_dev.txt

@@ -2,4 +2,4 @@ bumpversion==0.5.3
 wheel==0.29.0
 django>=2.0,<2.1
 elasticsearch-dsl>=2.1.0,<7.0.0
-
+-e .

tests/documents.py

@@ -123,7 +123,6 @@ def get_instances_from_related(self, related_instance):
         return related_instance.car_set.all()
 
 
-
 ad_index = Index('test_ads').settings(**index_settings)