apoc.uuid.setup

This is the APOC Extended documentation.

APOC Extended is not supported by Neo4j. For the officially supported APOC Core, go to the APOC Core page.

Procedure Apoc Extended

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

Signature

apoc.uuid.setup(label :: STRING?, databaseName = neo4j :: STRING?, config = {} :: MAP?) :: (label :: STRING?, installed :: BOOLEAN?, properties :: MAP?)

Input parameters

Name	Type	Default
label	STRING?	null
databaseName	STRING?	neo4j
config	MAP?	{}

Name

Type

Default

label

STRING?

null

databaseName

STRING?

neo4j

config

MAP?

{}

Output parameters

Name	Type
label	STRING?
installed	BOOLEAN?
properties	MAP?

Name

Type

label

STRING?

installed

BOOLEAN?

properties

MAP?

Enable automatic UUIDs

This procedure is part of a set of procedures that handle automatic adding of UUID properties, via the UUID Handler Lifecycle. The UUID handler is a transaction event handler that automatically adds the UUID property to a provided label and for the provided property name.

By default automatic adding of UUIDs is disabled. We can enable it by setting the following property in apoc.conf:

apoc.conf

apoc.uuid.enabled=true