apoc.cypher.runFile

Procedure APOC Full

apoc.cypher.runFile(file or url,[{statistics:true,timeout:10,parameters:{}}]) - runs each statement in the file, all semicolon separated - currently no schema operations

Signature

apoc.cypher.runFile(file :: STRING?, config = {} :: MAP?) :: (row :: INTEGER?, result :: MAP?)

Input parameters

Name Type Default

file

STRING?

null

config

MAP?

{}

Config parameters

The procedure support the following config parameters:

Table 1. Config parameters
name type default description

reportError

boolean

false

Returns a entry row with key error and value the error occurred, if any.

statistics

boolean

true

Returns an additional row with the query statistics, leveraging the org.neo4j.graphdb.QueryStatistics api

timeout

long

10

The single query timeout (in seconds)

queueCapacity

long

100

The capacity of the java.util.concurrent.BlockingQueue used to aggregate the results.

parameters

Map<String, Object>

Empty map

Optional parameter map to be used with the apoc.schema.runFile and apoc.schema.runFiles procedures.

Output parameters

Name Type

row

INTEGER?

result

MAP?

Reading from a file

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

apoc.conf
apoc.import.file.enabled=true

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

Failed to invoke procedure: Caused by: java.lang.RuntimeException: Import from files not enabled, please set apoc.import.file.enabled=true in your apoc.conf

Import files are read from the import directory, which is defined by the dbms.directories.import property. This means that any file path that we provide is relative to this directory. If we try to read from 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.lang.RuntimeException: Can’t read url or key file:/path/to/neo4j/import/tmp/filename as json: /path/to/neo4j//import/tmp/filename (No such file or directory)

We can enable reading files from 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 read from anywhere on the file system, so be sure that this is your intention before setting this property.

Usage Examples

The examples in this section are based on the following file:

$NEO4J_HOME/import/create_delete.cypher
CREATE (n:Node {id:1});

MATCH (n:Node)
DELETE n;

We can run the Cypher commands in create_delete.cypher, by running the following query:

CALL apoc.cypher.runFile("create_delete.cypher");
Table 2. Results
row result

-1

{constraintsRemoved: 0, indexesRemoved: 0, nodesCreated: 1, rows: 0, propertiesSet: 1, labelsRemoved: 0, relationshipsDeleted: 0, constraintsAdded: 0, nodesDeleted: 0, indexesAdded: 0, labelsAdded: 1, relationshipsCreated: 0, time: 0}

-1

{constraintsRemoved: 0, indexesRemoved: 0, nodesCreated: 0, rows: 0, propertiesSet: 0, labelsRemoved: 0, relationshipsDeleted: 0, constraintsAdded: 0, nodesDeleted: 1, indexesAdded: 0, labelsAdded: 0, relationshipsCreated: 0, time: 0}

If we don’t want to see statistics for each Cypher statement, we can set statistics: false:

CALL apoc.cypher.runFile("create_delete.cypher", {statistics: false});
Table 3. Results
row result