OARSearch#
- class eodag.plugins.search.oar.OARSearch(provider, config)[source]#
OGC API - Records Core search plugin.
Search requests use the standard query-string GET implementation from
QueryStringSearch, while queryables discovery reusesStacSearch.See also
OGC API - Records Core specification: https://docs.ogc.org/is/20-004r1/20-004r1.html
- Parameters:
provider (
str)config (
PluginConfig)
- __init__(provider, config)[source]#
- Parameters:
provider (
str)config (
PluginConfig)
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_byargument into a provider-specific string or dictionaryclear()Clear search context
collect_search_urls([prep])Handle OGC API - Records specificities, then delegate collect_search_urls to
QueryStringSearch.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)Delegate queryables discovery to
StacSearch.do_search([prep])Perform the actual search request.
ensure_plugins_loaded()Load plugin classes for this topic from entry points if needed.
extract_results_from_response(resp_as_json, ...)Extract results list from a JSON response using the
results_entryconfigurationget_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_byargument from the kwargs or the provider default sort configurationlist_queryables(filters, ...[, collection, ...])Get queryables
map_collection(collection, **kwargs)Get the provider collection from eodag collection
normalize_config(provider, config)Normalize and validate the plugin configuration for an OGC API Records provider.
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
entrypoint_groupextract_propertiespluginsauthnext_page_urlnext_page_query_objtotal_items_nbneed_count