Skip to content

Update changelog and corresponding pages #265

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

Merged
merged 1 commit into from
Feb 19, 2025
Merged

Update changelog and corresponding pages #265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
83 changes: 75 additions & 8 deletions modules/ROOT/pages/changelogs.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,25 @@
:description: This page lists all changes to status codes per Neo4j version.
= Changes to status codes per Neo4j version

== Neo4j 5.26

**New:**

[options="header", cols="<1m,<1"]
|===
| GQLSTATUS
| Neo4j code
| 01N72
| Neo.ClientNotification.Statement.InsecureProtocol
| 42I50
| Neo.ClientError.Schema.TokenLengthError
|===

Starting from 5.26, Neo4j errors sent over drivers include new fields,
such as GQLSTATUS code, StatusDescription, and DiagnosticRecord.
For more information, see xref:errors/index.adoc#gqlstatus-error-object[GQL-status error object].


== Neo4j 5.25

Starting from 5.25, the query log includes the GQL error information under the JSON object `errorInfo`.
Expand All @@ -10,14 +29,23 @@ For more information, see link:https://neo4j.com/docs/operations-manual/current/

**New:**

[source, status codes, role="noheader"]
-----
Neo.ClientNotification.Statement.RedundantOptionalProcedure
Neo.ClientNotification.Statement.RedundantOptionalSubquery
Neo.ClientNotification.Security.AuthProviderNotDefined
Neo.ClientNotification.Security.ExternalAuthNotEnabled
Neo.ClientNotification.Statement.AggregationSkippedNull
-----
[options="header", cols="<1m,<1"]
|===
| GQLSTATUS
| Neo4j code
| 00N72
| Neo.ClientNotification.Security.AuthProviderNotDefined
| 01G11
| Neo.ClientNotification.Statement.AggregationSkippedNull
| 01N71
| Neo.ClientNotification.Security.ExternalAuthNotEnabled
| 03N61
| Neo.ClientNotification.Statement.RedundantOptionalProcedure
| 03N62
| Neo.ClientNotification.Statement.RedundantOptionalSubquery
| N/A
| Neo.TransientError.Invalid.ResourceExhaustion
|===

== Neo4j 5.23

Expand All @@ -36,6 +64,7 @@ For more information, see xref:notifications/index.adoc#gqlstatus-notification-o
Neo.ClientNotification.Cluster.RequestedTopologyMatchedCurrentTopology
Neo.ClientNotification.Schema.IndexOrConstraintAlreadyExists
Neo.ClientNotification.Schema.IndexOrConstraintDoesNotExist
Neo.ClientError.Statement.InvalidTargetDatabaseError
-----

== Neo4j 5.15
Expand Down Expand Up @@ -68,12 +97,23 @@ The usage of `Neo.ClientNotification.Statement.RuntimeExperimental` has been rem
[source, status codes, role="noheader"]
-----
Neo.ClientNotification.Cluster.ServerAlreadyEnabled
Neo.ClientNotification.Cluster.ServerAlreadyCordoned
Neo.ClientError.ChangeDataCapture.InvalidIdentifier
Neo.TransientError.ChangeDataCapture.FutureIdentifier
Neo.DatabaseError.ChangeDataCapture.Disabled
Neo.DatabaseError.ChangeDataCapture.ScanFailure
-----

== Neo4j 5.10

**New:**

[source, status codes, role="noheader"]
-----
Neo.TransientError.Transaction.QueryExecutionFailedOnTransaction
-----


== Neo4j 5.9

**New:**
Expand All @@ -84,13 +124,27 @@ Neo.ClientNotification.Security.CommandHasNoEffect
Neo.ClientNotification.Security.ImpossibleRevokeCommand
-----

== Neo4j 5.7

**New:**

[source, status codes, role="noheader"]
-----
Neo.ClientError.Transacton.TransactionTimedOutClientConfiguration
Neo.ClientError.Routing.DbmsInPanic
Neo.ClientError.Routing.RoutingFailed
-----


== Neo4j 5.5

**New:**

[source, status codes, role="noheader"]
-----
Neo.ClientNotification.Statement.RepeatedRelationshipReference
Neo.ClientError.Statement.RemoteExecutionClientError
Neo.TransientError.Statement.RemoteExecutionTransientError
-----

== Neo4j 5.4
Expand All @@ -103,6 +157,17 @@ Neo.ClientNotification.Statement.RepeatedRelationshipReference
Neo.ClientNotification.Statement.UnsatisfiableRelationshipTypeExpression
-----


== Neo4j 5.3

**New:**

[source, status codes, role="noheader"]
-----
Neo.DatabaseError.Transaction.TransactionTerminationFailed
-----


== Neo4j 5.0

**New:**
Expand Down Expand Up @@ -152,6 +217,8 @@ Neo.ClientNotification.Statement.UnboundedVariableLengthPatternWarning
-----
Neo.ClientError.Statement.UnsupportedAdministrationCommand
Neo.DatabaseError.Transaction.LinkedTransactionError
Neo.TransientError.Transaction.LeaderSwitch
Neo.ClientError.Database.IllegalAliasChain
-----


