apoc.periodic.submit

Details

Syntax

apoc.periodic.submit(name, statement [, params ]) :: (name, delay, rate, done, cancelled)

Description

Creates a background job which runs the given Cypher statement once.

Input arguments

Name

Type

Description

name

STRING

The name of the job.

statement

STRING

The Cypher statement to run.

params

MAP

{ params = {} :: MAP } The default is: `{}.

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

CALL apoc.periodic.submit(
  "create-person",
  "CREATE (:Person {name: 'Michael Hunger'})"
);
Results
name delay rate done cancelled

"create-person"

0

0

FALSE

FALSE