Run transformations by id

async AsyncCogniteClient.transformations.run(
transformation_id: int | None = None,
transformation_external_id: str | None = None,
wait: bool = True,
timeout: float | None = None,
) → TransformationJob

Run a transformation.

Parameters:

  • transformation_id (int | None) – Transformation internal id

  • transformation_external_id (str | None) – Transformation external id

  • wait (bool) – Wait until the transformation run is finished. Defaults to True.

  • timeout (float | None) – maximum time (s) to wait, default is None (infinite time). Once the timeout is reached, it returns with the current status. Won’t have any effect if wait is False.

Returns:

Created transformation job

Return type:

TransformationJob

Examples

Run transformation to completion by id:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>>
>>> res = client.transformations.run(transformation_id=1)

Start running transformation by id:

>>> res = client.transformations.run(transformation_id=1, wait=False)