@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

2.1.0

Minor Changes

• #471 1c671f1 Thanks @angrykoala! - Add support for dynamic labels by passing an expression to node.label:

  new Cypher.Match(new Cypher.Pattern(movie)).set(movie.label(Cypher.labels(anotherNode)));
  

  MATCH (this0)
  SET
      this0:$(labels(this1))
  

Patch Changes

• #476 79e1e87 Thanks @angrykoala! - Escapes variables using the following reserved words (case insensitive):

  • where
  • is
  • contains
  • in

  For example:

  new Cypher.NamedVariable("Where").property("title");
  

  Generates the following Cypher

  `Where`.title