Skip to content

Commit

Permalink
Explain error compatibility (#229)
Browse files Browse the repository at this point in the history
Co-authored-by: Reneta Popova <[email protected]>
  • Loading branch information
Lojjs and renetapopova authored Nov 29, 2024
1 parent 58fbb09 commit 6571d3a
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions modules/ROOT/pages/errors/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -208,4 +208,47 @@ The server and driver communicate with each other through the Bolt protocol.
During the handshake process, they agree on using the newest possible Bolt protocol version that both the server and the driver support.
For more information on the Bolt versions supported by different server versions, see the link:https://neo4j.com/docs/bolt/current/bolt-compatibility[Bolt Protocol documentation].

The new error framework with the additional GQL-status object for errors is available in the JSON format query log for Neo4j server Neo4j 5.25 and later versions.
It is supported over Bolt since Bolt 5.7, which corresponds to version 5.26 or later on both server and driver side.

To fully utilize the new error framework, both your server and the driver must support it.
Drivers that are older than 5.26 will not send any GQL-status object for exceptions, even if server is 5.26 or later.

If a driver of version 5.26 or later talks to a server that is older than 5.26, the driver needs to poly-fill the exceptions with a GQL-status object.
In this case, the default GQLSTATUS code 50N42 is returned for all exceptions.

.Error compatibility matrix
[cols="1,2,2", grid="all", stripes="hover"]
|===
|
h| Driver 5.25 or older
h| Driver 5.26 or newer

h| Server 5.24 or older
| Bolt: old format

Query log: old format

| Bolt: new format with default values

Query log: old format

h| Server 5.25
| Bolt: old format

Query log: new format
| Bolt: new format with default values

Query log: new format

h| Server 5.26 or newer
| Bolt: old format

Query log: new format

| Bolt: new format

Query log: new format

|===

0 comments on commit 6571d3a

Please sign in to comment.