@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",
}

Contributing

See our contributing guide for development instructions.

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

Minor Changes

• #559 137a908 Thanks @angrykoala! - Support for dynamic labels in patterns

  const query = new Cypher.Match(
      new Cypher.Pattern(new Cypher.Node(), {
          labels: new Cypher.Param("Movie"),
      })
  );
  

  MATCH (this0:$($param0))
  

• #559 0223ca9 Thanks @angrykoala! - Add support for dynamic types in patterns

  const query = new Cypher.Match(
      new Cypher.Pattern(new Cypher.Node())
          .related({
              type: new Cypher.Param("ACTED_IN"),
          })
          .to()
  );
  

  MATCH (this0)-[:$($param1)]->()
  

Patch Changes

• #561 83774e8 Thanks @angrykoala! - Deprecates the option labelOperator, this option only exists for compatibility with Cypher 4 and is no longer relevant for Cypher 5 or 25