Skip to main content
Ctrl+K
Open Data Cube 1.9 documentation - Home Open Data Cube 1.9 documentation - Home
  • Overview
  • Setup
  • Analysis
  • API
  • About
  • GitHub
  • Discord
  • Overview
  • Setup
  • Analysis
  • API
  • About
  • GitHub
  • Discord

Section Navigation

Core Classes & Data Model

  • Datacube Class
  • Dataset
  • Product
  • Geometry Classes
  • Measurement
  • Metadata Type
  • LineageTree
  • Range
  • Query

Querying & Loading Data

  • Dataset & Product Discovery
  • Dataset Querying
    • datacube.index.abstract.AbstractDatasetResource.get
    • datacube.index.abstract.AbstractDatasetResource.search
    • datacube.index.abstract.AbstractDatasetResource.search_by_metadata
    • datacube.index.abstract.AbstractDatasetResource.search_by_product
    • datacube.index.abstract.AbstractDatasetResource.search_eager
    • datacube.index.abstract.AbstractDatasetResource.search_product_duplicates
    • datacube.index.abstract.AbstractDatasetResource.search_returning
    • datacube.index.abstract.AbstractDatasetResource.search_summaries
    • datacube.index.abstract.AbstractDatasetResource.has
    • datacube.index.abstract.AbstractDatasetResource.bulk_has
    • datacube.index.abstract.AbstractDatasetResource.can_update
    • datacube.index.abstract.AbstractDatasetResource.count
    • datacube.index.abstract.AbstractDatasetResource.count_by_product
    • datacube.index.abstract.AbstractDatasetResource.count_by_product_through_time
    • datacube.index.abstract.AbstractDatasetResource.count_product_through_time
    • datacube.index.abstract.AbstractDatasetResource.get_derived
    • datacube.index.abstract.AbstractDatasetResource.get_field_names
    • datacube.index.abstract.AbstractDatasetResource.get_locations
    • datacube.index.abstract.AbstractDatasetResource.get_archived_locations
    • datacube.index.abstract.AbstractDatasetResource.get_datasets_for_location
  • Product Querying
  • Data Loading
  • Masking

Managing Data

  • Dataset Writing
  • Product Writing
  • Index API

Configuration API

  • Configuration API

Utilities

  • Amazon Web Services (AWS)
  • Writing GeoTIFFs
  • Dask
  • Geometry
  • API
  • Dataset Querying
  • datacube.index.abstract.AbstractDatasetResource.search

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 results

  • query (str | float | int | Range | datetime | Not) – search query parameters

Return type:

Iterable[Dataset]

Returns:

Matching datasets

On this page
  • AbstractDatasetResource.search()
Edit on GitHub

Built with the PyData Sphinx Theme 0.16.1.