datacube.index.abstract.AbstractDatasetResource.get#

AbstractDatasetResource.get(id_, include_sources=False, include_deriveds=False, max_depth=0)[source]#

Get dataset by id (Return None if id_ does not exist).

  • Index drivers supporting the legacy lineage API:

Parameters:

  • id_ (str | UUID) – id of the dataset to retrieve

  • include_sources (bool) – include the full provenance tree of the dataset.

Return type:

Dataset | None

  • Index drivers supporting the external lineage API:

Parameters:

  • id_ – id of the dataset to retrieve

  • include_sources – include the full provenance tree for the dataset.

  • include_deriveds (bool) – include the full derivative tree for the dataset.

  • max_depth (int) – The maximum depth of the source and/or derived tree. Defaults to 0, meaning no limit.