@douglasgabr/cypher-builder

cypher-builder

Fluent CQL Builder for Neo4j

🚨🚨🚨 Warning 🚨🚨🚨

This package is in early stages of development, use it at your own risk.

Installation

npm install @douglasgabr/cypher-builder

or

yarn add @douglasgabr/cypher-builder

Usage

import { Builder, RelationshipDirection } from '@douglasgabr/cypher-builder';

const queryBuilder = new Builder()
  .match((match) =>
    match
      .node('person', 'Person', { name: 'Alice' })
      .relationship(RelationshipDirection.Either, 'KNOWS')
      .node('friend', 'Person'),
  )
  .where((where) => where.and('friend.age', '>=', 18))
  .return('person', 'friend');
const { query, parameters } = queryBuilder.buildQueryObject();

query:

MATCH (alice:Person{ name: $param1 })-[:KNOWS]-(friend:Person)
WHERE friend.age >= $param2
RETURN person, friend

parameters:

{
  param1: 'Alice',
  param2: 18
}

Changelog

1.2.0 / 2021-10-07

• feat: add delete and detachDelete to builder