descriptionstring
Human-readable description of the pipeline. Default is an empty string.
tagsstring[]
Free-form labels used to organize, group, and filter pipelines.
Default is no tags (empty vector).
created_atstring date-time required
deployment_desired_status'Stopped' | 'Unavailable' | 'Standby' | 'Paused' | 'Running' | 'Suspended' required
deployment_desired_status_sincestring date-time required
deployment_idstring uuid nullable
deployment_initial'Unavailable' | 'Coordination' | 'Standby' | 'Paused' | 'Running' | 'Suspended'
deployment_resources_desired_status'Stopped' | 'Provisioned' required
deployment_resources_desired_status_sincestring date-time required
deployment_resources_status'Stopped' | 'Provisioning' | 'Provisioned' | 'Stopping' required
Pipeline resources status.
/start (early start or provision check failed)
┌───┐
│ ▼
Stopped ◄────────── Stopping
/start │ ▲
│ │ /stop?force=true
│ │ OR: timeout (from Provisioning)
▼ │ OR: fatal runtime or resource error
⌛Provisioning ────────────│ OR: runtime status is Suspended
│ │
│ │
▼ │
Provisioned ─────────────┘
Desired and actual status
We use the desired state model to manage the lifecycle of a pipeline. In this model, the
pipeline has two status attributes associated with it: the desired status, which represents
what the user would like the pipeline to do, and the current status, which represents the
actual (last observed) status of the pipeline. The pipeline runner service continuously monitors
the desired status field to decide where to steer the pipeline towards.
There are two desired statuses:
- Provisioned (set by invoking /start)
- Stopped (set by invoking /stop?force=true)
The user can monitor the current status of the pipeline via the GET /v0/pipelines/{name}
endpoint. In a typical scenario, the user first sets the desired status, e.g., by invoking the
/start endpoint, and then polls the GET /v0/pipelines/{name} endpoint to monitor the actual
status of the pipeline until its deployment_resources_status attribute changes to
Provisioned indicating that the pipeline has been successfully provisioned, or Stopped with
deployment_error being set.
deployment_resources_status_detailsunknown
deployment_resources_status_sincestring date-time required
deployment_runtime_desired_status'Unavailable' | 'Coordination' | 'Standby' | 'Paused' | 'Running' | 'Suspended'
deployment_runtime_desired_status_sincestring date-time nullable
deployment_runtime_status'Unavailable' | 'Coordination' | 'Standby' | 'Initializing' | 'AwaitingApproval' | 'Bootstrapping' | 'Replaying' | 'Paused' | 'Running' | 'Suspended' | 'ConcurrentBootstrapping' | 'Synchronizing'
Runtime status of the pipeline.
Of the statuses, only Unavailable is determined by the runner. All other statuses are
determined by the pipeline and taken over by the runner.
deployment_runtime_status_sincestring date-time nullable
deployment_status'Stopped' | 'Provisioning' | 'Unavailable' | 'Coordination' | 'Standby' | 'AwaitingApproval' | 'Initializing' | 'Bootstrapping' | 'ConcurrentBootstrapping' | 'Synchronizing' | 'Replaying' | 'Paused' | 'Running' | 'Suspended' | 'Stopping' required
deployment_status_sincestring date-time required
platform_versionstring required
program_codestring required
program_status'Pending' | 'CompilingSql' | 'SqlCompiled' | 'CompilingRust' | 'Success' | 'SqlError' | 'RustError' | 'SystemError' required
Program compilation status.
program_status_sincestring date-time required
program_versioninteger required
refresh_versioninteger required
storage_status'Cleared' | 'InUse' | 'Clearing' required
Storage status.
The storage status can only transition when the resources status is Stopped.
Cleared ───┐
▲ │
/clear │ │
│ │
Clearing │
▲ │
│ │
InUse ◄───┘