Procedures & Functions

apoc.case

apoc.case([condition, query, condition, query, …​], elseQuery:'', params:{}) yield value - given a list of conditional / read-only query pairs, executes the query associated with the first conditional evaluating to true (or the else query if none are true) with the given parameters

Procedure

APOC Core

apoc.help

Provides descriptions of available procedures. To narrow the results, supply a search string. To also search in the description text, append + to the end of the search string.

Procedure

APOC Core

apoc.when

apoc.when(condition, ifQuery, elseQuery:'', params:{}) yield value - based on the conditional, executes read-only ifQuery or elseQuery with the given parameters

Procedure

APOC Core

apoc.version

RETURN apoc.version() | return the current APOC installed version

Function

APOC Core

apoc.agg.first

apoc.agg.first(value) - returns first value

Function

APOC Core

apoc.agg.graph

apoc.agg.graph(path) - returns map of graph {nodes, relationships} of all distinct nodes and relationships

Function

APOC Core

apoc.agg.last

apoc.agg.last(value) - returns last value

Function

APOC Core

apoc.agg.maxItems

apoc.agg.maxItems(item, value, groupLimit: -1) - returns a map {items:[], value:n} where value is the maximum value present, and items are all items with the same value. The number of items can be optionally limited.

Function

APOC Core

apoc.agg.median

apoc.agg.median(number) - returns median for non-null numeric values

Function

APOC Core

apoc.agg.minItems

apoc.agg.minItems(item, value, groupLimit: -1) - returns a map {items:[], value:n} where value is the minimum value present, and items are all items with the same value. The number of items can be optionally limited.

Function

APOC Core

apoc.agg.nth

apoc.agg.nth(value,offset) - returns value of nth row (or -1 for last)

Function

APOC Core

apoc.agg.percentiles

apoc.agg.percentiles(value,[percentiles = 0.5,0.75,0.9,0.95,0.99]) - returns given percentiles for values

Function

APOC Core

apoc.agg.product

apoc.agg.product(number) - returns given product for non-null values

Function

APOC Core

apoc.agg.slice

apoc.agg.slice(value, start, length) - returns subset of non-null values, start is 0 based and length can be -1

Function

APOC Core

apoc.agg.statistics

apoc.agg.statistics(value,[percentiles = 0.5,0.75,0.9,0.95,0.99]) - returns numeric statistics (percentiles, min,minNonZero,max,total,mean,stdev) for values

Function

APOC Core

apoc.agg.position

Returns index of the element that match the given value

Function

APOC Full

apoc.agg.row

Returns index of the element that match the given predicate

Procedure

APOC Full

apoc.algo.aStar

apoc.algo.aStar(startNode, endNode, 'KNOWS|<WORKS_WITH|IS_MANAGER_OF>', 'distance','lat','lon') YIELD path, weight - run A* with relationship property name as cost function

Procedure

APOC Core

apoc.algo.aStarConfig

apoc.algo.aStar(startNode, endNode, 'KNOWS|<WORKS_WITH|IS_MANAGER_OF>', {weight:'dist',default:10,x:'lon',y:'lat'}) YIELD path, weight - run A* with relationship property name as cost function

Procedure

APOC Core

apoc.algo.allSimplePaths

apoc.algo.allSimplePaths(startNode, endNode, 'KNOWS|<WORKS_WITH|IS_MANAGER_OF>', 5) YIELD path, weight - run allSimplePaths with relationships given and maxNodes

Procedure

APOC Core

apoc.algo.cover

apoc.algo.cover(nodes) yield rel - returns all relationships between this set of nodes

Procedure

APOC Core

apoc.algo.dijkstra

apoc.algo.dijkstra(startNode, endNode, 'KNOWS|<WORKS_WITH|IS_MANAGER_OF>', 'distance', defaultValue, numberOfWantedResults) YIELD path, weight - run dijkstra with relationship property name as cost function

Procedure

APOC Core

apoc.algo.dijkstraWithDefaultWeight

apoc.algo.dijkstraWithDefaultWeight(startNode, endNode, 'KNOWS|<WORKS_WITH|IS_MANAGER_OF>', 'distance', 10) YIELD path, weight - run dijkstra with relationship property name as cost function and a default weight if the property does not exist

Procedure

APOC Core

apoc.any.properties

returns properties for virtual and real, nodes, rels and maps

Function

APOC Core

apoc.any.property

returns property for virtual and real, nodes, rels and maps

Function

APOC Core

apoc.atomic.add

apoc.atomic.add(node/relatonship,propertyName,number) Sums the property’s value with the 'number' value

Procedure

APOC Core

apoc.atomic.concat

apoc.atomic.concat(node/relatonship,propertyName,string) Concats the property’s value with the 'string' value

Procedure

APOC Core

apoc.atomic.insert

apoc.atomic.insert(node/relatonship,propertyName,position,value) insert a value into the property’s array value at 'position'

Procedure

APOC Core

apoc.atomic.remove

apoc.atomic.remove(node/relatonship,propertyName,position) remove the element at position 'position'

Procedure

APOC Core

apoc.atomic.subtract

apoc.atomic.subtract(node/relatonship,propertyName,number) Subtracts the 'number' value to the property’s value

Procedure

APOC Core

apoc.atomic.update

apoc.atomic.update(node/relatonship,propertyName,updateOperation) update a property’s value with a cypher operation (ex. "n.prop1+n.prop2")

Procedure

APOC Core

apoc.bitwise.op

apoc.bitwise.op(60,'|',13) bitwise operations a & b, a | b, a ^ b, ~a, a >> b, a >>> b, a << b. returns the result of the bitwise operation

Function

APOC Core

apoc.agg.multiStats

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

Procedure

apoc.bolt.execute

apoc.bolt.execute(url-or-key, kernelTransaction, params, config) - access to other databases via bolt for reads and writes

Procedure

APOC Full

apoc.bolt.load

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

Procedure

APOC Full

apoc.bolt.load.fromLocal

Procedure

APOC Full

apoc.cluster.graph

Procedure

APOC Full

