v5.23.0 - Feedback wanted on GQL-compliant status objects 📣

[StephenCathcart]

In version 5.23.0 (#588), we introduce a new preview API to the driver, GQL-compliant status objects.

GqlStatusObject is a GQL-compliant Notification object and status of query execution, this new object includes GqlStatus and StatusDescription.

ResultSummary.GqlStatusObjects() always contains at least 1 status representing the Success, No Data or Omitted Result.

The GqlStatusObjects will be presented in the following order:

• A “no data” (02xxx) has precedence over a warning;
• A warning (01xxx) has precedence over a success.
• A success (00xxx) has precedence over anything informational (03xxx)

Migration from Notification

Most properties in Notification exist in the new GqlStatusObject, except Code and Title.
The GqlStatusObject.GqlStatus is equivalent to Code in Notification, but with values compliant with GQL.
The properties GqlStatusObject.Classification and GqlStatusObject.RawClassification are equivalent to Notification.Category and Notification.RawCategory. The name change is needed because Category has a different meaning in GQL.

Usage

Disabling GqlStatusObjects can be done in the same way as disabling Notifications. However, non-notification status can not be filtered (such as Success or No Data):

neo4j.NewDriverWithContext("neo4j://localhost", neo4j.BasicAuth("neo4j", "password", ""), func(config *config.Config) {
    config.NotificationsDisabledClassifications = notifications.DisableClassifications(notifications.Deprecation, notifications.Performance)
})

Iterating through GqlStatusObjects is also done in a similar way as Notifications:

gqlStatusObjects := result.Summary.GqlStatusObjects()
for _, gqlStatusObject := range gqlStatusObjects {
    fmt.Printf(gqlStatusObject.GqlStatus())
    fmt.Printf(gqlStatusObject.StatusDescription())
    fmt.Printf(gqlStatusObject.DiagnosticRecord())
    // and so on
}

Feedback wanted

​
This new API is currently marked as preview. What it means is that we are eagerly waiting for your feedback. Does it work well in your scenario? Do you wish there was more?
​
Let us know so we can correct course in the next releases!