sfeos-helpers 6.2.0__py3-none-any.whl → 6.3.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {sfeos_helpers-6.2.0.dist-info → sfeos_helpers-6.3.0.dist-info}/METADATA +42 -22
- {sfeos_helpers-6.2.0.dist-info → sfeos_helpers-6.3.0.dist-info}/RECORD +9 -9
- stac_fastapi/sfeos_helpers/database/query.py +5 -2
- stac_fastapi/sfeos_helpers/database/utils.py +75 -38
- stac_fastapi/sfeos_helpers/mappings.py +4 -2
- stac_fastapi/sfeos_helpers/models/patch.py +34 -76
- stac_fastapi/sfeos_helpers/version.py +1 -1
- {sfeos_helpers-6.2.0.dist-info → sfeos_helpers-6.3.0.dist-info}/WHEEL +0 -0
- {sfeos_helpers-6.2.0.dist-info → sfeos_helpers-6.3.0.dist-info}/top_level.txt +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: sfeos-helpers
|
|
3
|
-
Version: 6.
|
|
3
|
+
Version: 6.3.0
|
|
4
4
|
Summary: Helper library for the Elasticsearch and Opensearch stac-fastapi backends.
|
|
5
5
|
Home-page: https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch
|
|
6
6
|
License: MIT
|
|
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 3.13
|
|
|
15
15
|
Classifier: License :: OSI Approved :: MIT License
|
|
16
16
|
Requires-Python: >=3.9
|
|
17
17
|
Description-Content-Type: text/markdown
|
|
18
|
-
Requires-Dist: stac-fastapi.core==6.
|
|
18
|
+
Requires-Dist: stac-fastapi.core==6.3.0
|
|
19
19
|
|
|
20
20
|
# stac-fastapi-elasticsearch-opensearch
|
|
21
21
|
|
|
@@ -85,26 +85,43 @@ This project is built on the following technologies: STAC, stac-fastapi, FastAPI
|
|
|
85
85
|
|
|
86
86
|
## Table of Contents
|
|
87
87
|
|
|
88
|
-
- [
|
|
89
|
-
- [
|
|
90
|
-
- [
|
|
91
|
-
- [
|
|
92
|
-
- [
|
|
93
|
-
- [
|
|
94
|
-
- [
|
|
95
|
-
- [
|
|
96
|
-
- [
|
|
97
|
-
- [
|
|
98
|
-
- [
|
|
99
|
-
- [
|
|
100
|
-
- [
|
|
101
|
-
- [
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
- [
|
|
105
|
-
- [
|
|
106
|
-
- [
|
|
107
|
-
- [
|
|
88
|
+
- [stac-fastapi-elasticsearch-opensearch](#stac-fastapi-elasticsearch-opensearch)
|
|
89
|
+
- [Sponsors \& Supporters](#sponsors--supporters)
|
|
90
|
+
- [Project Introduction - What is SFEOS?](#project-introduction---what-is-sfeos)
|
|
91
|
+
- [Common Deployment Patterns](#common-deployment-patterns)
|
|
92
|
+
- [Technologies](#technologies)
|
|
93
|
+
- [Table of Contents](#table-of-contents)
|
|
94
|
+
- [Documentation \& Resources](#documentation--resources)
|
|
95
|
+
- [Package Structure](#package-structure)
|
|
96
|
+
- [Examples](#examples)
|
|
97
|
+
- [Performance](#performance)
|
|
98
|
+
- [Direct Response Mode](#direct-response-mode)
|
|
99
|
+
- [Quick Start](#quick-start)
|
|
100
|
+
- [Installation](#installation)
|
|
101
|
+
- [Running Locally](#running-locally)
|
|
102
|
+
- [Using Pre-built Docker Images](#using-pre-built-docker-images)
|
|
103
|
+
- [Using Docker Compose](#using-docker-compose)
|
|
104
|
+
- [Configuration Reference](#configuration-reference)
|
|
105
|
+
- [Datetime-Based Index Management](#datetime-based-index-management)
|
|
106
|
+
- [Overview](#overview)
|
|
107
|
+
- [When to Use](#when-to-use)
|
|
108
|
+
- [Configuration](#configuration)
|
|
109
|
+
- [Enabling Datetime-Based Indexing](#enabling-datetime-based-indexing)
|
|
110
|
+
- [Related Configuration Variables](#related-configuration-variables)
|
|
111
|
+
- [How Datetime-Based Indexing Works](#how-datetime-based-indexing-works)
|
|
112
|
+
- [Index and Alias Naming Convention](#index-and-alias-naming-convention)
|
|
113
|
+
- [Index Size Management](#index-size-management)
|
|
114
|
+
- [Interacting with the API](#interacting-with-the-api)
|
|
115
|
+
- [Configure the API](#configure-the-api)
|
|
116
|
+
- [Collection Pagination](#collection-pagination)
|
|
117
|
+
- [Ingesting Sample Data CLI Tool](#ingesting-sample-data-cli-tool)
|
|
118
|
+
- [Elasticsearch Mappings](#elasticsearch-mappings)
|
|
119
|
+
- [Managing Elasticsearch Indices](#managing-elasticsearch-indices)
|
|
120
|
+
- [Snapshots](#snapshots)
|
|
121
|
+
- [Reindexing](#reindexing)
|
|
122
|
+
- [Auth](#auth)
|
|
123
|
+
- [Aggregation](#aggregation)
|
|
124
|
+
- [Rate Limiting](#rate-limiting)
|
|
108
125
|
|
|
109
126
|
## Documentation & Resources
|
|
110
127
|
|
|
@@ -246,6 +263,9 @@ You can customize additional settings in your `.env` file:
|
|
|
246
263
|
| `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 |
|
|
247
264
|
| `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 |
|
|
248
265
|
| `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 |
|
|
266
|
+
| `STAC_ITEM_LIMIT` | Sets the environment variable for result limiting to SFEOS for the number of returned items and STAC collections. | `10` | Optional |
|
|
267
|
+
| `STAC_INDEX_ASSETS` | Controls if Assets are indexed when added to Elasticsearch/Opensearch. This allows asset fields to be included in search queries. | `false` | Optional |
|
|
268
|
+
| `ENV_MAX_LIMIT` | Configures the environment variable in SFEOS to override the default `MAX_LIMIT`, which controls the limit parameter for returned items and STAC collections. | `10,000` | Optional |
|
|
249
269
|
|
|
250
270
|
> [!NOTE]
|
|
251
271
|
> 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.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
stac_fastapi/sfeos_helpers/mappings.py,sha256=
|
|
2
|
-
stac_fastapi/sfeos_helpers/version.py,sha256=
|
|
1
|
+
stac_fastapi/sfeos_helpers/mappings.py,sha256=rSndYtkXRIy7uXYxZs_OtcI5V6pNRHD2PSpLM2Y-noA,8347
|
|
2
|
+
stac_fastapi/sfeos_helpers/version.py,sha256=rBLPQyvMDNA0PA0jXfByTouJPJn5p0wXiqmUWJMIfYc,45
|
|
3
3
|
stac_fastapi/sfeos_helpers/aggregation/__init__.py,sha256=Mym17lFh90by1GnoQgMyIKAqRNJnvCgVSXDYzjBiPQk,1210
|
|
4
4
|
stac_fastapi/sfeos_helpers/aggregation/client.py,sha256=PPUk0kAZnms46FlLGrR5w8wa52vG-dT6BG37896R5CY,17939
|
|
5
5
|
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
|
|
|
8
8
|
stac_fastapi/sfeos_helpers/database/document.py,sha256=LtjX15gvaOuZC_k2t_oQhys_c-zRTLN5rwX0hNJkHnM,1725
|
|
9
9
|
stac_fastapi/sfeos_helpers/database/index.py,sha256=g7_sKfd5XUwq4IhdKRNiasejk045dKlullsdeDSZTq8,6585
|
|
10
10
|
stac_fastapi/sfeos_helpers/database/mapping.py,sha256=4-MSd4xH5wg7yoC4aPjzYMDSEvP026bw4k2TfffMT5E,1387
|
|
11
|
-
stac_fastapi/sfeos_helpers/database/query.py,sha256=
|
|
12
|
-
stac_fastapi/sfeos_helpers/database/utils.py,sha256=
|
|
11
|
+
stac_fastapi/sfeos_helpers/database/query.py,sha256=g2iGdfgqpx6o8GoQJBMl3AMmqcbSf792qvKWfWipR5w,4193
|
|
12
|
+
stac_fastapi/sfeos_helpers/database/utils.py,sha256=9zU9hEglZb6f-uxOhd95saSw2id9w5PR36dWtyfXTb0,8757
|
|
13
13
|
stac_fastapi/sfeos_helpers/filter/__init__.py,sha256=n3zL_MhEGOoxMz1KeijyK_UKiZ0MKPl90zHtYI5RAy8,1557
|
|
14
14
|
stac_fastapi/sfeos_helpers/filter/client.py,sha256=QwjYWXkevoVS7HPtoXfeSzDy-_GJnFhPJtJM49D14oU,4229
|
|
15
15
|
stac_fastapi/sfeos_helpers/filter/cql2.py,sha256=Cg9kRYD9CVkVSyRqOyB5oVXmlyteSn2bw88sqklGpUM,955
|
|
16
16
|
stac_fastapi/sfeos_helpers/filter/transform.py,sha256=1GEWQSp-rbq7_1nDVv1ApDbWxt8DswJWxwaxzV85gj4,4644
|
|
17
|
-
stac_fastapi/sfeos_helpers/models/patch.py,sha256=
|
|
17
|
+
stac_fastapi/sfeos_helpers/models/patch.py,sha256=s5n85ktnH6M2SMqpqyItR8uLxliXmnSTg1WO0QLVsmI,3127
|
|
18
18
|
stac_fastapi/sfeos_helpers/search_engine/__init__.py,sha256=Bi0cAtul3FuLjFceTPtEcaWNBfmUX5vKaqDvbSUAm0o,754
|
|
19
19
|
stac_fastapi/sfeos_helpers/search_engine/base.py,sha256=9KOLW3NjW9PzWQzqLuhIjQU7FOHdDnB3ZNwDq469JZU,1400
|
|
20
20
|
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
|
|
|
26
26
|
stac_fastapi/sfeos_helpers/search_engine/selection/cache_manager.py,sha256=5yrgf9JA4mgRNMPDKih6xySF8mD724lEWnXhWud7m2c,4039
|
|
27
27
|
stac_fastapi/sfeos_helpers/search_engine/selection/factory.py,sha256=vbgNVCUW2lviePqzpgsPLxp6IEqcX3GHiahqN2oVObA,1305
|
|
28
28
|
stac_fastapi/sfeos_helpers/search_engine/selection/selectors.py,sha256=q83nfCfNfLUqtkHpORwNHNRU9Pa-heeaDIPO0RlHb-8,4779
|
|
29
|
-
sfeos_helpers-6.
|
|
30
|
-
sfeos_helpers-6.
|
|
31
|
-
sfeos_helpers-6.
|
|
32
|
-
sfeos_helpers-6.
|
|
29
|
+
sfeos_helpers-6.3.0.dist-info/METADATA,sha256=IyoP_KYyFtc3HWS4ibV65iIOJrDEeb6dHfw_3b6KlzE,35868
|
|
30
|
+
sfeos_helpers-6.3.0.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
|
|
31
|
+
sfeos_helpers-6.3.0.dist-info/top_level.txt,sha256=vqn-D9-HsRPTTxy0Vk_KkDmTiMES4owwBQ3ydSZYb2s,13
|
|
32
|
+
sfeos_helpers-6.3.0.dist-info/RECORD,,
|
|
@@ -80,11 +80,14 @@ def populate_sort_shared(sortby: List) -> Optional[Dict[str, Dict[str, str]]]:
|
|
|
80
80
|
This function transforms a list of sort specifications into the format required by
|
|
81
81
|
Elasticsearch/OpenSearch for sorting query results. The returned dictionary can be
|
|
82
82
|
directly used in search requests.
|
|
83
|
+
Always includes 'id' as secondary sort to ensure unique pagination tokens.
|
|
83
84
|
"""
|
|
84
85
|
if sortby:
|
|
85
|
-
|
|
86
|
+
sort_config = {s.field: {"order": s.direction} for s in sortby}
|
|
87
|
+
sort_config.setdefault("id", {"order": "asc"})
|
|
88
|
+
return sort_config
|
|
86
89
|
else:
|
|
87
|
-
return
|
|
90
|
+
return {"id": {"order": "asc"}}
|
|
88
91
|
|
|
89
92
|
|
|
90
93
|
def add_collections_to_body(
|
|
@@ -76,7 +76,7 @@ def merge_to_operations(data: Dict) -> List:
|
|
|
76
76
|
nested_operations = merge_to_operations(value)
|
|
77
77
|
|
|
78
78
|
for nested_operation in nested_operations:
|
|
79
|
-
nested_operation.path = f"{key}
|
|
79
|
+
nested_operation.path = f"{key}/{nested_operation.path}"
|
|
80
80
|
operations.append(nested_operation)
|
|
81
81
|
|
|
82
82
|
else:
|
|
@@ -90,6 +90,7 @@ def check_commands(
|
|
|
90
90
|
op: str,
|
|
91
91
|
path: ElasticPath,
|
|
92
92
|
from_path: bool = False,
|
|
93
|
+
create_nest: bool = False,
|
|
93
94
|
) -> None:
|
|
94
95
|
"""Add Elasticsearch checks to operation.
|
|
95
96
|
|
|
@@ -101,25 +102,44 @@ def check_commands(
|
|
|
101
102
|
|
|
102
103
|
"""
|
|
103
104
|
if path.nest:
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
105
|
+
part_nest = ""
|
|
106
|
+
for index, path_part in enumerate(path.parts):
|
|
107
|
+
|
|
108
|
+
# Create nested dictionaries if not present for merge operations
|
|
109
|
+
if create_nest and not from_path:
|
|
110
|
+
value = "[:]"
|
|
111
|
+
for sub_part in reversed(path.parts[index + 1 :]):
|
|
112
|
+
value = f"['{sub_part}': {value}]"
|
|
113
|
+
|
|
114
|
+
commands.add(
|
|
115
|
+
f"if (!ctx._source{part_nest}.containsKey('{path_part}'))"
|
|
116
|
+
f"{{ctx._source{part_nest}['{path_part}'] = {value};}}"
|
|
117
|
+
f"{'' if index == len(path.parts) - 1 else' else '}" # noqa: E275
|
|
118
|
+
)
|
|
119
|
+
|
|
120
|
+
else:
|
|
121
|
+
commands.add(
|
|
122
|
+
f"if (!ctx._source{part_nest}.containsKey('{path_part}'))"
|
|
123
|
+
f"{{Debug.explain('{path_part} in {path.path} does not exist');}}"
|
|
124
|
+
)
|
|
125
|
+
|
|
126
|
+
part_nest += f"['{path_part}']"
|
|
127
|
+
|
|
128
|
+
if from_path or op in ["remove", "replace", "test"]:
|
|
129
|
+
|
|
130
|
+
if isinstance(path.key, int):
|
|
131
|
+
commands.add(
|
|
132
|
+
f"if ((ctx._source{path.es_nest} instanceof ArrayList"
|
|
133
|
+
f" && ctx._source{path.es_nest}.size() < {abs(path.key)})"
|
|
134
|
+
f" || (!(ctx._source{path.es_nest} instanceof ArrayList)"
|
|
135
|
+
f" && !ctx._source{path.es_nest}.containsKey('{path.key}')))"
|
|
136
|
+
f"{{Debug.explain('{path.key} does not exist in {path.nest}');}}" # noqa: E713
|
|
137
|
+
)
|
|
138
|
+
else:
|
|
139
|
+
commands.add(
|
|
140
|
+
f"if (!ctx._source{path.es_nest}.containsKey('{path.key}'))"
|
|
141
|
+
f"{{Debug.explain('{path.key} does not exist in {path.nest}');}}" # noqa: E713
|
|
142
|
+
)
|
|
123
143
|
|
|
124
144
|
|
|
125
145
|
def remove_commands(commands: ESCommandSet, path: ElasticPath) -> None:
|
|
@@ -130,15 +150,16 @@ def remove_commands(commands: ESCommandSet, path: ElasticPath) -> None:
|
|
|
130
150
|
path (ElasticPath): Path to value to be removed
|
|
131
151
|
|
|
132
152
|
"""
|
|
133
|
-
|
|
153
|
+
commands.add(f"def {path.variable_name};")
|
|
154
|
+
if isinstance(path.key, int):
|
|
134
155
|
commands.add(
|
|
135
|
-
f"
|
|
156
|
+
f"if (ctx._source{path.es_nest} instanceof ArrayList)"
|
|
157
|
+
f"{{{path.variable_name} = ctx._source{path.es_nest}.remove({path.es_key});}} else "
|
|
136
158
|
)
|
|
137
159
|
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
)
|
|
160
|
+
commands.add(
|
|
161
|
+
f"{path.variable_name} = ctx._source{path.es_nest}.remove('{path.key}');"
|
|
162
|
+
)
|
|
142
163
|
|
|
143
164
|
|
|
144
165
|
def add_commands(
|
|
@@ -160,21 +181,22 @@ def add_commands(
|
|
|
160
181
|
value = (
|
|
161
182
|
from_path.variable_name
|
|
162
183
|
if operation.op == "move"
|
|
163
|
-
else f"ctx._source
|
|
184
|
+
else f"ctx._source{from_path.es_path}"
|
|
164
185
|
)
|
|
186
|
+
|
|
165
187
|
else:
|
|
166
188
|
value = f"params.{path.param_key}"
|
|
167
189
|
params[path.param_key] = operation.value
|
|
168
190
|
|
|
169
|
-
if path.
|
|
191
|
+
if isinstance(path.key, int):
|
|
170
192
|
commands.add(
|
|
171
|
-
f"if (ctx._source{path.
|
|
172
|
-
f"{{ctx._source{path.
|
|
173
|
-
f"else
|
|
193
|
+
f"if (ctx._source{path.es_nest} instanceof ArrayList)"
|
|
194
|
+
f"{{ctx._source{path.es_nest}.{'add' if operation.op in ['add', 'move'] else 'set'}({path.es_key}, {value});}}"
|
|
195
|
+
f" else ctx._source{path.es_nest}['{path.es_key}'] = {value};"
|
|
174
196
|
)
|
|
175
197
|
|
|
176
198
|
else:
|
|
177
|
-
commands.add(f"ctx._source
|
|
199
|
+
commands.add(f"ctx._source{path.es_path} = {value};")
|
|
178
200
|
|
|
179
201
|
|
|
180
202
|
def test_commands(
|
|
@@ -190,14 +212,23 @@ def test_commands(
|
|
|
190
212
|
value = f"params.{path.param_key}"
|
|
191
213
|
params[path.param_key] = operation.value
|
|
192
214
|
|
|
215
|
+
if isinstance(path.key, int):
|
|
216
|
+
commands.add(
|
|
217
|
+
f"if (ctx._source{path.es_nest} instanceof ArrayList)"
|
|
218
|
+
f"{{if (ctx._source{path.es_nest}[{path.es_key}] != {value})"
|
|
219
|
+
f"{{Debug.explain('Test failed `{path.path}`"
|
|
220
|
+
f" != ' + ctx._source{path.es_path});}}"
|
|
221
|
+
f"}} else "
|
|
222
|
+
)
|
|
223
|
+
|
|
193
224
|
commands.add(
|
|
194
|
-
f"if (ctx._source
|
|
195
|
-
f"{{Debug.explain('Test failed `{path.path}`
|
|
196
|
-
f"
|
|
225
|
+
f"if (ctx._source{path.es_path} != {value})"
|
|
226
|
+
f"{{Debug.explain('Test failed `{path.path}`"
|
|
227
|
+
f" != ' + ctx._source{path.es_path});}}"
|
|
197
228
|
)
|
|
198
229
|
|
|
199
230
|
|
|
200
|
-
def operations_to_script(operations: List) -> Dict:
|
|
231
|
+
def operations_to_script(operations: List, create_nest: bool = False) -> Dict:
|
|
201
232
|
"""Convert list of operation to painless script.
|
|
202
233
|
|
|
203
234
|
Args:
|
|
@@ -215,10 +246,16 @@ def operations_to_script(operations: List) -> Dict:
|
|
|
215
246
|
ElasticPath(path=operation.from_) if hasattr(operation, "from_") else None
|
|
216
247
|
)
|
|
217
248
|
|
|
218
|
-
check_commands(
|
|
249
|
+
check_commands(
|
|
250
|
+
commands=commands, op=operation.op, path=path, create_nest=create_nest
|
|
251
|
+
)
|
|
219
252
|
if from_path is not None:
|
|
220
253
|
check_commands(
|
|
221
|
-
commands=commands,
|
|
254
|
+
commands=commands,
|
|
255
|
+
op=operation.op,
|
|
256
|
+
path=from_path,
|
|
257
|
+
from_path=True,
|
|
258
|
+
create_nest=create_nest,
|
|
222
259
|
)
|
|
223
260
|
|
|
224
261
|
if operation.op in ["remove", "move"]:
|
|
@@ -28,6 +28,8 @@ Function Naming Conventions:
|
|
|
28
28
|
import os
|
|
29
29
|
from typing import Any, Dict, Literal, Protocol
|
|
30
30
|
|
|
31
|
+
from stac_fastapi.core.utilities import get_bool_env
|
|
32
|
+
|
|
31
33
|
|
|
32
34
|
# stac_pydantic classes extend _GeometryBase, which doesn't have a type field,
|
|
33
35
|
# So create our own Protocol for typing
|
|
@@ -134,7 +136,7 @@ ES_ITEMS_MAPPINGS = {
|
|
|
134
136
|
"id": {"type": "keyword"},
|
|
135
137
|
"collection": {"type": "keyword"},
|
|
136
138
|
"geometry": {"type": "geo_shape"},
|
|
137
|
-
"assets": {"type": "object", "enabled":
|
|
139
|
+
"assets": {"type": "object", "enabled": get_bool_env("STAC_INDEX_ASSETS")},
|
|
138
140
|
"links": {"type": "object", "enabled": False},
|
|
139
141
|
"properties": {
|
|
140
142
|
"type": "object",
|
|
@@ -162,7 +164,7 @@ ES_COLLECTIONS_MAPPINGS = {
|
|
|
162
164
|
"extent.temporal.interval": {"type": "date"},
|
|
163
165
|
"providers": {"type": "object", "enabled": False},
|
|
164
166
|
"links": {"type": "object", "enabled": False},
|
|
165
|
-
"item_assets": {"type": "object", "enabled":
|
|
167
|
+
"item_assets": {"type": "object", "enabled": get_bool_env("STAC_INDEX_ASSETS")},
|
|
166
168
|
},
|
|
167
169
|
}
|
|
168
170
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
import re
|
|
4
4
|
from typing import Any, Dict, Optional, Union
|
|
5
5
|
|
|
6
|
-
from pydantic import BaseModel,
|
|
6
|
+
from pydantic import BaseModel, model_validator
|
|
7
7
|
|
|
8
8
|
regex = re.compile(r"([^.' ]*:[^.'[ ]*)\.?")
|
|
9
9
|
replacements = str.maketrans({"/": "", ".": "", ":": "", "[": "", "]": ""})
|
|
@@ -71,16 +71,23 @@ class ElasticPath(BaseModel):
|
|
|
71
71
|
|
|
72
72
|
"""
|
|
73
73
|
|
|
74
|
-
|
|
74
|
+
parts: list[str] = []
|
|
75
|
+
|
|
76
|
+
path: Optional[str] = None
|
|
77
|
+
key: Optional[Union[str, int]] = None
|
|
75
78
|
nest: Optional[str] = None
|
|
76
|
-
partition: Optional[str] = None
|
|
77
|
-
key: Optional[str] = None
|
|
78
79
|
|
|
79
80
|
es_path: Optional[str] = None
|
|
80
|
-
es_nest: Optional[str] = None
|
|
81
81
|
es_key: Optional[str] = None
|
|
82
|
+
es_nest: Optional[str] = None
|
|
83
|
+
|
|
84
|
+
variable_name: Optional[str] = None
|
|
85
|
+
param_key: Optional[str] = None
|
|
82
86
|
|
|
83
|
-
|
|
87
|
+
class Config:
|
|
88
|
+
"""Class config."""
|
|
89
|
+
|
|
90
|
+
frozen = True
|
|
84
91
|
|
|
85
92
|
@model_validator(mode="before")
|
|
86
93
|
@classmethod
|
|
@@ -90,77 +97,28 @@ class ElasticPath(BaseModel):
|
|
|
90
97
|
Args:
|
|
91
98
|
data (Any): input data
|
|
92
99
|
"""
|
|
93
|
-
data["
|
|
94
|
-
data["nest"], data["partition"], data["key"] = data["path"].rpartition(".")
|
|
95
|
-
|
|
96
|
-
if data["key"].lstrip("-").isdigit() or data["key"] == "-":
|
|
97
|
-
data["index_"] = -1 if data["key"] == "-" else int(data["key"])
|
|
98
|
-
data["path"] = f"{data['nest']}[{data['index_']}]"
|
|
99
|
-
data["nest"], data["partition"], data["key"] = data["nest"].rpartition(".")
|
|
100
|
-
|
|
101
|
-
data["es_path"] = to_es(data["path"])
|
|
102
|
-
data["es_nest"] = f".{to_es(data['nest'])}" if data["nest"] else ""
|
|
103
|
-
data["es_key"] = to_es(data["key"])
|
|
104
|
-
|
|
105
|
-
return data
|
|
106
|
-
|
|
107
|
-
@computed_field # type: ignore[misc]
|
|
108
|
-
@property
|
|
109
|
-
def index(self) -> Union[int, str, None]:
|
|
110
|
-
"""Compute location of path.
|
|
111
|
-
|
|
112
|
-
Returns:
|
|
113
|
-
str: path index
|
|
114
|
-
"""
|
|
115
|
-
if self.index_ and self.index_ < 0:
|
|
100
|
+
data["parts"] = data["path"].lstrip("/").split("/")
|
|
116
101
|
|
|
117
|
-
|
|
102
|
+
data["key"] = data["parts"].pop(-1)
|
|
103
|
+
data["nest"] = "/".join(data["parts"])
|
|
104
|
+
data["path"] = data["nest"] + "/" + data["key"]
|
|
118
105
|
|
|
119
|
-
|
|
106
|
+
data["es_key"] = data["key"]
|
|
107
|
+
data["es_nest"] = "".join([f"['{part}']" for part in data["parts"]])
|
|
108
|
+
data["es_path"] = data["es_nest"] + f"['{data['es_key']}']"
|
|
120
109
|
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
"""Compute location of path.
|
|
135
|
-
|
|
136
|
-
Returns:
|
|
137
|
-
str: path location
|
|
138
|
-
"""
|
|
139
|
-
if self.es_key and ":" in self.es_key:
|
|
140
|
-
return self.es_nest + self.es_key
|
|
141
|
-
return self.es_nest + self.partition + self.es_key
|
|
142
|
-
|
|
143
|
-
@computed_field # type: ignore[misc]
|
|
144
|
-
@property
|
|
145
|
-
def variable_name(self) -> str:
|
|
146
|
-
"""Variable name for scripting.
|
|
147
|
-
|
|
148
|
-
Returns:
|
|
149
|
-
str: variable name
|
|
150
|
-
"""
|
|
151
|
-
if self.index is not None:
|
|
152
|
-
return f"{self.location.replace('.','_').replace(':','_')}_{self.index}"
|
|
153
|
-
|
|
154
|
-
return (
|
|
155
|
-
f"{self.nest.replace('.','_').replace(':','_')}_{self.key.replace(':','_')}"
|
|
156
|
-
)
|
|
157
|
-
|
|
158
|
-
@computed_field # type: ignore[misc]
|
|
159
|
-
@property
|
|
160
|
-
def param_key(self) -> str:
|
|
161
|
-
"""Param key for scripting.
|
|
110
|
+
if data["key"].lstrip("-").isdigit() or data["key"] == "-":
|
|
111
|
+
data["key"] = -1 if data["key"] == "-" else int(data["key"])
|
|
112
|
+
data["es_key"] = (
|
|
113
|
+
f"ctx._source{data['es_nest']}.size() - {-data['key']}"
|
|
114
|
+
if data["key"] < 0
|
|
115
|
+
else str(data["key"])
|
|
116
|
+
)
|
|
117
|
+
data["es_path"] = data["es_nest"] + f"[{data['es_key']}]"
|
|
118
|
+
|
|
119
|
+
data[
|
|
120
|
+
"variable_name"
|
|
121
|
+
] = f"{data['nest'].replace('/','_').replace(':','_')}_{str(data['key']).replace(':','_')}"
|
|
122
|
+
data["param_key"] = data["path"].translate(replacements)
|
|
162
123
|
|
|
163
|
-
|
|
164
|
-
str: param key
|
|
165
|
-
"""
|
|
166
|
-
return self.path.translate(replacements)
|
|
124
|
+
return data
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
"""library version."""
|
|
2
|
-
__version__ = "6.
|
|
2
|
+
__version__ = "6.3.0"
|
|
File without changes
|
|
File without changes
|