apoc.coll.elements

apoc.coll.elements(list,limit,offset) yield _1,_2,..,_10,_1s,_2i,_3f,_4m,_5l,_6n,_7r,_8p - deconstruct subset of mixed list into identifiers of the correct type

Procedure

APOC Core

apoc.coll.pairWithOffset

apoc.coll.pairWithOffset(values, offset) - returns a list of pairs defined by the offset

Procedure

APOC Core

apoc.coll.partition

apoc.coll.partition(list,batchSize)

Procedure

APOC Core

apoc.coll.split

apoc.coll.split(list,value) | splits collection on given values rows of lists, value itself will not be part of resulting lists

Procedure

APOC Core

apoc.coll.zipToRows

apoc.coll.zipToRows(list1,list2) - creates pairs like zip but emits one row per pair

Procedure

APOC Core

apoc.coll.avg

apoc.coll.avg([0.5,1,2.3])

Function

APOC Core

apoc.coll.avgDuration

apoc.coll.avgDuration([duration('P2DT3H'), duration('PT1H45S'), …​]) - returns the average of a list of duration values

Function

APOC Full

apoc.coll.combinations

apoc.coll.combinations(coll, minSelect, maxSelect:minSelect) - Returns collection of all combinations of list elements of selection size between minSelect and maxSelect (default:minSelect), inclusive

Function

APOC Core

apoc.coll.contains

apoc.coll.contains(coll, value) optimized contains operation (using a HashSet) (returns single row or not)

Function

APOC Core

apoc.coll.containsAll

apoc.coll.containsAll(coll, values) optimized contains-all operation (using a HashSet) (returns single row or not)

Function

APOC Core

apoc.coll.containsAllSorted

apoc.coll.containsAllSorted(coll, value) optimized contains-all on a sorted list operation (Collections.binarySearch) (returns single row or not)

Function

APOC Core

apoc.coll.containsDuplicates

apoc.coll.containsDuplicates(coll) - returns true if a collection contains duplicate elements

Function

APOC Core

apoc.coll.containsSorted

apoc.coll.containsSorted(coll, value) optimized contains on a sorted list operation (Collections.binarySearch) (returns single row or not)

Function

APOC Core

apoc.coll.different

apoc.coll.different(values) - returns true if values are different

Function

APOC Core

apoc.coll.disjunction

apoc.coll.disjunction(first, second) - returns the disjunct set of the two lists

Function

APOC Core

apoc.coll.dropDuplicateNeighbors

apoc.coll.dropDuplicateNeighbors(list) - remove duplicate consecutive objects in a list

Function

APOC Core

apoc.coll.duplicates

apoc.coll.duplicates(coll) - returns a list of duplicate items in the collection

Function

APOC Core

apoc.coll.duplicatesWithCount

apoc.coll.duplicatesWithCount(coll) - returns a list of duplicate items in the collection and their count, keyed by item and count (e.g., [{item: xyz, count:2}, {item:zyx, count:5}])

Function

APOC Core

apoc.coll.fill

apoc.coll.fill(item, count) - returns a list with the given count of items

Function

APOC Core

apoc.coll.flatten

apoc.coll.flatten(coll, [recursive]) - flattens list (nested if recursive is true)

Function

APOC Core

apoc.coll.frequencies

apoc.coll.frequencies(coll) - returns a list of frequencies of the items in the collection, keyed by item and count (e.g., [{item: xyz, count:2}, {item:zyx, count:5}, {item:abc, count:1}])

Function

APOC Core

apoc.coll.frequenciesAsMap

apoc.coll.frequenciesAsMap(coll) - return a map of frequencies of the items in the collection, key item, value count (e.g., {1:2, 2:1})

Function

APOC Core

apoc.coll.indexOf

apoc.coll.indexOf(coll, value) | position of value in the list

Function

APOC Core

apoc.coll.insert

apoc.coll.insert(coll, index, value) | insert value at index

Function

APOC Core

apoc.coll.insertAll

apoc.coll.insertAll(coll, index, values) | insert values at index

Function

APOC Core

apoc.coll.intersection

apoc.coll.intersection(first, second) - returns the unique intersection of the two lists

Function

APOC Core

apoc.coll.isEqualCollection

apoc.coll.isEqualCollection(coll, values) return true if two collections contain the same elements with the same cardinality in any order (using a HashMap)

Function

APOC Core

apoc.coll.max

apoc.coll.max([0.5,1,2.3])

Function

APOC Core

apoc.coll.min

apoc.coll.min([0.5,1,2.3])

Function

APOC Core

apoc.coll.occurrences

apoc.coll.occurrences(coll, item) - returns the count of the given item in the collection

Function

APOC Core

apoc.coll.pairWithOffset

apoc.coll.pairWithOffset(values, offset) - returns a list of pairs defined by the offset

Function

APOC Core

apoc.coll.pairs

apoc.coll.pairs([1,2,3]) returns [1,2],[2,3],[3,null]

Function

APOC Core

apoc.coll.pairsMin

apoc.coll.pairsMin([1,2,3]) returns [1,2],[2,3]

Function

APOC Core

apoc.coll.partition

apoc.coll.partition(list,batchSize)

Function

APOC Core

apoc.coll.randomItem

apoc.coll.randomItem(coll)- returns a random item from the list, or null on an empty or null list

Function

APOC Core

apoc.coll.randomItems

apoc.coll.randomItems(coll, itemCount, allowRepick: false) - returns a list of itemCount random items from the original list, optionally allowing picked elements to be picked again

Function

APOC Core

apoc.coll.remove

apoc.coll.remove(coll, index, [length=1]) | remove range of values from index to length

Function

APOC Core

apoc.coll.removeAll

apoc.coll.removeAll(first, second) - returns first list with all elements of second list removed

Function

APOC Core

apoc.coll.reverse

apoc.coll.reverse(coll) - returns reversed list

Function

APOC Core

apoc.coll.runningTotal

apoc.coll.runningTotal(list1) - returns an accumulative array. For example apoc.coll.runningTotal([1,2,3.5]) return [1,3,6.5]

