STOP PIPELINE

The STOP PIPELINE statement stops a currently running pipeline in a SingleStoreDB Cloud database.

Syntax

STOP PIPELINE [IF RUNNING] pipeline_name [DETACH];
STOP ALL PIPELINES;

Arguments

pipeline_name

The name of the pipeline.

ALL

When ALL is used in the STOP PIPELINE command, all pipelines will stop in the current database.

Remarks

An error will occur if the pipeline is not already running, unless IF RUNNING is specified, in which case the command is ignored.
To stop all pipelines in the current database, run STOP ALL PIPELINES.
This command causes implicit commits. See COMMIT for more information.
Use the DETACH option to temporarily stop a pipeline, without losing offsets, for performing an ALTER on the table that is loaded from an Avro pipeline. See Avro Schema Evolution with Pipelines for details.

To stop a pipeline, a user must have the START PIPELINE permission. Pipelines without the required user access will be skipped and see a message similar to the one below:

STOP ALL PIPELINES;

****
STOP PIPELINE test_pipeline;
ERROR 1142 (42000): STOP PIPELINE command denied to user 'singlestore-4100c00-bd00-0d'@'%' for table 'test_pipeline'

See the Permission Matrix for the required permission.

Examples

Example 1: Stop Pipeline

STOP PIPELINE mypipeline;

To verify that the pipeline was successfully stopped, you can execute SHOW PIPELINES:

SHOW PIPELINES;

****
+-------------------+---------+
| Pipelines_in_mydb | State   |
+-------------------+---------+
| mypipeline        | Stopped |
+-------------------+---------+
1 row in set (0.00 sec)

Example 2: Stop All Pipelines

STOP ALL PIPELINES;