Procedures & Functions

apoc.agg.position

Returns index of the element that match the given value

Function

apoc.agg.row

Returns index of the element that match the given predicate

Procedure

apoc.agg.multiStats

apoc.agg.multiStats(nodeOrRel, keys) - Return a multi-dimensional aggregation

Procedure

apoc.agg.rollup

apoc.agg.rollup(<ANY>, [groupKeys], [aggKeys])

Emulate an Oracle/Mysql rollup command: `ROLLUP groupKeys, SUM(aggKey1), AVG(aggKey1), COUNT(aggKey1), SUM(aggKey2), AVG(aggKey2), …​ `

Procedure

apoc.bolt.load

apoc.bolt.load(url-or-key, kernelTransaction, params, config) - access to other databases via bolt for read

Procedure

apoc.bolt.load.fromLocal

Procedure

apoc.config.list

apoc.config.list | Lists the Neo4j configuration as key,value table

Procedure

apoc.config.map

apoc.config.map | Lists the Neo4j configuration as map

Procedure

apoc.convert.toYaml

apoc.convert.toYaml(value, $config) - Serializes the given value to a YAML string

Function

apoc.convert.fromYaml

apoc.convert.fromYaml(value, $config) - Deserializes the YAML string to Neo4j value

Function

apoc.couchbase.append

apoc.couchbase.append(hostOrKey, bucket, documentId, content, config) yield id, expiry, cas, mutationToken, content - append a couchbase json document to an existing one.

Procedure

apoc.couchbase.exists

apoc.couchbase.exists(hostOrKey, bucket, documentId, config) yield value - check whether a couchbase json document with the given ID does exist.

Procedure

apoc.couchbase.get

apoc.couchbase.get(hostOrKey, bucket, documentId, config) yield id, expiry, cas, mutationToken, content - retrieves a couchbase json document by its unique ID.

Procedure

apoc.couchbase.insert

apoc.couchbase.insert(hostOrKey, bucket, documentId, jsonDocument, config) yield id, expiry, cas, mutationToken, content - insert a couchbase json document with its unique ID.

Procedure

apoc.couchbase.namedParamsQuery

apoc.couchbase.namedParamsQuery(hostkOrKey, bucket, statement, paramNames, paramValues, config) yield queryResult - executes a N1QL statement with named parameters.

Procedure

apoc.couchbase.posParamsQuery

apoc.couchbase.posParamsQuery(hostOrKey, bucket, statement, params, config) yield queryResult - executes a N1QL statement with positional parameters.

Procedure

apoc.couchbase.prepend

apoc.couchbase.prepend(hostOrKey, bucket, documentId, content, config) yield id, expiry, cas, mutationToken, content - prepend a couchbase json document to an existing one.

Procedure

apoc.couchbase.query

apoc.couchbase.query(hostOrKey, bucket, statement, config) yield queryResult - executes a plain un-parameterized N1QL statement.

Procedure

apoc.couchbase.remove

apoc.couchbase.remove(hostOrKey, bucket, documentId, config) yield id, expiry, cas, mutationToken, content - remove the couchbase json document identified by its unique ID.

Procedure

apoc.couchbase.replace

apoc.couchbase.replace(hostOrKey, bucket, documentId, jsonDocument, config) yield id, expiry, cas, mutationToken, content - replace the content of the couchbase json document identified by its unique ID.

Procedure

apoc.couchbase.upsert

apoc.couchbase.upsert(hostOrKey, bucket, documentId, jsonDocument) yield id, expiry, cas, mutationToken, content - insert or overwrite a couchbase json document with its unique ID.

Procedure

apoc.custom.declareFunction

apoc.custom.declareFunction(signature, statement, forceSingle, description) - register a custom cypher function

Procedure

apoc.custom.declareProcedure

apoc.custom.declareProcedure(signature, statement, mode, description) - register a custom cypher procedure

Procedure

apoc.custom.list

apoc.custom.list() - provide a list of custom procedures/function registered

Procedure

apoc.custom.removeFunction

apoc.custom.removeFunction(name, type) - remove the targeted custom function

Procedure

apoc.custom.removeProcedure

