apoc.meta.data.of

Procedure

apoc.meta.data.of(graph ANY, config MAP<STRING, ANY>) - examines the given sub-graph and returns a table of metadata.

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.

Signature

apoc.meta.data.of(graph :: ANY, config = {} :: MAP) :: (label :: STRING, property :: STRING, count :: INTEGER, unique :: BOOLEAN, index :: BOOLEAN, existence :: BOOLEAN, type :: STRING, array :: BOOLEAN, sample :: LIST<ANY>, left :: INTEGER, right :: INTEGER, other :: LIST<STRING>, otherLabels :: LIST<STRING>, elementType :: STRING)

Input parameters

Name Type Default

graph

ANY

null

config

MAP

{}

Config Parameters

This procedure supports the following config parameters:

Table 1. Config parameters
Name Type Default Description

sample

INTEGER

1000

Number of nodes to skip, e.g. a sample of 1000 will read every 1000th node.

Output parameters

Name Type

label

STRING

property

STRING

count

INTEGER

unique

BOOLEAN

index

BOOLEAN

existence

BOOLEAN

type

STRING

array

BOOLEAN

sample

LIST<ANY>

left

INTEGER

right

INTEGER

other

LIST<STRING>

otherLabels

LIST<STRING>

elementType

STRING

Usage Examples

Type of supported input graphs

Type Description

STRING

a Cypher query

Virtual Graph

a Virtual Graph returned by apoc.graph.*

MAP

a map with two field nodes (a list of nodes, mandatory), relationships (a list of relationships)

If you want more details you can look at apoc.meta.data documentation