Skip to content

feat: upgrade Neo4j driver to v5 #1182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat: upgrade Neo4j driver to v5 #1182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2030a4a
feat: added support for Neo4j 5.x migrations
fabiomarini Nov 14, 2022
606fc17
feat: upgraded Neo4j driver to v4
fabiomarini Nov 14, 2022
8f9b789
feat: upgraded Neo4j driver to v5
joschi Oct 6, 2024
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
39 changes: 26 additions & 13 deletions database/neo4j/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,33 @@
# neo4j
The Neo4j driver (bolt) does not natively support executing multiple statements in a single query. To allow for multiple statements in a single migration, you can use the `x-multi-statement` param.
This mode splits the migration text into separately-executed statements by a semi-colon `;`. Thus `x-multi-statement` cannot be used when a statement in the migration contains a string with a semi-colon.
The queries **should** run in a single transaction, so partial migrations should not be a concern, but this is untested.
The Neo4j driver (bolt) does not natively support executing multiple statements
in a single query. To allow for multiple statements in a single migration, you
can use the `x-multi-statement` param. This mode splits the migration text into
separately-executed statements by a semicolon `;`. Thus `x-multi-statement`
cannot be used when a statement in the migration contains a string with a
semicolon. The queries **should** run in a single transaction, so partial
migrations should not be a concern, but this is untested.

Here are possible connection URLs:

`neo4j://user:password@host:port/`
- `neo4j://user:password@host:port/`
- `neo4j+s://user:password@host:port/`
- `neo4j+ssc://user:password@host:port/`
- `bolt://user:password@host:port/`
- `bolt+s://user:password@host:port/`
- `bolt+ssc://user:password@host:port/`

| URL Query | WithInstance Config | Description |
|---------------------|-------------------------------|------------------------------------------------------------------------------------------------------|
| `x-multi-statement` | `MultiStatement` | Enable multiple statements to be ran in a single migration (See note above) |
| `user` | Contained within `AuthConfig` | The user to sign in as |
| `password` | Contained within `AuthConfig` | The user's password |
| `host` | | The host to connect to. Values that start with / are for unix domain sockets. (default is localhost) |
| `port` | | The port to bind to. (default is 7687) |
| | `MigrationsLabel` | Name of the migrations node label |

| URL Query | WithInstance Config | Description |
|------------|---------------------|-------------|
| `x-multi-statement` | `MultiStatement` | Enable multiple statements to be ran in a single migration (See note above) |
| `user` | Contained within `AuthConfig` | The user to sign in as |
| `password` | Contained within `AuthConfig` | The user's password |
| `host` | | The host to connect to. Values that start with / are for unix domain sockets. (default is localhost) |
| `port` | | The port to bind to. (default is 7687) |
| | `MigrationsLabel` | Name of the migrations node label |

## Supported versions

Only Neo4j v3.5+ is [supported](https://github.com/neo4j/neo4j-go-driver/issues/64#issuecomment-625133600)
Neo4j v4.4 LTS and v5+ is supported.

Make sure to check [End Of Life dates](https://neo4j.com/developer/kb/neo4j-supported-versions/) of Neo4j versions.
2 changes: 1 addition & 1 deletion database/neo4j/examples/migrations/1578421040_create_movies_constraint.down.cypher
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
DROP CONSTRAINT ON (m:Movie) ASSERT m.Name IS UNIQUE
DROP CONSTRAINT FOR (m:Movie) REQUIRE m.Name IS UNIQUE
2 changes: 1 addition & 1 deletion database/neo4j/examples/migrations/1578421040_create_movies_constraint.up.cypher
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
CREATE CONSTRAINT ON (m:Movie) ASSERT m.Name IS UNIQUE
CREATE CONSTRAINT FOR (m:Movie) REQUIRE m.Name IS UNIQUE
Loading
Loading