Iterate over containers

async AsyncCogniteClient.data_modeling.containers.__call__(
chunk_size: int | None = None,
space: str | None = None,
include_global: bool = False,
used_for: Literal['node', 'edge', 'record', 'all'] | Sequence[Literal['node', 'edge', 'record', 'all']] | None = None,
limit: int | None = None,
) → AsyncIterator[Container] | AsyncIterator[ContainerList]

Iterate over containers

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

Parameters:

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

  • space (str | None) – The space to query.

  • include_global (bool) – Whether the global containers should be returned.

  • used_for (ContainerUsedFor | Sequence[ContainerUsedFor] | None) – Only include containers marked for these purposes. If omitted, containers of every kind (nodes, edges, and records) are returned.

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

Yields:

Container | ContainerList – yields Container one by one if chunk_size is not specified, else ContainerList objects.