apoc.custom.removeProcedure(name) - remove the targeted custom procedure

Procedure

apoc.cypher.mapParallel

apoc.cypher.mapParallel(fragment, params, list-to-parallelize) yield value - executes fragment in parallel batches with the list segments being assigned to _

Procedure

apoc.cypher.mapParallel2

apoc.cypher.mapParallel2(fragment, params, list-to-parallelize) yield value - executes fragment in parallel batches with the list segments being assigned to _

Procedure

apoc.cypher.parallel

apoc.cypher.parallel(fragment, paramMap, keyList) yield value - executes fragments in parallel through a list defined in paramMap with a key keyList

Procedure

apoc.cypher.parallel2

apoc.cypher.parallel2(fragment, paramMap, keyList) yield value - executes fragments in parallel batches through a list defined in paramMap with a key keyList

Procedure

apoc.cypher.runFile

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

Procedure

apoc.cypher.runFiles

apoc.cypher.runFiles([files or urls],[{statistics:true,timeout:10,parameters:{}}])) - runs each statement in the files, all semicolon separated

Procedure

apoc.cypher.runFileReadOnly

apoc.cypher.runFileReadOnly(file or url,[{timeout:10,parameters:{}}]) - runs each READ statement in the file, all semicolon separated

Procedure

apoc.cypher.runFilesReadOnly

apoc.cypher.runFilesReadOnly([files or urls],[{timeout:10,parameters:{}}])) - runs each READ statement in the files, all semicolon separated

Procedure

apoc.cypher.runSchemaFile

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

Procedure

apoc.cypher.runSchemaFiles

apoc.cypher.runSchemaFiles([files or urls],{statistics:true,timeout:10}) - allows only schema operations, runs each schema statement in the files, all semicolon separated

Procedure

apoc.diff.relationships

Returns a Map detailing the property differences between the two given relationships

Function

apoc.data.email

apoc.data.email('email_address') as {personal,user,domain} - extract the personal name, user and domain as a map

Function

apoc.dv.catalog.add

Add a virtualized resource configuration

Procedure

apoc.dv.catalog.list

List all virtualized resource configs

Procedure

apoc.dv.catalog.remove

Remove a virtualized resource config by name

Procedure

apoc.dv.query

Query a virtualized resource by name and return virtual nodes

Procedure

apoc.dv.queryAndLink

Query a virtualized resource by name and return virtual nodes linked using virtual rels to the node passed as first param

Procedure

apoc.es.get

apoc.es.get(host-or-key,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null,$config) yield value - perform a GET operation on elastic search

Procedure

apoc.es.getRaw

apoc.es.getRaw(host-or-key,path,payload-or-null,$config) yield value - perform a raw GET operation on elastic search

Procedure

apoc.es.post

apoc.es.post(host-or-key,index-or-null,type-or-null,query-or-null,payload-or-null,$config) yield value - perform a POST operation on elastic search

Procedure

apoc.es.postRaw

apoc.es.postRaw(host-or-key,path,payload-or-null,$config) yield value - perform a raw POST operation on elastic search

Procedure

apoc.es.put

apoc.es.put(host-or-key,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null,$config) yield value - perform a PUT operation on elastic search

Procedure

apoc.es.query

apoc.es.query(host-or-key,index-or-null,type-or-null,query-or-null,payload-or-null,$config) yield value - perform a SEARCH operation on elastic search

Procedure

apoc.es.stats

apoc.es.stats(host-or-key,$config) - elastic search statistics

Procedure

apoc.es.delete

apoc.es.delete(host-or-key,index-or-null,type-or-null,id-or-null,query-or-null,$config) yield value - perform a DELETE operation on elastic search

Procedure

apoc.export.xls.all

apoc.export.xls.all(file,config) - exports whole database as xls to the provided file

Procedure

apoc.export.xls.data

apoc.export.xls.data(nodes,rels,file,config) - exports given nodes and relationships as xls to the provided file

Procedure

apoc.export.xls.graph

apoc.export.xls.graph(graph,file,config) - exports given graph object as xls to the provided file

Procedure

apoc.export.xls.query

