Built in Help

The APOC library ships with the apoc.help procedure, which can be used for procedure and function discovery.

apoc help apoc

Running call apoc.help('keyword') will lists all procedures and functions that have the keyword in their name. If no keyword is provided, it will return a list of all APOC procedures and functions, along with their signatures and descriptions.

If you use RETURN apoc.version() it displays the current APOC version.

To generate the help output, this procedure uses SHOW PROCEDURES and SHOW FUNCTIONS.

Procedure & Function Signatures

To call procedures correctly, you need to know their parameter names, types and positions. And for YIELDing their results, you have to know the output column names and types.

INFO:The signatures are shown in error messages, if you use a procedure incorrectly.

You can see the procedures signature in the output of CALL apoc.help("name")

CALL apoc.help("levenshteinDistance")

The signature is always name : : TYPE, so in this case:

(text1 :: STRING?, text2 :: STRING?)
Table 1. Parameter Explanation
Name Type

Procedure Parameters





Output Return Columns