Elements runtime reference / Live streaming

`emitProgress`

Emit a live progress/status event during ExecuteStream runs.

Terug naar builtin index Signatuur Payloadformaat Voorbeeld Scope-notities

Signatuur

emitProgress(payload=None, **kwargs)

Emit a live progress/status event during ExecuteStream runs.

Use these fields as the Python call arguments or keyword payload for this helper.

{
  "phase": "running",
  "message": "Loaded batch",
  "progressPercent": 50,
  "details": {
    "batch": 2
  }
}

Field	Description
`payload`	Optional dict with phase, message, progressPercent, and details.
`kwargs`	Merged into payload.

{
  "event": "progress",
  "phase": "running",
  "message": "Loaded batch",
  "progressPercent": 50,
  "details": {
    "batch": 2
  }
}

def run():
    emitProgress(phase="running", message="Loaded batch", progressPercent=50)
    return {"ok": True}

Progress events do not add datasource rows.
Use for live datasource streams and long-running executions where the caller consumes stream events.