Hi,

Just noticed that setVariables() supports override: true but it expands all the variables rather than just passing parameters while setValues() doesn't support adding properties.

What I expect is

SET data += $data

For example:

const data = {
  a: 'some string',
  b: 1234
}

With setVariables({ data: data }), it goes:

SET
  data.a += some string, // as your document said, the string won't be escaped
  data.b += 1234

With setValues({ data: data }), it goes:

SET data = $data

The devDependency rollup was updated from 1.27.13 to 1.27.14.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

rollup is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency semantic-release was updated from 15.13.32 to 15.14.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

semantic-release is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

When I attempt to use COLLECT on a return node, the Transformer class currently returns null. I would like to get the array of transformed values - or alternatively specify a custom transformer with the connection initializer.

Thanks for all the great work!

The devDependency @types/chai-as-promised was updated from 7.1.1 to 7.1.2.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/chai-as-promised is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Hello, I've been using this great library for a while now. I recently tried to fork an existing app and can't get it to work. I'm receiving the following error. Thanks for your work on this library and thanks for taking time to review my issue.

`internal/modules/cjs/loader.js:582
throw err;
^

Error: Cannot find module '../node_modules/lodash/isArray.js'
at Function.Module._resolveFilename (internal/modules/cjs/loader.js:580:15)
at Function.Module._load (internal/modules/cjs/loader.js:506:25)
at Module.require (internal/modules/cjs/loader.js:636:17)
at require (internal/modules/cjs/helpers.js:20:18)
at Object. (C:_\myappname\node_modules\cypher-query-builder\dist\cjs5.js:7:32)
at Module._compile (internal/modules/cjs/loader.js:688:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:699:10)
at Module.load (internal/modules/cjs/loader.js:598:32)
at tryModuleLoad (internal/modules/cjs/loader.js:537:12)
at Function.Module._load (internal/modules/cjs/loader.js:529:3)`

There have been updates to the babel7 monorepo:

• • The devDependency @babel/core was updated from 7.7.5 to 7.7.7.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

This monorepo update includes releases of one or more dependencies which all belong to the babel7 group definition.

babel7 is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

The push permission to the Git repository is required.

semantic-release cannot push the version tag to the branch master on remote Git repository with URL github:jamesfer/cypher-query-builder.

Please refer to the authentication configuration documentation to configure the Git credentials on your CI environment and make sure the repositoryUrl is configured with a valid Git URL.

Good luck with your project ✨

Your semantic-release bot 📦🚀

The Neo4j driver supports streaming results from the database as they arrive allowing them to be transformed and processed immediately. The Query and Connection classes should both support a stream method that will return an observable of the results of the query.

Seems like a stupid question, but how do I generate a query like this one:

MATCH (someNode:SomeLabel) 
WHERE someNode.someProperty > 1 AND someNode.someProperty < 100

I want to be able to add any type of conditions, not just < and >, so please don't tell me to use between 😛

Since you need to pass an object to and, it seems like there's no way to combine multiple conditions on a single property

When many labels are added to a relation pattern they should be joined with a |

Because the generic passed to run/stream/first is wrapped in a Dictionary, I cannot specify the object being returned.

For example,

const orgFromNode = (node: Node<Organization>) =>
  Organization.from(node.properties);

const orgNode = await q
  .matchNode('org', 'Organization')
  .return('org')
  .first();
return orgFromNode(orgNode);

TS2345: Argument of type 'Dictionary<any>' is not assignable to parameter of type 'Node<Organization>'.
  Type 'Dictionary<any>' is missing the following properties from type 'Node<Organization>': identity, labels, properties

IMO, Dictionary types are pretty worthless since you can't specify their associated keys. All keys could be any of the value types.

const record = {} as Dictionary<string | boolean | DateTime>;
record.updatedAt; // this a DateTime but TS thinks it could be a boolean or string as well
record.active; // this a boolean but TS thinks it could be a DateTime or string as well

