Parameters mapping

eodag interacts with various data providers, each having its own way of naming and structuring metadata parameters. To provide a unified interface for users, eodag maps these provider metadata parameters to a common model.

Parameters mapping

EODAG maps each provider’s specific metadata parameters to a common model using OGC OpenSearch Extension for Earth Observation. Extra parameters having no equivalent in this model are mapped as is.

Depending on the provider, some parameters are queryable or not. This is configured in providers.yml:

• If a parameter metadata-mapping is a list, the first element will help constructing the query (using format()), and the 2nd will help extracting its values from the query result (using jsonpath)

• If a parameter metadata-mapping is a string, it will not be queryable and this string will help extracting its values from the query result (using jsonpath).

some_provider:
   search:
      metadata_mapping:
         queryableParameter:
            - 'this_is_query_string={queryableParameter}'
            - '$.jsonpath.in.result.to.parameter'
         nonQueryableParameter: '$.jsonpath.in.result.to.another_parameter'

Formatters

An EOProduct has a properties attribute which is built based on how its metadata are set in the provider configuration. For example:

search:
   ...
   metadata_mapping:
      publicationDate: '{$.data.timestamp#to_iso_utc_datetime_from_milliseconds}'
      ...

The following converters can be used to transform the values collected from the provider:

eodag.api.product.metadata_mapping.format_metadata(search_param, *args, **kwargs)

