Allow index templates to have order

Fixes #1186

Author: honzakral

docs/persistence.rst

@@ -562,7 +562,7 @@ Potential workflow for a set of time based indices governed by a single template
             return super().save(**kwargs)
 
     # once, as part of application setup, during deploy/migrations:
-    logs = Log._index.as_template('logs')
+    logs = Log._index.as_template('logs', order=0)
     logs.save()
 
     # to perform search across all logs:

elasticsearch_dsl/index.py

@@ -9,7 +9,7 @@
 DEFAULT_DOC_TYPE = 'doc'
 
 class IndexTemplate(object):
-    def __init__(self, name, template, index=None, **kwargs):
+    def __init__(self, name, template, index=None, order=None, **kwargs):
         if index is None:
             self._index = Index(template, **kwargs)
         else:
@@ -19,13 +19,16 @@ def __init__(self, name, template, index=None, **kwargs):
             self._index = index.clone()
             self._index._name = template
         self._template_name = name
+        self.order = order
 
     def __getattr__(self, attr_name):
         return getattr(self._index, attr_name)
 
     def to_dict(self):
         d = self._index.to_dict()
         d['index_patterns'] = [self._index._name]
+        if self.order is not None:
+            d['order'] = self.order
         return d
 
     def save(self, using=None):
@@ -51,11 +54,12 @@ def get_or_create_mapping(self):
             self._mapping = Mapping()
         return self._mapping
 
-    def as_template(self, template_name, pattern=None):
+    def as_template(self, template_name, pattern=None, order=None):
         # TODO: should we allow pattern to be a top-level arg?
         # or maybe have an IndexPattern that allows for it and have
         # Document._index be that?
-        return IndexTemplate(template_name, pattern or self._name, index=self)
+        return IndexTemplate(template_name, pattern or self._name, index=self,
+                             order=order)
 
     def resolve_nested(self, field_path):
         for doc in self._doc_types:

test_elasticsearch_dsl/test_index.py

@@ -141,3 +141,12 @@ def test_conflicting_analyzer_raises_error():
 
     with raises(ValueError):
         i.analyzer('my_analyzer', tokenizer='keyword', filter=['lowercase', 'stop'])
+
+def test_index_template_can_have_order():
+    i = Index('i-*')
+    it = i.as_template('i', order=2)
+
+    assert {
+        "index_patterns": ["i-*"],
+        "order": 2
+    } == it.to_dict()