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)source_filter (
dict
[str
,str
|float
|int
|Range
|datetime
|Not
] |None
) – Filter criteria for sources (None/default = no filtering)archived (
bool
|None
) – False (default): Return active datasets only. None: Include archived and active datasets. True: Return archived datasets only.order_by (
Iterable
[Any
] |None
) – field or expression by which to order resultsquery (
str
|float
|int
|Range
|datetime
|Not
) – search query parameters
- Return type:
- Returns:
Matching datasets