|| apoc.export.json.graph - APOC 核心文档 - Neo4j 文档

apoc.export.json.graph

此过程不被认为可在多线程中安全运行。因此,并行运行时不支持此过程。欲了解更多信息,请参阅Cypher 手册 → 并行运行时

详情

语法

apoc.export.json.graph(graph, file [, config ]) :: (file, source, format, nodes, relationships, properties, time, rows, batchSize, batches, done, data)

描述

将给定图导出到提供的 JSON 文件。

输入参数

名称

类型

描述

graph

MAP

要导出的图。

file

STRING

数据将导出到的文件名称。

config

MAP

{ stream = false :: BOOLEAN, batchSize = 20000 :: INTEGER, bulkImport = false :: BOOLEAN, timeoutSeconds = 100 :: INTEGER, compression = 'None' :: STRING, charset = 'UTF_8' :: STRING, sampling = false :: BOOLEAN, samplingConfig :: MAP }。默认值是:{}

返回参数

名称

类型

描述

file

STRING

数据导出到的文件名称。

source

STRING

导出数据的摘要。

format

STRING

文件导出的格式。

nodes

INTEGER

导出节点的数量。

relationships

INTEGER

导出关系的数量。

properties

INTEGER

导出属性的数量。

time

INTEGER

导出持续时间。

rows

INTEGER

返回的行数。

batchSize

INTEGER

导出运行时批处理的大小。

batches

INTEGER

导出运行时批处理的数量。

done

BOOLEAN

导出是否成功运行。

data

ANY

导出返回的数据。

配置参数

此过程支持以下配置参数

配置参数
名称 类型 默认值 描述

writeNodeProperties

BOOLEAN

true

如果为 true,也导出属性。

stream

BOOLEAN

false

将 JSON 直接流式传输到客户端的 data 字段中。

导出到文件

默认情况下,禁用导出到文件系统。我们可以通过在 apoc.conf 中设置以下属性来启用它

apoc.conf
apoc.export.file.enabled=true

有关访问 apoc.conf 的更多信息,请参阅配置选项章节。

如果我们在未首先设置此属性的情况下尝试使用任何导出过程,将收到以下错误消息

调用过程失败:原因:java.lang.RuntimeException: 未启用文件导出,请在您的 apoc.conf 中设置 apoc.export.file.enabled=true。否则,如果您在没有文件系统访问权限的云环境中运行,请使用 {stream:true} 配置并使用 null 作为“file”参数将导出流式传输回您的客户端。

导出文件会写入 import 目录,该目录由 server.directories.import 属性定义。这意味着我们提供的任何文件路径都是相对于此目录的。如果我们尝试写入绝对路径,例如 /tmp/filename,将收到类似于以下内容的错误消息

调用过程失败:原因:java.io.FileNotFoundException: /path/to/neo4j/import/tmp/fileName (无此文件或目录)

我们可以通过在 apoc.conf 中设置以下属性来启用向文件系统中任意位置的写入

apoc.conf
apoc.import.file.use_neo4j_config=false

现在 Neo4j 将能够写入文件系统上的任何位置,因此在设置此属性之前请务必确认这是您的意图。

流式导出

如果我们不想导出到文件,可以通过传入 null 文件名并提供 stream:true 配置,将结果流式传输回 data 列。

© . This site is unofficial and not affiliated with Neo4j, Inc.