It would be helpful if this wrapping is removed so one can specify the actual return type. i.e.

const orgNode = await q
  .matchNode('org', 'Organization')
  .return('org')
  .first<Node<Organization>>()

And Dictionary types could still be used by users, just explicitly now.
I know this is probably considered a breaking change 🙁

On a positive note, I'm loving the library and it's design. Thanks for your hard work 🤝

Hi @jamesfer ,

Thanks for all your work on this!

Do you plan to implement FOREACH clause?

db
  .matchNode('foo', 'Foo', { id: "123" })
  .with(['foo', 'foo {.*} AS snapshot'])
  .return(['foo', 'snapshot'])

leads to

MATCH (foo:Foo { id: "123" }) WITH foo, foo {.*} AS snapshot RETURN foo, snapshot

The result snapshot will be null since the raw response won't be identity, labels, and properties but the object itself.

Is it possible to assign a query to a variable ?
For instance
MATCH p=(n:Node)-[r:REL]->(x:Node)
RETURN p

I would like to be able to assign to and access 'p' in the following example

db.match([
node('u', 'User', {id: '333333'}),
relation('out', ['MEMBER_OF_GROUP','HAS_REPORT_ROLE'],'*'),
node('r', 'Role', {allowed_delete: true})
]).return('count(u) > 0 as authorised')
.run()
.then(function (results) {
l.info(Is Authorised: + JSON.stringify(results[0]));
});

Hi, I like this library, makes things easy. Could you please provide an example on how to add a relationship between two existing nodes?
I tries this:
const query = this.db.match([ node("a", this.modelType.constructor.name, {uuid: uuidFrom}), node("b", new toType().constructor.name, {uuid: uuidTo}) ]).create([ node("a"), relation("out", :${name}), node("b") ]);
but this results in
MATCH (a:User { uuid: '2c0d4196-0851-4ae2-b764-37696bd52a20' })(b:Token { uuid: '98a4551c-326d-417e-9f80-54151fb5b6e0' }) CREATE (a)-[:HasToken]->(b);
there is a comma missing between node a and b in the MATCH operation.

Thank you!

Later edit:
I finally managed to do it with this query:
const query = this.db.matchNode("a", this.modelType.constructor.name, {uuid: uuidFrom}) .matchNode("b", new toType().constructor.name, {uuid: uuidTo}) .create([ node("a"), relation("out", rel:${name}), node("b") ]);
It seems to be what I need. Do I miss something here? Maybe there are some performance issues because of the two matches?

Sometimes it's handy to be able insert literal sections of a query into other clauses. Currently it's not possible to do this meaning if there is no clause function that fits your use-case you have to resort to the raw() function.

We are using the .where() method to fetch nodes like so:
existingDataQuery.match([ node('a', Attribute.getLabel()), InstanceValue.getAttributeRelationship(false), InstanceValue.getEmptyNode('iv') ]) .where({ 'ID(a)': attribute.id }) .return(['iv']).limit(1);

We were noticing that there were no results returned for this query (even though we should see something). Running .toString() seems to return the correct query:
MATCH (a:Attribute)<-[:IS_VALUE_OF]-(iv:InstanceValue) WHERE ID(a) = $idA RETURN iv LIMIT 1;

When we run .interpolate() to see the parameters dropped in we see a problem:
MATCH (a:Attribute)<-[:IS_VALUE_OF]-(iv:InstanceValue) WHERE ID(a) = 9882 RETURN iv LIMIT 1;

The number value on the end of the parameter bag property name seems to be left at the end of the id parameter. See the attached images for an example.

Following snippet would throw an error:

builder.create([
  [
    node('userA', 'User', { id: 'xxx' }),
    relation('out', ['HAS']),
    node('stuff', 'Stuff', { foo: 'bar' })
  ],
  [
    node('userA'),
    relation('out', ['LIKE']),
    node('userB', 'User', { id: 'yyy' }),
  ]
])

