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

Patch Changes

• #373 99eb375 Thanks @angrykoala! - Add support for new Union().distinct()

• #378 51ae499 Thanks @angrykoala! - Add support for trimCharacter on rtrim and ltrim

• #377 d4c790e Thanks @angrykoala! - Add support for btrim

• #378 51ae499 Thanks @angrykoala! - Deprecates lTrim and rTrim in favour of ltrim and rtrim