apoc.export.xls.query(query,file,{config,…​,params:{params}}) - exports results from the cypher statement as xls to the provided file

Procedure

apoc.generate.ba

apoc.generate.ba(noNodes, edgesPerNode, label, type) - generates a random graph according to the Barabasi-Albert model

Procedure

apoc.generate.complete

apoc.generate.complete(noNodes, label, type) - generates a random complete graph

Procedure

apoc.generate.er

apoc.generate.er(noNodes, noEdges, label, type) - generates a random graph according to the Erdos-Renyi model

Procedure

apoc.generate.simple

apoc.generate.simple(degrees, label, type) - generates a simple random graph according to the given degree distribution

Procedure

apoc.generate.ws

apoc.generate.ws(noNodes, degree, beta, label, type) - generates a random graph according to the Watts-Strogatz model

Procedure

apoc.gephi.add

apoc.gephi.add(url-or-key, workspace, data, weightproperty, ['exportproperty']) | streams passed in data to Gephi

Procedure

apoc.get.nodes

apoc.get.nodes(node|id|[ids]) - quickly returns all nodes with these id’s

Procedure

apoc.get.rels

apoc.get.rels(rel|id|[ids]) - quickly returns all relationships with these id’s

Procedure

apoc.import.arrow

apoc.import.arrow(input, $config) - Imports arrow from the provided arrow file or byte array

Procedure

apoc.load.csv

