ECMWFSearch

class eodag.plugins.search.build_search_result.ECMWFSearch(provider, config)

ECMWF search plugin.

This plugin builds a SearchResult containing a single product using given query parameters as product properties.

The available configuration parameters inherits from parent classes, with some particular parameters for this plugin.

Parameters:

• provider (str) – An eodag providers configuration dictionary

• config (PluginConfig) –

  Search plugin configuration:

  • remove_from_query (list[str]): List of parameters used to parse metadata but that must not be included to the query

  • end_date_excluded (bool): Set to False if provider does not include end date to search

  • discover_queryables (DiscoverQueryables): configuration to fetch the queryables from a provider queryables endpoint; It has the following keys:

    • fetch_url (str): url to fetch the queryables valid for all product types

    • product_type_fetch_url (str): url to fetch the queryables for a specific product type

    • constraints_url (str): url of the constraint file used to build queryables

__init__(provider, config)

Parameters:

• provider (str)

• config (PluginConfig)

Methods

__init__(provider, config)
available_values_from_constraints(...)	Filter constraints using input_keywords.
build_query_string(product_type, 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 method that will always return 1.
discover_product_types(**kwargs)	Fetch product types list from provider using discover_product_types conf
discover_product_types_per_page(**kwargs)	Fetch product types list from provider using discover_product_types conf using paginated kwargs["fetch_url"]
discover_queryables(**kwargs)	Fetch queryables list from provider using its constraints file
do_search(*args, **kwargs)	Should perform the actual search request.
format_as_provider_keyword(product_type, ...)	Return provider equivalent keyword names from EODAG keywords.
get_collections(prep, **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_cfg_value(key[, default])	Get the value of a configuration option specific to the current product type.
get_product_type_def_params(product_type[, ...])	Get the provider product type definition parameters and specific settings
get_sort_by_arg(kwargs)	Extract the sort_by argument from the kwargs or the provider default sort configuration
list_queryables(filters, ...[, ...])	Get queryables
map_product_type(product_type, **kwargs)	Get the provider product type from eodag product type
normalize_results(results, **kwargs)	Build EOProduct from provider result
query([prep])	Build ready-to-download SearchResult
queryables_by_form(form, available_values, ...)	Generate Annotated field definitions from form entries and available values Used by Copernicus services like cop_cds, cop_ads, cop_ewds.
queryables_by_values(available_values, ...)	Generate Annotated field definitions from available values.
queryables_from_metadata_mapping([...])	Extract queryable parameters from product type metadata mapping.
update_metadata_mapping(metadata_mapping)	Update plugin metadata_mapping with input metadata_mapping configuration

Attributes

extract_properties
plugins
auth
next_page_url
next_page_query_obj
total_items_nb
need_count