Skip to main content

Compute Program Diff

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).

Path Parameters
pipeline_name string REQUIRED

Unique pipeline name

Request Body REQUIRED

The proposed new SQL program and/or runtime version (both optional)

program_code string

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

runtime_version string

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.

Responses
200

Diff successfully computed

Schema OPTIONAL
added_input_connectors string[]
added_output_connectors string[]
modified_input_connectors string[]
modified_output_connectors string[]
program_diff object OPTIONAL

Summary of changes in the program between checkpointed and new versions.

added_tables string[]
added_views string[]
modified_tables string[]
modified_views string[]
removed_tables string[]
removed_views string[]
program_diff_error string OPTIONAL
removed_input_connectors string[]
removed_output_connectors string[]
400

The new program failed to compile or the change cannot be bootstrapped

Schema OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

404

Pipeline does not exist or its current program has not been compiled

Schema OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

500
Schema OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

503

The compiler service is unavailable

Schema OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

504

The compiler did not respond within the configured timeout

Schema OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.