apoc.uuid.removeAll

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 Deprecated

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

Signature

apoc.uuid.removeAll() :: (label :: STRING?, installed :: BOOLEAN?, properties :: MAP?)

Please note that this procedure is deprecated.

Use the following ones instead, which allow for better support in a cluster:

deprecated procedure new procedure

apoc.uuid.install('<name>', $config)

apoc.uuid.setup('<name>', '<query>', '<dbName>', $config)

apoc.uuid.remove('<name>')

apoc.uuid.drop('<name>', '<dbName>')

apoc.uuid.removeAll()

apoc.uuid.removeAll('<dbName>')

where <dbName> is the database where we want to execute the automatic UUIDs and has "neo4j" as default value.

See here for more info.

This procedure is not intended to be used in a cluster environment, and may act unpredictably.

Output parameters

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

Usage Examples

We can remove all UUID handler (installed by apoc.uuid.install), by running the following query:

CALL apoc.uuid.removeAll();
Table 1. Results
label installed properties

"Person"

FALSE

{uuidProperty: "myUUID"}

If we try to remove UUID handlers when non are installed, the output will indicate that no handlers were removed:

CALL apoc.uuid.removeAll();
Table 2. Results
label installed properties

More documentation of apoc.uuid.removeAll