apoc.help

此过程不建议在多线程中运行,因此并行运行时(Parallel runtime)不支持该过程。有关更多信息,请参阅 Cypher 手册 → 并行运行时

详细信息

语法

apoc.help(proc) :: (type, name, text, signature, roles, writes, core, isDeprecated)

描述

返回可用 APOC 过程和函数的说明。如果提供了关键字,则仅返回名称中包含该关键字的过程和函数。

输入参数

名称

类型

描述

proc

STRING

用于筛选结果的关键字。

返回参数

名称

类型

描述

type

STRING

函数或过程的类型。

名称 (name)

STRING

函数或过程的名称。

文本 (text)

STRING

函数或过程的说明。

签名

STRING

函数或过程的签名。

角色

LIST<STRING>

此值始终为 null。

writes (写入)

布尔值 (BOOLEAN)

此值始终为 null。

core

布尔值 (BOOLEAN)

函数或过程是否属于 APOC Core。

isDeprecated

布尔值 (BOOLEAN)

函数或过程是否已弃用。

使用示例

返回有关特定过程或函数的信息
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        |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
© . This site is unofficial and not affiliated with Neo4j, Inc.