eodag.plugins.search.static_stac_search.StaticStacSearch#
- class eodag.plugins.search.static_stac_search.StaticStacSearch(provider: str, config: PluginConfig)[source]#
Static STAC Catalog search plugin
The available configuration parameters for this plugin are (to be set in provider configuration):
api_endpoint: (mandatory) path to the catalog (url or local system path)
max_connections: (optional) Maximum number of connections for HTTP requests, defaut is 100.
timeout: (mandatory) Timeout in seconds for each internal HTTP request, default is 5.
This plugin first loads all STAC items found in the catalog, and converts them to EOProducts using StacSearch. Then it uses crunchers to only keep products matching query parameters.
- Parameters:
Methods
__init__
(provider, config)build_query_string
(product_type, **kwargs)Build The query string using the search parameters
build_sort_by
(sort_by_arg)Build the sorting part of the query string or body by transforming the "sortBy" argument into a provider-specific string or dictionnary
clear
()Clear search context
collect_search_urls
([page, items_per_page, ...])Adds pagination to query parameters, and auth to url
count_hits
(count_url[, result_type])Count the number of results satisfying some criteria
discover_product_types
(**kwargs)Fetch product types is disabled for StaticStacSearch
discover_queryables
(**kwargs)Fetch queryables list from provider using discover_queryables conf
do_search
([items_per_page])Perform the actual search request.
get_collections
(**kwargs)Get the collection to which the product belongs
get_metadata_mapping
([product_type])Get the plugin metadata mapping configuration (product type specific if exists)
get_product_type_def_params
(product_type, ...)Get the provider product type definition parameters and specific settings
get_sort_by_arg
(kwargs)Extract the "sortBy" argument from the kwargs or the provider default sort configuration
list_queryables
(filters[, product_type])Get queryables
map_product_type
(product_type, **kwargs)Get the provider product type from eodag product type
normalize_results
(results, **kwargs)Build EOProducts from provider results
query
([product_type, items_per_page, page, ...])Perform a search on a static STAC Catalog
update_metadata_mapping
(metadata_mapping)Update plugin metadata_mapping with input metadata_mapping configuration
Attributes
DEFAULT_ITEMS_PER_PAGE
extract_properties
plugins
auth
next_page_url
next_page_query_obj
total_items_nb
need_count