@neo4j/cypher-builder

Cypher Builder - Beta

The Cypher builder is a library for building Cypher for Neo4j queries with a programmatic API.

Note that this library is still under development.

Try it live on CodePen.

Getting Started

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);

In this example, cypher will be a string containing the following:

MATCH (this0:`Movie`)
WHERE this0.title = $param0
RETURN this0.title

params will contain the parameters used in that query as an object:

{
    "param0": "The Matrix",
}

Examples

You can find usage examples in the examples folder and in CodePen.

Development

• yarn test to run cypher builder tests
• yarn build to compile cypher builder library
• yarn docs to generate the API reference docs

Changelog

0.4.0

Minor Changes

• #3147 2bc2c7019 Thanks @angrykoala! - Refactor Cypher.Map to use a Map internally, include .size method and remove support for undefined fields

• #3106 bfae63097 Thanks @darrellwarde! - The type Cypher.PropertyRef is now fully exported under Cypher.Property for use with utilities such as instanceof. However, it maintains the current behaviour of not being directly instantiable.

• #3115 a04ef4469 Thanks @angrykoala! - Map projections inject the leading dot (.) in the map fields automatically.

Patch Changes

• #3091 0d7a140ae Thanks @angrykoala! - Add support for using sets when defining the labels of a Node

• #3153 d47624ea1 Thanks @MacondoExpress! - Adds divide, multiply, mod, pow to the Math Operators.

• #3154 b276bbae2 Thanks @angrykoala! - Add inequality operator (<>) with Cypher.neq