Function

APOC Core

apoc.coll.set

apoc.coll.set(coll, index, value) | set index to value

Function

APOC Core

apoc.coll.shuffle

apoc.coll.shuffle(coll) - returns the shuffled list

Function

APOC Core

apoc.coll.sort

apoc.coll.sort(coll) sort on Collections

Function

APOC Core

apoc.coll.sortMaps

apoc.coll.sortMaps([maps], 'name') - sort maps by property

Function

APOC Core

apoc.coll.sortMulti

apoc.coll.sortMulti(coll, ['^name','age'],[limit],[skip]) - sort list of maps by several sort fields (ascending with ^ prefix) and optionally applies limit and skip

Function

APOC Core

apoc.coll.sortNodes

apoc.coll.sortNodes([nodes], 'name') sort nodes by property

Function

APOC Core

apoc.coll.sortText

apoc.coll.sortText(coll) sort on string based collections

Function

APOC Core

apoc.coll.stdev

apoc.coll.stdev(list, isBiasCorrected) - returns the sample or population standard deviation with isBiasCorrected true or false respectively. For example apoc.coll.stdev([10, 12, 23]) return 7

Function

APOC Core

apoc.coll.subtract

apoc.coll.subtract(first, second) - returns unique set of first list with all elements of second list removed

Function

APOC Core

apoc.coll.sum

apoc.coll.sum([0.5,1,2.3])

Function

APOC Core

apoc.coll.sumLongs

apoc.coll.sumLongs([1,3,3])

Function

APOC Core

apoc.coll.toSet

apoc.coll.toSet([list]) returns a unique list backed by a set

Function

APOC Core

apoc.coll.union

apoc.coll.union(first, second) - creates the distinct union of the 2 lists

Function

APOC Core

apoc.coll.unionAll

apoc.coll.unionAll(first, second) - creates the full union with duplicates of the two lists

Function

APOC Core

apoc.coll.zip

apoc.coll.zip([list1],[list2])

Function

APOC Core

apoc.config.list

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

Procedure

APOC Full

apoc.config.map

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

Procedure

APOC Full

apoc.convert.setJsonProperty

apoc.convert.setJsonProperty(node,key,complexValue) - sets value serialized to JSON as property with the given name on the node

Procedure

APOC Core

apoc.convert.toTree

apoc.convert.toTree([paths],[lowerCaseRels=true], [config]) creates a stream of nested documents representing the at least one root of these paths

Procedure

APOC Core

apoc.convert.fromJsonList

apoc.convert.fromJsonList('[1,2,3]'[,'json-path', 'path-options'])

Function

APOC Core

apoc.convert.fromJsonMap

apoc.convert.fromJsonMap('{"a":42,"b":"foo","c":[1,2,3]}'[,'json-path', 'path-options'])

Function

APOC Core

apoc.convert.getJsonProperty

apoc.convert.getJsonProperty(node,key[,'json-path', 'path-options']) - converts serialized JSON in property back to original object

Function

APOC Core

apoc.convert.getJsonPropertyMap

apoc.convert.getJsonPropertyMap(node,key[,'json-path', 'path-options']) - converts serialized JSON in property back to map

Function

APOC Core

apoc.convert.toBoolean

apoc.convert.toBoolean(value) | tries it’s best to convert the value to a boolean

Function

APOC Core

apoc.convert.toBooleanList

apoc.convert.toBooleanList(value) | tries it’s best to convert the value to a list of booleans

Function

APOC Core

apoc.convert.toFloat

apoc.convert.toFloat(value) | tries it’s best to convert the value to a float

Function

APOC Core

apoc.convert.toIntList

apoc.convert.toIntList(value) | tries it’s best to convert the value to a list of integers

Function

APOC Core

apoc.convert.toInteger

apoc.convert.toInteger(value) | tries it’s best to convert the value to an integer

Function

APOC Core

apoc.convert.toJson

apoc.convert.toJson([1,2,3]) or toJson({a:42,b:"foo",c:[1,2,3]}) or toJson(NODE/REL/PATH)

Function

APOC Core

apoc.convert.toList

apoc.convert.toList(value) | tries it’s best to convert the value to a list

Function

APOC Core

apoc.convert.toMap

apoc.convert.toMap(value) | tries it’s best to convert the value to a map

Function

APOC Core

apoc.convert.toNode

apoc.convert.toNode(value) | tries it’s best to convert the value to a node

Function

APOC Core

apoc.convert.toNodeList

apoc.convert.toNodeList(value) | tries it’s best to convert the value to a list of nodes

Function

APOC Core

apoc.convert.toRelationship

apoc.convert.toRelationship(value) | tries it’s best to convert the value to a relationship

Function

APOC Core

apoc.convert.toRelationshipList

apoc.convert.toRelationshipList(value) | tries it’s best to convert the value to a list of relationships

Function

APOC Core

apoc.convert.toSet

apoc.convert.toSet(value) | tries it’s best to convert the value to a set

Function

APOC Core

apoc.convert.toSortedJsonMap

apoc.convert.toSortedJsonMap(node|map, ignoreCase:true) - returns a JSON map with keys sorted alphabetically, with optional case sensitivity

Function

APOC Core

apoc.convert.toString

apoc.convert.toString(value) | tries it’s best to convert the value to a string

Function

APOC Core

apoc.convert.toStringList

apoc.convert.toStringList(value) | tries it’s best to convert the value to a list of strings

Function

APOC Core

apoc.convert.fromYaml

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

Function

APOC Full

apoc.couchbase.append

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

Procedure

APOC Full

apoc.couchbase.exists

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

Procedure

APOC Full

apoc.couchbase.get

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

Procedure

APOC Full

apoc.couchbase.insert

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

Procedure

APOC Full

apoc.couchbase.namedParamsQuery

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

Procedure

APOC Full

apoc.couchbase.posParamsQuery

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

Procedure

APOC Full

apoc.couchbase.prepend

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

Procedure

APOC Full

apoc.couchbase.query

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

Procedure

