过程与函数
apoc.agg
| 限定名称 | 类型 |
|---|---|
返回与给定 |
函数 |
返回与给定 |
过程 |
apoc.agg
| 限定名称 | 类型 |
|---|---|
apoc.agg.multiStats(nodeOrRel, keys) - 返回多维聚合 |
过程 |
apoc.agg.rollup(<ANY>, [groupKeys], [aggKeys]) 模拟 Oracle/Mysql rollup 命令：`ROLLUP groupKeys, SUM(aggKey1), AVG(aggKey1), COUNT(aggKey1), SUM(aggKey2), AVG(aggKey2), … ` |
过程 |
apoc.bolt
| 限定名称 | 类型 |
|---|---|
apoc.bolt.load(url-or-key, kernelTransaction, params, config) - 通过 bolt 访问其他数据库以进行读取 |
过程 |
过程 |
apoc.coll
| apoc.coll.avgDuration apoc.coll.avgDuration([duration('P2DT3H'), duration('PT1H45S'), …]) - 返回持续时间值列表的平均值 | 函数 | apoc.coll.fillObject apoc.coll.fillObject(item, count) - 返回具有给定大小的相等项目的列表 |
|---|
apoc.config
| 限定名称 | 类型 |
|---|---|
apoc.config.list | 将 Neo4j 配置列为键值表 |
过程 |
apoc.config.map | 将 Neo4j 配置列为映射 |
过程 |
apoc.convert
| 限定名称 | 类型 |
|---|---|
apoc.convert.toYaml(value, $config) - 将给定值序列化为 YAML 字符串 |
函数 |
apoc.convert.fromYaml(value, $config) - 将 YAML 字符串反序列化为 Neo4j 值 |
函数 |
apoc.couchbase
| 限定名称 | 类型 |
|---|---|
apoc.couchbase.append(hostOrKey, bucket, documentId, content, config) yield id, expiry, cas, mutationToken, content - 将 Couchbase JSON 文档追加到现有文档中。 |
过程 |
apoc.couchbase.exists(hostOrKey, bucket, documentId, config) yield value - 检查是否存在具有给定 ID 的 Couchbase JSON 文档。 |
过程 |
apoc.couchbase.get(hostOrKey, bucket, documentId, config) yield id, expiry, cas, mutationToken, content - 通过其唯一 ID 检索 Couchbase JSON 文档。 |
过程 |
apoc.couchbase.insert(hostOrKey, bucket, documentId, jsonDocument, config) yield id, expiry, cas, mutationToken, content - 插入具有其唯一 ID 的 Couchbase JSON 文档。 |
过程 |
apoc.couchbase.namedParamsQuery(hostkOrKey, bucket, statement, paramNames, paramValues, config) yield queryResult - 使用命名参数执行 N1QL 语句。 |
过程 |
apoc.couchbase.posParamsQuery(hostOrKey, bucket, statement, params, config) yield queryResult - 使用位置参数执行 N1QL 语句。 |
过程 |
apoc.couchbase.prepend(hostOrKey, bucket, documentId, content, config) yield id, expiry, cas, mutationToken, content - 将 Couchbase JSON 文档附加到现有文档的开头。 |
过程 |
apoc.couchbase.query(hostOrKey, bucket, statement, config) yield queryResult - 执行一个普通的未参数化的 N1QL 语句。 |
过程 |
apoc.couchbase.remove(hostOrKey, bucket, documentId, config) yield id, expiry, cas, mutationToken, content - 删除由唯一 ID 标识的 Couchbase JSON 文档。 |
过程 |
apoc.couchbase.replace(hostOrKey, bucket, documentId, jsonDocument, config) yield id, expiry, cas, mutationToken, content - 替换由唯一 ID 标识的 Couchbase JSON 文档的内容。 |
过程 |
apoc.couchbase.upsert(hostOrKey, bucket, documentId, jsonDocument) yield id, expiry, cas, mutationToken, content - 插入或覆盖具有唯一 ID 的 Couchbase JSON 文档。 |
过程 |
apoc.custom
| 限定名称 | 类型 |
|---|---|
apoc.custom.declareFunction(signature, statement, forceSingle, description) - 注册自定义 Cypher 函数。 |
过程 |
apoc.custom.declareProcedure(signature, statement, mode, description) - 注册自定义 Cypher 过程。 |
过程 |
apoc.custom.list() - 提供已注册的自定义过程/函数列表。 |
过程 |
apoc.custom.removeFunction(name, type) - 删除目标自定义函数。 |
过程 |
apoc.custom.removeProcedure(name) - 删除目标自定义过程。 |
过程 |
apoc.cypher
| 限定名称 | 类型 |
|---|---|
apoc.cypher.mapParallel(fragment, params, list-to-parallelize) yield value - 并行批处理执行片段，列表段分配给 _。 |
过程 |
apoc.cypher.mapParallel2(fragment, params, list-to-parallelize) yield value - 并行批处理执行片段，列表段分配给 _。 |
过程 |
apoc.cypher.parallel(fragment, |
过程 |
apoc.cypher.parallel2(fragment, |
过程 |
apoc.cypher.runFile(file or url,[{statistics:true,timeout:10,parameters:{}}]) - 运行文件中每个语句，所有语句用分号分隔 - 目前没有模式操作。 |
过程 |
apoc.cypher.runFiles([files or urls],[{statistics:true,timeout:10,parameters:{}}])) - 运行文件中每个语句，所有语句用分号分隔。 |
过程 |
apoc.cypher.runFileReadOnly(file or url,[{timeout:10,parameters:{}}]) - 运行文件中每个 |
过程 |
apoc.cypher.runFilesReadOnly([files or urls],[{timeout:10,parameters:{}}])) - 运行文件中每个 |
过程 |
apoc.cypher.runSchemaFile(file or url,[{statistics:true,timeout:10}]) - 仅允许模式操作，运行文件中每个模式语句，所有语句用分号分隔。 |
过程 |
apoc.cypher.runSchemaFiles([files or urls],{statistics:true,timeout:10}) - 仅允许模式操作，运行文件中每个模式语句，所有语句用分号分隔。 |
过程 |
apoc.diff
| 限定名称 | 类型 |
|---|---|
返回一个 Map，详细说明两个给定关系之间的属性差异。 |
函数 |
apoc.data
| 限定名称 | 类型 |
|---|---|
apoc.data.email('email_address') as {personal,user,domain} - 将个人姓名、用户和域名提取为一个 Map。 |
函数 |
apoc.dv
| 限定名称 | 类型 |
|---|---|
添加虚拟化资源配置。 |
过程 |
列出所有虚拟化资源配置。 |
过程 |
按名称删除虚拟化资源配置。 |
过程 |
按名称查询虚拟化资源并返回虚拟节点。 |
过程 |
按名称查询虚拟化资源并返回虚拟节点，使用虚拟关系链接到作为第一个参数传递的节点。 |
过程 |
apoc.es
| 限定名称 | 类型 |
|---|---|
apoc.es.get(host-or-key,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null,$config) yield value - 对 Elasticsearch 执行 GET 操作。 |
过程 |
apoc.es.getRaw(host-or-key,path,payload-or-null,$config) yield value - 对 Elasticsearch 执行原始 GET 操作。 |
过程 |
apoc.es.post(host-or-key,index-or-null,type-or-null,query-or-null,payload-or-null,$config) yield value - 对 Elasticsearch 执行 POST 操作。 |
过程 |
apoc.es.postRaw(host-or-key,path,payload-or-null,$config) yield value - 对 Elasticsearch 执行原始 POST 操作。 |
过程 |
apoc.es.put(host-or-key,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null,$config) yield value - 对 Elasticsearch 执行 PUT 操作。 |
过程 |
apoc.es.query(host-or-key,index-or-null,type-or-null,query-or-null,payload-or-null,$config) yield value - 对 Elasticsearch 执行 SEARCH 操作。 |
过程 |
apoc.es.stats(host-or-key,$config) - Elasticsearch 统计信息。 |
过程 |
apoc.es.delete(host-or-key,index-or-null,type-or-null,id-or-null,query-or-null,$config) yield value - 对 Elasticsearch 执行 DELETE 操作。 |
过程 |
apoc.export
| 限定名称 | 类型 |
|---|---|
apoc.export.xls.all(file,config) - 将整个数据库导出为 xls 到提供的文件。 |
过程 |
apoc.export.xls.data(nodes,rels,file,config) - 将给定的节点和关系导出为 xls 到提供的文件。 |
过程 |
apoc.export.xls.graph(graph,file,config) - 将给定的图形对象导出为 xls 到提供的文件。 |
过程 |
apoc.export.xls.query(query,file,{config,…,params:{params}}) - 将 Cypher 语句的结果导出为 xls 到提供的文件。 |
过程 |
apoc.generate
| 限定名称 | 类型 |
|---|---|
apoc.generate.ba(noNodes, edgesPerNode, label, type) - 根据 Barabasi-Albert 模型生成一个随机图。 |
过程 |
apoc.generate.complete(noNodes, label, type) - 生成一个随机完全图。 |
过程 |
apoc.generate.er(noNodes, noEdges, label, type) - 根据 Erdos-Renyi 模型生成一个随机图。 |
过程 |
apoc.generate.simple(degrees, label, type) - 根据给定的度分布生成一个简单的随机图。 |
过程 |
apoc.generate.ws(noNodes, degree, beta, label, type) - 根据 Watts-Strogatz 模型生成一个随机图。 |
过程 |
apoc.gephi
| 限定名称 | 类型 |
|---|---|
apoc.gephi.add(url-or-key, workspace, data, weightproperty, ['exportproperty']) | 将数据流传递到 Gephi。 |
过程 |
apoc.get
| 限定名称 | 类型 |
|---|---|
apoc.get.nodes(node|id|[ids]) - 快速返回所有具有这些 ID 的节点。 |
过程 |
apoc.get.rels(rel|id|[ids]) - 快速返回所有具有这些 ID 的关系。 |
过程 |
apoc.import
| 限定名称 | 类型 |
|---|---|
apoc.import.arrow(input, $config) - 从提供的箭头文件或字节数组导入箭头。 |
过程 |
apoc.load
| 限定名称 | 类型 |
|---|---|
apoc.load.csv('urlOrBinary',{config}) YIELD lineNo, list, map - 从 URL 加载 CSV 作为值流，config 包含以下任何内容：{skip:1,limit:5,header:false,sep:'TAB',ignore:['tmp'],nullValues:['na'],arraySep:';',mapping:{years:{type:'int',arraySep:'-',array:false,name:'age',ignore:false}} |
过程 |
apoc.load.csvParams('urlOrBinary', {httpHeader: value}, payload, {config}) YIELD lineNo, list, map - 从 CSV URL（例如 web-api）加载，同时发送标头/有效负载以加载 CSV 作为值流，config 包含以下任何内容：{skip:1,limit:5,header:false,sep:'TAB',ignore:['tmp'],nullValues:['na'],arraySep:';',mapping:{years:{type:'int',arraySep:'-',array:false,name:'age',ignore:false}}} |
过程 |
apoc.load.directory('pattern', 'urlDir', {config}) YIELD value - 加载参数 urlDir 指定的文件夹中满足给定模式的所有文件的列表。如果参数 urlDir 未指定或为空，则改为加载导入文件夹的文件。 |
过程 |
apoc.load.directory.async.add(name, cypher, pattern, urlDir, {}) YIELD name, status, pattern, cypher, urlDir, config, error - 添加或替换具有特定名称的文件夹侦听器，该侦听器会为所有具有给定模式的文件触发，并在触发时执行指定的 Cypher 查询。返回所有侦听器的列表。可以在 config 参数中指定事件类型。 |
过程 |
apoc.load.directory.async.list() YIELD name, status, pattern, cypher, urlDir, config, error - 列出所有文件夹侦听器。 |
过程 |
apoc.load.directory.async.remove(name) YIELD name, status, pattern, cypher, urlDir, config, error - 通过名称移除文件夹监听器并返回所有剩余的监听器（如果有） |
过程 |
apoc.load.directory.async.removeAll() - 移除所有文件夹监听器 |
过程 |
apoc.load.driver('org.apache.derby.jdbc.EmbeddedDriver') 注册源数据库的 JDBC 驱动程序 |
过程 |
apoc.load.html('url',{name: jquery, name2: jquery}, config) YIELD value - 加载 Html 页面并将其结果作为 Map 返回 |
过程 |
apoc.load.htmlPlainText('urlOrHtml',{name: jquery, name2: jquery}, config) YIELD value - 加载 Html 页面并将其结果作为 Map 返回 |
过程 |
apoc.load.jdbc('key or url','table or statement', params, config) YIELD row - 从关系数据库加载数据，可以是整个表或 SQL 语句 |
过程 |
apoc.load.jdbcUpdate('key or url','statement',[params],config) YIELD row - 更新关系数据库，通过 SQL 语句并可带可选参数 |
过程 |
apoc.load.ldap("key" or {connectionMap},{searchMap}) 从 ldap 源加载条目 (yield entry) |
过程 |
apoc.load.xls('url','selector',{config}) YIELD lineNo, list, map - 将 XLS 从 URL 加载为行值的流，config 包含以下任何内容：{skip:1,limit:5,header:false,ignore:['tmp'],arraySep:';',mapping:{years:{type:'int',arraySep:'-',array:false,name:'age',ignore:false, dateFormat:'iso_date', dateParse:['dd-MM-yyyy']}} |
过程 |
apoc.log
| 限定名称 | 类型 |
|---|---|
apoc.log.debug(message, params) - 记录调试消息 |
过程 |
apoc.log.error(message, params) - 记录错误消息 |
过程 |
apoc.log.info(message, params) - 记录信息消息 |
过程 |
apoc.log.warn(message, params) - 记录警告消息 |
过程 |
apoc.map
| 限定名称 | 类型 |
|---|---|
重命名 |
函数 |
apoc.metrics
| 限定名称 | 类型 |
|---|---|
apoc.metrics.get(metricName, {}) - 通过指标名称检索系统指标。可以传递其他配置选项，这些选项与 apoc.load.csv 中提供的选项匹配。 |
过程 |
apoc.metrics.list() - 获取可用指标的列表 |
过程 |
apoc.metrics.storage(directorySetting) - 检索 Neo4j 用于数据存储的设备的存储指标。directorySetting 可以是任何有效的 neo4j 目录设置名称，例如“server.directories.data”。如果提供 null 作为 directorySetting，则会返回所有可用的目录设置。有关可用目录设置的列表，请参阅 Neo4j 操作手册中关于配置设置的参考。目录设置**不是**路径，而是 neo4j.conf 设置键名 |
过程 |
apoc.model
| 限定名称 | 类型 |
|---|---|
apoc.model.jdbc('key or url', {schema:'<schema>', write: <true/false>, filters: { tables:[], views: [], columns: []}) YIELD nodes, relationships - 从关系数据库加载模式 |
过程 |
apoc.mongo
| 限定名称 | 类型 |
|---|---|
apoc.mongo.aggregate(uri, pipeline, $config) yield value - 对 mongodb 集合执行聚合操作 |
过程 |
apoc.mongo.count(uri, query, $config) yield value - 对 mongodb 集合执行计数操作 |
过程 |
apoc.mongo.delete(uri, query, $config) - 删除 mongodb 集合中的给定文档并返回受影响的文档数量 |
过程 |
apoc.mongo.find(uri, query, $config) yield value - 对 mongodb 集合执行查找操作 |
过程 |
apoc.mongo.insert(uri, documents, $config) yield value - 将给定的文档插入到 mongodb 集合中 |
过程 |
apoc.mongo.update(uri, query, update, $config) - 更新 mongodb 集合中的给定文档并返回受影响的文档数量 |
过程 |
apoc.mongodb
| 限定名称 | 类型 |
|---|---|
apoc.mongodb.get.byObjectId(hostOrKey, db, collection, objectIdValue, config(default:{})) - 通过 Object id 值获取文档 |
过程 |
apoc.monitor
| 限定名称 | 类型 |
|---|---|
apoc.monitor.ids() 返回此 neo4j 实例正在使用的对象 ID |
过程 |
apoc.monitor.kernel() 返回有关 neo4j 内核的信息 |
过程 |
apoc.monitor.store() 返回有关 neo4j 图存储不同部分大小的信息 |
过程 |
apoc.monitor.tx() 返回有关 neo4j 事务管理器的信息 |
过程 |
apoc.nlp
| 限定名称 | 类型 |
|---|---|
为提供的文本创建（虚拟）实体图 |
过程 |
返回为提供的文本提供的实体流 |
过程 |
为提供的文本创建（虚拟）关键词短语图 |
过程 |
返回为提供的文本提供的关键词短语流 |
过程 |
为提供的文本创建（虚拟）情感图 |
过程 |
返回为提供的文本中的项目提供的情感流 |
过程 |
为提供的文本创建（虚拟）实体图 |
过程 |
为提供的文本提供实体分析 |
过程 |
为提供的文本创建（虚拟）关键词短语图 |
过程 |
为提供的文本提供实体分析 |
过程 |
为提供的文本创建（虚拟）情感图 |
过程 |
为提供的文本提供情感分析 |
过程 |
将文档分类到类别中。 |
过程 |
将文档分类到类别中。 |
过程 |
为提供的文本创建（虚拟）实体图 |
过程 |
返回为提供的文本提供的实体流 |
过程 |
apoc.redis
| 限定名称 | 类型 |
|---|---|
apoc.redis.append(uri, key, value, {config}) | 执行“APPEND key value”命令 |
过程 |
apoc.redis.configGet(uri, parameter, {config}) | 执行“CONFIG GET parameter”命令 |
过程 |
apoc.redis.configSet(uri, parameter, {config}) | 执行“CONFIG SET parameter value”命令 |
过程 |
apoc.redis.copy(uri, source, destination, {config}) | 执行“COPY source destination”命令，如果源被复制则返回 true，否则返回 false |
过程 |
apoc.redis.eval(uri, script, outputType, keys, values, {config}) | 执行“EVAL script”命令。在提供给过程的参数中，键绑定到 KEYS[n] 类似于 Lua 脚本的特殊数组，值绑定到 ARGV[n] 类似于 Lua 脚本的特殊数组。 |
过程 |
apoc.redis.exists(uri, keys, {config}) | 执行“EXISTS keys”命令 |
过程 |
apoc.redis.get(uri, key, {config}) | 执行“GET key”命令 |
过程 |
apoc.redis.hdel(uri, key, fields, {config}) | 执行“HDEL key fields”命令 |
过程 |
apoc.redis.hexists(uri, key, field, {config}) | 执行“HEXISTS key field”命令 |
过程 |
apoc.redis.hget(uri, key, field, {config}) | 执行“HGET key field”命令 |
过程 |
apoc.redis.hgetall(uri, key, {config}) | 执行“HGETALL key”命令 |
过程 |
apoc.redis.hincrby(uri, key, field, amount, {config}) | 执行“HINCRBY key field amount”命令 |
过程 |
apoc.redis.hset(uri, key, field, value, {config}) | 执行“HSET key field value”命令，如果它是散列中的新字段则返回 true，如果字段已存在则返回 false |
过程 |
apoc.redis.incrby(uri, key, amount, {config}) | 执行“INCRBY key increment”命令 |
过程 |
apoc.redis.info(uri, {config}) | 执行“INFO”命令 |
过程 |
apoc.redis.lrange(uri, key, start, stop, {config}) | 执行“LRANGE key start stop”命令 |
过程 |
apoc.redis.persist(uri, key, {config}) | 执行“PERSIST key”命令 |
过程 |
apoc.redis.pexpire(uri, key, time, isExpireAt {config}) | 执行“PEXPIRE key time”命令，或如果 isExpireAt=true 则执行“PEPXPIREAT” |
过程 |
apoc.redis.pop(uri, key, {config}) | 执行“LPOP key”命令，或如果 config right=true（默认值）则执行“RPOP” |
过程 |
apoc.redis.pttl(uri, key, {config}) | 执行“PTTL key”命令 |
过程 |
apoc.redis.push(uri, key, values, {config}) | 执行“LPUSH key field values”命令，或如果 config right=true（默认值）则执行“RPUSH” |
过程 |
apoc.redis.sadd(uri, key, members, {config}) | 执行“SADD key members”命令 |
过程 |
apoc.redis.scard(uri, key, {config}) | 执行 'SCARD key' 命令 |
过程 |
apoc.redis.smembers(uri, key, {config}) | 执行 'SMEMBERS key' 命令 |
过程 |
apoc.redis.spop(uri, key, {config}) | 执行 'SPOP key' 命令 |
过程 |
apoc.redis.sunion(uri, keys, {config}) | 执行 'SUNION keys' 命令 |
过程 |
apoc.redis.zadd(uri, keys, scoresAndMembers, {config}) | 执行 'ZADD key scoresAndMembers' 命令，其中 scoresAndMembers 是一个 score,member,score,member,… 的列表。 |
过程 |
apoc.redis.zcard(uri, key, {config}) | 执行 'ZCARD key' 命令 |
过程 |
apoc.redis.zrangebyscore(uri, key, min, max, {config}) | 执行 'ZRANGEBYSCORE key min max' 命令 |
过程 |
apoc.redis.zrem(uri, key, members, {config}) | 执行 'ZREM key members' 命令 |
过程 |
apoc.static
| 限定名称 | 类型 |
|---|---|
apoc.static.list(prefix) - 从配置 (apoc.static.<prefix>.*) 或服务器生命周期存储中返回静态存储的值 |
过程 |
apoc.static.set(name, value) - 在键下存储值以供服务器生命周期存储使用，返回之前存储或配置的值 |
过程 |
apoc.static.get(name) - 从配置 (apoc.static.<key>) 或服务器生命周期存储中返回静态存储的值 |
函数 |
apoc.static.getAll(prefix) - 从配置 (apoc.static.<prefix>.*) 或服务器生命周期存储中返回静态存储的值 |
函数 |
apoc.systemdb
| 限定名称 | 类型 |
|---|---|
过程 |
|
过程 |
|
过程 |
apoc.ttl
| 限定名称 | 类型 |
|---|---|
CALL apoc.ttl.expire(node,time,'time-unit') - 通过设置 :TTL 标签和 `ttl` 属性在指定时间使节点过期 |
过程 |
CALL apoc.ttl.expireIn(node,timeDelta,'time-unit') - 通过设置 :TTL 标签和 `ttl` 属性在指定时间长度后使节点过期 |
过程 |
函数 |
apoc.util
| 限定名称 | 类型 |
|---|---|
apoc.util.hashCode(value) - 返回值的 java.lang.Object#hashCode()。 |
函数 |
apoc.uuid
| 限定名称 | 类型 |
|---|---|
CALL apoc.uuid.drop(label, databaseName) yield label, installed, properties | 最终删除之前添加的 UUID 处理程序并返回 uuid 信息 |
过程 |
CALL apoc.uuid.dropAll(databaseName) yield label, installed, properties | 最终删除之前添加的所有 UUID 处理程序并返回 uuid 信息 |
过程 |
CALL apoc.uuid.install(label, {addToExistingNodes: true/false, uuidProperty: 'uuid'}) yield label, installed, properties, batchComputationResult | 将为提供的 `label` 和 `uuidProperty` 添加 uuid 事务处理程序，如果 UUID 处理程序已存在，则将被新的替换。 |
过程 |
CALL apoc.uuid.list() yield label, installed, properties | 提供已安装的所有 uuid 处理程序及其相关配置的列表。 |
过程 |
CALL apoc.uuid.remove(label) yield label, installed, properties | 删除之前添加的 uuid 处理程序并返回 uuid 信息。所有现有的 uuid 属性保持不变。 |
过程 |
CALL apoc.uuid.removeAll() yield label, installed, properties | 删除之前添加的所有 uuid 处理程序并返回 uuid 信息。所有现有的 uuid 属性保持不变。 |
过程 |
CALL apoc.uuid.setup(label, databaseName, $config) | 最终为提供的 `label` 和 `uuidProperty` 添加 uuid 事务处理程序，如果 UUID 处理程序已存在，则将被新的替换。 |
过程 |
CALL apoc.uuid.show(databaseName) | 列出数据库中最终安装的所有 UUID 处理程序。 |
过程 |