satorbis_kit.pgstac.manager.api module¶

Function-based convenience API for STAC ingestion.

This module provides simple function-based helpers for common ingestion workflows, serving as a lightweight alternative to the class-based STACIngestionManager API.

satorbis_kit.pgstac.manager.api.stack_rasters_and_ingest_via_airflow(s3_urls: List[str], collection_name: str, airflow_base_url: str, airflow_username: str, airflow_password: str, convert_to_cog: bool | None = None, cog_profile: str | None = None, cog_profile_options: Dict[str, Any] | None = None, cog_overview_level: int | None = None, ingestion_batch_size: int | None = None, ttl: int | None = None, **kwargs: Any) → str | List[str][source]¶

Convenience function to submit raster ingestion via Airflow.

This function provides a simple, function-based interface for basic use cases using direct Airflow DAG triggering.

For OpenEO/SQS-based submission, use stack_rasters_and_ingest_via_spatial_engine(). For more control and advanced features, use STACIngestionManager class directly.

Parameters:

s3_urls – List of S3 URLs to raster files
collection_name – STAC collection name
airflow_base_url – Airflow API URL (required)
airflow_username – Username for authentication (required)
airflow_password – Password for authentication (required)
convert_to_cog – Whether to convert to COG format (optional)
cog_profile – COG profile name (e.g., ‘lzw’, ‘deflate’) (optional)
cog_profile_options – Profile options for cog_translate (optional)
cog_overview_level – Number of overview levels (optional)
ingestion_batch_size – Batch size for ingestion (optional, default: 100)
ttl – Time To Live in days (optional). Integer representing days (e.g., ttl=10 means 10 days). If not provided, defaults to 30 days. Note: In this function API, passing ttl=None will also default to 30 days. To explicitly skip TTL for permanent items, use the class-based API with ttl=None. The value is stored as an expiry date string in properties[“ss:ttl”] in STAC metadata, computed as today’s date + ttl days (ISO format YYYY-MM-DD).
**kwargs – Additional keyword arguments (for future extensions)

Returns:

Job ID(s) for tracking the ingestion workflow.

Return type:

Union[str, List[str]]

Raises:

ValidationError – If any input parameters are invalid
APIError – If Airflow API request fails

satorbis_kit.pgstac.manager.api.stack_rasters_and_ingest_via_spatial_engine(s3_urls: List[str], collection_name: str, base_url: str | None = None, api_key: str | None = None, convert_to_cog: bool | None = None, cog_profile: str | None = None, cog_profile_options: Dict[str, Any] | None = None, cog_overview_level: int | None = None, ingestion_batch_size: int | None = None, timeout: int = 30, ttl: int | None = None, **kwargs: Any) → str | List[str][source]¶

Convenience function to submit raster ingestion via spatial engine API.

This function provides a simple, function-based interface for submitting jobs through a spatial engine API (e.g., OpenEO) with SQS queueing. Better for large batch jobs.

For direct Airflow triggering, use stack_rasters_and_ingest(). For more control and advanced features, use STACIngestionManager class directly.