APOC Full

apoc.couchbase.remove

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

Procedure

APOC Full

apoc.couchbase.replace

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

Procedure

APOC Full

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 Full

apoc.create.addLabels

apoc.create.addLabels( [node,id,ids,nodes], ['Label',…​]) - adds the given labels to the node or nodes

Procedure

APOC Core

apoc.create.node

apoc.create.node(['Label'], {key:value,…​}) - create node with dynamic labels

Procedure

APOC Core

apoc.create.nodes

apoc.create.nodes(['Label'], [{key:value,…​}]) create multiple nodes with dynamic labels

Procedure

APOC Core

apoc.create.relationship

apoc.create.relationship(person1,'KNOWS',{key:value,…​}, person2) create relationship with dynamic rel-type

Procedure

APOC Core

apoc.create.removeLabels

apoc.create.removeLabels( [node,id,ids,nodes], ['Label',…​]) - removes the given labels from the node or nodes

Procedure

APOC Core

apoc.create.removeProperties

apoc.create.removeProperties( [node,id,ids,nodes], [keys]) - removes the given properties from the nodes(s)

Procedure

APOC Core

apoc.create.removeRelProperties

apoc.create.removeRelProperties( [rel,id,ids,rels], [keys]) - removes the given properties from the relationship(s)

Procedure

APOC Core

apoc.create.setLabels

apoc.create.setLabels( [node,id,ids,nodes], ['Label',…​]) - sets the given labels, non matching labels are removed on the node or nodes

Procedure

APOC Core

apoc.create.setProperties

apoc.create.setProperties( [node,id,ids,nodes], [keys], [values]) - sets the given properties on the nodes(s)

Procedure

APOC Core

apoc.create.setProperty

apoc.create.setProperty( [node,id,ids,nodes], key, value) - sets the given property on the node(s)

Procedure

APOC Core

apoc.create.setRelProperties

apoc.create.setRelProperties( [rel,id,ids,rels], [keys], [values]) - sets the given properties on the relationship(s)

Procedure

APOC Core

apoc.create.setRelProperty

apoc.create.setRelProperty( [rel,id,ids,rels], key, value) - sets the given property on the relationship(s)

Procedure

APOC Core

apoc.create.uuids

apoc.create.uuids(count) yield uuid - creates 'count' UUIDs

Procedure

APOC Core

apoc.create.vNode

apoc.create.vNode(['Label'], {key:value,…​}) returns a virtual node

Procedure

APOC Core

apoc.create.vNodes

apoc.create.vNodes(['Label'], [{key:value,…​}]) returns virtual nodes

Procedure

APOC Core

apoc.create.clonePathToVirtual

apoc.create.clonePathToVirtual

Procedure

APOC Core

apoc.create.clonePathsToVirtual

apoc.create.clonePathsToVirtual

Procedure

APOC Core

apoc.create.vPattern

apoc.create.vPattern({_labels:['LabelA'],key:value},'KNOWS',{key:value,…​}, {_labels:['LabelB'],key:value}) returns a virtual pattern

Procedure

APOC Core

apoc.create.vPatternFull

apoc.create.vPatternFull(['LabelA'],{key:value},'KNOWS',{key:value,…​},['LabelB'],{key:value}) returns a virtual pattern

Procedure

APOC Core

apoc.create.vRelationship

apoc.create.vRelationship(nodeFrom,'KNOWS',{key:value,…​}, nodeTo) returns a virtual relationship

Procedure

APOC Core

apoc.create.virtualPath

apoc.create.virtualPath(['LabelA'],{key:value},'KNOWS',{key:value,…​},['LabelB'],{key:value}) returns a virtual path of nodes joined by a relationship and the associated properties

Procedure

APOC Core

apoc.create.uuid

apoc.create.uuid() - creates an UUID

Function

APOC Core

apoc.create.vNode

apoc.create.vNode(['Label'], {key:value,…​}) returns a virtual node

Function

APOC Core

apoc.create.vRelationship

apoc.create.vRelationship(nodeFrom,'KNOWS',{key:value,…​}, nodeTo) returns a virtual relationship

Function

APOC Core

apoc.create.virtual.fromNode

apoc.create.virtual.fromNode(node, [propertyNames]) returns a virtual node built from an existing node with only the requested properties

Function

APOC Core

apoc.custom.asFunction

apoc.custom.asFunction(name, statement, outputs, inputs, forceSingle, description) - register a custom cypher function

Procedure

APOC Full

apoc.custom.asProcedure

apoc.custom.asProcedure(name, statement, mode, outputs, inputs, description) - register a custom cypher procedure

Procedure

APOC Full

apoc.custom.declareFunction

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

Procedure

APOC Full

apoc.custom.declareProcedure

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

Procedure

APOC Full

apoc.custom.list

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

Procedure

APOC Full

apoc.custom.removeFunction

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

Procedure

APOC Full

apoc.custom.removeProcedure

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

Procedure

APOC Full

apoc.cypher.doIt

apoc.cypher.doIt(fragment, params) yield value - executes writing fragment with the given parameters

Procedure

APOC Core

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 Full

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 Full

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 Full

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 Full

apoc.cypher.run

apoc.cypher.run(fragment, params) yield value - executes reading fragment with the given parameters - currently no schema operations

Procedure

APOC Core

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 Full

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 Full

apoc.cypher.runFileReadOnly

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

Procedure

APOC Full

apoc.cypher.runFilesReadOnly

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

Procedure

APOC Full

apoc.cypher.runMany

apoc.cypher.runMany('cypher;\nstatements;', $params, [{statistics:true,timeout:10}]) - runs each semicolon separated statement and returns summary - currently no schema operations

Procedure

APOC Core

apoc.cypher.runManyReadOnly

apoc.cypher.runManyReadOnly('cypher;\nstatements;', $params, [{statistics:true,timeout:10}]) - runs each semicolon separated, read-only statement and returns summary - currently no schema operations

Procedure

APOC Core

apoc.cypher.runSchema

apoc.cypher.runSchema(statement, params) yield value - executes query schema statement with the given parameters

