StacSearch

StacSearch#

class eodag.plugins.search.qssearch.StacSearch(provider, config)[source]#

A specialisation of PostJsonSearch that uses generic STAC configuration.

It therefore has the same configuration parameters (those inherited from QueryStringSearch).

For providers using StacSearch default values are defined for most of the parameters (see stac_provider.yml). If some parameters are different for a specific provider, they have to be overwritten. If certain functionalities are not available, their configuration parameters have to be overwritten with null. E.g. if there is no queryables endpoint, the fetch_url and collection_fetch_url in the discover_queryables config have to be set to null.

Plugins inheriting from StacSearch have to be referenced in STAC_SEARCH_PLUGINS to be correctly initialized with the expected STAC configuration and features.

Parameters:
__init__(provider, config)[source]#
Parameters:

Methods

__init__(provider, config)

build_query_string(collection, query_dict)

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 sort_by argument into a provider-specific string or dictionary

clear()

Clear search context

collect_search_urls([prep])

Adds pagination to query parameters, and auth to url

count_hits(count_url[, result_type])

Count the number of results satisfying some criteria

discover_collections(**kwargs)

Fetch collections list from provider using discover_collections conf

discover_collections_per_page(**kwargs)

Fetch collections list from provider using discover_collections conf using paginated kwargs["fetch_url"]

discover_queryables(**kwargs)

Fetch queryables list from provider using discover_queryables conf

do_search([prep])

Perform the actual search request.

get_assets_from_mapping(provider_item)

Create assets based on the assets_mapping in the provider's config and an item returned by the provider

get_collection_cfg_dates([start_default, ...])

Get start and end dates from the collection configuration.

get_collection_cfg_value(key[, default])

Get the value of a configuration option specific to the current collection.

get_collection_def_params(collection[, ...])

Get the provider collection definition parameters and specific settings

get_metadata_mapping([collection])

Get the plugin metadata mapping configuration (collection specific if exists)

get_provider_collections(prep, **kwargs)

Get the _collection(s) / provider collection(s) to which the product belongs

get_sort_by_arg(kwargs)

Extract the sort_by argument from the kwargs or the provider default sort configuration

list_queryables(filters, ...[, collection, ...])

Get queryables

map_collection(collection, **kwargs)

Get the provider collection from eodag collection

normalize_results(results, **kwargs)

Build EOProducts from provider results

query([prep])

Perform a search on an OpenSearch-like interface

queryables_from_metadata_mapping([...])

Extract queryable parameters from collection metadata mapping.

validate(search_params, auth)

Validate a search request.

Attributes

extract_properties

plugins

auth

next_page_url

next_page_query_obj

total_items_nb

need_count