Procedures
Procedures are functions that can be called from within Cypher queries using the CALL syntax.
Syntax
Basic procedure call:
GRAPH.QUERY social "CALL db.labels()"
With explicit YIELD to select specific return values:
GRAPH.QUERY social "CALL db.labels() YIELD label"
Note: The YIELD clause is optional. When omitted, all values listed in the ‘Yields’ column are returned automatically.
Available Procedures
| Procedure | Arguments | Yields | Description |
|---|---|---|---|
| db.labels | none | label |
Yields all node labels in the graph. |
| db.relationshipTypes | none | relationshipType |
Yields all relationship types in the graph. |
| db.propertyKeys | none | propertyKey |
Yields all property keys in the graph. |
| db.meta.stats | none | labels, relTypes, relCount, nodeCount, labelCount, relTypeCount, propertyKeyCount |
Yield comprehensive graph statistics including maps of labels and relationship types with their counts, total node/relationship counts, and schema metadata counts. |
| db.indexes | none | label, properties, types, options, language, stopwords, entitytype, status, info |
Yield all indexes in the graph, denoting whether they are of the type of exact-match (“RANGE”), full-text (“FULLTEXT”) or vector (“VECTOR”) and which label and properties each covers and whether they are indexing node or relationship attributes. |
| db.constraints | none | type, label, properties, entitytype, status |
Yield all constraints in the graph, denoting constraint type (UNIQUE/MANDATORY), which label/relationship-type and properties each enforces. |
| db.idx.fulltext.createNodeIndex | label, property [, property …] |
none | Builds a full-text searchable index on a label and the 1 or more specified properties. |
| db.idx.fulltext.drop | label |
none | Deletes the full-text index associated with the given label. |
| db.idx.fulltext.queryNodes | label, string |
node, score |
Retrieve all nodes that contain the specified string in the full-text indexes on the given label. |
| db.idx.fulltext.queryRelationships | relationshipType, string |
relationship, score |
Retrieve all relationships that contain the specified string in the full-text indexes on the given relationship type. See Full-Text Indexing for details. |
| db.idx.vector.queryNodes | label, attribute, k, query |
node, score |
Retrieve up to k nodes with vectors most similar to the query vector using the specified label and attribute. See Vector Indexing for details. |
| db.idx.vector.queryRelationships | relationshipType, attribute, k, query |
relationship, score |
Retrieve up to k relationships with vectors most similar to the query vector using the specified relationship type and attribute. See Vector Indexing for details. |
| algo.pageRank | label, relationship-type |
node, score |
Runs the pagerank algorithm over nodes of given label, considering only edges of given relationship type. |
| algo.BFS | source-node, max-level, relationship-type |
nodes, edges |
Performs BFS to find all nodes connected to the source. A max level of 0 indicates unlimited and a non-NULL relationship-type defines the relationship type that may be traversed. See BFS Algorithm for details. |
| algo.MSF | config |
src, dest, weight, relationshipType |
Computes the Minimum Spanning Forest of the graph. See MSF Algorithm for details. |
| dbms.procedures() | none | name, mode |
List all procedures in the DBMS, yields for every procedure its name and mode (read/write). |