@neo4j/cypher-builder

Cypher Builder

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

• Documentation
• Discussions

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.19.0

Minor Changes

• #369 3514bdd Thanks @angrykoala! - Add support for LOAD CSV:

  const row = new Cypher.Variable();
  const loadClause = new Cypher.LoadCSV("https://data.neo4j.com/bands/artists.csv", row).return(row);
  

• #354 ef49a96 Thanks @angrykoala! - Add support for quantifier patterns:

  const m = new Cypher.Node();
  const m2 = new Cypher.Node();
  
  const quantifiedPath = new Cypher.QuantifiedPath(
      new Cypher.Pattern(m, { labels: ["Movie"], properties: { title: new Cypher.Param("V for Vendetta") } }),
      new Cypher.Pattern({ labels: ["Movie"] })
          .related({ type: "ACTED_IN" })
          .to({ labels: ["Person"] })
          .quantifier({ min: 1, max: 2 }),
      new Cypher.Pattern(m2, {
          labels: ["Movie"],
          properties: { title: new Cypher.Param("Something's Gotta Give") },
      })
  );
  
  const query = new Cypher.Match(quantifiedPath).return(m2);
  

  Cypher

  MATCH (this0:Movie { title: $param0 })
        ((:Movie)-[:ACTED_IN]->(:Person)){1,2}
        (this1:Movie { title: $param1 })
  RETURN this1
  

Patch Changes

• #371 6d1b0c4 Thanks @angrykoala! - Add LOAD CSV related functions:

  • file()
  • linenumber()