Queryables

Queryables#

The CommonQueryables and Queryables classes are Pydantic models listing queryable parameters and their characteristics.

pydantic model eodag.types.queryables.CommonQueryables[source]#

A class representing search common queryable properties.

Parameters:: data (Any)

Show JSON schema

{
   "title": "CommonQueryables",
   "description": "A class representing search common queryable properties.",
   "type": "object",
   "properties": {
      "collection": {
         "title": "Collection",
         "type": "string"
      }
   },
   "required": []
}

Config:

arbitrary_types_allowed: bool = True

field collection: Annotated[str, Field()] [Required]#

classmethod from_stac_models(extensions=[SarExtension(FIELDS=<class 'eodag.types.stac_extensions.SarFields'>, schema_href='https://stac-extensions.github.io/sar/v1.3.0/schema.json', field_name_prefix='sar'), SatelliteExtension(FIELDS=<class 'eodag.types.stac_extensions.SatelliteFields'>, schema_href='https://stac-extensions.github.io/sat/v1.1.0/schema.json', field_name_prefix='sat'), TimestampExtension(FIELDS=<class 'eodag.types.stac_extensions.TimestampFields'>, schema_href='https://stac-extensions.github.io/timestamps/v1.1.0/schema.json', field_name_prefix=None), ProcessingExtension(FIELDS=<class 'eodag.types.stac_extensions.ProcessingFields'>, schema_href='https://stac-extensions.github.io/processing/v1.2.0/schema.json', field_name_prefix='processing'), ViewGeometryExtension(FIELDS=<class 'eodag.types.stac_extensions.ViewGeometryFields'>, schema_href='https://stac-extensions.github.io/view/v1.1.0/schema.json', field_name_prefix='view'), ElectroOpticalExtension(FIELDS=<class 'eodag.types.stac_extensions.ElectroOpticalFields'>, schema_href='https://stac-extensions.github.io/eo/v2.0.0/schema.json', field_name_prefix='eo'), ScientificCitationExtension(FIELDS=<class 'eodag.types.stac_extensions.ScientificCitationFields'>, schema_href='https://stac-extensions.github.io/scientific/v1.0.0/schema.json', field_name_prefix='sci'), ProductExtension(FIELDS=<class 'eodag.types.stac_extensions.ProductFields'>, schema_href='https://stac-extensions.github.io/product/v1.0.0/schema.json', field_name_prefix='product'), StorageExtension(FIELDS=<class 'eodag.types.stac_extensions.StorageFields'>, schema_href='https://stac-extensions.github.io/storage/v2.0.0/schema.json', field_name_prefix='storage'), OrderExtension(FIELDS=<class 'eodag.types.stac_extensions.OrderFields'>, schema_href='https://stac-extensions.github.io/order/v1.1.0/schema.json', field_name_prefix='order'), FileExtension(FIELDS=<class 'eodag.types.stac_extensions.FileFields'>, schema_href='https://stac-extensions.github.io/file/v2.1.0/schema.json', field_name_prefix='file'), GridExtension(FIELDS=<class 'eodag.types.stac_extensions.GridFields'>, schema_href='https://stac-extensions.github.io/grid/v1.1.0/schema.json', field_name_prefix='grid'), MgrsExtension(FIELDS=<class 'eodag.types.stac_extensions.MgrsFields'>, schema_href='https://stac-extensions.github.io/mgrs/v1.0.0/schema.json', field_name_prefix='mgrs'), ProjectionExtension(FIELDS=<class 'eodag.types.stac_extensions.ProjectionFields'>, schema_href='https://stac-extensions.github.io/projection/v2.0.0/schema.json', field_name_prefix='proj'), DatacubeExtension(FIELDS=<class 'eodag.types.stac_extensions.DatacubeFields'>, schema_href='https://stac-extensions.github.io/datacube/v2.3.0/schema.json', field_name_prefix='cube'), LabelExtension(FIELDS=<class 'eodag.types.stac_extensions.LabelFields'>, schema_href='https://stac-extensions.github.io/label/v1.0.1/schema.json', field_name_prefix='label'), FederationExtension(FIELDS=<class 'eodag.types.stac_extensions.FederationFields'>, schema_href=None, field_name_prefix='federation'), EcmwfExtension(FIELDS=<class 'eodag.types.stac_extensions.EcmwfItemProperties'>, schema_href=None, field_name_prefix='ecmwf'), UsgsExtension(FIELDS=<class 'eodag.types.stac_extensions.UsgsFields'>, schema_href=None, field_name_prefix='usgs')], base_model=<class 'eodag.types.stac_metadata.CommonStacMetadata'>)[source]#

