Iterate over data sets

async AsyncCogniteClient.data_sets.__call__(
chunk_size: int | None = None,
metadata: dict[str, str] | None = None,
created_time: dict[str, Any] | TimestampRange | None = None,
last_updated_time: dict[str, Any] | TimestampRange | None = None,
external_id_prefix: str | None = None,
write_protected: bool | None = None,
limit: int | None = None,
) → AsyncIterator[DataSet] | AsyncIterator[DataSetList]

Iterate over data sets

Fetches data sets as they are iterated over, so you keep a limited number of data sets in memory.

Parameters:

  • chunk_size (int | None) – Number of data sets to return in each chunk. Defaults to yielding one data set a time.

  • metadata (dict[str, str] | None) – Custom, application-specific metadata. String key -> String value.

  • created_time (dict[str, Any] | TimestampRange | None) – Range between two timestamps.

  • last_updated_time (dict[str, Any] | TimestampRange | None) – Range between two timestamps.

  • external_id_prefix (str | None) – Filter by this (case-sensitive) prefix for the external ID.

  • write_protected (bool | None) – Specify whether the filtered data sets are write-protected, or not. Set to True to only list write-protected data sets.

  • limit (int | None) – Maximum number of data sets to return. Defaults to return all items.

Yields:

DataSet | DataSetList – yields DataSet one by one if chunk is not specified, else DataSetList objects.