start_pipeline
Start or resume a data pipeline to load data, with optional foreground mode to report rows loaded and errors for testing.
Instructions
Start a pipeline so it begins (or resumes) loading data.
Args:
pipeline_name: Name of the pipeline to start.
database: Database the pipeline lives in (defaults to the
connection's configured database).
foreground: If true, run synchronously and report rows loaded /
errors in the result instead of returning immediately. Useful
for a one-off load or for testing a pipeline end to end.
limit_batches: Only valid with foreground=True: stop after this many
batches instead of running indefinitely.
if_not_running: Add IF NOT RUNNING so starting an already-running
pipeline is a no-op instead of an error.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| database | No | ||
| foreground | No | ||
| limit_batches | No | ||
| pipeline_name | Yes | ||
| if_not_running | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||