-
Notifications
You must be signed in to change notification settings - Fork 70
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.
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
Add GqlStatusObject
support as notifications to ResultSummary
#588
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
robsdedude
requested changes
Jul 5, 2024
Co-authored-by: Robsdedude <dev@rouvenbauer.de>
Co-authored-by: Robsdedude <dev@rouvenbauer.de>
Co-authored-by: Robsdedude <dev@rouvenbauer.de>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduces GQL-compliant status objects to the
ResultSummary
.GqlStatusObject
is a GQL-compliantNotification
object and status of query execution, this new object includesGqlStatus
andStatusDescription
.ResultSummary.GqlStatusObjects()
always contains at least 1 status representing theSuccess
,No Data
orOmitted Result
.The GqlStatusObjects will be presented in the following order:
02xxx
) has precedence over a warning;01xxx
) has precedence over a success.00xxx
) has precedence over anything informational (03xxx
)Migration from Notification
Most properties in
Notification
exist in the newGqlStatusObject
, exceptCode
andTitle
.The
GqlStatusObject.GqlStatus
is equivalent toCode
inNotification
, but with values compliant with GQL.The properties
GqlStatusObject.Classification
andGqlStatusObject.RawClassification
are equivalent toNotification.Category
andNotification.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):
Iterating through GqlStatusObjects is also done in the same way as Notifications:
Deprecations
neo4j.NotificationSeverity
please usenotifications.NotificationSeverity
directly.neo4j.Warning
please usenotifications.Warning
directly.neo4j.Information
please usenotifications.Information
directly.neo4j.UnknownSeverity
please usenotifications.UnknownSeverity
directly.neo4j.NotificationCategory
please usenotifications.NotificationCategory
directly.neo4j.Hint
please usenotifications.Hint
directly.neo4j.Unrecognized
please usenotifications.Unrecognized
directly.neo4j.Unsupported
please usenotifications.Unsupported
directly.neo4j.Performance
please usenotifications.Performance
directly.neo4j.Deprecation
please usenotifications.Deprecation
directly.neo4j.Generic
please usenotifications.Generic
directly.neo4j.Security
please usenotifications.Security
directly.neo4j.Topology
please usenotifications.Topology
directly.neo4j.UnknownCategory
please usenotifications.Unknown
directly.