Procedure

APOC Core

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 Full

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 Full

apoc.cypher.runTimeboxed

apoc.cypher.runTimeboxed('cypherStatement',{params}, timeout) - abort kernelTransaction after timeout ms if not finished

Procedure

APOC Core

apoc.cypher.runWrite

apoc.cypher.runWrite(statement, params) yield value - alias for apoc.cypher.doIt

Procedure

APOC Core

apoc.cypher.runFirstColumn

use either apoc.cypher.runFirstColumnMany for a list return or apoc.cypher.runFirstColumnSingle for returning the first row of the first column

Function

APOC Core

apoc.cypher.runFirstColumnMany

apoc.cypher.runFirstColumnMany(statement, params) - executes statement with given parameters, returns first column only collected into a list, params are available as identifiers

Function

APOC Core

apoc.cypher.runFirstColumnSingle

apoc.cypher.runFirstColumnSingle(statement, params) - executes statement with given parameters, returns first element of the first column only, params are available as identifiers

Function

APOC Core

apoc.data.domain

apoc.data.domain('url_or_email_address') YIELD domain - extract the domain name from a url or an email address. If nothing was found, yield null.

Function

APOC Core

apoc.data.email

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

Function

APOC Full

apoc.data.url

apoc.data.url('url') as {protocol,host,port,path,query,file,anchor,user} | turn URL into map structure

Function

APOC Core

apoc.date.expire

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

Procedure

APOC Full

apoc.date.expireIn

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

Procedure

APOC Full

apoc.date.add

apoc.date.add(12345, 'ms', -365, 'd') - given a timestamp in one time unit, adds a value of the specified time unit

Function

APOC Core

apoc.date.convert

apoc.date.convert(12345, 'ms', 'd') - convert a timestamp in one time unit into one of a different time unit

Function

APOC Core

apoc.date.convertFormat

apoc.date.convertFormat('Tue, 14 May 2019 14:52:06 -0400', 'rfc_1123_date_time', 'iso_date_time') - convert a String of one date format into a String of another date format.

Function

APOC Core

apoc.date.currentTimestamp

apoc.date.currentTimestamp() - returns System.currentTimeMillis() at the time it was called. The value is current throughout transaction execution, and is different from Cypher’s timestamp() function, which does not update within a transaction.

Function

APOC Core

apoc.date.field

