@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.0.2

Patch Changes

• #463 57a3f9c Thanks @angrykoala! - Fix order of set remove subclauses. The generated cypher will now maintain the order of multiple SET and REMOVE statements.

  For example:

  const matchQuery = new Cypher.Match(new Cypher.Pattern(personNode, { labels: ["Person"] }))
      .where(personNode, { name: nameParam })
      .set([personNode.property("name"), evilKeanu])
      .remove(personNode.property("anotherName"))
      .set([personNode.property("anotherName"), new Cypher.Param(nameParam)])
      .set([personNode.property("oldName"), new Cypher.Param(nameParam)])
      .return(personNode);
  

  Before

  MATCH (this0:Person)
  WHERE this0.name = $param0
  SET
      this0.name = $param1
      this0.anotherName = $param2,
      this0.oldName = $param3
  REMOVE this0.anotherName
  RETURN this0
  

  After

  MATCH (this0:Person)
  WHERE this0.name = $param0
  SET
      this0.name = $param1
  REMOVE this0.anotherName
  SET
      this0.anotherName = $param2,
      this0.oldName = $param3
  RETURN this0