apoc.periodic.cancel

Procedure

apoc.periodic.cancel(name STRING) - cancels the given background job. Background jobs are created using apoc.periodic.submit.

Signature

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

Input parameters

Name Type Default

name

STRING

null

Output parameters

Name Type

name

STRING

delay

INTEGER

rate

INTEGER

done

BOOLEAN

cancelled

BOOLEAN

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");
Table 1. Results
name delay rate done cancelled

"create-people"

0

0

TRUE

TRUE