Skip to content

Commit a228bb2

Browse files
miguelgrinbergmiguelgrinberg
committed
support composable templates
1 parent 5511abe commit a228bb2

File tree

16 files changed

+191
-14
lines changed

16 files changed

+191
-14
lines changed

‎elasticsearch_dsl/__init__.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,14 @@
7979
construct_field,
8080
)
8181
from .function import SF
82-
from .index import AsyncIndex, AsyncIndexTemplate, Index, IndexTemplate
82+
from .index import (
83+
AsyncIndex,
84+
AsyncIndexTemplate,
85+
AsyncNewIndexTemplate,
86+
Index,
87+
IndexTemplate,
88+
NewIndexTemplate,
89+
)
8390
from .mapping import AsyncMapping, Mapping
8491
from .query import Q, Query
8592
from .response import AggResponse, Response, UpdateByQueryResponse
@@ -109,6 +116,7 @@
109116
"AsyncIndexTemplate",
110117
"AsyncMapping",
111118
"AsyncMultiSearch",
119+
"AsyncNewIndexTemplate",
112120
"AsyncSearch",
113121
"AsyncUpdateByQuery",
114122
"AttrDict",
@@ -158,6 +166,7 @@
158166
"Murmur3",
159167
"Nested",
160168
"NestedFacet",
169+
"NewIndexTemplate",
161170
"Object",
162171
"Percolator",
163172
"Q",

‎elasticsearch_dsl/_async/index.py

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,47 @@ async def save(
7373
)
7474

7575

76+
class AsyncNewIndexTemplate:
77+
def __init__(
78+
self,
79+
name: str,
80+
template: str,
81+
index: Optional["AsyncIndex"] = None,
82+
priority: Optional[int] = None,
83+
**kwargs: Any,
84+
):
85+
if index is None:
86+
self._index = AsyncIndex(template, **kwargs)
87+
else:
88+
if kwargs:
89+
raise ValueError(
90+
"You cannot specify options for Index when"
91+
" passing an Index instance."
92+
)
93+
self._index = index.clone()
94+
self._index._name = template
95+
self._template_name = name
96+
self.priority = priority
97+
98+
def __getattr__(self, attr_name: str) -> Any:
99+
return getattr(self._index, attr_name)
100+
101+
def to_dict(self) -> Dict[str, Any]:
102+
d: Dict[str, Any] = {"template": self._index.to_dict()}
103+
d["index_patterns"] = [self._index._name]
104+
if self.priority is not None:
105+
d["priority"] = self.priority
106+
return d
107+
108+
async def save(
109+
self, using: Optional[AsyncUsingType] = None
110+
) -> "ObjectApiResponse[Any]":
111+
es = get_connection(using or self._index._using)
112+
return await es.indices.put_index_template(
113+
name=self._template_name, **self.to_dict()
114+
)
115+
116+
76117
class AsyncIndex(IndexBase):
77118
_using: AsyncUsingType
78119

@@ -109,6 +150,19 @@ def as_template(
109150
template_name, pattern or self._name, index=self, order=order
110151
)
111152

