Checking if a pipeline exists

We can check if a pipeline is available in the catalog by looking up its name.

Syntax

Check if a pipeline exists in the catalog:
CALL gds.pipeline.exists(pipelineName: String)
YIELD
    pipelineName: String,
    pipelineType: String,
    exists: Boolean
Table 1. Parameters
Name Type Default Optional Description

pipelineName

String

n/a

no

The name of a pipeline.

Table 2. Results
Name Type Description

pipelineName

String

The name of a pipeline.

pipelineType

String

The type of the pipeline.

exists

Boolean

True, if the pipeline exists in the pipeline catalog.

Example

In this section we are going to demonstrate the usage of gds.pipeline.exists. To exemplify this, we create a node classification pipeline and check for its existence.

Creating a node classification training pipeline:
CALL gds.beta.pipeline.nodeClassification.create('pipe')
Check if a pipeline exists in the catalog:
CALL gds.pipeline.exists('pipe')
Table 3. Results
pipelineName pipelineType exists

"pipe"

"Node classification training pipeline"

true