@neo4j/cypher-builder

Cypher Builder

Cypher Builder is a JavaScript programmatic API to create Cypher queries for Neo4j.

• Documentation

import Cypher from "@neo4j/cypher-builder";

const movieNode = new Cypher.Node();
const pattern = new Cypher.Pattern(movieNode, { labels: ["Movie"] });

const matchQuery = new Cypher.Match(pattern)
    .where(movieNode, {
        title: new Cypher.Param("The Matrix"),
    })
    .return(movieNode.property("title"));

const { cypher, params } = matchQuery.build();

console.log(cypher);
console.log(params);

Cypher

MATCH (this0:Movie)
WHERE this0.title = $param0
RETURN this0.title

Params

{
    "param0": "The Matrix",
}

Examples

You can find usage examples in the examples folder.

This library is for JavaScript and TypeScript only. If you are using Java, check Neo4j Cypher DSL.

Changelog

1.21.0

Minor Changes

• #413 0f2dfe6 Thanks @angrykoala! - Add support for SHORTEST keyword in match and its variations:

  • .shortest(k)
  • .shortestGroups(k)
  • .allShortest
  • .any

  For example:

  new Cypher.Match(pattern).shortest(2).return(node);
  

  MATCH ALL SHORTEST (this0:Movie)-[this1]->(this2:Person)
  RETURN this0
  

• #419 c7dd297 Thanks @angrykoala! - Add support for labels in set and remove:

  const movie = new Cypher.Node();
  const clause = new Cypher.Match(new Cypher.Pattern(movie)).set(movie.label("NewLabel"));
  

  MATCH (this0)
  SET
      this0:NewLabel