stac-fastapi-elasticsearch 6.5.0__tar.gz → 6.6.0__tar.gz

stac_fastapi_elasticsearch-6.6.0/.gitignore

@@ -0,0 +1,143 @@
+elasticsearch/snapshots/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+/esdata
+
+# Virtualenv
+venv
+
+# VSCode folder
+.vscode
+
+/docs/src/api/*
+
+.DS_Store

stac_fastapi_elasticsearch-6.6.0/PKG-INFO

@@ -0,0 +1,58 @@
+Metadata-Version: 2.4
+Name: stac_fastapi_elasticsearch
+Version: 6.6.0
+Summary: An implementation of STAC API based on the FastAPI framework with Elasticsearch.
+Project-URL: Homepage, https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch
+License: MIT
+Keywords: Elasticsearch,FastAPI,STAC,STAC-API,stac-fastapi
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.9
+Requires-Dist: elasticsearch[async]~=8.19.1
+Requires-Dist: sfeos-helpers==6.6.0
+Requires-Dist: stac-fastapi-core==6.6.0
+Requires-Dist: starlette<0.36.0,>=0.35.0
+Requires-Dist: uvicorn~=0.23.0
+Provides-Extra: dev
+Requires-Dist: ciso8601~=2.3.0; extra == 'dev'
+Requires-Dist: httpx<0.28.0,>=0.24.0; extra == 'dev'
+Requires-Dist: pre-commit~=3.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio~=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov~=4.0.0; extra == 'dev'
+Requires-Dist: pytest~=8.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material~=9.0.0; extra == 'docs'
+Requires-Dist: mkdocs~=1.4.0; extra == 'docs'
+Requires-Dist: pdocs~=1.2.0; extra == 'docs'
+Provides-Extra: server
+Requires-Dist: uvicorn[standard]~=0.23.0; extra == 'server'
+Description-Content-Type: text/markdown
+
+# stac-fastapi-elasticsearch
+
+This is the Elasticsearch backend for stac-fastapi. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md).
+
+## Package Information
+
+- **Package name**: stac-fastapi-elasticsearch
+- **Description**: An implementation of STAC API based on the FastAPI framework with Elasticsearch.
+- **Documentation**: [https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/)
+- **Source**: [GitHub Repository](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/)
+
+## Installation
+
+```bash
+pip install stac-fastapi-elasticsearch
+```
+
+## Quick Start
+
+For detailed usage and examples, please refer to the [main documentation](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/).

stac_fastapi_elasticsearch-6.6.0/README.md

@@ -0,0 +1,20 @@
+# stac-fastapi-elasticsearch
+
+This is the Elasticsearch backend for stac-fastapi. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md).
+
+## Package Information
+
+- **Package name**: stac-fastapi-elasticsearch
+- **Description**: An implementation of STAC API based on the FastAPI framework with Elasticsearch.
+- **Documentation**: [https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/)
+- **Source**: [GitHub Repository](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/)
+
+## Installation
+
+```bash
+pip install stac-fastapi-elasticsearch
+```
+
+## Quick Start
+
+For detailed usage and examples, please refer to the [main documentation](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/).

stac_fastapi_elasticsearch-6.6.0/pyproject.toml

@@ -0,0 +1,71 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "stac_fastapi_elasticsearch"
+description = "An implementation of STAC API based on the FastAPI framework with Elasticsearch."
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "MIT"}
+authors = []
+classifiers = [
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "License :: OSI Approved :: MIT License",
+]
+keywords = [
+    "STAC",
+    "STAC-API",
+    "FastAPI",
+    "Elasticsearch",
+    "stac-fastapi",
+]
+dynamic = ["version"]
+dependencies = [
+    "stac-fastapi-core==6.6.0",
+    "sfeos-helpers==6.6.0",
+    "elasticsearch[async]~=8.19.1",
+    "uvicorn~=0.23.0",
+    "starlette>=0.35.0,<0.36.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch"
+
+[project.optional-dependencies]
+dev = [
+    "pytest~=8.0",
+    "pytest-cov~=4.0.0",
+    "pytest-asyncio~=0.21.0",
+    "pre-commit~=3.0.0",
+    "ciso8601~=2.3.0",
+    "httpx>=0.24.0,<0.28.0",
+]
+docs = [
+    "mkdocs~=1.4.0",
+    "mkdocs-material~=9.0.0",
+    "pdocs~=1.2.0",
+]
+server = [
+    "uvicorn[standard]~=0.23.0",
+]
+
+[project.scripts]
+stac-fastapi-elasticsearch = "stac_fastapi.elasticsearch.app:run"
+
+[tool.hatch.version]
+path = "stac_fastapi/elasticsearch/version.py"
+
+[tool.hatch.build.targets.sdist]
+exclude = ["alembic", "tests", "scripts"]
+
+[tool.hatch.build.targets.wheel]
+only-include = ["stac_fastapi"]

stac_fastapi_elasticsearch-6.6.0/pytest.ini

@@ -0,0 +1,4 @@
+[pytest]
+testpaths = tests
+addopts = -sv
+asyncio_mode = auto

{stac_fastapi_elasticsearch-6.5.0 → stac_fastapi_elasticsearch-6.6.0}/stac_fastapi/elasticsearch/database_logic.py

@@ -17,7 +17,7 @@ from starlette.requests import Request
 
 from stac_fastapi.core.base_database_logic import BaseDatabaseLogic
 from stac_fastapi.core.serializers import CollectionSerializer, ItemSerializer
-from stac_fastapi.core.utilities import bbox2polygon, get_bool_env, get_max_limit
+from stac_fastapi.core.utilities import MAX_LIMIT, bbox2polygon, get_bool_env
 from stac_fastapi.elasticsearch.config import AsyncElasticsearchSettings
 from stac_fastapi.elasticsearch.config import (
     ElasticsearchSettings as SyncElasticsearchSettings,
@@ -29,13 +29,15 @@ from stac_fastapi.extensions.core.transaction.request import (
 )
 from stac_fastapi.sfeos_helpers import filter as filter_module
 from stac_fastapi.sfeos_helpers.database import (
+    add_bbox_shape_to_collection,
+    apply_collections_bbox_filter_shared,
+    apply_collections_datetime_filter_shared,
     apply_free_text_filter_shared,
     apply_intersects_filter_shared,
     create_index_templates_shared,
     delete_item_index_shared,
     get_queryables_mapping_shared,
     index_alias_by_collection_id,
-    index_by_collection_id,
     mk_actions,
     mk_item_id,
     populate_sort_shared,
@@ -99,26 +101,6 @@ async def create_collection_index() -> None:
     await client.close()
 
 
-async def create_item_index(collection_id: str):
-    """
-    Create the index for Items. The settings of the index template will be used implicitly.
-
-    Args:
-        collection_id (str): Collection identifier.
-
-    Returns:
-        None
-
-    """
-    client = AsyncElasticsearchSettings().create_client
-
-    await client.options(ignore_status=400).indices.create(
-        index=f"{index_by_collection_id(collection_id)}-000001",
-        body={"aliases": {index_alias_by_collection_id(collection_id): {}}},
-    )
-    await client.close()
-
-
 async def delete_item_index(collection_id: str):
     """Delete the index for items in a collection.
 
@@ -175,6 +157,7 @@ class DatabaseLogic(BaseDatabaseLogic):
         limit: int,
         request: Request,
         sort: Optional[List[Dict[str, Any]]] = None,
+        bbox: Optional[List[float]] = None,
         q: Optional[List[str]] = None,
         filter: Optional[Dict[str, Any]] = None,
         query: Optional[Dict[str, Dict[str, Any]]] = None,
@@ -187,6 +170,7 @@ class DatabaseLogic(BaseDatabaseLogic):
             limit (int): The number of results to return.
             request (Request): The FastAPI request object.
             sort (Optional[List[Dict[str, Any]]]): Optional sort parameter from the request.
+            bbox (Optional[List[float]]): Bounding box to filter collections by spatial extent.
             q (Optional[List[str]]): Free text search terms.
             query (Optional[Dict[str, Dict[str, Any]]]): Query extension parameters.
             filter (Optional[Dict[str, Any]]): Structured query in CQL2 format.
@@ -309,18 +293,20 @@ class DatabaseLogic(BaseDatabaseLogic):
                     query_parts.append(search_dict["query"])
 
             except Exception as e:
-                logger = logging.getLogger(__name__)
                 logger.error(f"Error converting query to Elasticsearch: {e}")
                 # If there's an error, add a query that matches nothing
                 query_parts.append({"bool": {"must_not": {"match_all": {}}}})
                 raise
 
-        # Combine all query parts with AND logic if there are multiple
-        datetime_filter = None
-        if datetime:
-            datetime_filter = self._apply_collection_datetime_filter(datetime)
-            if datetime_filter:
-                query_parts.append(datetime_filter)
+        # Apply bbox filter if provided
+        bbox_filter = apply_collections_bbox_filter_shared(bbox)
+        if bbox_filter:
+            query_parts.append(bbox_filter)
+
+        # Apply datetime filter if provided
+        datetime_filter = apply_collections_datetime_filter_shared(datetime)
+        if datetime_filter:
+            query_parts.append(datetime_filter)
 
         # Combine all query parts with AND logic
         if query_parts:
@@ -330,12 +316,6 @@ class DatabaseLogic(BaseDatabaseLogic):
                 else {"bool": {"must": query_parts}}
             )
 
-        # Create a copy of the body for count query (without pagination and sorting)
-        count_body = body.copy()
-        if "search_after" in count_body:
-            del count_body["search_after"]
-        count_body["size"] = 0
-
         # Create async tasks for both search and count
         search_task = asyncio.create_task(
             self.client.search(
@@ -381,46 +361,10 @@ class DatabaseLogic(BaseDatabaseLogic):
             try:
                 matched = count_task.result().get("count")
             except Exception as e:
-                logger = logging.getLogger(__name__)
                 logger.error(f"Count task failed: {e}")
 
         return collections, next_token, matched
 
-    @staticmethod
-    def _apply_collection_datetime_filter(
-        datetime_str: Optional[str],
-    ) -> Optional[Dict[str, Any]]:
-        """Create a temporal filter for collections based on their extent."""
-        if not datetime_str:
-            return None
-
-        # Parse the datetime string into start and end
-        if "/" in datetime_str:
-            start, end = datetime_str.split("/")
-            # Replace open-ended ranges with concrete dates
-            if start == "..":
-                # For open-ended start, use a very early date
-                start = "1800-01-01T00:00:00Z"
-            if end == "..":
-                # For open-ended end, use a far future date
-                end = "2999-12-31T23:59:59Z"
-        else:
-            # If it's just a single date, use it for both start and end
-            start = end = datetime_str
-
-        return {
-            "bool": {
-                "must": [
-                    # Check if any date in the array is less than or equal to the query end date
-                    # This will match if the collection's start date is before or equal to the query end date
-                    {"range": {"extent.temporal.interval": {"lte": end}}},
-                    # Check if any date in the array is greater than or equal to the query start date
-                    # This will match if the collection's end date is after or equal to the query start date
-                    {"range": {"extent.temporal.interval": {"gte": start}}},
-                ]
-            }
-        }
-
     async def get_one_item(self, collection_id: str, item_id: str) -> Dict:
         """Retrieve a single item from the database.
 
@@ -818,7 +762,7 @@ class DatabaseLogic(BaseDatabaseLogic):
             index_param = ITEM_INDICES
             query = add_collections_to_body(collection_ids, query)
 
-        max_result_window = get_max_limit()
+        max_result_window = MAX_LIMIT
 
         size_limit = min(limit + 1, max_result_window)
 
@@ -1388,7 +1332,7 @@ class DatabaseLogic(BaseDatabaseLogic):
             None
 
         Notes:
-            A new index is created for the items in the Collection using the `create_item_index` function.
+            A new index is created for the items in the Collection if the index insertion strategy requires it.
         """
         collection_id = collection["id"]
 
@@ -1406,6 +1350,12 @@ class DatabaseLogic(BaseDatabaseLogic):
         if await self.client.exists(index=COLLECTIONS_INDEX, id=collection_id):
             raise ConflictError(f"Collection {collection_id} already exists")
 
+        if get_bool_env("ENABLE_COLLECTIONS_SEARCH") or get_bool_env(
+            "ENABLE_COLLECTIONS_SEARCH_ROUTE"
+        ):
+            # Convert bbox to bbox_shape for geospatial queries (ES/OS specific)
+            add_bbox_shape_to_collection(collection)
+
         # Index the collection in the database
         await self.client.index(
             index=COLLECTIONS_INDEX,
@@ -1509,6 +1459,12 @@ class DatabaseLogic(BaseDatabaseLogic):
             await self.delete_collection(collection_id)
 
         else:
+            if get_bool_env("ENABLE_COLLECTIONS_SEARCH") or get_bool_env(
+                "ENABLE_COLLECTIONS_SEARCH_ROUTE"
+            ):
+                # Convert bbox to bbox_shape for geospatial queries (ES/OS specific)
+                add_bbox_shape_to_collection(collection)
+
             # Update the existing collection
             await self.client.index(
                 index=COLLECTIONS_INDEX,

{stac_fastapi_elasticsearch-6.5.0 → stac_fastapi_elasticsearch-6.6.0}/stac_fastapi/elasticsearch/version.py

@@ -1,2 +1,2 @@
 """library version."""
-__version__ = "6.5.0"
+__version__ = "6.6.0"