apoc.uuid.remove

Procedure APOC Full Deprecated

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

Signature

apoc.uuid.remove(label :: STRING?) :: (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.

Input parameters

Name Type Default

label

STRING?

null

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 a UUID handler (installed by apoc.uuid.install), by running the following query:

CALL apoc.uuid.remove("Person");
Table 1. Results
label installed properties

"Person"

FALSE

{uuidProperty: "myUUID"}

If we try to remove a non existent UUID handler, the output will indicate that no such handler is installed:

CALL apoc.uuid.remove("Foo");
Table 2. Results
label installed properties

NULL

FALSE

{}

More documentation of apoc.uuid.remove