@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({
    labels: ["Movie"],
});

const matchQuery = new Cypher.Match(movieNode)
    .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

0.6.0

Minor Changes

• #53 7623c25 Thanks @angrykoala! - Add support for number params in skip and limit

• #34 ee295d0 Thanks @angrykoala! - Removes getReference method from the Environment class

• #27 9d6cfe3 Thanks @angrykoala! - Updates CypherResult type to Record<string, unknown>, better reflecting the results of the parameters

Patch Changes

• #51 f2394db Thanks @angrykoala! - Add support for count(*)

• #30 c92b67a Thanks @angrykoala! - Add support for COUNT subqueries

• #26 9c46104 Thanks @angrykoala! - Fix typings for predicate functions