Creates Queryables from STAC models.

Parameters:

extensions (list[BaseStacExtension], default: [SarExtension(FIELDS=<class 'eodag.types.stac_extensions.SarFields'>, schema_href='https://stac-extensions.github.io/sar/v1.3.0/schema.json', field_name_prefix='sar'), SatelliteExtension(FIELDS=<class 'eodag.types.stac_extensions.SatelliteFields'>, schema_href='https://stac-extensions.github.io/sat/v1.1.0/schema.json', field_name_prefix='sat'), TimestampExtension(FIELDS=<class 'eodag.types.stac_extensions.TimestampFields'>, schema_href='https://stac-extensions.github.io/timestamps/v1.1.0/schema.json', field_name_prefix=None), ProcessingExtension(FIELDS=<class 'eodag.types.stac_extensions.ProcessingFields'>, schema_href='https://stac-extensions.github.io/processing/v1.2.0/schema.json', field_name_prefix='processing'), ViewGeometryExtension(FIELDS=<class 'eodag.types.stac_extensions.ViewGeometryFields'>, schema_href='https://stac-extensions.github.io/view/v1.1.0/schema.json', field_name_prefix='view'), ElectroOpticalExtension(FIELDS=<class 'eodag.types.stac_extensions.ElectroOpticalFields'>, schema_href='https://stac-extensions.github.io/eo/v2.0.0/schema.json', field_name_prefix='eo'), ScientificCitationExtension(FIELDS=<class 'eodag.types.stac_extensions.ScientificCitationFields'>, schema_href='https://stac-extensions.github.io/scientific/v1.0.0/schema.json', field_name_prefix='sci'), ProductExtension(FIELDS=<class 'eodag.types.stac_extensions.ProductFields'>, schema_href='https://stac-extensions.github.io/product/v1.0.0/schema.json', field_name_prefix='product'), StorageExtension(FIELDS=<class 'eodag.types.stac_extensions.StorageFields'>, schema_href='https://stac-extensions.github.io/storage/v2.0.0/schema.json', field_name_prefix='storage'), OrderExtension(FIELDS=<class 'eodag.types.stac_extensions.OrderFields'>, schema_href='https://stac-extensions.github.io/order/v1.1.0/schema.json', field_name_prefix='order'), FileExtension(FIELDS=<class 'eodag.types.stac_extensions.FileFields'>, schema_href='https://stac-extensions.github.io/file/v2.1.0/schema.json', field_name_prefix='file'), GridExtension(FIELDS=<class 'eodag.types.stac_extensions.GridFields'>, schema_href='https://stac-extensions.github.io/grid/v1.1.0/schema.json', field_name_prefix='grid'), MgrsExtension(FIELDS=<class 'eodag.types.stac_extensions.MgrsFields'>, schema_href='https://stac-extensions.github.io/mgrs/v1.0.0/schema.json', field_name_prefix='mgrs'), ProjectionExtension(FIELDS=<class 'eodag.types.stac_extensions.ProjectionFields'>, schema_href='https://stac-extensions.github.io/projection/v2.0.0/schema.json', field_name_prefix='proj'), DatacubeExtension(FIELDS=<class 'eodag.types.stac_extensions.DatacubeFields'>, schema_href='https://stac-extensions.github.io/datacube/v2.3.0/schema.json', field_name_prefix='cube'), LabelExtension(FIELDS=<class 'eodag.types.stac_extensions.LabelFields'>, schema_href='https://stac-extensions.github.io/label/v1.0.1/schema.json', field_name_prefix='label'), FederationExtension(FIELDS=<class 'eodag.types.stac_extensions.FederationFields'>, schema_href=None, field_name_prefix='federation'), EcmwfExtension(FIELDS=<class 'eodag.types.stac_extensions.EcmwfItemProperties'>, schema_href=None, field_name_prefix='ecmwf'), UsgsExtension(FIELDS=<class 'eodag.types.stac_extensions.UsgsFields'>, schema_href=None, field_name_prefix='usgs')]) – list of STAC extensions to include in the model
base_model (type[BaseModel], default: <class 'eodag.types.stac_metadata.CommonStacMetadata'>) – base STAC model to use

