apoc.util.validate

Procedure

apoc.util.validate(predicate BOOLEAN, message STRING, params LIST<ANY>) - if the given predicate is true an exception is thrown.

Signature

apoc.util.validate(predicate :: BOOLEAN, message :: STRING, params :: LIST<ANY>)

Name

Type

Default

predicate

BOOLEAN

null

message

STRING

null

params

LIST<ANY>

null

The following throws an exception because the predicate is true:

WITH true AS predicate
CALL apoc.util.validate(predicate,'message %d',[42])
RETURN count(*);

Table 1. Results
Failed to invoke procedure `apoc.util.validate`: Caused by: java.lang.RuntimeException: message 42

The following does nothing because the predicate is false:

WITH false AS predicate
CALL apoc.util.validate(predicate,'message %d',[42])
RETURN count(*);

Table 2. Results
count(*)
1