apoc.date.field(12345,('ms|s|m|h|d|month|year'),('TZ')

Function

APOC Core

apoc.date.fields

apoc.date.fields('2012-12-23',('yyyy-MM-dd')) - return columns and a map representation of date parsed with the given format with entries for years,months,weekdays,days,hours,minutes,seconds,zoneid

Function

APOC Core

apoc.date.format

apoc.date.format(12345,('ms|s|m|h|d'),('yyyy-MM-dd HH:mm:ss zzz'),('TZ')) - get string representation of time value optionally using the specified unit (default ms) using specified format (default ISO) and specified time zone (default current TZ)

Function

APOC Core

apoc.date.fromISO8601

apoc.date.fromISO8601('yyyy-MM-ddTHH:mm:ss.SSSZ') - return number representation of time in EPOCH format

Function

APOC Core

apoc.date.parse

apoc.date.parse('2012-12-23','ms|s|m|h|d','yyyy-MM-dd') - parse date string using the specified format into the specified time unit

Function

APOC Core

apoc.date.parseAsZonedDateTime

apoc.date.parseAsZonedDateTime('2012-12-23 23:59:59','yyyy-MM-dd HH:mm:ss', 'UTC-hour-offset') - parse date string using the specified format to specified timezone

Function

APOC Core

apoc.date.systemTimezone

apoc.date.systemTimezone() - returns the system timezone display name

Function

APOC Core

apoc.date.toISO8601

apoc.date.toISO8601(12345,('ms|s|m|h|d') - return string representation of time in ISO8601 format

Function

APOC Core

apoc.date.toYears

toYears(timestamp) or toYears(date[,format]) - converts timestamp into floating point years

Function

APOC Core

apoc.diff.nodes

Function

APOC Core

apoc.diff.relationships

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

Function

APOC Full

apoc.do.case

apoc.do.case([condition, query, condition, query, …​], elseQuery:'', params:{}) yield value - given a list of conditional / writing query pairs, executes the query associated with the first conditional evaluating to true (or the else query if none are true) with the given parameters

Procedure

APOC Core

apoc.do.when

apoc.do.when(condition, ifQuery, elseQuery:'', params:{}) yield value - based on the conditional, executes writing ifQuery or elseQuery with the given parameters

Procedure

APOC Core

apoc.dv.catalog.add

Add a virtualized resource configuration

Procedure

APOC Full

apoc.dv.catalog.list

List all virtualized resource configs

Procedure

APOC Full

apoc.dv.catalog.remove

Remove a virtualized resource config by name

Procedure

APOC Full

apoc.dv.query

Query a virtualized resource by name and return virtual nodes

Procedure

APOC Full

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 Full

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 Full

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 Full

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 Full

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 Full

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 Full

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 Full

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

apoc.example.movies

apoc.example.movies() | Creates the sample movies graph

Procedure

APOC Core

apoc.export.csv.all

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

Procedure

APOC Core

apoc.export.csv.data

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

Procedure

APOC Core

apoc.export.csv.graph

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

Procedure

APOC Core

apoc.export.csv.query

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

Procedure

APOC Core

apoc.export.cypher.all

apoc.export.cypher.all(file,config) - exports whole database incl. indexes as cypher statements to the provided file

Procedure

APOC Core

apoc.export.cypher.data

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

Procedure

APOC Core

apoc.export.cypher.graph

apoc.export.cypher.graph(graph,file,config) - exports given graph object incl. indexes as cypher statements to the provided file

Procedure

APOC Core

apoc.export.cypher.query

apoc.export.cypher.query(query,file,config) - exports nodes and relationships from the cypher statement incl. indexes as cypher statements to the provided file

Procedure

APOC Core

apoc.export.cypher.schema

apoc.export.cypher.schema(file,config) - exports all schema indexes and constraints to cypher

Procedure

APOC Core

apoc.export.cypherAll

apoc.export.cypherAll(file,config) - exports whole database incl. indexes as cypher statements to the provided file

Procedure

APOC Core

apoc.export.cypherData

apoc.export.cypherData(nodes,rels,file,config) - exports given nodes and relationships incl. indexes as cypher statements to the provided file

Procedure

APOC Core

apoc.export.cypherGraph

apoc.export.cypherGraph(graph,file,config) - exports given graph object incl. indexes as cypher statements to the provided file

Procedure

APOC Core

apoc.export.cypherQuery

apoc.export.cypherQuery(query,file,config) - exports nodes and relationships from the cypher kernelTransaction incl. indexes as cypher statements to the provided file

Procedure

APOC Core

apoc.export.graphml.all

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

Procedure

APOC Core

apoc.export.graphml.data

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

Procedure

APOC Core

apoc.export.graphml.graph

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

Procedure

APOC Core

apoc.export.graphml.query

apoc.export.graphml.query(query,file,config) - exports nodes and relationships from the cypher statement as graphml to the provided file

Procedure

APOC Core

apoc.export.json.all

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

Procedure

APOC Core

apoc.export.json.data

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

Procedure

APOC Core

apoc.export.json.graph

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

Procedure

APOC Core

apoc.export.json.query

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

Procedure

APOC Core

apoc.export.xls.all

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

Procedure

APOC Full

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 Full

apoc.export.xls.graph

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

Procedure

APOC Full

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 Full

apoc.generate.ba

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

Procedure

APOC Full

apoc.generate.complete

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

Procedure

APOC Full

apoc.generate.er

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

Procedure

APOC Full

apoc.generate.simple

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

Procedure

APOC Full

apoc.generate.ws

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

Procedure

APOC Full

apoc.gephi.add

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

Procedure

APOC Full

apoc.get.nodes

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

Procedure

APOC Full

apoc.get.rels

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

Procedure

APOC Full

apoc.graph.from

apoc.graph.from(data,'name',{properties}) | creates a virtual graph object for later processing it tries its best to extract the graph information from the data you pass in

Procedure

APOC Core

apoc.graph.fromCypher

apoc.graph.fromCypher('kernelTransaction',{params},'name',{properties}) - creates a virtual graph object for later processing

Procedure

APOC Core

apoc.graph.fromDB

apoc.graph.fromDB('name',{properties}) - creates a virtual graph object for later processing

Procedure

APOC Core

apoc.graph.fromData

apoc.graph.fromData([nodes],[relationships],'name',{properties}) | creates a virtual graph object for later processing

Procedure

APOC Core

apoc.graph.fromDocument

apoc.graph.fromDocument({json}, {config}) yield graph - transform JSON documents into graph structures

Procedure

APOC Core

apoc.graph.fromPath

apoc.graph.fromPath(path,'name',{properties}) - creates a virtual graph object for later processing

Procedure

APOC Core

apoc.graph.fromPaths

apoc.graph.fromPaths([paths],'name',{properties}) - creates a virtual graph object for later processing

Procedure

APOC Core

apoc.graph.validateDocument

apoc.graph.validateDocument({json}, {config}) yield row - validates the json, return the result of the validation

Procedure

APOC Core

apoc.hashing.fingerprint

calculate a checksum (md5) over a node or a relationship. This deals gracefully with array properties. Two identical entities do share the same hash. Unsuitable for cryptographic use-cases.

Function

APOC Core

apoc.hashing.fingerprintGraph

calculate a checksum (md5) over a the full graph. Be aware that this function does use in-memomry datastructures depending on the size of your graph. Unsuitable for cryptographic use-cases.

Function

APOC Core

apoc.hashing.fingerprinting

calculate a checksum (md5) over a node or a relationship. This deals gracefully with array properties. Two identical entities do share the same hash. Unsuitable for cryptographic use-cases.

Function

APOC Core

apoc.import.csv

apoc.import.csv(nodes, relationships, config) - imports nodes and relationships from the provided CSV files with given labels and types

Procedure

APOC Core

apoc.import.graphml

apoc.import.graphml(urlOrBinaryFile,config) - imports graphml file

Procedure

APOC Core

apoc.import.json

apoc.import.json(urlOrBinaryFile,config) - imports the json list to the provided file

Procedure

APOC Core

apoc.import.xml

apoc.import.xml(file,config) - imports graph from provided file

Procedure

APOC Core

apoc.json.validate

apoc.json.validate('{json}' [,'json-path' , 'path-options']) - to check if the json is correct (returning an empty result) or not

Procedure

APOC Full

apoc.json.path

apoc.json.path('{json}' [,'json-path' , 'path-options'])

Function

APOC Core

apoc.label.exists

apoc.label.exists(element, label) - returns true or false related to label existance

Function

APOC Core

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 Full

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 Full

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 Full

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 Full

apoc.load.directory.async.list

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

Procedure

APOC Full

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 Full

apoc.load.directory.async.removeAll

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

Procedure

APOC Full

apoc.load.driver

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

Procedure

APOC Full

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 Full

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 Full

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 Full

apoc.load.jdbcParams

deprecated - please use: apoc.load.jdbc('key or url','',[params]) YIELD row - load from relational database, from a sql statement with parameters

Procedure

APOC Full

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 Full

apoc.load.json

apoc.load.json('urlOrKeyOrBinary',path, config) YIELD value - import JSON as stream of values if the JSON was an array or a single value if it was a map

Procedure

APOC Core

apoc.load.jsonArray

apoc.load.jsonArray('url') YIELD value - load array from JSON URL (e.g. web-api) to import JSON as stream of values

Procedure

APOC Core

apoc.load.jsonParams

apoc.load.jsonParams('urlOrKeyOrBinary',{header:value},payload, config) YIELD value - load from JSON URL (e.g. web-api) while sending headers / payload to import JSON as stream of values if the JSON was an array or a single value if it was a map

Procedure

APOC Core

apoc.load.ldap

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

Procedure

APOC Full

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 Full

apoc.load.xml

apoc.load.xml('http://example.com/test.xml', 'xPath',config, false) YIELD value as doc CREATE (p:Person) SET p.name = doc.name - load from XML URL (e.g. web-api) to import XML as single nested map with attributes and _type, _text and _childrenx fields.

Procedure

APOC Core

apoc.lock.all

apoc.lock.all([nodes],[relationships]) acquires a write lock on the given nodes and relationships

Procedure

APOC Core

apoc.lock.nodes

apoc.lock.nodes([nodes]) acquires a write lock on the given nodes

Procedure

APOC Core

apoc.lock.read.nodes

apoc.lock.read.nodes([nodes]) acquires a read lock on the given nodes

Procedure

APOC Core

apoc.lock.read.rels

apoc.lock.read.rels([relationships]) acquires a read lock on the given relationship

Procedure

APOC Core

apoc.lock.rels

apoc.lock.rels([relationships]) acquires a write lock on the given relationship

Procedure

APOC Core

apoc.log.debug

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

Procedure

APOC Full

apoc.log.error

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

Procedure

APOC Full

apoc.log.info

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

Procedure

APOC Full

apoc.log.stream

apoc.log.stream('neo4j.log', { last: n }) - retrieve log file contents, optionally return only the last n lines

Procedure

APOC Core

apoc.log.warn

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

Procedure

APOC Full

apoc.map.clean

apoc.map.clean(map,[skip,keys],[skip,values]) yield map filters the keys and values contained in those lists, good for data cleaning from CSV/JSON

Function

APOC Core

apoc.map.flatten

apoc.map.flatten(map, delimiter:'.') yield map - flattens nested items in map using dot notation

Function

APOC Core

apoc.map.fromLists

apoc.map.fromLists([keys],[values])

Function

APOC Core

apoc.map.fromNodes

apoc.map.fromNodes(label, property)

Function

APOC Core

apoc.map.fromPairs

apoc.map.fromPairs([[key,value],[key2,value2],…​])

Function

APOC Core

apoc.map.fromValues

apoc.map.fromValues([key1,value1,key2,value2,…​])

Function

APOC Core

apoc.map.get

apoc.map.get(map,key,[default],[fail=true]) - returns value for key or throws exception if key doesn’t exist and no default given

Function

APOC Core

apoc.map.groupBy

apoc.map.groupBy([maps/nodes/relationships],'key') yield value - creates a map of the list keyed by the given property, with single values

Function

APOC Core

apoc.map.groupByMulti

apoc.map.groupByMulti([maps/nodes/relationships],'key') yield value - creates a map of the list keyed by the given property, with list values

Function

APOC Core

apoc.map.merge

apoc.map.merge(first,second) - merges two maps

Function

APOC Core

apoc.map.mergeList

apoc.map.mergeList([{maps}]) yield value - merges all maps in the list into one

Function

APOC Core

apoc.map.mget

apoc.map.mget(map,key,[defaults],[fail=true]) - returns list of values for keys or throws exception if one of the key doesn’t exist and no default value given at that position

Function

APOC Core

apoc.map.removeKey

apoc.map.removeKey(map,key,{recursive:true/false}) - remove the key from the map (recursively if recursive is true)

Function

APOC Core

apoc.map.removeKeys

apoc.map.removeKeys(map,[keys],{recursive:true/false}) - remove the keys from the map (recursively if recursive is true)

Function

APOC Core

apoc.map.setEntry

apoc.map.setEntry(map,key,value)

Function

APOC Core

apoc.map.setKey

apoc.map.setKey(map,key,value)

Function

APOC Core

apoc.map.setLists

apoc.map.setLists(map,[keys],[values])

Function

APOC Core

apoc.map.setPairs

apoc.map.setPairs(map,[[key1,value1],[key2,value2])

Function

APOC Core

apoc.map.setValues

apoc.map.setValues(map,[key1,value1,key2,value2])

Function

APOC Core

apoc.map.sortedProperties

apoc.map.sortedProperties(map, ignoreCase:true) - returns a list of key/value list pairs, with pairs sorted by keys alphabetically, with optional case sensitivity

Function

APOC Core

apoc.map.submap

apoc.map.submap(map,keys,[defaults],[fail=true]) - returns submap for keys or throws exception if one of the key doesn’t exist and no default value given at that position

Function

APOC Core

apoc.map.unflatten

apoc.map.unflatten(map, delimiter:'.') yield map - unflat from items separated by delimiter string to nested items (reverse of apoc.map.flatten function)

Function

APOC Core

apoc.map.updateTree

apoc.map.updateTree(tree,key,) returns map - adds the {data} map on each level of the nested tree, where the key-value pairs match

Function

APOC Core

apoc.map.values

apoc.map.values(map, [key1,key2,key3,…​],[addNullsForMissing]) returns list of values indicated by the keys

Function

APOC Core

apoc.math.regr

apoc.math.regr(label, propertyY, propertyX) - It calculates the coefficient of determination (R-squared) for the values of propertyY and propertyX in the provided label

Procedure

APOC Core

apoc.math.cosh

apoc.math.cosh(val) | returns the hyperbolic cosin

Function

APOC Core

apoc.math.coth

apoc.math.coth(val) | returns the hyperbolic cotangent

Function

APOC Core

apoc.math.csch

apoc.math.csch(val) | returns the hyperbolic cosecant

Function

APOC Core

apoc.math.maxByte

apoc.math.maxByte() | return the maximum value an byte can have

Function

APOC Core

apoc.math.maxDouble

apoc.math.maxDouble() | return the largest positive finite value of type double

Function

APOC Core

apoc.math.maxInt

apoc.math.maxInt() | return the maximum value an int can have

Function

APOC Core

apoc.math.maxLong

apoc.math.maxLong() | return the maximum value a long can have

Function

APOC Core

apoc.math.minByte

apoc.math.minByte() | return the minimum value an byte can have

Function

APOC Core

apoc.math.minDouble

apoc.math.minDouble() | return the smallest positive nonzero value of type double

Function

APOC Core

apoc.math.minInt

apoc.math.minInt() | return the minimum value an int can have

Function

APOC Core

apoc.math.minLong

apoc.math.minLong() | return the minimum value a long can have

Function

APOC Core

apoc.math.round

apoc.math.round(value,[prec],mode=[CEILING,FLOOR,UP,DOWN,HALF_EVEN,HALF_DOWN,HALF_UP,DOWN,UNNECESSARY])

Function

APOC Core

apoc.math.sech

apoc.math.sech(val) | returns the hyperbolic secant

Function

APOC Core

apoc.math.sigmoid

apoc.math.sigmoid(val) | returns the sigmoid value

Function

APOC Core

apoc.math.sigmoidPrime

apoc.math.sigmoidPrime(val) | returns the sigmoid prime [ sigmoid(val) * (1 - sigmoid(val)) ]

Function

APOC Core

apoc.math.sinh

apoc.math.sinh(val) | returns the hyperbolic sin

Function

APOC Core

apoc.math.tanh

apoc.math.tanh(val) | returns the hyperbolic tangent

Function

APOC Core

apoc.merge.node

"apoc.merge.node.eager(['Label'], identProps:{key:value, …​}, onCreateProps:{key:value,…​}, onMatchProps:{key:value,…​}}) - merge nodes with dynamic labels, with support for setting properties ON CREATE or ON MATCH

Procedure

APOC Core

apoc.merge.node.eager

apoc.merge.node.eager(['Label'], identProps:{key:value, …​}, onCreateProps:{key:value,…​}, onMatchProps:{key:value,…​}}) - merge nodes eagerly, with dynamic labels, with support for setting properties ON CREATE or ON MATCH

Procedure

APOC Core

apoc.merge.relationship

apoc.merge.relationship(startNode, relType, identProps:{key:value, …​}, onCreateProps:{key:value, …​}, endNode, onMatchProps:{key:value, …​}) - merge relationship with dynamic type, with support for setting properties ON CREATE or ON MATCH

Procedure

APOC Core

apoc.merge.relationship.eager

apoc.merge.relationship(startNode, relType, identProps:{key:value, …​}, onCreateProps:{key:value, …​}, endNode, onMatchProps:{key:value, …​}) - merge relationship with dynamic type, with support for setting properties ON CREATE or ON MATCH

Procedure

APOC Core

apoc.meta.data

apoc.meta.data({config}) - examines a subset of the graph to provide a tabular meta information

Procedure

APOC Core

apoc.meta.data.of

apoc.meta.data.of({graph}, {config}) - examines a subset of the graph to provide a tabular meta information

Procedure

APOC Core

apoc.meta.graph

apoc.meta.graph - examines the full graph to create the meta-graph

Procedure

APOC Core

apoc.meta.graph.of

apoc.meta.graph.of({graph}, {config}) - examines a subset of the graph to provide a graph meta information

Procedure

APOC Core

apoc.meta.graphSample

apoc.meta.graphSample() - examines the database statistics to build the meta graph, very fast, might report extra relationships

Procedure

APOC Core

apoc.meta.nodeTypeProperties

apoc.meta.nodeTypeProperties()

Procedure

APOC Core

apoc.meta.relTypeProperties

apoc.meta.relTypeProperties()

Procedure

APOC Core

apoc.meta.schema

apoc.meta.schema({config}) - examines a subset of the graph to provide a map-like meta information

Procedure

APOC Core

apoc.meta.stats

apoc.meta.stats yield labelCount, relTypeCount, propertyKeyCount, nodeCount, relCount, labels, relTypes, stats | returns the information stored in the transactional database statistics

Procedure

APOC Core

apoc.meta.subGraph

apoc.meta.subGraph({labels:[labels],rels:[rel-types], excludes:[labels,rel-types]}) - examines a sample sub graph to create the meta-graph

Procedure

APOC Core

apoc.meta.cypher.isType

apoc.meta.cypher.isType(value,type) - returns a row if type name matches none if not (INTEGER,FLOAT,STRING,BOOLEAN,RELATIONSHIP,NODE,PATH,NULL,MAP,LIST OF <TYPE>,POINT,DATE,DATE_TIME,LOCAL_TIME,LOCAL_DATE_TIME,TIME,DURATION)

Function

APOC Core

apoc.meta.cypher.type

apoc.meta.cypher.type(value) - type name of a value (INTEGER,FLOAT,STRING,BOOLEAN,RELATIONSHIP,NODE,PATH,NULL,MAP,LIST OF <TYPE>,POINT,DATE,DATE_TIME,LOCAL_TIME,LOCAL_DATE_TIME,TIME,DURATION)

Function

APOC Core

apoc.meta.cypher.types

apoc.meta.cypher.types(node-relationship-map) - returns a map of keys to types

Function

APOC Core

apoc.meta.isType

apoc.meta.isType(value,type) - returns a row if type name matches none if not (INTEGER,FLOAT,STRING,BOOLEAN,RELATIONSHIP,NODE,PATH,NULL,UNKNOWN,MAP,LIST)

Function

APOC Core

apoc.meta.nodes.count

apoc.meta.nodes.count([labels], $config) - Returns the sum of the nodes with a label present in the list.

Function

APOC Core

apoc.meta.type

apoc.meta.type(value) - type name of a value (INTEGER,FLOAT,STRING,BOOLEAN,RELATIONSHIP,NODE,PATH,NULL,UNKNOWN,MAP,LIST)

Function

APOC Core

apoc.meta.typeName

apoc.meta.typeName(value) - type name of a value (INTEGER,FLOAT,STRING,BOOLEAN,RELATIONSHIP,NODE,PATH,NULL,UNKNOWN,MAP,LIST)

Function

APOC Core

apoc.meta.types

apoc.meta.types(node-relationship-map) - returns a map of keys to types

Function

APOC Core

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 Full

apoc.metrics.list

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

Procedure

APOC Full

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 'dbms.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 Full

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 Full