Return type:

type[Queryables]

Returns:

Queryables model

classmethod get_queryable_from_alias(value)[source]#

Get queryable parameter from alias

>>> CommonQueryables.get_queryable_from_alias('collection')
'collection'

Parameters:: value (str)
Return type:: str

classmethod get_with_default(field, default)[source]#

Get field and set default value.

Parameters:

field (str)
default (Any | None)

Return type:

Any

pydantic model eodag.types.queryables.Queryables[source]#

A class representing all search queryable properties.

Parameters default value is set to None to have them not required. Fields described here are queryables-specific and complete StacMetadata fields.

Parameters:: data (Any)

Show JSON schema

{
   "title": "Queryables",
   "description": "A class representing all search queryable properties.\n\nParameters default value is set to ``None`` to have them not required.\nFields described here are queryables-specific and complete StacMetadata fields.",
   "type": "object",
   "properties": {
      "collection": {
         "title": "Collection",
         "type": "string"
      },
      "start_datetime": {
         "default": null,
         "description": "Date/time as string in ISO 8601 format (e.g. '2024-06-10T12:00:00Z')",
         "title": "Start Datetime",
         "type": "string"
      },
      "end_datetime": {
         "default": null,
         "description": "Date/time as string in ISO 8601 format (e.g. '2024-06-10T12:00:00Z')",
         "title": "End Datetime",
         "type": "string"
      },
      "geometry": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "additionalProperties": {
                  "type": "number"
               },
               "type": "object"
            }
         ],
         "default": null,
         "description": "Read EODAG documentation for all supported geometry format.",
         "title": "Geometry"
      },
      "id": {
         "default": null,
         "title": "Id",
         "type": "string"
      }
   },
   "required": []
}

Config:

arbitrary_types_allowed: bool = True

Validators:

check_date_range » ecmwf_date

field end: Annotated[str, Field(None, alias='end_datetime', description="Date/time as string in ISO 8601 format (e.g. '2024-06-10T12:00:00Z')")] (alias 'end_datetime')#: Date/time as string in ISO 8601 format (e.g. ‘2024-06-10T12:00:00Z’)

field geom: Annotated[Union[str, dict[str, float], BaseGeometry], Field(None, alias=AliasChoices('geometry', 'intersects'), description='Read EODAG documentation for all supported geometry format.')] (alias 'AliasChoices(choices=['geometry', 'intersects'])')#: Read EODAG documentation for all supported geometry format.

field id: Annotated[str, Field(None)]#

field start: Annotated[str, Field(None, alias=AliasChoices('start_datetime', 'datetime'), description="Date/time as string in ISO 8601 format (e.g. '2024-06-10T12:00:00Z')")] (alias 'AliasChoices(choices=['start_datetime', 'datetime'])')#: Date/time as string in ISO 8601 format (e.g. ‘2024-06-10T12:00:00Z’)

validator check_date_range » ecmwf_date[source]#

Validate date ranges

Parameters:: v (str)
Return type:: str

Queryables

Contents

Queryables#