apoc.help

This procedure is not considered safe to run from multiple threads. It is therefore not supported by the parallel runtime (introduced in Neo4j 5.13). For more information, see the Cypher Manual → Parallel runtime.

Details
Syntax	`apoc.help(proc) :: (type, name, text, signature, roles, writes, core, isDeprecated)`
Description	Returns descriptions of the available APOC procedures and functions. If a keyword is provided, it will return only those procedures and functions that have the keyword in their name.
Input arguments	Name	Type	Description
Input arguments	`proc`	`STRING`	A keyword to filter the results by.
Return arguments	Name	Type	Description
	`type`	`STRING`	Whether it is a function or a procedure.
	`name`	`STRING`	The name of the function or procedure.
	`text`	`STRING`	The description of the function or procedure.
	`signature`	`STRING`	The signature of the function or procedure.
	`roles`	`LIST<STRING>`	This value is always null.
	`writes`	`BOOLEAN`	This value is always null.
	`core`	`BOOLEAN`	If the function or procedure belongs to APOC Core.
	`isDeprecated`	`BOOLEAN`	If the function or procedure is deprecated.

Usage examples

Return information about a specific procedure or function

CALL apoc.help('apoc.atomic.add')

Result

+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| type        | name              | text                                                                                                                                               | signature                                                                                                                                                                                        | roles | writes | core | isDeprecated |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| "procedure" | "apoc.atomic.add" | "Sets the given property to the sum of itself and the given `INTEGER` or `FLOAT` value. The procedure then sets the property to the returned sum." | "apoc.atomic.add(container :: ANY, propertyName :: STRING, number :: INTEGER | FLOAT, retryAttempts = 5 :: INTEGER) :: (container :: ANY, property :: STRING, oldValue :: ANY, newValue :: ANY)" | NULL  | NULL   | TRUE | FALSE        |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Return information about a group of procedures or functions

CALL apoc.help('atomic')

Result

+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| type        | name                   | text                                                                                                                                                 | signature                                                                                                                                                                                                   | roles | writes | core | isDeprecated |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| "procedure" | "apoc.atomic.add"      | "Sets the given property to the sum of itself and the given `INTEGER` or `FLOAT` value. The procedure then sets the property to the returned sum."   | "apoc.atomic.add(container :: ANY, propertyName :: STRING, number :: INTEGER | FLOAT, retryAttempts = 5 :: INTEGER) :: (container :: ANY, property :: STRING, oldValue :: ANY, newValue :: ANY)"            | NULL  | NULL   | TRUE | FALSE        |
| "procedure" | "apoc.atomic.concat"   | "Sets the given property to the concatenation of itself and the `STRING` value. The procedure then sets the property to the returned `STRING`."      | "apoc.atomic.concat(container :: ANY, propertyName :: STRING, string :: STRING, retryAttempts = 5 :: INTEGER) :: (container :: ANY, property :: STRING, oldValue :: ANY, newValue :: ANY)"                  | NULL  | NULL   | TRUE | FALSE        |
| "procedure" | "apoc.atomic.insert"   | "Inserts a value at position into the `LIST<ANY>` value of a property. The procedure then sets the result back on the property."                     | "apoc.atomic.insert(container :: ANY, propertyName :: STRING, position :: INTEGER, value :: ANY, retryAttempts = 5 :: INTEGER) :: (container :: ANY, property :: STRING, oldValue :: ANY, newValue :: ANY)" | NULL  | NULL   | TRUE | FALSE        |
| "procedure" | "apoc.atomic.remove"   | "Removes the element at position from the `LIST<ANY>` value of a property. The procedure then sets the property to the resulting `LIST<ANY>` value." | "apoc.atomic.remove(container :: ANY, propertyName :: STRING, position :: INTEGER, retryAttempts = 5 :: INTEGER) :: (container :: ANY, property :: STRING, oldValue :: ANY, newValue :: ANY)"               | NULL  | NULL   | TRUE | FALSE        |
| "procedure" | "apoc.atomic.subtract" | "Sets the property of a value to itself minus the given `INTEGER` or `FLOAT` value. The procedure then sets the property to the returned sum."       | "apoc.atomic.subtract(container :: ANY, propertyName :: STRING, number :: INTEGER | FLOAT, retryAttempts = 5 :: INTEGER) :: (container :: ANY, property :: STRING, oldValue :: ANY, newValue :: ANY)"       | NULL  | NULL   | TRUE | FALSE        |
| "procedure" | "apoc.atomic.update"   | "Updates the value of a property with a Cypher operation."                                                                                           | "apoc.atomic.update(container :: ANY, propertyName :: STRING, operation :: STRING, retryAttempts = 5 :: INTEGER) :: (container :: ANY, property :: STRING, oldValue :: ANY, newValue :: ANY)"               | NULL  | NULL   | TRUE | FALSE        |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+