Pause the workflow execution

Pausing the workflow stops auto-advancing and marks the workflow state so that no new jobs are dispatched. It does not cancel currently running jobs.

Usage

bg_pause(project)

Arguments

project

A bg_handle.

Value

Invisibly, a minimal acknowledgement list with elements state and workflow_state, both "paused". Unlike bg_resume(), this does not return the full project status; call bg_status() for that.

Details

In a synchronous runtime the pause marker prevents the next bg_run call from starting work. Under parallel execution, pause takes effect at wave boundaries: the current wave finishes, then the run stops before the next wave starts. bg_resume clears the flag. This API is experimental.