apoc.load.csv('urlOrBinary',{config}) YIELD lineNo, list, map - load CSV from URL as stream of values, config contains any of: {skip:1,limit:5,header:false,sep:'TAB',ignore:['tmp'],nullValues:['na'],arraySep:';',mapping:{years:{type:'int',arraySep:'-',array:false,name:'age',ignore:false}}

Procedure

apoc.load.csvParams

apoc.load.csvParams('urlOrBinary', {httpHeader: value}, payload, {config}) YIELD lineNo, list, map - load from CSV URL (e.g. web-api) while sending headers / payload to load CSV from URL as stream of values, config contains any of: {skip:1,limit:5,header:false,sep:'TAB',ignore:['tmp'],nullValues:['na'],arraySep:';',mapping:{years:{type:'int',arraySep:'-',array:false,name:'age',ignore:false}}

Procedure

apoc.load.directory

apoc.load.directory('pattern', 'urlDir', {config}) YIELD value - Loads list of all files in the folder specified by the parameter urlDir satisfying the given pattern. If the parameter urlDir is not specified or empty, the files of the import folder are loaded instead.

Procedure

apoc.load.directory.async.add

apoc.load.directory.async.add(name, cypher, pattern, urlDir, {}) YIELD name, status, pattern, cypher, urlDir, config, error - Adds or replaces a folder listener with a specific name, which is triggered for all files with the given pattern and executes the specified Cypher query when triggered. Returns a list of all listeners. It is possible to specify the event type in the config parameter.

Procedure

apoc.load.directory.async.list

apoc.load.directory.async.list() YIELD name, status, pattern, cypher, urlDir, config, error - Lists all folder listeners

Procedure

apoc.load.directory.async.remove

apoc.load.directory.async.remove(name) YIELD name, status, pattern, cypher, urlDir, config, error - Removes a folder listener by name and returns all remaining listeners, if any

Procedure

apoc.load.directory.async.removeAll

apoc.load.directory.async.removeAll() - Removes all folder listeners

Procedure

apoc.load.driver

apoc.load.driver('org.apache.derby.jdbc.EmbeddedDriver') register JDBC driver of source database

Procedure

apoc.load.html

apoc.load.html('url',{name: jquery, name2: jquery}, config) YIELD value - Load Html page and return the result as a Map

Procedure

apoc.load.htmlPlainText

apoc.load.htmlPlainText('urlOrHtml',{name: jquery, name2: jquery}, config) YIELD value - Load Html page and return the result as a Map

Procedure

apoc.load.jdbc

apoc.load.jdbc('key or url','table or statement', params, config) YIELD row - load from relational database, from a full table or a sql statement

Procedure

apoc.load.jdbcUpdate

apoc.load.jdbcUpdate('key or url','statement',[params],config) YIELD row - update relational database, from a SQL statement with optional parameters

Procedure

apoc.load.ldap

apoc.load.ldap("key" or {connectionMap},{searchMap}) Load entries from an ldap source (yield entry)

Procedure

apoc.load.xls

apoc.load.xls('url','selector',{config}) YIELD lineNo, list, map - load XLS fom URL as stream of row values, config contains any of: {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']}}

Procedure

apoc.log.debug

apoc.log.debug(message, params) - logs debug message

Procedure

apoc.log.error

apoc.log.error(message, params) - logs error message

Procedure

apoc.log.info

apoc.log.info(message, params) - logs info message

Procedure

apoc.log.warn

apoc.log.warn(message, params) - logs warn message

Procedure

apoc.map.renameKey

Rename the given key(s) in the MAP.

Function

apoc.metrics.get

apoc.metrics.get(metricName, {}) - retrieve a system metric by its metric name. Additional configuration options may be passed matching the options available for apoc.load.csv.

Procedure

apoc.metrics.list

apoc.metrics.list() - get a list of available metrics

Procedure

apoc.metrics.storage

apoc.metrics.storage(directorySetting) - retrieve storage metrics about the devices Neo4j uses for data storage. directorySetting may be any valid neo4j directory setting name, such as 'server.directories.data'. If null is provided as a directorySetting, you will get back all available directory settings. For a list of available directory settings, see the Neo4j operations manual reference on configuration settings. Directory settings are not paths, they are a neo4j.conf setting key name

Procedure

apoc.model.jdbc

apoc.model.jdbc('key or url', {schema:'<schema>', write: <true/false>, filters: { tables:[], views: [], columns: []}) YIELD nodes, relationships - load schema from relational database

Procedure

apoc.mongo.aggregate

apoc.mongo.aggregate(uri, pipeline, $config) yield value - perform an aggregate operation on mongodb collection

Procedure

apoc.mongo.count

apoc.mongo.count(uri, query, $config) yield value - perform a count operation on mongodb collection

Procedure

apoc.mongo.delete

apoc.mongo.delete(uri, query, $config) - delete the given documents from the mongodb collection and returns the number of affected documents

Procedure

apoc.mongo.find

apoc.mongo.find(uri, query, $config) yield value - perform a find operation on mongodb collection

Procedure

apoc.mongo.insert

apoc.mongo.insert(uri, documents, $config) yield value - inserts the given documents into the mongodb collection

Procedure

apoc.mongo.update

apoc.mongo.update(uri, query, update, $config) - updates the given documents from the mongodb collection and returns the number of affected documents

Procedure

apoc.mongodb.get.byObjectId

apoc.mongodb.get.byObjectId(hostOrKey, db, collection, objectIdValue, config(default:{})) - get the document by Object id value

Procedure

apoc.monitor.ids

apoc.monitor.ids() returns the object ids in use for this neo4j instance

Procedure

apoc.monitor.kernel

apoc.monitor.kernel() returns informations about the neo4j kernel

Procedure

apoc.monitor.store

apoc.monitor.store() returns informations about the sizes of the different parts of the neo4j graph store

Procedure

apoc.monitor.tx

apoc.monitor.tx() returns informations about the neo4j transaction manager

Procedure

apoc.nlp.aws.entities.graph

Creates a (virtual) entity graph for provided text

Procedure

apoc.nlp.aws.entities.stream

Returns a stream of entities for provided text

Procedure

apoc.nlp.aws.keyPhrases.graph

Creates a (virtual) key phrases graph for provided text

Procedure

apoc.nlp.aws.keyPhrases.stream

Returns a stream of key phrases for provided text

Procedure

apoc.nlp.aws.sentiment.graph

Creates a (virtual) sentiment graph for provided text

Procedure

apoc.nlp.aws.sentiment.stream

Returns stream of sentiment for items in provided text

Procedure

apoc.nlp.azure.entities.graph

Creates a (virtual) entity graph for provided text

Procedure

apoc.nlp.azure.entities.stream

Provides a entity analysis for provided text

Procedure

apoc.nlp.azure.keyPhrases.graph

Creates a (virtual) key phrase graph for provided text

Procedure

apoc.nlp.azure.keyPhrases.stream

Provides a entity analysis for provided text

Procedure

apoc.nlp.azure.sentiment.graph

Creates a (virtual) sentiment graph for provided text

Procedure

apoc.nlp.azure.sentiment.stream

Provides a sentiment analysis for provided text

Procedure

apoc.nlp.gcp.classify.graph

Classifies a document into categories.

Procedure

apoc.nlp.gcp.classify.stream

Classifies a document into categories.

Procedure

apoc.nlp.gcp.entities.graph

Creates a (virtual) entity graph for provided text

Procedure

apoc.nlp.gcp.entities.stream

Returns a stream of entities for provided text

Procedure

apoc.redis.append

apoc.redis.append(uri, key, value, {config}) | Execute the 'APPEND key value' command

Procedure

apoc.redis.configGet

apoc.redis.configGet(uri, parameter, {config}) | Execute the 'CONFIG GET parameter' command

Procedure

apoc.redis.configSet

apoc.redis.configSet(uri, parameter, {config}) | Execute the 'CONFIG SET parameter value' command

Procedure

apoc.redis.copy

apoc.redis.copy(uri, source, destination, {config}) | Execute the 'COPY source destination' command and returns true if source was copied and false otherwise

Procedure

apoc.redis.eval

apoc.redis.eval(uri, script, outputType, keys, values, {config}) | Execute the 'EVAL script' command. In the parameters provided to the procedure, keys are bound to the KEYS[n] like special array of the Lua script and values are bound to the ARGV[n] like special array of the Lua script.

Procedure

apoc.redis.exists

apoc.redis.exists(uri, keys, {config}) | Execute the 'EXISTS keys' command

Procedure

apoc.redis.get

apoc.redis.get(uri, key, {config}) | Execute the 'GET key' command

Procedure

apoc.redis.hdel

apoc.redis.hdel(uri, key, fields, {config}) | Execute the 'HDEL key fields' command

Procedure

apoc.redis.hexists

apoc.redis.hexists(uri, key, field, {config}) | Execute the 'HEXISTS key field' command

Procedure

apoc.redis.hget

apoc.redis.hget(uri, key, field, {config}) | Execute the 'HGET key field' command

Procedure

apoc.redis.hgetall

apoc.redis.hgetall(uri, key, {config}) | Execute the 'HGETALL key' command

Procedure

apoc.redis.hincrby

apoc.redis.hincrby(uri, key, field, amount, {config}) | Execute the 'HINCRBY key field amount' command

Procedure

apoc.redis.hset

apoc.redis.hset(uri, key, field, value, {config}) | Execute the 'HSET key field value' command and returns true if it is a new field in the hash or false if the field already exists

Procedure

apoc.redis.incrby

apoc.redis.incrby(uri, key, amount, {config}) | Execute the 'INCRBY key increment' command

Procedure

apoc.redis.info

apoc.redis.info(uri, {config}) | Execute the 'INFO' command

Procedure

apoc.redis.lrange

apoc.redis.lrange(uri, key, start, stop, {config}) | Execute the 'LRANGE key start stop' command

Procedure

apoc.redis.persist

apoc.redis.persist(uri, key, {config}) | Execute the 'PERSIST key' command

Procedure

apoc.redis.pexpire

apoc.redis.pexpire(uri, key, time, isExpireAt {config}) | Execute the 'PEXPIRE key time' command, or the 'PEPXPIREAT' if isExpireAt=true

Procedure

apoc.redis.pop

apoc.redis.pop(uri, key, {config}) | Execute the 'LPOP key' command, or the 'RPOP' if config right=true (default)

Procedure

apoc.redis.pttl

apoc.redis.pttl(uri, key, {config}) | Execute the 'PTTL key' command

Procedure

apoc.redis.push

apoc.redis.push(uri, key, values, {config}) | Execute the 'LPUSH key field values' command, or the 'RPUSH' if config right=true (default)

Procedure

apoc.redis.sadd

apoc.redis.sadd(uri, key, members, {config}) | Execute the 'SADD key members' command

Procedure

apoc.redis.scard

apoc.redis.scard(uri, key, {config}) | Execute the 'SCARD key' command

Procedure

apoc.redis.smembers

apoc.redis.smembers(uri, key, {config}) | Execute the 'SMEMBERS key' command

Procedure

apoc.redis.spop

apoc.redis.spop(uri, key, {config}) | Execute the 'SPOP key' command

Procedure

apoc.redis.sunion

apoc.redis.sunion(uri, keys, {config}) | Execute the 'SUNION keys' command

Procedure

apoc.redis.zadd

apoc.redis.zadd(uri, keys, scoresAndMembers, {config}) | Execute the 'ZADD key scoresAndMembers' command, where scoresAndMembers is a list of score,member,score,member,…​

Procedure

apoc.redis.zcard

apoc.redis.zcard(uri, key, {config}) | Execute the 'ZCARD key' command

Procedure

apoc.redis.zrangebyscore

apoc.redis.zrangebyscore(uri, key, min, max, {config}) | Execute the 'ZRANGEBYSCORE key min max' command

Procedure

apoc.redis.zrem

apoc.redis.zrem(uri, key, members, {config}) | Execute the 'ZREM key members' command

Procedure

apoc.static.list

apoc.static.list(prefix) - returns statically stored values from config (apoc.static.<prefix>.*) or server lifetime storage

Procedure

apoc.static.set

apoc.static.set(name, value) - stores value under key for server lifetime storage, returns previously stored or configured value

Procedure

apoc.static.get

apoc.static.get(name) - returns statically stored value from config (apoc.static.<key>) or server lifetime storage

Function

apoc.static.getAll

apoc.static.getAll(prefix) - returns statically stored values from config (apoc.static.<prefix>.*) or server lifetime storage

Function

apoc.systemdb.execute

Procedure

apoc.systemdb.export.metadata

Procedure

apoc.systemdb.graph

Procedure

apoc.temporal.overlap

Function

apoc.trigger.nodesByLabel

Function

apoc.trigger.propertiesByKey

Function

apoc.ttl.expire

CALL apoc.ttl.expire(node,time,'time-unit') - expire node at specified time by setting :TTL label and ttl property

Procedure

apoc.ttl.expireIn

CALL apoc.ttl.expireIn(node,timeDelta,'time-unit') - expire node after specified length of time time by setting :TTL label and ttl property

Procedure

apoc.ttl.config

Function

apoc.util.hashCode

apoc.util.hashCode(value) - Returns the java.lang.Object#hashCode() of the value

Function

apoc.uuid.drop

CALL apoc.uuid.drop(label, databaseName) yield label, installed, properties | eventually removes previously added UUID handler and returns uuid information

Procedure

apoc.uuid.dropAll

CALL apoc.uuid.dropAll(databaseName) yield label, installed, properties | eventually removes all previously added UUID handlers and returns uuids' information

Procedure

apoc.uuid.install

CALL apoc.uuid.install(label, {addToExistingNodes: true/false, uuidProperty: 'uuid'}) yield label, installed, properties, batchComputationResult | it will add the uuid transaction handler for the provided label and uuidProperty, in case the UUID handler is already present it will be replaced by the new one

Procedure

apoc.uuid.list

CALL apoc.uuid.list() yield label, installed, properties | provides a list of all the uuid handlers installed with the related configuration

Procedure

apoc.uuid.remove

CALL apoc.uuid.remove(label) yield label, installed, properties | remove previously added uuid handler and returns uuid information. All the existing uuid properties are left as-is

Procedure

apoc.uuid.removeAll

CALL apoc.uuid.removeAll() yield label, installed, properties | it removes all previously added uuid handlers and returns uuids information. All the existing uuid properties are left as-is

Procedure

apoc.uuid.setup

CALL apoc.uuid.setup(label, databaseName, $config) | eventually adds the uuid transaction handler for the provided label and uuidProperty, in case the UUID handler is already present it will be replaced by the new one

Procedure

apoc.uuid.show

CALL apoc.uuid.show(databaseName) | it lists all eventually installed UUID handler for a database

Procedure