apoc.load.directory.async.add
过程 Apoc 扩展
apoc.load.directory.async.add(name, cypher, pattern, urlDir, {}) YIELD name, status, pattern, cypher, urlDir, config, error - 添加或替换具有特定名称的文件夹监听器，该监听器在所有具有给定模式的文件触发时执行指定的 Cypher 查询。返回所有监听器的列表。可以在配置参数中指定事件类型。
签名
apoc.load.directory.async.add(name :: STRING?, cypher :: STRING?, pattern = * :: STRING?, urlDir = :: STRING?, config = {} :: MAP?) :: (name :: STRING?, status :: STRING?, pattern :: STRING?, cypher :: STRING?, urlDir :: STRING?, config :: MAP?, error :: STRING?)输入参数
| 名称 | 类型 | 默认 |
|---|---|---|
名称 (name) |
STRING? |
null |
cypher |
STRING? |
null |
pattern |
STRING? |
* |
urlDir |
STRING? |
|
config |
MAP? |
{} |
配置参数
该过程支持以下配置参数
| 名称 (name) | type | 默认 | description（描述） |
|---|---|---|---|
interval |
整数 |
1000 |
重新监视目录更改后的时间间隔（以毫秒为单位） |
listenEventType |
List<Enum> |
List.of("CREATE", "DELETE", "MODIFY") |
触发执行 Cypher 查询的事件类型，即指定文件夹中文件的创建 (CREATE)、删除 (DELETE) 或编辑 (MODIFY) |
输出参数
| 名称 | 类型 |
|---|---|
名称 (name) |
STRING? |
状态 (status) |
STRING? |
pattern |
STRING? |
cypher |
STRING? |
urlDir |
STRING? |
config |
MAP? |
错误 (error) |
STRING? |
用法示例
关于 apoc.load.directory.async.add 过程参数的补充信息
-
name 参数定义分配给触发器的名称。如果名称已存在，则现有触发器将被覆盖。
-
cypher 参数应包含一个 Cypher 查询，该查询将在触发器激活时执行。
-
pattern 参数描述了触发器应考虑的文件。该模式支持使用“?”和“*”来表示单个或多个通配符，更多信息请参阅 WildcardFileFilter - Apache Commons IO。默认值：*
-
urlDir 参数定义了监视更改的目录。默认值：空字符串，即观察
import目录 -
config 参数允许进行额外配置。默认值：{}
Cypher 查询中已知的额外触发器事件上下文参数
Cypher 查询可以包含以下参数，以提供有关触发器事件的额外上下文：
-
$fileName：触发事件的文件名称
-
$filePath：如果
apoc.import.file.use_neo4j_config=false，则为触发事件的文件的绝对路径；否则为从$IMPORT_DIR开始的相对路径 -
$fileDirectory：如果
apoc.import.file.use_neo4j_config=false，则为触发事件的文件的绝对路径目录；否则为从$IMPORT_DIR开始的相对路径 -
$listenEventType：触发的事件（"CREATE"、"DELETE" 或 "MODIFY"）。当文件插入文件夹时发生 "CREATE" 事件，当文件从文件夹中移除时发生 "DELETE" 事件，当文件夹中的文件发生更改时发生 "MODIFY" 事件。
| 如果重命名文件，将触发 2 个事件，先是 "DELETE"，然后是 "CREATE"。 |