Format a string of form {<field_name>#<conversion_function>}

The currently understood converters are:

• ceda_collection_name: generate a CEDA collection name from a string

• wekeo_to_cop_collection: converts the name of a collection from the WEkEO format to the Copernicus format

• csv_list: convert to a comma separated list

• datetime_to_timestamp_milliseconds: converts a utc date string to a timestamp in milliseconds

• dict_filter_and_sub: filter dict items using jsonpath and then apply recursive_sub_str

• dict_with_roles: keep only dict items with given roles in their “roles” list

• fake_l2a_title_from_l1c: used to generate SAFE format metadata for data from AWS

• from_alternate: update assets using given alternate

• from_ewkt: convert EWKT to shapely geometry / WKT in DEFAULT_PROJ

• from_georss: convert GeoRSS to shapely geometry / WKT in DEFAULT_PROJ

• get_ecmwf_time: get the time of a datetime string in the ECMWF format

• get_group_name: get the matching regex group name

• literalize_unicode: convert a string to its raw Unicode literal form

• not_available: replace value with “Not Available”

• recursive_sub_str: recursively substitue in the structure (e.g. dict) values matching a regex

• remove_extension: on a string that contains dots, only take the first part of the list obtained by splitting the string on dots

• replace_str: execute “string”.replace(old, new)

• replace_str_tuple: apply multiple replacements on a string (parts or complete)

• replace_tuple: apply multiple replacements matching whole value

• s2msil2a_title_to_aws_productinfo: used to generate SAFE format metadata for data from AWS

• sanitize: sanitize string

• slice_str: slice a string (equivalent to s[start, end, step])

• split: split a string using given separator

• split_cop_dem_id: get the bbox by splitting the product id

• split_corine_id: get the collection by splitting the product id

• to_bounds_lists: convert to list(s) of bounds

• to_datetime_dict: convert a datetime string to a dictionary where values are either a string or a list

• to_ewkt: convert to EWKT (Extended Well-Known text)

• to_geojson: convert to a GeoJSON (via __geo_interface__ if exists)

• to_geojson_polytope: convert shapely Point/LineString/Polygon to ECMWF polytope feature dicts

• to_iso_date: remove the time part of a iso datetime string

• to_iso_utc_datetime_from_milliseconds: convert a utc timestamp in given milliseconds to a utc iso datetime

• to_iso_utc_datetime: convert a UTC datetime string to ISO UTC datetime string

• to_lower: Convert a string to lowercase

• to_nwse_bounds_str: convert to North,West,South,East bounds string with given separator

• to_nwse_bounds: convert to North,West,South,East bounds

• to_rounded_wkt: simplify the WKT of a geometry

• to_title: Convert a string to title case

• to_upper: Convert a string to uppercase

Parameters:

• search_param (str) – The string to be formatted

• args (Any) – (optional) Additional arguments to use in the formatting process

• kwargs (Any) – (optional) Additional named-arguments to use when formatting

Return type:

str

Returns:

The formatted string

Queryables

The list_queryables() method will help you to dynamically check which parameters are queryable for a given provider or collection. See Python API User Guide / Queryables for more information and examples.

The following static tables list the parameters supported by providers, and if they are queryable or not.

OpenSearch parameters (CSV)

parameter	cop_dataspace	cop_ghsl	cop_marine	creodias	dlr_eoc_geoservice	earth_search	earth_search_gcs	ecmwf	eocat	eumetsat_ds	fedeo_ceda	geodes	planetary_computer	sara	theia	usgs_satapi_aws
platform	queryable metadata			queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata	metadata only	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
platformSerialIdentifier	metadata only			metadata only
productType					metadata only	metadata only	metadata only		metadata only		metadata only	metadata only	metadata only		metadata only	metadata only
title	metadata only			metadata only	metadata only	metadata only	metadata only		metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only

Provider/eodag specific parameters (CSV)

parameter	cop_dataspace	cop_ghsl	cop_marine	creodias	dlr_eoc_geoservice	earth_search	earth_search_gcs	ecmwf	eocat	eumetsat_ds	fedeo_ceda	geodes	planetary_computer	sara	theia	usgs_satapi_aws
_collection	queryable metadata			queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata
_processor_name	queryable metadata			queryable metadata
_provider	metadata only			metadata only										metadata only
acquisitionInformation										metadata only
assets					metadata only	metadata only	metadata only		metadata only	metadata only	metadata only	metadata only	metadata only		metadata only	metadata only
beginningDateTime	metadata only			metadata only
collection	queryable metadata			queryable metadata
constellation	queryable metadata			queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata		queryable metadata	queryable metadata	queryable metadata	metadata only	queryable metadata	queryable metadata
created					metadata only	metadata only	metadata only		metadata only		metadata only	metadata only	metadata only	metadata only	metadata only	metadata only
datetime					metadata only	metadata only	metadata only		metadata only		metadata only	metadata only	metadata only		metadata only	metadata only
description													metadata only	metadata only
end_datetime	queryable metadata			queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
endingDateTime	metadata only			metadata only
eo:cloud_cover	queryable metadata			queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
eo:snow_cover														queryable metadata
eodag:default_geometry		metadata only	metadata only					metadata only		metadata only
eodag:download_link	metadata only			metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only
eodag:quicklook	metadata only			metadata only	metadata only	metadata only	metadata only		metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only
eodag:thumbnail	metadata only			metadata only	metadata only	metadata only	metadata only		metadata only		metadata only	metadata only	metadata only	metadata only	metadata only	metadata only
expires					metadata only	metadata only	metadata only		metadata only		metadata only	metadata only	metadata only		metadata only	metadata only
extraInformation										metadata only
file:checksum	metadata only			metadata only										metadata only
file:size	metadata only			metadata only										metadata only
geometry	queryable metadata			queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	metadata only	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
grid:code	queryable metadata			queryable metadata		queryable metadata						queryable metadata	queryable metadata
gsd	queryable metadata			queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
id	queryable metadata			queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
instruments	queryable metadata			queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata	metadata only	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
keywords												metadata only		metadata only
license														metadata only
order:status	metadata only			metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only
processing:datetime	queryable metadata			queryable metadata
processing:facility	queryable metadata			queryable metadata
processing:level	queryable metadata			queryable metadata										queryable metadata
processing:software	metadata only			metadata only
processing:version	queryable metadata			queryable metadata
product:acquisition_type														metadata only
product:timeliness	queryable metadata			queryable metadata
product:type	queryable metadata			queryable metadata				metadata only		queryable metadata		queryable metadata		queryable metadata
productInformation										metadata only
providers	queryable metadata			queryable metadata										queryable metadata
published	metadata only			metadata only	metadata only	metadata only	metadata only		metadata only		metadata only	metadata only	metadata only	metadata only	metadata only	metadata only
published_after	queryable metadata			queryable metadata
published_before	queryable metadata			queryable metadata
qs								metadata only
s1:datatake_id	queryable metadata			queryable metadata
s1:instrument_configuration_ID	queryable metadata			queryable metadata
s1:slice_number	queryable metadata			queryable metadata
s1:total_slices	queryable metadata			queryable metadata
s2:datastrip_id	queryable metadata			queryable metadata
s2:datatake_id	queryable metadata			queryable metadata
s2:datatake_type	queryable metadata			queryable metadata
s2:product_uri	queryable metadata			queryable metadata
s2:tile_id	queryable metadata			queryable metadata
sar:beam_ids					queryable metadata	queryable metadata	queryable metadata		queryable metadata		queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata
sar:instrument_mode	queryable metadata			queryable metadata								metadata only		queryable metadata
sar:polarizations	queryable metadata			queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
sat:absolute_orbit	queryable metadata			queryable metadata								queryable metadata		queryable metadata
sat:orbit_state	queryable metadata			queryable metadata								queryable metadata		queryable metadata
sat:relative_orbit	queryable metadata			queryable metadata								queryable metadata		queryable metadata
sci:doi												metadata only
size										metadata only
start_datetime	queryable metadata			queryable metadata	metadata only	metadata only	metadata only	metadata only	metadata only	queryable metadata	metadata only	queryable metadata	metadata only	queryable metadata	metadata only	metadata only
type	metadata only			metadata only						metadata only				metadata only
uid	metadata only			metadata only						metadata only		metadata only		metadata only
unpublished					metadata only	metadata only	metadata only		metadata only		metadata only	metadata only	metadata only		metadata only	metadata only
updated	queryable metadata			metadata only	metadata only	metadata only	metadata only		metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only
updated_after	queryable metadata			queryable metadata
updated_before	queryable metadata			queryable metadata
version														metadata only