apoc.export.json.data

This procedure is not considered safe to run from multiple threads. It is therefore not supported by the parallel runtime (introduced in Neo4j 5.13). For more information, see the Cypher Manual → Parallel runtime.

Details
Syntax	`apoc.export.json.data(nodes, rels, file [, config ]) :: (file, source, format, nodes, relationships, properties, time, rows, batchSize, batches, done, data)`
Description	Exports the given `NODE` and `RELATIONSHIP` values to the provided JSON file.
Input arguments	Name	Type	Description
	`nodes`	`LIST<NODE>`	A list of nodes to export.
	`rels`	`LIST<RELATIONSHIP>`	A list of relationships to export.
	`file`	`STRING`	The name of the file to which the data will be exported.
	`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 }` The default is: `{}`.
Return arguments	Name	Type	Description
	`file`	`STRING`	The name of the file to which the data was exported.
	`source`	`STRING`	A summary of the exported data.
	`format`	`STRING`	The format the file is exported in.
	`nodes`	`INTEGER`	The number of exported nodes.
	`relationships`	`INTEGER`	The number of exported relationships.
	`properties`	`INTEGER`	The number of exported properties.
	`time`	`INTEGER`	The duration of the export.
	`rows`	`INTEGER`	The number of rows returned.
	`batchSize`	`INTEGER`	The size of the batches the export was run in.
	`batches`	`INTEGER`	The number of batches the export was run in.
	`done`	`BOOLEAN`	Whether the export ran successfully.
	`data`	`ANY`	The data returned by the export.

Config parameters

The procedure supports the following config parameters:

Config parameters
Name	Type	Default	Description
`writeNodeProperties`	`BOOLEAN`	true	If true export properties too.
`stream`	`BOOLEAN`	false	Stream the json directly to the client into the `data` field.

Exporting to a file

By default exporting to the file system is disabled. We can enable it by setting the following property in apoc.conf:

apoc.conf

apoc.export.file.enabled=true

For more information about accessing apoc.conf, see the chapter on Configuration Options.

If we try to use any of the export procedures without having first set this property, we’ll get the following error message:

Failed to invoke procedure: Caused by: java.lang.RuntimeException: Export to files not enabled, please set apoc.export.file.enabled=true in your apoc.conf. Otherwise, if you are running in a cloud environment without filesystem access, use the {stream:true} config and null as a 'file' parameter to stream the export back to your client.

Export files are written to the import directory, which is defined by the server.directories.import property. This means that any file path that we provide is relative to this directory. If we try to write to an absolute path, such as /tmp/filename, we’ll get an error message similar to the following one:

Failed to invoke procedure: Caused by: java.io.FileNotFoundException: /path/to/neo4j/import/tmp/fileName (No such file or directory)

We can enable writing to anywhere on the file system by setting the following property in apoc.conf:

apoc.conf

apoc.import.file.use_neo4j_config=false

Neo4j will now be able to write anywhere on the file system, so be sure that this is your intention before setting this property.

Exporting a stream

If we don’t want to export to a file, we can stream results back in the data column instead by passing a file name of null and providing the stream:true config.

More documentation of apoc.export.json.data