which the expected should be

CREATE (userA:User { id: 'xxx' })-[:HAS]->(stuff:Stuff { foo: 'bar' }), (userA)-[:LIKE]->(userB:User { id: 'yyy' })

Rather it throws an error TypeError: Cannot read property 'setExpandedConditions' of undefined

I think the bug is here

Hi James,

I've been playing with your query-builder, but stumbled upon a few problems:

1. Whenever I try to implement a standalone query like

query.merge([
  node('user', 'User', { id: 1 }),
  relation('out', 'rel', 'OwnsProject'),
  node('project', 'Project', { id: 20 }),
])

I get a
ReferenceError: node is not defined.

2. Importing cypher does not work for me for some reason.

import cypher from 'cypher-query-builder'
console.log(cypher) // undefined 

So I can't get 'node'/'relation' functions to work (either standalone, or as method of cypher).
How do I import cypher? Or, rather, where do I get 'node' and 'relation' functions from?

3. This query works perfectly fine

db.matchNode('stuff', 'Stuff')
    .return('stuff')
    .run()
    .then(result => console.log(result))

Many thanks!

• Expand documentation section
• Add paragraph about donations
• Add paragraph about contributions
• Add table of contents

When a regular expression is used as the value in a where clause, it should be implied to use the RegExp operator, =~.

query.where({ name: /[a-z]*/ })
// WHERE name =~ '[a-z]*'

Just tried return a list, seems a list result is not well handled.

await db.return('range(1, 50)').run()
// { "range(1, 50)": null }

Hi, thanks a lot for this library, it really cleaned up the logic of my recommendation engine :)

One issue I encountered though is that it doesn't seem possible to use patterns in where clauses such as described here.
I had to use qb.raw(), but it doesn't fit nicely in it as I have to determine wether .where was already called or not:

const hasWhereClause = !!filter && !!filter.resourceTypeIn;
 if (hasWhereClause) {
	    q.where({
	      r: {
	       type: inArray(filter.resourceTypeIn),
	      },
	    });
	}
	q.raw(`${hasWhereClause ? ' AND ' : 'WHERE '}(u)-[:CONSUMED]->(r)`);

Am I missing something, is there a better way to do it already ?

Also if supporting patterns in where conditions is too complex, maybe just adding the ability to add raw conditions in .where() would bring more flexibility already: it would also allow things like
toLower(r.name) CONTAINS toLower($query).

Let me know what you think !

Arrays of values inside conditions as a shorthand for the OR operator should also accept comparators as their members.

