sfeos-helpers 6.2.0__py3-none-any.whl → 6.2.1__py3-none-any.whl

{sfeos_helpers-6.2.0.dist-info → sfeos_helpers-6.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
-Name: sfeos-helpers
-Version: 6.2.0
+Metadata-Version: 2.4
+Name: sfeos_helpers
+Version: 6.2.1
 Summary: Helper library for the Elasticsearch and Opensearch stac-fastapi backends.
 Home-page: https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch
 License: MIT
@@ -15,7 +15,15 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-Requires-Dist: stac-fastapi.core==6.2.0
+Requires-Dist: stac-fastapi.core==6.2.1
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # stac-fastapi-elasticsearch-opensearch
 
@@ -246,6 +254,7 @@ You can customize additional settings in your `.env` file:
 | `RAISE_ON_BULK_ERROR`        | Controls whether bulk insert operations raise exceptions on errors. If set to `true`, the operation will stop and raise an exception when an error occurs. If set to `false`, errors will be logged, and the operation will continue. **Note:** STAC Item and ItemCollection validation errors will always raise, regardless of this flag. | `false` | Optional |
 | `DATABASE_REFRESH`           | Controls whether database operations refresh the index immediately after changes. If set to `true`, changes will be immediately searchable. If set to `false`, changes may not be immediately visible but can improve performance for bulk operations. If set to `wait_for`, changes will wait for the next refresh cycle to become visible. | `false` | Optional |
 | `ENABLE_TRANSACTIONS_EXTENSIONS` | Enables or disables the Transactions and Bulk Transactions API extensions. If set to `false`, the POST `/collections` route and related transaction endpoints (including bulk transaction operations) will be unavailable in the API. This is useful for deployments where mutating the catalog via the API should be prevented. | `true` | Optional |
+| `STAC_ITEM_LIMIT` | Sets the environment variable for result limiting to SFEOS for the number of returned items and STAC collections. | `10` | Optional |
 
 > [!NOTE]
 > The variables `ES_HOST`, `ES_PORT`, `ES_USE_SSL`, `ES_VERIFY_CERTS` and `ES_TIMEOUT` apply to both Elasticsearch and OpenSearch backends, so there is no need to rename the key names to `OS_` even if you're using OpenSearch.

{sfeos_helpers-6.2.0.dist-info → sfeos_helpers-6.2.1.dist-info}/RECORD

@@ -1,5 +1,5 @@
 stac_fastapi/sfeos_helpers/mappings.py,sha256=z6GJFJUE7bRKF9ODc8_ddkb7JCOokMtj4p2LeaQqrQQ,8237
-stac_fastapi/sfeos_helpers/version.py,sha256=ro2d3oERQL2KxSo7qmbU0z6qT77XShwY6vsqrLf2VFw,45
+stac_fastapi/sfeos_helpers/version.py,sha256=TvDysD5xP1CNnI8XDtkkz5sggBM1uuxjhZCv120q3AU,45
 stac_fastapi/sfeos_helpers/aggregation/__init__.py,sha256=Mym17lFh90by1GnoQgMyIKAqRNJnvCgVSXDYzjBiPQk,1210
 stac_fastapi/sfeos_helpers/aggregation/client.py,sha256=PPUk0kAZnms46FlLGrR5w8wa52vG-dT6BG37896R5CY,17939
 stac_fastapi/sfeos_helpers/aggregation/format.py,sha256=qUW1jjh2EEjy-V7riliFR77grpi-AgsTmP76z60K5Lo,2011
@@ -8,13 +8,13 @@ stac_fastapi/sfeos_helpers/database/datetime.py,sha256=XMyi9Q09cuP_hj97qbGbHFtel
 stac_fastapi/sfeos_helpers/database/document.py,sha256=LtjX15gvaOuZC_k2t_oQhys_c-zRTLN5rwX0hNJkHnM,1725
 stac_fastapi/sfeos_helpers/database/index.py,sha256=g7_sKfd5XUwq4IhdKRNiasejk045dKlullsdeDSZTq8,6585
 stac_fastapi/sfeos_helpers/database/mapping.py,sha256=4-MSd4xH5wg7yoC4aPjzYMDSEvP026bw4k2TfffMT5E,1387
-stac_fastapi/sfeos_helpers/database/query.py,sha256=k6aS20gnnjJzDynJ2AaPstpAPXEeWUEbPSkDffOf2To,4001
-stac_fastapi/sfeos_helpers/database/utils.py,sha256=nPTWqP-pdSZumeYRx92XTN4xmmufRSqCDHaiSLdg-3o,7311
+stac_fastapi/sfeos_helpers/database/query.py,sha256=g2iGdfgqpx6o8GoQJBMl3AMmqcbSf792qvKWfWipR5w,4193
+stac_fastapi/sfeos_helpers/database/utils.py,sha256=sgkvjhWtQVGwQLeEXgPR6VoWpdbuVV-WJIGFUsVxqYg,8715
 stac_fastapi/sfeos_helpers/filter/__init__.py,sha256=n3zL_MhEGOoxMz1KeijyK_UKiZ0MKPl90zHtYI5RAy8,1557
 stac_fastapi/sfeos_helpers/filter/client.py,sha256=QwjYWXkevoVS7HPtoXfeSzDy-_GJnFhPJtJM49D14oU,4229
 stac_fastapi/sfeos_helpers/filter/cql2.py,sha256=Cg9kRYD9CVkVSyRqOyB5oVXmlyteSn2bw88sqklGpUM,955
 stac_fastapi/sfeos_helpers/filter/transform.py,sha256=1GEWQSp-rbq7_1nDVv1ApDbWxt8DswJWxwaxzV85gj4,4644
-stac_fastapi/sfeos_helpers/models/patch.py,sha256=akzfF7vXI6AyGDrxgP8KqVwBvBDQayXYNNf4pm6Q8qM,4209
+stac_fastapi/sfeos_helpers/models/patch.py,sha256=s5n85ktnH6M2SMqpqyItR8uLxliXmnSTg1WO0QLVsmI,3127
 stac_fastapi/sfeos_helpers/search_engine/__init__.py,sha256=Bi0cAtul3FuLjFceTPtEcaWNBfmUX5vKaqDvbSUAm0o,754
 stac_fastapi/sfeos_helpers/search_engine/base.py,sha256=9KOLW3NjW9PzWQzqLuhIjQU7FOHdDnB3ZNwDq469JZU,1400
 stac_fastapi/sfeos_helpers/search_engine/factory.py,sha256=nPty3L8esypSVIzl5IKfmqQ1hVUIjMQ183Ksistr1bM,1066
@@ -26,7 +26,7 @@ stac_fastapi/sfeos_helpers/search_engine/selection/base.py,sha256=106c4FK50cgMmT
 stac_fastapi/sfeos_helpers/search_engine/selection/cache_manager.py,sha256=5yrgf9JA4mgRNMPDKih6xySF8mD724lEWnXhWud7m2c,4039
 stac_fastapi/sfeos_helpers/search_engine/selection/factory.py,sha256=vbgNVCUW2lviePqzpgsPLxp6IEqcX3GHiahqN2oVObA,1305
 stac_fastapi/sfeos_helpers/search_engine/selection/selectors.py,sha256=q83nfCfNfLUqtkHpORwNHNRU9Pa-heeaDIPO0RlHb-8,4779
-sfeos_helpers-6.2.0.dist-info/METADATA,sha256=2CP3C0hpgotEerT4UZGsL16FCKtf--6Qm7zbNA8IE14,34297
-sfeos_helpers-6.2.0.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-sfeos_helpers-6.2.0.dist-info/top_level.txt,sha256=vqn-D9-HsRPTTxy0Vk_KkDmTiMES4owwBQ3ydSZYb2s,13
-sfeos_helpers-6.2.0.dist-info/RECORD,,
+sfeos_helpers-6.2.1.dist-info/METADATA,sha256=Q_L1-BW_owsnpv1KVGneU7O0y-eP31OA-QlcHHiIpZw,34629
+sfeos_helpers-6.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+sfeos_helpers-6.2.1.dist-info/top_level.txt,sha256=vqn-D9-HsRPTTxy0Vk_KkDmTiMES4owwBQ3ydSZYb2s,13
+sfeos_helpers-6.2.1.dist-info/RECORD,,

{sfeos_helpers-6.2.0.dist-info → sfeos_helpers-6.2.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.45.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

stac_fastapi/sfeos_helpers/database/query.py

@@ -80,11 +80,14 @@ def populate_sort_shared(sortby: List) -> Optional[Dict[str, Dict[str, str]]]:
         This function transforms a list of sort specifications into the format required by
         Elasticsearch/OpenSearch for sorting query results. The returned dictionary can be
         directly used in search requests.
+        Always includes 'id' as secondary sort to ensure unique pagination tokens.
     """
     if sortby:
-        return {s.field: {"order": s.direction} for s in sortby}
+        sort_config = {s.field: {"order": s.direction} for s in sortby}
+        sort_config.setdefault("id", {"order": "asc"})
+        return sort_config
     else:
-        return None
+        return {"id": {"order": "asc"}}
 
 
 def add_collections_to_body(

stac_fastapi/sfeos_helpers/database/utils.py

@@ -76,7 +76,7 @@ def merge_to_operations(data: Dict) -> List:
             nested_operations = merge_to_operations(value)
 
             for nested_operation in nested_operations:
-                nested_operation.path = f"{key}.{nested_operation.path}"
+                nested_operation.path = f"{key}/{nested_operation.path}"
                 operations.append(nested_operation)
 
         else:
@@ -90,6 +90,7 @@ def check_commands(
     op: str,
     path: ElasticPath,
     from_path: bool = False,
+    create_nest: bool = False,
 ) -> None:
     """Add Elasticsearch checks to operation.
 
@@ -101,25 +102,44 @@ def check_commands(
 
     """
     if path.nest:
-        commands.add(
-            f"if (!ctx._source.containsKey('{path.nest}'))"
-            f"{{Debug.explain('{path.nest} does not exist');}}"
-        )
-
-    if path.index or op in ["remove", "replace", "test"] or from_path:
-        commands.add(
-            f"if (!ctx._source{path.es_nest}.containsKey('{path.key}'))"
-            f"{{Debug.explain('{path.key}  does not exist in {path.nest}');}}"
-        )
-
-    if from_path and path.index is not None:
-        commands.add(
-            f"if ((ctx._source{path.es_location} instanceof ArrayList"
-            f" && ctx._source{path.es_location}.size() < {path.index})"
-            f" || (!(ctx._source{path.es_location} instanceof ArrayList)"
-            f" && !ctx._source{path.es_location}.containsKey('{path.index}')))"
-            f"{{Debug.explain('{path.path} does not exist');}}"
-        )
+        part_nest = ""
+        for index, path_part in enumerate(path.parts):
+
+            # Create nested dictionaries if not present for merge operations
+            if create_nest and not from_path:
+                value = "[:]"
+                for sub_part in reversed(path.parts[index + 1 :]):
+                    value = f"['{sub_part}': {value}]"
+
+                commands.add(
+                    f"if (!ctx._source{part_nest}.containsKey('{path_part}'))"
+                    f"{{ctx._source{part_nest}['{path_part}'] = {value};}}"
+                    f"{'' if index == len(path.parts) - 1 else' else '}"
+                )
+
+            else:
+                commands.add(
+                    f"if (!ctx._source{part_nest}.containsKey('{path_part}'))"
+                    f"{{Debug.explain('{path_part} in {path.path} does not exist');}}"
+                )
+
+            part_nest += f"['{path_part}']"
+
+    if from_path or op in ["remove", "replace", "test"]:
+
+        if isinstance(path.key, int):
+            commands.add(
+                f"if ((ctx._source{path.es_nest} instanceof ArrayList"
+                f" && ctx._source{path.es_nest}.size() < {abs(path.key)})"
+                f" || (!(ctx._source{path.es_nest} instanceof ArrayList)"
+                f" && !ctx._source{path.es_nest}.containsKey('{path.key}')))"
+                f"{{Debug.explain('{path.key} does not exist in {path.nest}');}}"
+            )
+        else:
+            commands.add(
+                f"if (!ctx._source{path.es_nest}.containsKey('{path.key}'))"
+                f"{{Debug.explain('{path.key} does not exist in {path.nest}');}}"
+            )
 
 
 def remove_commands(commands: ESCommandSet, path: ElasticPath) -> None:
@@ -130,15 +150,16 @@ def remove_commands(commands: ESCommandSet, path: ElasticPath) -> None:
         path (ElasticPath): Path to value to be removed
 
     """
-    if path.index is not None:
+    commands.add(f"def {path.variable_name};")
+    if isinstance(path.key, int):
         commands.add(
-            f"def {path.variable_name} = ctx._source{path.es_location}.remove({path.index});"
+            f"if (ctx._source{path.es_nest} instanceof ArrayList)"
+            f"{{{path.variable_name} = ctx._source{path.es_nest}.remove({path.es_key});}} else "
         )
 
-    else:
-        commands.add(
-            f"def {path.variable_name} = ctx._source{path.es_nest}.remove('{path.key}');"
-        )
+    commands.add(
+        f"{path.variable_name} = ctx._source{path.es_nest}.remove('{path.key}');"
+    )
 
 
 def add_commands(
@@ -160,21 +181,22 @@ def add_commands(
         value = (
             from_path.variable_name
             if operation.op == "move"
-            else f"ctx._source.{from_path.es_path}"
+            else f"ctx._source{from_path.es_path}"
         )
+
     else:
         value = f"params.{path.param_key}"
         params[path.param_key] = operation.value
 
-    if path.index is not None:
+    if isinstance(path.key, int):
         commands.add(
-            f"if (ctx._source{path.es_location} instanceof ArrayList)"
-            f"{{ctx._source{path.es_location}.{'add' if operation.op in ['add', 'move'] else 'set'}({path.index}, {value})}}"
-            f"else{{ctx._source.{path.es_path} = {value}}}"
+            f"if (ctx._source{path.es_nest} instanceof ArrayList)"
+            f"{{ctx._source{path.es_nest}.{'add' if operation.op in ['add', 'move'] else 'set'}({path.es_key}, {value});}}"
+            f" else ctx._source{path.es_nest}['{path.es_key}'] = {value};"
         )
 
     else:
-        commands.add(f"ctx._source.{path.es_path} = {value};")
+        commands.add(f"ctx._source{path.es_path} = {value};")
 
 
 def test_commands(
@@ -190,14 +212,23 @@ def test_commands(
     value = f"params.{path.param_key}"
     params[path.param_key] = operation.value
 
+    if isinstance(path.key, int):
+        commands.add(
+            f"if (ctx._source{path.es_nest} instanceof ArrayList)"
+            f"{{if (ctx._source{path.es_nest}[{path.es_key}] != {value})"
+            f"{{Debug.explain('Test failed `{path.path}`"
+            f" != ' + ctx._source{path.es_path});}}"
+            f"}} else "
+        )
+
     commands.add(
-        f"if (ctx._source.{path.es_path} != {value})"
-        f"{{Debug.explain('Test failed `{path.path}` | "
-        f"{operation.json_value} != ' + ctx._source.{path.es_path});}}"
+        f"if (ctx._source{path.es_path} != {value})"
+        f"{{Debug.explain('Test failed `{path.path}`"
+        f" != ' + ctx._source{path.es_path});}}"
     )
 
 
-def operations_to_script(operations: List) -> Dict:
+def operations_to_script(operations: List, create_nest: bool = False) -> Dict:
     """Convert list of operation to painless script.
 
     Args:
@@ -215,10 +246,16 @@ def operations_to_script(operations: List) -> Dict:
             ElasticPath(path=operation.from_) if hasattr(operation, "from_") else None
         )
 
-        check_commands(commands=commands, op=operation.op, path=path)
+        check_commands(
+            commands=commands, op=operation.op, path=path, create_nest=create_nest
+        )
         if from_path is not None:
             check_commands(
-                commands=commands, op=operation.op, path=from_path, from_path=True
+                commands=commands,
+                op=operation.op,
+                path=from_path,
+                from_path=True,
+                create_nest=create_nest,
             )
 
         if operation.op in ["remove", "move"]:

stac_fastapi/sfeos_helpers/models/patch.py

@@ -3,7 +3,7 @@
 import re
 from typing import Any, Dict, Optional, Union
 
-from pydantic import BaseModel, computed_field, model_validator
+from pydantic import BaseModel, model_validator
 
 regex = re.compile(r"([^.' ]*:[^.'[ ]*)\.?")
 replacements = str.maketrans({"/": "", ".": "", ":": "", "[": "", "]": ""})
@@ -71,16 +71,23 @@ class ElasticPath(BaseModel):
 
     """
 
-    path: str
+    parts: list[str] = []
+
+    path: Optional[str] = None
+    key: Optional[Union[str, int]] = None
     nest: Optional[str] = None
-    partition: Optional[str] = None
-    key: Optional[str] = None
 
     es_path: Optional[str] = None
-    es_nest: Optional[str] = None
     es_key: Optional[str] = None
+    es_nest: Optional[str] = None
+
+    variable_name: Optional[str] = None
+    param_key: Optional[str] = None
 
-    index_: Optional[int] = None
+    class Config:
+        """Class config."""
+
+        frozen = True
 
     @model_validator(mode="before")
     @classmethod
@@ -90,77 +97,28 @@ class ElasticPath(BaseModel):
         Args:
             data (Any): input data
         """
-        data["path"] = data["path"].lstrip("/").replace("/", ".")
-        data["nest"], data["partition"], data["key"] = data["path"].rpartition(".")
-
-        if data["key"].lstrip("-").isdigit() or data["key"] == "-":
-            data["index_"] = -1 if data["key"] == "-" else int(data["key"])
-            data["path"] = f"{data['nest']}[{data['index_']}]"
-            data["nest"], data["partition"], data["key"] = data["nest"].rpartition(".")
-
-        data["es_path"] = to_es(data["path"])
-        data["es_nest"] = f".{to_es(data['nest'])}" if data["nest"] else ""
-        data["es_key"] = to_es(data["key"])
-
-        return data
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def index(self) -> Union[int, str, None]:
-        """Compute location of path.
-
-        Returns:
-            str: path index
-        """
-        if self.index_ and self.index_ < 0:
+        data["parts"] = data["path"].lstrip("/").split("/")
 
-            return f"ctx._source.{self.location}.size() - {-self.index_}"
+        data["key"] = data["parts"].pop(-1)
+        data["nest"] = "/".join(data["parts"])
+        data["path"] = data["nest"] + "/" + data["key"]
 
-        return self.index_
+        data["es_key"] = data["key"]
+        data["es_nest"] = "".join([f"['{part}']" for part in data["parts"]])
+        data["es_path"] = data["es_nest"] + f"['{data['es_key']}']"
 
-    @computed_field  # type: ignore[misc]
-    @property
-    def location(self) -> str:
-        """Compute location of path.
-
-        Returns:
-            str: path location
-        """
-        return self.nest + self.partition + self.key
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def es_location(self) -> str:
-        """Compute location of path.
-
-        Returns:
-            str: path location
-        """
-        if self.es_key and ":" in self.es_key:
-            return self.es_nest + self.es_key
-        return self.es_nest + self.partition + self.es_key
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def variable_name(self) -> str:
-        """Variable name for scripting.
-
-        Returns:
-            str: variable name
-        """
-        if self.index is not None:
-            return f"{self.location.replace('.','_').replace(':','_')}_{self.index}"
-
-        return (
-            f"{self.nest.replace('.','_').replace(':','_')}_{self.key.replace(':','_')}"
-        )
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def param_key(self) -> str:
-        """Param key for scripting.
+        if data["key"].lstrip("-").isdigit() or data["key"] == "-":
+            data["key"] = -1 if data["key"] == "-" else int(data["key"])
+            data["es_key"] = (
+                f"ctx._source{data['es_nest']}.size() - {-data['key']}"
+                if data["key"] < 0
+                else str(data["key"])
+            )
+            data["es_path"] = data["es_nest"] + f"[{data['es_key']}]"
+
+        data[
+            "variable_name"
+        ] = f"{data['nest'].replace('/','_').replace(':','_')}_{str(data['key']).replace(':','_')}"
+        data["param_key"] = data["path"].translate(replacements)
 
-        Returns:
-            str: param key
-        """
-        return self.path.translate(replacements)
+        return data

stac_fastapi/sfeos_helpers/version.py

@@ -1,2 +1,2 @@
 """library version."""
-__version__ = "6.2.0"
+__version__ = "6.2.1"