上章节中提到了内置过程函数,用来创建全文索引。Neo4j本身内置过程函数的功能其实不多,为了方便我们使用到更多的内置过程函数,我们引入了APOC。
一、什么是APOC?用来做什么?
APOC代表Awesome Procedures on Cypher。在发布APOC之前,开发人员需要编写自己的过程和函数,以实现Cypher或Neo4j数据库尚未实现的常见功能。每个开发人员可能会编写自己的这些函数版本,从而导致大量重复。
因此,我们的Neo4j开发人员之一将APOC库创建为通用程序和功能的标准实用程序库。这使跨平台和行业的开发人员可以将标准库用于通用过程,而仅为业务逻辑和特定于用例的需求编写自己的功能。
Neo4j 3.x引入了用户定义的过程和功能的概念。APOC库被认为是Neo4j最大,使用最广泛的扩展库。它包括450多个标准过程,提供实用程序,转换,图形更新等功能。它们得到了很好的支持,并且非常容易作为单独的函数运行或包含在Cypher查询中。
从Neo4j 4.1.1开始,有两个可用的APOC库版本:
APOC Core:与没有外部依赖性或不需要配置的强化过程和功能进行战斗。
APOC Full:包含APOC核心中的所有内容以及其他过程和功能。
⚠️ APOC Full包含APOC Core中包含的所有过程和功能。您不能同时安装两个库。二、如何安装?
如果要使用APOC的库,需要先安装APOC的jar包。由于APOC依赖Neo4j的内部API,因此您需要为Neo4j安装使用匹配的APOC版本。确保Neo4j和APOC之间的前两个版本号匹配。我这里用的是3.5的版本。下载地址:
https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/3.5.0.11
将下载好的jar文件移动到neo4j的安装目录plugins文件夹下,然后重新启动neo4j
neo4j restart
在浏览器界面输入CALL apoc.help('text'),如果成功返回结果。则表示安装成功了。
三、如何使用?
与内置函数一样,用户定义的函数可以在任何表达式或谓词中使用。可以通过以下方式将过程称为独立程序:CALL procedure.name();
也可以将它们集成到Cypher语句中,这使它们功能更加强大。
APOC库附带该apoc.help
过程,可用于过程和功能发现。
运行call apoc.help('keyword')
将列出名称中包含关键字的所有过程和函数。如果未提供关键字,它将返回所有APOC过程和功能的列表,以及它们的签名和描述。
接下来我们以导入CSV文件为例子说明APOC的使用。
要读取文件,必须启用config选项:
apoc.import.file.enabled = true
默认情况下,文件路径是全局的,用于相对于import
目录集的路径:
apoc.import.file.use_neo4j_config = true
test.csv
name,age,beverage
Selma,9,Soda
Rana,12,Tea;MilkSelina,19,Cola
CALL apoc.load.csv('test.csv')
YIELD lineNo, map, list
RETURN *;
lineNolistmap
0
["Selma", "9", "Soda"]
{name: "Selma", age: "9", beverage: "Soda"}
1
["Rana", "12", "Tea;Milk"]
{name: "Rana", age: "12", beverage: "Tea;Milk"}
2
["Selina", "19", "Cola"]
{name: "Selina", age: "19", beverage: "Cola"}
除了文件之外,您还可以传入配置映射:
姓名默认描述
skip
none
跳过结果行
limit
none
限制结果行
header
true
文件是否具有标题
sep
','
分隔符或“ TAB”
quoteChar
'"'
用于引用元素的字符
arraySep
';'
数组分隔符
ignore
[]
哪些列要忽略
nullValues
[]
将哪些值视为空值,例如 ['na',false]
mapping
{}
对于每个字段映射,输入键是字段名称。例如,{years:{….}
请参见下文
表2.mapping
条目中每个字段的映射配置姓名默认描述
type
none
'int','string'等
array
false
指示字段是否为数组
arraySep
';'
数组分隔符
name
none
重命名字段
ignore
false
忽略/删除此字段
nullValues
[]
将哪些值视为空值,例如 ['na',false]
CALL apoc.load.csv('test.csv', {skip:1, limit:1, header:true, ignore:['name'],
mapping:{
age: {type:'int'},
beverage: {array:true, arraySep:';', name:'drinks'}
}
})
YIELD lineNo, map, list
RETURN *;
本篇文章主要是以APOC使用为主,后续文章会继续讲解APOC中常用的过程函数。
- 本期完 -