Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .changeset/easy-horses-repeat.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const { cypher, params } = matchQuery.build({

_Before_

```js
```cypher
MATCH (this1:Movie:Film)
```

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@
** xref:how-to/update-labels.adoc[]
** xref:how-to/define-cypher-version.adoc[]
* xref:compatibility.adoc[]
* xref:migration-guide-2.adoc[]
* xref:migration-guide-3.adoc[]
* link:https://github.com/neo4j/cypher-builder/tree/main/examples[Examples]
* link:https://neo4j.github.io/cypher-builder/reference/[Reference]
3 changes: 1 addition & 2 deletions docs/modules/ROOT/pages/build-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ The method `build` accepts an object with options to configure the build process
[cols="2,1,1,3",options="header"]
|===
| Setting | Type | Default | Description
| `labelOperator` | String | `":"` | Define the default operator to use when using multiple labels in a Pattern. It can be either `:` or `&`
| `cypherVersion` | String | `undefined` | If set, will prepend all queries with a `CYPHER [Version]` statement. The only valid value is `"5"`
| `cypherVersion` | String | `undefined` | If set, will prepend all queries with a `CYPHER [Version]` statement. The possible values are `"5"` and `"25"`
| `prefix` | String | `undefined` | If set, will add a prefix to all variable names. See xref:how-to/customize-cypher.adoc#_build_prefix[Customize Cypher]
| `extraParams` | Object | `{}` | Add the provided parameters to the resulting params object. See xref:variables-and-params/parameters.adoc#_adding_extra_parameters[Parameters]
| `unsafeEscapeOptions` | Object | `{}` | Set of options to disable escaping from generated Cypher. See xref:_unsafe_escape_options[Unsafe escape options]
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/clauses/with.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: This page describes how to create `WITH` clauses.
= With

This page describes how to create a link:https://neo4j.com/docs/cypher-manual/current/clauses/with/[`WITH`] clause using the `Cypher.With` class. Note that this is different to the xref:../subqueries/call.adoc#_importwith[ImportWith] statement inside `CALL`.
This page describes how to create a link:https://neo4j.com/docs/cypher-manual/current/clauses/with/[`WITH`] clause using the `Cypher.With` class.

A `With` clause will take multiple parameters. Variables can be passed directly without aliasing:

Expand Down
10 changes: 5 additions & 5 deletions docs/modules/ROOT/pages/compatibility.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
[[compatibility]]
:description: This page outlines the compatibility requirements for `@neo4j/cypher-builder` version 2 with Cypher and Node.js.
:description: This page outlines the compatibility requirements for `@neo4j/cypher-builder` version 3 with Cypher and Node.js.
= Compatibility

This page outlines the compatibility requirements for `@neo4j/cypher-builder` version 2 with Cypher and Node.js.
This page outlines the compatibility requirements for `@neo4j/cypher-builder` version 3 with Cypher and Node.js.

* Targets link:https://neo4j.com/docs/cypher-manual/5/introduction/[Cypher 5], with support for link:https://neo4j.com/docs/cypher-manual/4.4/introduction/[Cypher 4.4].
* Compatible with Node.js version 16.0.0 and later.
* Targets link:https://neo4j.com/docs/cypher-manual/25/introduction/[Cypher 25], with support for link:https://neo4j.com/docs/cypher-manual/5/introduction/[Cypher 5].
* Compatible with Node.js version 20.0.0 and later.

[NOTE]
====
`@neo4j/cypher-builder` version 1 is no longer supported. Version 2 is a full replacement and maintains the same compatibility with Cypher and Node.js.
If you need to support Neo4j 4, stay with Cypher Builder 2.x, otherwise, xref:migration-guide-3.adoc#migration[migrate to version 3].
====
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/getting-started/installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This guide shows how to start using Cypher Builder by setting up a Node.js proje

== Requirements

* link:https://nodejs.org/[Node.js] 16.0.0 or greater
* link:https://nodejs.org/[Node.js] 20.0.0 or greater
* link:https://docs.npmjs.com/downloading-and-installing-node-js-and-npm[npm]
* **[Optional]** A link:https://neo4j.com/cloud/platform/aura-graph-database/?ref=nav-get-started-cta[Neo4j] database to try Cypher queries.

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/how-to/define-cypher-version.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: This page describes how to define the Cypher version to be used in the query.
= Define Cypher version

It is possible to define the version of Cypher to use in a query by prepending that query with `CYPHER [version]`. For example:
It is possible to explicitly define the version of Cypher to use in a query by prepending that query with `CYPHER [version]`. For example:


[source, cypher]
Expand All @@ -13,7 +13,7 @@ RETURN this0
----


To add the Cypher version at the beggining of the query, pass the parameter `cypherVersion` to `.build`:
To add the Cypher version at the beggining of the query, pass the parameter `cypherVersion` to `.build`. The possible values are `"5"` and `"25"`:

[source, javascript]
----
Expand Down
Loading