datacube.index.abstract.AbstractDatasetResource.search#
- abstract AbstractDatasetResource.search(limit=None, source_filter=None, archived=False, order_by=None, **query)[source]#
Perform a search, returning results as Dataset objects.
Prior to dataccube-1.9.0, search always returned datasets sorted by product. From 1.9, no ordering is guaranteed. Ordering of results is now unspecified and may vary between index drivers.
- Parameters:
limit (
int
|None
) – Limit number of datasets per product (None/default = unlimited)archived (
bool
|None
) – False (default): Return active datasets only. None: Include archived and active datasets. True: Return archived datasets only.order_by (
Optional
[Iterable
[Any
]]) – field or expression by which to order resultsgeopolygon – Spatial search polygon (only supported if index supports_spatial_indexes)
query (
str
|float
|int
|Range
|datetime
|Not
) – search query parameters
- Return type:
- Returns:
Matching datasets