153+
def as_new_template(
154+
self,
155+
template_name: str,
156+
pattern: Optional[str] = None,
157+
priority: Optional[int] = None,
158+
) -> AsyncNewIndexTemplate:
159+
# TODO: should we allow pattern to be a top-level arg?
160+
# or maybe have an IndexPattern that allows for it and have
161+
# Document._index be that?
162+
return AsyncNewIndexTemplate(
163+
template_name, pattern or self._name, index=self, priority=priority
164+
)
165+
112166
async def load_mappings(self, using: Optional[AsyncUsingType] = None) -> None:
113167
await self.get_or_create_mapping().update_from_es(
114168
self._name, using=using or self._using

‎elasticsearch_dsl/_sync/index.py

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,43 @@ def save(self, using: Optional[UsingType] = None) -> "ObjectApiResponse[Any]":
6969
return es.indices.put_template(name=self._template_name, body=self.to_dict())
7070

7171

72+
class NewIndexTemplate:
73+
def __init__(
74+
self,
75+
name: str,
76+
template: str,
77+
index: Optional["Index"] = None,
78+
priority: Optional[int] = None,
79+
**kwargs: Any,
80+
):
81+
if index is None:
82+
self._index = Index(template, **kwargs)
83+
else:
84+
if kwargs:
85+
raise ValueError(
86+
"You cannot specify options for Index when"
87+
" passing an Index instance."
88+
)
89+
self._index = index.clone()
90+
self._index._name = template
91+
self._template_name = name
92+
self.priority = priority
93+
94+
def __getattr__(self, attr_name: str) -> Any:
95+
return getattr(self._index, attr_name)
96+
97+
def to_dict(self) -> Dict[str, Any]:
98+
d: Dict[str, Any] = {"template": self._index.to_dict()}
99+
d["index_patterns"] = [self._index._name]
100+
if self.priority is not None:
101+
d["priority"] = self.priority
102+
return d
103+
104+
def save(self, using: Optional[UsingType] = None) -> "ObjectApiResponse[Any]":
105+
es = get_connection(using or self._index._using)
106+
return es.indices.put_index_template(name=self._template_name, **self.to_dict())
107+
108+
72109
class Index(IndexBase):
73110
_using: UsingType
74111

@@ -103,6 +140,19 @@ def as_template(
103140
template_name, pattern or self._name, index=self, order=order
104141
)
105142

143+
def as_new_template(
144+
self,
145+
template_name: str,
146+
pattern: Optional[str] = None,
147+
priority: Optional[int] = None,
148+
) -> NewIndexTemplate:
149+
# TODO: should we allow pattern to be a top-level arg?
150+
# or maybe have an IndexPattern that allows for it and have
151+
# Document._index be that?
152+
return NewIndexTemplate(
153+
template_name, pattern or self._name, index=self, priority=priority
154+
)
155+
106156
def load_mappings(self, using: Optional[UsingType] = None) -> None:
107157
self.get_or_create_mapping().update_from_es(
108158
self._name, using=using or self._using

‎elasticsearch_dsl/index.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,9 @@
1515
# specific language governing permissions and limitations
1616
# under the License.
1717

18-
from ._async.index import AsyncIndex, AsyncIndexTemplate # noqa: F401
19-
from ._sync.index import Index, IndexTemplate # noqa: F401
18+
from ._async.index import ( # noqa: F401
19+
AsyncIndex,
20+
AsyncIndexTemplate,
21+
AsyncNewIndexTemplate,
22+
)
23+
from ._sync.index import Index, IndexTemplate, NewIndexTemplate # noqa: F401

‎examples/alias_migration.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444

4545
ALIAS = "test-blog"
4646
PATTERN = ALIAS + "-*"
47+
PRIORITY = 100
4748

4849

4950
class BlogPost(Document):
@@ -81,7 +82,7 @@ def setup() -> None:
8182
deploy.
8283
"""
8384
# create an index template
84-
index_template = BlogPost._index.as_template(ALIAS, PATTERN)
85+
index_template = BlogPost._index.as_new_template(ALIAS, PATTERN, priority=PRIORITY)
8586
# upload the template into elasticsearch
8687
# potentially overriding the one already there
8788
index_template.save()

‎examples/async/alias_migration.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@
4545

4646
ALIAS = "test-blog"
4747
PATTERN = ALIAS + "-*"
48+
PRIORITY = 100
4849

4950

5051
class BlogPost(AsyncDocument):
@@ -82,7 +83,7 @@ async def setup() -> None:
8283
deploy.
8384
"""
8485
# create an index template
85-
index_template = BlogPost._index.as_template(ALIAS, PATTERN)
86+
index_template = BlogPost._index.as_new_template(ALIAS, PATTERN, priority=PRIORITY)
8687
# upload the template into elasticsearch
8788
# potentially overriding the one already there
8889
await index_template.save()

‎examples/async/parent_child.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ async def save(self, **kwargs: Any) -> None: # type: ignore[override]
226226

227227
async def setup() -> None:
228228
"""Create an IndexTemplate and save it into elasticsearch."""
229-
index_template = Post._index.as_template("base")
229+
index_template = Post._index.as_new_template("base", priority=100)
230230
await index_template.save()
231231

232232

‎examples/parent_child.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ def save(self, **kwargs: Any) -> None: # type: ignore[override]
225225

226226
def setup() -> None:
227227
"""Create an IndexTemplate and save it into elasticsearch."""
228-
index_template = Post._index.as_template("base")
228+
index_template = Post._index.as_new_template("base", priority=100)
229229
index_template.save()
230230

231231

‎tests/conftest.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ def teardown_method(self, _: Any) -> None:
122122
)
123123
self.client.indices.delete(index="*", expand_wildcards=expand_wildcards)
124124
self.client.indices.delete_template(name="*")
125+
self.client.indices.delete_index_template(name="*")
125126

126127
def es_version(self) -> Tuple[int, ...]:
127128
if not hasattr(self, "_es_version"):
@@ -172,6 +173,9 @@ def write_client(client: Elasticsearch) -> Generator[Elasticsearch, None, None]:
172173
for index_name in client.indices.get(index="test-*", expand_wildcards="all"):
173174
client.indices.delete(index=index_name)
174175
client.options(ignore_status=404).indices.delete_template(name="test-template")
176+
client.options(ignore_status=404).indices.delete_index_template(
177+
name="test-template"
178+
)
175179

176180

177181
@pytest_asyncio.fixture

‎tests/test_integration/_async/test_index.py

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
AsyncDocument,
2323
AsyncIndex,
2424
AsyncIndexTemplate,
25+
AsyncNewIndexTemplate,
2526
Date,
2627
Text,
2728
analysis,
@@ -35,7 +36,29 @@ class Post(AsyncDocument):
3536

3637
@pytest.mark.asyncio
3738
async def test_index_template_works(async_write_client: AsyncElasticsearch) -> None:
38-
it = AsyncIndexTemplate("test-template", "test-*")
39+
it = AsyncIndexTemplate("test-template", "test-legacy-*")
40+
it.document(Post)
41+
it.settings(number_of_replicas=0, number_of_shards=1)
42+
await it.save()
43+
44+
i = AsyncIndex("test-legacy-blog")
45+
await i.create()
46+
47+
assert {
48+
"test-legacy-blog": {
49+
"mappings": {
50+
"properties": {
51+
"title": {"type": "text", "analyzer": "my_analyzer"},
52+
"published_from": {"type": "date"},
53+
}
54+
}
55+
}
56+
} == await async_write_client.indices.get_mapping(index="test-legacy-blog")
57+
58+
59+
@pytest.mark.asyncio
60+
async def test_new_index_template_works(async_write_client: AsyncElasticsearch) -> None:
61+
it = AsyncNewIndexTemplate("test-template", "test-*")
3962
it.document(Post)
4063
it.settings(number_of_replicas=0, number_of_shards=1)
4164
await it.save()

0 commit comments

Comments
 (0)