Records

AsyncCogniteClient.data_modeling.records.delete(...)

Delete records from a stream.

AsyncCogniteClient.data_modeling.records.ingest(...)

Ingest records into a stream.

AsyncCogniteClient.data_modeling.records.upsert(...)

Upsert records into a stream.

Records data classes

class cognite.client.data_classes.data_modeling.records.RecordContainerId(*args: Any, **kwargs: Any)

Bases: ContainerId

Container reference used as a source in a record write.

Parameters:

  • space (str) – Space that contains the container.

  • external_id (str) – External ID of the container.

class cognite.client.data_classes.data_modeling.records.RecordId(space: 'str', external_id: 'str')

Bases: InstanceId

class cognite.client.data_classes.data_modeling.records.RecordIdSequence(
identifiers: list[T_Identifier],
is_singleton: bool,
)

Bases: IdentifierSequenceCore[RecordId]

class cognite.client.data_classes.data_modeling.records.RecordSource(
source: RecordContainerId,
properties: dict[str, Any],
)

Bases: CogniteResource

Container source with property values for a record write.

Parameters:

  • source (RecordContainerId) – Reference to the container.

  • properties (dict[str, Any]) – The data to write to the source container.

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:

camel_case (bool) – Use camelCase for attribute names. Defaults to True.

Returns:

A dictionary representation of the instance.

Return type:

dict[str, Any]

class cognite.client.data_classes.data_modeling.records.RecordWrite(
space: str,
external_id: str,
sources: list[RecordSource],
)

Bases: WriteableCogniteResource[RecordWrite]

Write representation of a record, used for ingest and upsert.

This is the write version of Record.

Parameters:

  • space (str) – Space the record belongs to.

  • external_id (str) – External ID of the record (1-256 chars, no null bytes).

  • sources (list[RecordSource]) – Container property values to write (1-100 sources).

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:

camel_case (bool) – Use camelCase for attribute names. Defaults to True.

Returns:

A dictionary representation of the instance.

Return type:

dict[str, Any]

class cognite.client.data_classes.data_modeling.records.RecordWriteList(
resources: Sequence[T_CogniteResource],
)

Bases: CogniteResourceList[RecordWrite]

A list of RecordWrite objects.