Iterate over time series
- async AsyncCogniteClient.time_series.__call__(
- chunk_size: int | None = None,
- name: str | None = None,
- unit: str | None = None,
- unit_external_id: str | None = None,
- unit_quantity: str | None = None,
- is_string: bool | None = None,
- is_step: bool | None = None,
- asset_ids: Sequence[int] | None = None,
- asset_external_ids: SequenceNotStr[str] | None = None,
- asset_subtree_ids: int | Sequence[int] | None = None,
- asset_subtree_external_ids: str | SequenceNotStr[str] | None = None,
- data_set_ids: int | Sequence[int] | None = None,
- data_set_external_ids: str | SequenceNotStr[str] | None = None,
- metadata: dict[str, Any] | None = None,
- external_id_prefix: str | None = None,
- created_time: dict[str, Any] | None = None,
- last_updated_time: dict[str, Any] | None = None,
- limit: int | None = None,
- advanced_filter: Filter | dict[str, Any] | None = None,
- sort: TimeSeriesSort | str | SortableTimeSeriesProperty | tuple[str, Literal['asc', 'desc']] | tuple[str, Literal['asc', 'desc'], Literal['auto', 'first', 'last']] | list[TimeSeriesSort | str | SortableTimeSeriesProperty | tuple[str, Literal['asc', 'desc']] | tuple[str, Literal['asc', 'desc'], Literal['auto', 'first', 'last']]] | None = None,
Iterate over time series
Fetches time series as they are iterated over, so you keep a limited number of objects in memory.
- Parameters:
chunk_size (int | None) – Number of time series to return in each chunk. Defaults to yielding one time series a time.
name (str | None) – Name of the time series. Often referred to as tag.
unit (str | None) – Unit of the time series.
unit_external_id (str | None) – Filter on unit external ID.
unit_quantity (str | None) – Filter on unit quantity.
is_string (bool | None) – Whether the time series is a string time series.
is_step (bool | None) – Whether the time series is a step (piecewise constant) time series.
asset_ids (Sequence[int] | None) – List time series related to these assets.
asset_external_ids (SequenceNotStr[str] | None) – List time series related to these assets.
asset_subtree_ids (int | Sequence[int] | None) – Only include time series that are related to an asset in a subtree rooted at any of these assetIds. If the total size of the given subtrees exceeds 100,000 assets, an error will be returned.
asset_subtree_external_ids (str | SequenceNotStr[str] | None) – Only include time series that are related to an asset in a subtree rooted at any of these assetExternalIds. If the total size of the given subtrees exceeds 100,000 assets, an error will be returned.
data_set_ids (int | Sequence[int] | None) – Return only time series in the specified data set(s) with this id / these ids.
data_set_external_ids (str | SequenceNotStr[str] | None) – Return only time series in the specified data set(s) with this external id / these external ids.
metadata (dict[str, Any] | None) – Custom, application specific metadata. String key -> String value
external_id_prefix (str | None) – Filter by this (case-sensitive) prefix for the external ID.
created_time (dict[str, Any] | None) – Range between two timestamps. Possible keys are min and max, with values given as time stamps in ms.
last_updated_time (dict[str, Any] | None) – Range between two timestamps. Possible keys are min and max, with values given as time stamps in ms.
limit (int | None) – Maximum number of time series to return. Defaults to return all items.
advanced_filter (Filter | dict[str, Any] | None) – Advanced filter query using the filter DSL (Domain Specific Language). It allows defining complex filtering expressions that combine simple operations, such as equals, prefix, exists, etc., using boolean operators and, or, and not.
sort (SortSpec | list[SortSpec] | None) – The criteria to sort by. Defaults to desc for _score_ and asc for all other properties. Sort is not allowed if partitions is used.
- Yields:
TimeSeries | TimeSeriesList – yields TimeSeries one by one if chunk_size is not specified, else TimeSeriesList objects.