CLI and automation
Operations commands
Look up what happened to a create, provision, start, pause or stop command from its idempotency key, when the response was lost.
An operation is the record SQL Flow keeps when a command carries an idempotency key. The sqlflow operation status command reads that record back. Use it when a command ran but its answer never reached you, for example because the connection dropped, and you need to know whether the command took effect. For how keys work, see Idempotency keys and CI/CD. Set up the CLI first: see Overview and authentication.
Check an operation
sqlflow operation status --idempotency-key <key>| Option | Description |
|---|---|
--idempotency-key <key> | The key you gave to pipeline create, provision, start, pause or stop. Required. |
The command prints one line of JSON and exits with code 0:
sqlflow operation status --idempotency-key release-418-orders-start{"operation":{"id":"op-1f3a9c27b84d5e06","pipelineId":"orders","status":"accepted","createdAt":"2026-10-15T08:12:44+00:00","command":"start","agentIds":["agent-3f9c0a7e1b"],"commandIds":["c5a2e1d4"]},"replayed":true}| Field | Meaning |
|---|---|
operation.id | The operation's ID. |
operation.pipelineId | The pipeline the operation concerns. |
operation.status | accepted |
operation.createdAt | When the operation was recorded. |
operation.command, agentIds, commandIds | For a command sent to agents, such as start: the command and the agents and commands it was queued for. They are empty for the other operations. |
replayed | Always true for this command, because it only reads an operation that already exists. |
accepted means SQL Flow recorded the operation and queued its effect. It doesn't mean the agent finished the work. To follow the work, use pipeline status.
In PowerShell, turn the output into an object:
$op = sqlflow operation status --idempotency-key release-418-orders-start | ConvertFrom-Json
$op.operation.statusErrors
| Message | Cause |
|---|---|
missing required option --idempotency-key. | You didn't give a key. |
… failed (404 Not Found): Not Found | No operation is recorded for this key. Either the original command never reached the control plane, so it is safe to run it again with the same key, or the key was used by another user or in another account. |
… failed (400 Bad Request): Idempotency-Key must be one non-empty printable ASCII value no longer than 200 characters. [invalid_idempotency_key] | The key is empty, too long, or contains a space or a non-ASCII character. |
