apoc.help
This procedure is not considered safe to run from multiple threads. It is therefore not supported by the parallel runtime. For more information, see the Cypher Manual → Parallel runtime. |
Syntax |
|
||
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 |
|
|
A keyword to filter the results by. |
|
Return arguments |
Name |
Type |
Description |
|
|
Whether it is a function or a procedure. |
|
|
|
The name of the function or procedure. |
|
|
|
The description of the function or procedure. |
|
|
|
The signature of the function or procedure. |
|
|
|
This value is always null. |
|
|
|
This value is always null. |
|
|
|
If the function or procedure belongs to APOC Core. |
|
|
|
If the function or procedure is deprecated. |
Usage examples
CALL apoc.help('apoc.atomic.add')
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
CALL apoc.help('atomic')
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+