apoc.periodic

Qualified Name Type

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

Procedure

apoc.periodic.commit(statement STRING, params MAP<STRING, ANY>) - runs the given statement in separate batched transactions.

Procedure

apoc.periodic.countdown(name STRING, statement STRING, delay INTEGER) - runs a repeatedly called background statement until it returns 0.

Procedure

apoc.periodic.iterate(cypherIterate STRING, cypherAction STRING, config MAP<STRING, ANY>) - runs the second statement for each item returned by the first statement. This procedure returns the number of batches and the total number of processed rows.

Procedure Deprecated in Cypher 25

apoc.periodic.list() - returns a LIST<ANY> of all background jobs.

Procedure

apoc.periodic.repeat(name STRING, statement STRING, rate INTEGER, config MAP<STRING, ANY>) - runs a repeatedly called background job. To stop this procedure, use apoc.periodic.cancel.

Procedure

apoc.periodic.submit(name STRING, statement STRING, params MAP<STRING, ANY>) - creates a background job which runs the given Cypher statement once.

Procedure

apoc.periodic.truncate(config MAP<STRING, ANY>) - removes all entities (and optionally indexes and constraints) from the database using the apoc.periodic.iterate procedure.

Procedure Admin Only