Sign in
Pipeline Lifecycle

Compute Program Diff

Required role: write or higher.

Compute the diff between the pipeline's current program and a proposed new version, without modifying or restarting the pipeline.

The diff lists the tables, views, and connectors that would be added, removed, or modified. It is the same diff shown when approving changes during bootstrapping, letting you preview the effect of a change before applying it.

The baseline is the pipeline's currently configured program compiled with its runtime, not necessarily the program in the latest checkpoint (which may have been produced by a different program or runtime version).

post/v0/pipelines/{pipeline_name}/diff

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

pipeline_namestring required

Unique pipeline name

Request body

program_codestring nullable

New SQL program code to compare against. If omitted, the pipeline's current program code is used.

runtime_versionstring nullable

Runtime version to compile the new program with: a version tag (vX.Y.Z) or a 40-character git SHA. If omitted, the platform's default runtime is used.

Response

Diff successfully computed

added_input_connectorsstring[] required
added_output_connectorsstring[] required
modified_input_connectorsstring[] required
modified_output_connectorsstring[] required
program_diff_errorstring nullable
removed_input_connectorsstring[] required
removed_output_connectorsstring[] required

Changes

No recorded changes to this operation across all 51 revisions of this API.