query.where({ age: [ lessThan(18), greater than(65) ]}
// WHERE age < 18 OR age > 65

Current:

MATCH (n:Label)
WHERE n.date <= $upper,n.date >= $lower
RETURN n;

Invalid input ',': expected an identifier character, whitespace, '.',

Expected:

MATCH (n:Label)
WHERE $lower <= n.date <= $upper
RETURN n;

Great work! 👍

My project has started to use neo4j and I had begun to try this builder today.
May I know if there's any plan to support MERGE clause? It will be great to see this clause being implemented.

Keep it up!

Add support for the USING keyword and all its possible hints.

https://neo4j.com/docs/cypher-manual/current/query-tuning/using/

query.raw(raw `MATCH (person { name: ${name} })`)
// MATCH (person { name: $parameter })

All parameters passed to the query will be converted into query parameters. This would mean that queries won't be able to be built dynamically using template strings as some parts of cypher don't support parameters, eg.

// Invalid
query.raw(raw `MATCH (person { ${prop}: ${name} })`)
// MATCH (person { $paramter: $parameter2 })

Most of the time, dynamically building queries is to be avoided as Neo4j cannot optimise them as well, so this shouldn't be a big issue.

The raw method should return a query object like the one that is returned from query.buildQueryObject. The raw method will need to be overloaded to accept an object as the first parameter.

The dependency @types/node was updated from 12.7.0 to 12.7.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/node is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

The dependency tslib was updated from 1.11.0 to 1.11.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

tslib is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

Hi,

I am experimenting with this package and it all looks promising. Thank you for the hard work!

I am running across a small issue though.
I am using neo4j date() and datetime() types in some properties.

When getting the result back from neo4j in a query, those properties come back as instances of neo4jDriver.v1.types.Date and neo4jDriver.v1.types.DateTime (see Temporal types).

However, when going through the transformer, they get transformed into standard objects here.

This means that I cannot use neo4jDriver.v1.isDate or neo4jDriver.v1.isDateTime anymore on them later on in my code for custom handling (in my case I use them to determine how to format them).

I would expect the transformer to either:

• transform them into a Date object
• return a formatted string (based on the type)
• return them as-is

In fact, I am thinking that it would also be great to be able to inject a custom Transformer into the Connection. That would allow custom transformations.
In the case of date objects, it might be useful for localization, for example.

I haven't tested yet, but similar issues will likely happen with Duration, Type, Localtime, Point, etc.
See also https://neo4j.com/docs/driver-manual/1.7/cypher-values/#driver-neo4j-type-system

What do you think?

Thanks you

Hello,

Can you add provision of following parameter connectionAcquisitionTimeout in Connection class under the driverConfig:{}. I face following error:

Neo4jError: Connection acquisition timed out in 60000 ms

Also, if possible, one more parameter MaxConnectionPoolSize. The details of these parameters are available at 2.4.3. Connection pool management

Many Thanks

In the .return docs you say this is valid:

query.return({
  people: {
    name: 'personName',
    age: 'personAge',
  },
})

But Term doesn't allow a Dictionary of Dictionary's. people has to be an array of objects.
https://github.com/jamesfer/cypher-query-builder/blob/master/src/clauses/term-list-clause.ts#L14

Either

setValues({ foo: foo }, { override: true }) // foo is an object

or

setValues({ foo: foo }, true) // foo is an object

are sending out

SET foo = $foo

BTW, I think default value should be { override: false } to be compatible with previous versions

  public async update(id: string, card: Card): Promise<Card> {
    const results = await this.db
      .matchNode('card', 'Card')
      .where({
        'card.id': id
      })
      .setValues({
        'card.title': card.title,
        'card.type': card.type,
        'card.isActive': card.isActive,
      })
      .return('card')
      .run();
    return CardService.map(results)[0];
  }

produces this error:

Invalid input '+': expected whitespace, comment, '(', '.' or '=' (line 3, column 16 (offset: 53)) "SET card.title += $cardTitle, card.type += $cardType, card.isActive += $cardIsActive"
                ^
Neo4jError: Invalid input '+': expected whitespace, comment, '(', '.' or '=' (line 3, column 16 (offset: 53))
"SET card.title += $cardTitle, card.type += $cardType, card.isActive += $cardIsActive"

I assume this is a bug and not a feature? Ima go ahead and remove that '+' sign and shoot you a pull request! On the other hand Ima not set you a pr. I got no clue where the override is set to true in:

  setValues(values: Dictionary<any>, override?: boolean) {
    return this.chain(this.wrap(new Set({ values }, { override })));
  }

Ive forked it and ill hack the override: false for now so I can continue... but great work btw thank you so much for that!

How do I do these?

• MATCH (n) DETACH DELETE n
• MATCH (n) RETURN count(*) as total

When using MATCH, the path pattern can be stored in a variable for use in FOREACH clauses or other functions.

Possible implementation could be:

query.match('path', [
  node('person'),
  relation('out', [ 'FriendsWith' ]),
  node('friend'),
])
// MATCH path = (person)-[:FriendsWith]->(friend)

According to the where operator types xor and or must accept an array of NodeConditions, Conditions or a single Condition.

This means you can do things like

query.where({
  age: xor([greaterThan(65), lessThan(12)]),
})

However, the and operator only accepts NodeConditions or Conditions. So you wouldn't be able to do the same thing.

I think and should be able to accept a Condition argument, which means that it probably needs to accept array properties as well. To make things entirely consistent, we should consider make all operators accept AnyConditions and then just use the operator to combine the outer most structure so:

query.where({ age: and([lessThan(65), greaterThan(12)])
// becomes
// WHERE age < 65 AND age > 12

query.where({ department: or({ inactive: true, members: 0 }) })
// becomes
// WHERE department.inactive = true OR department.members = 0

This shouldn't be a breaking change because previously the types limited what constructs could be supplied to each operator so this would technically be an expanding of functionality, but I would need to double check because maybe the code accepted all types to each function anyway which would mean that some javascript code may already be relying on old unsupported behaviour.

This is related to #14 and should probably be implemented together (unless this issue is breaking then #14 should be released soon and this deferred until 5.0).

When I tried to execute a bunch of queries in a very short time, a Neo4jError will be thrown.

After investigation, the issue is caused by excessive open connection since every run() create a new session to execute which would create new socket connection.

Might consider using a session pool, or just make it possible to use a specified session.

Heya!
Using the JavaScript Date primitive results in the following error for me:

{ Neo4jError: Property values can only be of primitive types or arrays thereof

    at captureStacktrace (/Users/berger/workspace/eventzimmer/api/node_modules/neo4j-driver/lib/v1/result.js:200:15)
    at new Result (/Users/berger/workspace/eventzimmer/api/node_modules/neo4j-driver/lib/v1/result.js:73:19)
    at Session._run (/Users/berger/workspace/eventzimmer/api/node_modules/neo4j-driver/lib/v1/session.js:116:14)
    at Session.run (/Users/berger/workspace/eventzimmer/api/node_modules/neo4j-driver/lib/v1/session.js:95:19)
    at n.run (/Users/berger/workspace/eventzimmer/api/node_modules/cypher-query-builder/dist/index.js:1:23282)
    at n.<anonymous> (/Users/berger/workspace/eventzimmer/api/node_modules/cypher-query-builder/dist/index.js:1:8774)
    at e (/Users/berger/workspace/eventzimmer/api/node_modules/cypher-query-builder/dist/index.js:1:7976)
    at Object.next (/Users/berger/workspace/eventzimmer/api/node_modules/cypher-query-builder/dist/index.js:1:7311)
    at /Users/berger/workspace/eventzimmer/api/node_modules/cypher-query-builder/dist/index.js:1:7220
    at new Promise (<anonymous>)
  code: 'Neo.ClientError.Statement.TypeError',
  name: 'Neo4jError' }

My corresponding code looks like:

      let query = new cypher.Query(db)
      query.create([
        cypher.node(event.name, 'Event'),
        cypher.relation('out', ['StartsAt'], { date: event.date }),
        cypher.node(event.location.name, 'Location')
      ])

whereas event.date is a JavaScript date event.date instanceof Date.
The resulting query looks like:

CREATE (commodi:Event)-[:StartsAt $conditions]->(tenetur:Location);

What needs to be done in order to use Date's with this query builder?

query.orderBy({
  name: 'ASC',
  occupation: 'DESC',
})

In the above example, it is not guaranteed that name will appear first in the final output query.

Arrays should be used instead to control individual property's iteration direction. Eg:

query.orderBy([
  'name',
  [ 'occupation', 'DESC' ]
})

When the individual direction is unspecified, as it is for name above, it should default to ASC or whatever was provided in the dir argument.

Query and Connection classes should have a first method that returns only the first result from the query or undefined if there are no results.

The type parameter of first should be wrapped in a dictionary, eg:

first<T>(): Dictionary<T>

The devDependency rollup was updated from 1.18.0 to 1.19.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

rollup is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Connection::run throws non-query errors synchronously, Query::run throws errors via a rejected promise.

This line should be:

return map(records, rec => this.transformRecord<T>(rec));

Submitting a PR to fix this.