Expand Down
10 changes: 10 additions & 0 deletions modules/ROOT/pages/errors/all-errors.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,9 @@ If you want to drop the index, you must also drop the constraint.
| Neo.ClientError.Schema.RepeatedRelationshipTypeInSchema
| Unable to create an index or a constraint because the schema had a repeated relationship type.

| Neo.ClientError.Schema.TokenLengthError
| A token name, such as a label, relationship type or property key is too long

| Neo.ClientError.Schema.TokenNameError
|
An invalid name is used for a token (label, relationship type, property key).
Expand Down Expand Up @@ -188,6 +191,9 @@ Please reconnect.
| Neo.ClientError.Statement.ExternalResourceFailed
| Access to an external resource failed.

| Neo.ClientError.Statement.InvalidTargetDatabaseError
| The specified database is not a valid target for this command.

| Neo.ClientError.Statement.NotSystemDatabaseError
| This is an administration command and it should be executed against the `system` database.

Expand Down Expand Up @@ -319,6 +325,10 @@ You could try increasing the stack size; for example to set the stack size to `2
There is not enough memory to perform the current task.
Please try increasing `server.memory.off_heap.transaction_max_size` in the Neo4j configuration file (normally in _conf/neo4j.conf_ or, if you are using Neo4j Desktop, found through the user interface), and then restart the database.

| Neo.TransientError.Invalid.ResourceExhaustion
| The server has rejected this request as a resource is exhausted at the moment.
You can retry at a later time. For further details see server logs.

| Neo.TransientError.Request.NoThreadsAvailable
|
There are no available threads to serve this request at the moment.
Expand Down
41 changes: 33 additions & 8 deletions modules/ROOT/pages/notifications/all-notifications.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1219,7 +1219,7 @@ The query contains an aggregation function that skips null values.
=====

[#_unsupported_notifications]
== `UNSUPPORTED` category
== `UNSUPPORTED` notifications

Unsupported notifications are returned when the query or command is trying to use features that are not supported by the current system or using experimental features that should not be used in production.

Expand Down Expand Up @@ -2710,7 +2710,7 @@ m|WARNING
|===

[#_security_notifications]
== `SECURITY` category
== `SECURITY` notifications

Security notifications indicate that the result of the query or command might have a potential security issue.
Verify that this is the intended behavior of your query or command.
Expand Down Expand Up @@ -3362,7 +3362,7 @@ Use `DATABASE *` without the parameter to revoke the privilege on all databases.
=====

[#_neo_clientnotification_security_authprovidernotdefined]
=== AuthProviderNotDefined
=== The auth provider is not defined

.Notification details
[cols="<1s,<4"]
Expand Down Expand Up @@ -3478,7 +3478,7 @@ If it is correct, make sure to add it as a known auth provider in one or both of


[#_neo_clientnotification_security_externalauthnotenabled]
=== ExternalAuthNotEnabled
=== External auth for user is not enabled

.Notification details
[cols="<1s,<4"]
Expand Down Expand Up @@ -3581,9 +3581,34 @@ Until enabled, the new external auth will be ignored, and current external auth
======
=====

[role=label--new-5.26]
=== Query uses an insecure protocol


.Notification details
[cols="<1s,<4"]
|===
|Neo4j code
m|Neo.ClientNotification.Statement.InsecureProtocol
|Title
a|Query uses an insecure protocol
|Description
a|The query uses an insecure protocol. Please consider using 'https' instead.
|Category
m|SECURITY
|GQLSTATUS code
m|01N72
|Status description
a|warn: insecure URL protocol. Query uses an insecure protocol. Consider using 'https' instead.
|Classification
m|SECURITY
|SeverityLevel
m|WARNING
|===


[#_topology_notifications]
== `TOPOLOGY` category
== `TOPOLOGY` notifications

Topology notifications provide additional information related to managing databases and servers.

Expand Down Expand Up @@ -3940,7 +3965,7 @@ The requested topology matched the current topology. No allocations were changed
=====

[#_schema_notifications]
== `SCHEMA` category
== `SCHEMA` notifications

Schema notifications provide additional information related to indexes and constraints.

Expand Down Expand Up @@ -4660,7 +4685,7 @@ m|WARNING

When matching on a relationship type expression that can never be satisfied, for example asking for zero, more than one or contradictory types.

.Notification category details
.Notification details
[cols="<1s,<4"]
|===
|Neo4j code
Expand Down Expand Up @@ -4719,7 +4744,7 @@ Relationship type expression cannot possibly be satisfied. (`R1&R2` can never be
[#_neo_clientnotification_statement_repeatedrelationshipreference]
=== Repeated relationship reference

.Notification category details
.Notification details
[cols="<1s,<4"]
|===
|Neo4j code
Expand Down