Safe Haskell	None
Language	GHC2021

Database.Bolty.Notification

Description

Server notification types (warnings, deprecations, performance hints).

Synopsis

data Notification = Notification {
- nCode :: !Text
- nTitle :: !Text
- nDescription :: !Text
- nSeverity :: !Severity
- nCategory :: !Text
- nPosition :: !(Maybe Position)
}
data Severity
- = SevWarning
- | SevInformation
- | SevUnknown !Text
data Position = Position {
- offset :: !Int64
- line :: !Int64
- col :: !Int64
}
parseNotifications :: Maybe Ps -> Vector Notification

Documentation

data Notification Source #

A notification emitted by the server during query execution. Notifications include warnings about performance (cartesian products, missing indexes), deprecation notices, and hints.

Constructors

Notification

Fields

nCode :: !Text
e.g. Neo.ClientNotification.Statement.CartesianProduct
nTitle :: !Text
Human-readable title.
nDescription :: !Text
Detailed description of the issue.
nSeverity :: !Severity
WARNING or INFORMATION.
nCategory :: !Text
e.g. PERFORMANCE, DEPRECATION, HINT, UNRECOGNIZED, UNSUPPORTED, GENERIC, SECURITY, TOPOLOGY, SCHEMA.
nPosition :: !(Maybe Position)
Position in the Cypher query, if available.

Instances

Instances details

Show Notification Source #
Instance details Defined in Database.Bolty.Notification Methods showsPrec :: Int -> Notification -> ShowS # show :: Notification -> String # showList :: [Notification] -> ShowS #
Eq Notification Source #
Instance details Defined in Database.Bolty.Notification Methods (==) :: Notification -> Notification -> Bool # (/=) :: Notification -> Notification -> Bool #

data Severity Source #

Severity level of a notification.

Constructors

SevWarning
SevInformation
SevUnknown !Text

Instances

Instances details

Show Severity Source #
Instance details Defined in Database.Bolty.Notification Methods showsPrec :: Int -> Severity -> ShowS # show :: Severity -> String # showList :: [Severity] -> ShowS #
Eq Severity Source #
Instance details Defined in Database.Bolty.Notification Methods (==) :: Severity -> Severity -> Bool # (/=) :: Severity -> Severity -> Bool #

data Position Source #

Position in a Cypher query string.

Constructors

Position
Fields offset :: !Int64 line :: !Int64 col :: !Int64

Instances

Instances details

Show Position Source #
Instance details Defined in Database.Bolty.Notification Methods showsPrec :: Int -> Position -> ShowS # show :: Position -> String # showList :: [Position] -> ShowS #
Eq Position Source #
Instance details Defined in Database.Bolty.Notification Methods (==) :: Position -> Position -> Bool # (/=) :: Position -> Position -> Bool #

parseNotifications :: Maybe Ps -> Vector Notification Source #

Parse the raw notifications field from PULL SUCCESS metadata. Returns an empty vector if the field is Nothing or not a list.