apoc.periodic.cancel

Details

Syntax

apoc.periodic.cancel(name) :: (name, delay, rate, done, cancelled)

Description

Cancels the given background job.

Input arguments

Name

Type

Description

name

STRING

The name of the job to cancel.

Return arguments

Name

Type

Description

name

STRING

The name of the job.

delay

INTEGER

The delay on the job.

rate

INTEGER

The rate of the job.

done

BOOLEAN

If the job has completed.

cancelled

BOOLEAN

If the job has been cancelled.

Usage Examples

If we want to cancel the job submitted by the example in apoc.periodic.repeat, we can run the following query:

CALL apoc.periodic.cancel("create-people");
Results
name delay rate done cancelled

"create-people"

0

0

TRUE

TRUE