apoc.schema.node.indexExists

Function

apoc.schema.node.indexExists(labelName STRING, propertyName LIST<STRING>) - returns a BOOLEAN depending on whether or not an index exists for the given NODE label with the given property names.

This function 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.schema.node.indexExists(labelName :: STRING, propertyName :: LIST<STRING>) :: BOOLEAN

Input parameters

Name Type Default

labelName

STRING

null

propertyName

LIST<STRING>

null

Usage Examples

The examples in this section are based on a database that has applied the following constraints:

CREATE CONSTRAINT personName FOR (person:Person)
REQUIRE person.name IS UNIQUE;

CREATE CONSTRAINT userId FOR (user:User)
REQUIRE user.id IS UNIQUE;

CREATE INDEX personCity FOR (person:Person)
ON (person.city);
RETURN apoc.schema.node.indexExists("Person", ["name"]) AS output;
Table 1. Results
output

TRUE

RETURN apoc.schema.node.indexExists("Person", ["city"]) AS output;
Table 2. Results
output

TRUE