Skip to content

Commit 6571d3a

Browse files
Lojjsrenetapopova
andauthored
Explain error compatibility (#229)
Co-authored-by: Reneta Popova <[email protected]>
1 parent 58fbb09 commit 6571d3a

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

modules/ROOT/pages/errors/index.adoc

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,4 +208,47 @@ The server and driver communicate with each other through the Bolt protocol.
208208
During the handshake process, they agree on using the newest possible Bolt protocol version that both the server and the driver support.
209209
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].
210210

211+
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.
212+
It is supported over Bolt since Bolt 5.7, which corresponds to version 5.26 or later on both server and driver side.
213+
214+
To fully utilize the new error framework, both your server and the driver must support it.
215+
Drivers that are older than 5.26 will not send any GQL-status object for exceptions, even if server is 5.26 or later.
216+
217+
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.
218+
In this case, the default GQLSTATUS code 50N42 is returned for all exceptions.
219+
220+
.Error compatibility matrix
221+
[cols="1,2,2", grid="all", stripes="hover"]
222+
|===
223+
|
224+
h| Driver 5.25 or older
225+
h| Driver 5.26 or newer
226+
227+
h| Server 5.24 or older
228+
| Bolt: old format
229+
230+
Query log: old format
231+
232+
| Bolt: new format with default values
233+
234+
Query log: old format
235+
236+
h| Server 5.25
237+
| Bolt: old format
238+
239+
Query log: new format
240+
| Bolt: new format with default values
241+
242+
Query log: new format
243+
244+
h| Server 5.26 or newer
245+
| Bolt: old format
246+
247+
Query log: new format
248+
249+
| Bolt: new format
250+
251+
Query log: new format
252+
253+
|===
211254

0 commit comments

Comments
 (0)