Filter

async AsyncCogniteClient.data_modeling.records.filter(
stream_id: str,
*,
last_updated_time: TimeRange | None = None,
filter: Filter | None = None,
sources: Sequence[RecordSourceSelector] | None = None,
sort: Sequence[InstanceSort] | InstanceSort | None = None,
limit: int = 10,
include_typing: bool = False,
) → RecordList

Filter records in a stream.

Returns records matching the given filters, sorted by lastUpdatedTime unless a custom sort is given.

Parameters:

  • stream_id (str) – External ID of the stream to query.

  • last_updated_time (TimeRange | None) – Filter by last-updated time. Required for immutable streams (must include a lower bound).

  • filter (Filter | None) – Filter expression (see cognite.client.data_classes.filters).

  • sources (Sequence[RecordSourceSelector] | None) – Which container properties to return.

  • sort (Sequence[InstanceSort] | InstanceSort | None) – Sort specification(s); up to 5.

  • limit (int) – Maximum number of records to return (1-1000).

  • include_typing (bool) – If True, include property type information on the returned list’s typing attribute.

Returns:

The matching records.

Return type:

RecordList

Examples

List records updated since a given timestamp:

>>> from cognite.client import CogniteClient
>>> from cognite.client.data_classes.data_modeling.records import TimeRange
>>> client = CogniteClient()
>>> res = client.data_modeling.records.filter(
...     stream_id="my-stream",
...     last_updated_time=TimeRange(gt=1705341600000),
...     limit=100,
... )