STOP PIPELINE

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. Refer to 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:

  SQL

  Copy

  STOP ALL PIPELINES;

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

• Refer to the Permissions Matrix for the required permissions.

Examples

STOP PIPELINE mypipeline;

SHOW PIPELINES;

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

STOP ALL PIPELINES;

SHOW PIPELINES;

+-----------------------+---------+-----------+
| Pipelines_in_examples | State   | Scheduled |
+-----------------------+---------+-----------+
| nfbooks               | Stopped | False     |
| books                 | Stopped | False     |
+-----------------------+---------+-----------+