Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# STAC API Serverless
# stac-fastapi-indexed

[![Pull Request, Any Branch](https://github.com/sparkgeo/STAC-API-Serverless/actions/workflows/pull-request-all.yml/badge.svg)](https://github.com/sparkgeo/STAC-API-Serverless/actions/workflows/pull-request-all.yml)
[![Pull Request, Any Branch](https://github.com/sparkgeo/stac-fastapi-indexed/actions/workflows/pull-request-all.yml/badge.svg)](https://github.com/sparkgeo/stac-fastapi-indexed/actions/workflows/pull-request-all.yml)

A [stac-fastapi](https://github.com/stac-utils/stac-fastapi) backend that indexes a STAC catalog to Parquet to make it searchable. The ability to work with static files, and the lack of a need for another persistent data store such as a database, mean this backend can run in a serverless environment. See [Overview](#overview) for more information on this approach.

Expand Down Expand Up @@ -46,7 +46,7 @@ scripts/run-with-remote-source.sh https://esa.pages.eox.at/cubes-and-clouds-cata
Output includes the following information about the index.
```sh
* Indexing may take some time, depending on the size of the catalog
* Indexing to /.../source/sparkgeo/STAC-API-Serverless/.remote-source-index/httpsesapageseoxatcubesandcloudscatalogMOOCCubesandcloudscatalogjson
* Indexing to /.../source/sparkgeo/stac-fastapi-indexed/.remote-source-index/httpsesapageseoxatcubesandcloudscatalogMOOCCubesandcloudscatalogjson
```

The generated index files can be inspected at `.../.remote-source-index/httpsesapageseoxatcubesandcloudscatalogMOOCCubesandcloudscatalogjson` if necessary. If at a later time you want to run the API against this same index, without re-indexing the remote STAC catalog, this can be achieved with the following:
Expand Down
4 changes: 2 additions & 2 deletions docs/suitability.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ This stac-fastapi backend does not support transactions and never will. If you n

The indexing approach requires that some STAC data be duplicated in Parquet index files, and these files are the API's source of truth about that STAC data. If the STAC data changes and the Parquet index files are not updated before an API request is received it is possible for the API to return incorrect data or an error.

This risk can be mitigated somewhat by a shorter indexer repeat cycle, or by event-driven item updates as are intended by [#157](https://github.com/sparkgeo/STAC-API-Serverless/issues/157), but the risk cannot be eliminated entirely.
This risk can be mitigated somewhat by a shorter indexer repeat cycle, or by event-driven item updates as are intended by [#157](https://github.com/sparkgeo/stac-fastapi-indexed/issues/157), but the risk cannot be eliminated entirely.

[#160](https://github.com/sparkgeo/STAC-API-Serverless/issues/160) could also help to address some data duplication risks.
[#160](https://github.com/sparkgeo/stac-fastapi-indexed/issues/160) could also help to address some data duplication risks.

### Performance

Expand Down
2 changes: 1 addition & 1 deletion iac/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
app = cdk.App()
CdkDeploymentStack(
app,
"STAC-API-Serverless",
"stac-fastapi-indexed",
env=cdk.Environment(
account=app.node.get_context("AWS_ACCOUNT"),
region=app.node.get_context("AWS_REGION"),
Expand Down
2 changes: 1 addition & 1 deletion iac/cdk_deployment/cdk_deployment_stack.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ def create_api(
default_cors_preflight_options=cors,
proxy=True,
binary_media_types=[],
rest_api_name="STAC-API-Serverless",
rest_api_name="stac-fastapi-indexed",
)

def create_indexer(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ async def process(response: ClientResponse) -> None:
await self._get_uri_and_process(uri, process)

# This function interacts with HTTP endpoints inefficiently.
# See https://github.com/sparkgeo/STAC-API-Serverless/issues/98 for thoughts on this.
# See https://github.com/sparkgeo/stac-fastapi-indexed/issues/98 for thoughts on this.
async def get_item_uris_from_items_uri(
self: Self, uri: str, item_limit: Optional[int] = None
) -> Tuple[List[str], List[str]]:
Expand Down