Add a GQLSTATUS code to the current errors #176
Conversation
|
Thanks for the documentation updates. The preview documentation has now been torn down - reopening this PR will republish it. |
| = List of all server error codes | ||
| = List of all Neo4j 5 server error codes | ||
|
|
||
| Error codes are Neo4j status codes returned by the server when the execution of a query fails. |
There was a problem hiding this comment.
It is always hard with naming, but I wonder if 'error codes' is too unspecific here? The new GQLSTATUS codes are also a type of error codes is my thinking.
Maybe the other way around i.e. that we call the section
'List of all Neo4j 5 status codes' and rewrite this sentence to 'Neo4j status codes are error codes returned by the server...'. Let me know what you think
There was a problem hiding this comment.
I somehow needed to differentiate between both pages. We'll have another page about the GQLSTATUS codes. So, in the end, the structure will be something similar to:
- Server errors
- List of all Neo4j 5 server error codes
- List of all GQLSTATUS server error codes
- Server notifications
|
|
||
| Client errors:: | ||
| These errors are caused by the client and are usually related to the request itself. | ||
| Client errors have the prefix `Neo.ClientError`. |
There was a problem hiding this comment.
I know this is just moved text, but we could maybe clarify it by writing 'Neo4j status codes for client errors have the prefix Neo.ClientError'. Same for transient errors and database errors too
There was a problem hiding this comment.
I am not sure what you're suggesting. The whole page is about Neo4j status codes only.
| @@ -4,18 +4,4 @@ | |||
| = Server errors | |||
There was a problem hiding this comment.
I suppose we might also want to rewrite the rest of the text here a bit and turn this into more of an overview page? That can be a separate PR though
| |=== | ||
| |Description | ||
| a| Invalid change identifier. | ||
| |GQLSTATUS code(s) |
There was a problem hiding this comment.
I think we should clarify that this is a cause GQLSTATUS code in some way. In the next table you have the top level code in the same place and that distinction would be important to know for someone adapting their code to the new system
There was a problem hiding this comment.
Hmm, this shouldn't be the cause code. This is the top-level code.
There was a problem hiding this comment.
| ! Message ! GQLSTATUS code | ||
| ! Invalid change identifier. ! 52N26 | ||
| ! Given change identifier does not belong to this database ! 52N31 | ||
| ! Given ChangeIdentifier describes a transaction that hasn't yet occurred ! 52N30 |
There was a problem hiding this comment.
When I look at the CDC tab in the Error spreadsheet the one listed as 52N30 here (CDC-005) is actually 52N32 (although it has an old comment from me and the same old message as CDC-001 which is 52N30). Also CDC-004 seems to be missing.
I am not sure which source you have used for the table, so it can be either a misstake there or by you. The rest of the codes in this table look correct
There was a problem hiding this comment.
I think we are seeing different things in the spreadsheet. This is what I see for 52N16:
| This error occurs when the request cannot be processed by this server. | ||
| Write requests can only be processed by the leader. | ||
|
|
||
| .Error details |
There was a problem hiding this comment.
Maybe that is because this is just a first draft, but the messages below are only a subset of the ones for Neo.ClientError.Cluster.NotALeader
|
We decided to go with a different solution. |
renetapopova
added
wontfix
Hey @Lojjs, please take a look to see if that makes sense for the current errors.