implement the use of index templates (#208)

Author: StijnCaerts

stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py

@@ -14,6 +14,7 @@
 from stac_fastapi.elasticsearch.database_logic import (
     DatabaseLogic,
     create_collection_index,
+    create_index_templates,
 )
 from stac_fastapi.extensions.core import (
     ContextExtension,
@@ -73,6 +74,7 @@
 
 @app.on_event("startup")
 async def _startup_event() -> None:
+    await create_index_templates()
     await create_collection_index()
 
 

stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/database_logic.py

@@ -171,9 +171,36 @@ def indices(collection_ids: Optional[List[str]]) -> str:
         return ",".join([index_by_collection_id(c) for c in collection_ids])
 
 
+async def create_index_templates() -> None:
+    """
+    Create index templates for the Collection and Item indices.
+
+    Returns:
+        None
+
+    """
+    client = AsyncElasticsearchSettings().create_client
+    await client.indices.put_template(
+        name=f"template_{COLLECTIONS_INDEX}",
+        body={
+            "index_patterns": [f"{COLLECTIONS_INDEX}*"],
+            "mappings": ES_COLLECTIONS_MAPPINGS,
+        },
+    )
+    await client.indices.put_template(
+        name=f"template_{ITEMS_INDEX_PREFIX}",
+        body={
+            "index_patterns": [f"{ITEMS_INDEX_PREFIX}*"],
+            "settings": ES_ITEMS_SETTINGS,
+            "mappings": ES_ITEMS_MAPPINGS,
+        },
+    )
+    await client.close()
+
+
 async def create_collection_index() -> None:
     """
-    Create the index for a Collection.
+    Create the index for a Collection. The settings of the index template will be used implicitly.
 
     Returns:
         None
@@ -184,14 +211,13 @@ async def create_collection_index() -> None:
     await client.options(ignore_status=400).indices.create(
         index=f"{COLLECTIONS_INDEX}-000001",
         aliases={COLLECTIONS_INDEX: {}},
-        mappings=ES_COLLECTIONS_MAPPINGS,
     )
     await client.close()
 
 
 async def create_item_index(collection_id: str):
     """
-    Create the index for Items.
+    Create the index for Items. The settings of the index template will be used implicitly.
 
     Args:
         collection_id (str): Collection identifier.
@@ -206,8 +232,6 @@ async def create_item_index(collection_id: str):
     await client.options(ignore_status=400).indices.create(
         index=f"{index_by_collection_id(collection_id)}-000001",
         aliases={index_name: {}},
-        mappings=ES_ITEMS_MAPPINGS,
-        settings=ES_ITEMS_SETTINGS,
     )
     await client.close()
 

stac_fastapi/opensearch/stac_fastapi/opensearch/app.py

@@ -23,6 +23,7 @@
 from stac_fastapi.opensearch.database_logic import (
     DatabaseLogic,
     create_collection_index,
+    create_index_templates,
 )
 
 settings = OpensearchSettings()
@@ -73,6 +74,7 @@
 
 @app.on_event("startup")
 async def _startup_event() -> None:
+    await create_index_templates()
     await create_collection_index()
 
 

stac_fastapi/opensearch/stac_fastapi/opensearch/database_logic.py

@@ -173,18 +173,44 @@ def indices(collection_ids: Optional[List[str]]) -> str:
         return ",".join([index_by_collection_id(c) for c in collection_ids])
 
 
+async def create_index_templates() -> None:
+    """
+    Create index templates for the Collection and Item indices.
+
+    Returns:
+        None
+
+    """
+    client = AsyncSearchSettings().create_client
+    await client.indices.put_template(
+        name=f"template_{COLLECTIONS_INDEX}",
+        body={
+            "index_patterns": [f"{COLLECTIONS_INDEX}*"],
+            "mappings": ES_COLLECTIONS_MAPPINGS,
+        },
+    )
+    await client.indices.put_template(
+        name=f"template_{ITEMS_INDEX_PREFIX}",
+        body={
+            "index_patterns": [f"{ITEMS_INDEX_PREFIX}*"],
+            "settings": ES_ITEMS_SETTINGS,
+            "mappings": ES_ITEMS_MAPPINGS,
+        },
+    )
+    await client.close()
+
+
 async def create_collection_index() -> None:
     """
-    Create the index for a Collection.
+    Create the index for a Collection. The settings of the index template will be used implicitly.
 
     Returns:
         None
 
     """
     client = AsyncSearchSettings().create_client
 
-    search_body = {
-        "mappings": ES_COLLECTIONS_MAPPINGS,
+    search_body: dict[str, Any] = {
         "aliases": {COLLECTIONS_INDEX: {}},
     }
 
@@ -203,7 +229,7 @@ async def create_collection_index() -> None:
 
 async def create_item_index(collection_id: str):
     """
-    Create the index for Items.
+    Create the index for Items. The settings of the index template will be used implicitly.
 
     Args:
         collection_id (str): Collection identifier.
@@ -214,10 +240,8 @@ async def create_item_index(collection_id: str):
     """
     client = AsyncSearchSettings().create_client
     index_name = index_by_collection_id(collection_id)
-    search_body = {
+    search_body: dict[str, Any] = {
         "aliases": {index_name: {}},
-        "mappings": ES_ITEMS_MAPPINGS,
-        "settings": ES_ITEMS_SETTINGS,
     }
 
     try:

stac_fastapi/tests/conftest.py

@@ -23,6 +23,7 @@
     from stac_fastapi.opensearch.database_logic import (
         DatabaseLogic,
         create_collection_index,
+        create_index_templates,
     )
 else:
     from stac_fastapi.elasticsearch.config import (
@@ -32,6 +33,7 @@
     from stac_fastapi.elasticsearch.database_logic import (
         DatabaseLogic,
         create_collection_index,
+        create_index_templates,
     )
 
 from stac_fastapi.extensions.core import (  # FieldsExtension,
@@ -215,6 +217,7 @@ async def app():
 
 @pytest_asyncio.fixture(scope="session")
 async def app_client(app):
+    await create_index_templates()
     await create_collection_index()
 
     async with AsyncClient(app=app, base_url="http://test-server") as c:

stac_fastapi/tests/database/__init__.py

@@ -0,0 +1,47 @@
+import os
+import uuid
+from copy import deepcopy
+
+import pytest
+
+from ..conftest import MockRequest, database
+
+if os.getenv("BACKEND", "elasticsearch").lower() == "opensearch":
+    from stac_fastapi.opensearch.database_logic import (
+        COLLECTIONS_INDEX,
+        ES_COLLECTIONS_MAPPINGS,
+        ES_ITEMS_MAPPINGS,
+        index_by_collection_id,
+    )
+else:
+    from stac_fastapi.elasticsearch.database_logic import (
+        COLLECTIONS_INDEX,
+        ES_COLLECTIONS_MAPPINGS,
+        ES_ITEMS_MAPPINGS,
+        index_by_collection_id,
+    )
+
+
+@pytest.mark.asyncio
+async def test_index_mapping_collections(ctx):
+    response = await database.client.indices.get_mapping(index=COLLECTIONS_INDEX)
+    actual_mappings = next(iter(response.body.values()))["mappings"]
+    assert (
+        actual_mappings["dynamic_templates"]
+        == ES_COLLECTIONS_MAPPINGS["dynamic_templates"]
+    )
+
+
+@pytest.mark.asyncio
+async def test_index_mapping_items(ctx, txn_client):
+    collection = deepcopy(ctx.collection)
+    collection["id"] = str(uuid.uuid4())
+    await txn_client.create_collection(collection, request=MockRequest)
+    response = await database.client.indices.get_mapping(
+        index=index_by_collection_id(collection["id"])
+    )
+    actual_mappings = next(iter(response.body.values()))["mappings"]
+    assert (
+        actual_mappings["dynamic_templates"] == ES_ITEMS_MAPPINGS["dynamic_templates"]
+    )
+    await txn_client.delete_collection(collection["id"])