Search Plugins#

Search plugins must inherit the following class and implement query():

class eodag.plugins.search.base.Search(provider, config)[source]#

Base Search Plugin.

Parameters

  • provider (dict) – An eodag providers configuration dictionary

  • config (str) – Path to the user configuration file

clear()[source]#

Method used to clear a search context between two searches.

discover_product_types()[source]#

Fetch product types list from provider using discover_product_types conf

query(*args, count=True, **kwargs)[source]#

Implementation of how the products must be searched goes here.

This method must return a tuple with (1) a list of EOProduct instances (see eodag.api.product module) which will be processed by a Download plugin (2) and the total number of products matching the search criteria. If count is False, the second element returned must be None.

This table lists all the search plugins currently available:

eodag.plugins.search.qssearch.QueryStringSearch(...)

A plugin that helps implementing any kind of search protocol that relies on query strings (e.g: opensearch).

eodag.plugins.search.qssearch.AwsSearch(...)

A specialisation of RestoSearch that modifies the way the EOProducts are built from the search results

eodag.plugins.search.qssearch.ODataV4Search(...)

A specialisation of a QueryStringSearch that does a two step search to retrieve all products metadata

eodag.plugins.search.qssearch.PostJsonSearch(...)

A specialisation of a QueryStringSearch that uses POST method

eodag.plugins.search.qssearch.StacSearch(...)

A specialisation of a QueryStringSearch that uses generic STAC configuration

eodag.plugins.search.static_stac_search.StaticStacSearch(...)

Static STAC Catalog search plugin

eodag.plugins.search.csw.CSWSearch(provider, ...)

A plugin for implementing search based on OGC CSW