Safe Haskell	Safe-Inferred
Language	Haskell2010

Hasura.RQL.DDL.Warnings

Description

Warnings for metadata APIs

This module provides a mechanism for metadata APIs to emit warnings. An example use of MonadWarnings to emit warnings with success message is given below:

import Hasura.RQL.DDL.Warnings

someMetadataAPIHandler :: args -> m EncJSON
someMetadataAPIHandler args = successMsgWithWarnings $ do
  -- do some stuff
  let warning = MetadataWarning (MOSource defaultSource) "some warning message"
  warn $ warning
  -- do some more stuff
  pure ()

Synopsis

data AllowWarnings
- = AllowWarnings
- | DisallowWarnings
data WarningCode
data MetadataWarning = MetadataWarning {
- _mwCode :: WarningCode
- _mwMetadataObj :: MetadataObjId
- _mwMessage :: Text
}
type MetadataWarnings = Seq MetadataWarning
class Monad m => MonadWarnings m where
- warn :: MetadataWarning -> m ()
runMetadataWarnings :: StateT MetadataWarnings m a -> m (a, MetadataWarnings)
mkSuccessResponseWithWarnings :: MetadataWarnings -> EncJSON
successMsgWithWarnings :: Monad m => StateT MetadataWarnings m () -> m EncJSON

Documentation

data AllowWarnings Source #

Allow/Disallow metadata warnings

Constructors

AllowWarnings
DisallowWarnings

Instances

Instances details

FromJSON AllowWarnings Source #
Instance details Defined in Hasura.RQL.DDL.Warnings Methods parseJSON :: Value -> Parser AllowWarnings Source # parseJSONList :: Value -> Parser [AllowWarnings] Source #
ToJSON AllowWarnings Source #
Instance details Defined in Hasura.RQL.DDL.Warnings Methods toJSON :: AllowWarnings -> Value Source # toEncoding :: AllowWarnings -> Encoding Source # toJSONList :: [AllowWarnings] -> Value Source # toEncodingList :: [AllowWarnings] -> Encoding Source #
Show AllowWarnings Source #
Instance details Defined in Hasura.RQL.DDL.Warnings Methods showsPrec :: Int -> AllowWarnings -> ShowS # show :: AllowWarnings -> String # showList :: [AllowWarnings] -> ShowS #
Eq AllowWarnings Source #
Instance details Defined in Hasura.RQL.DDL.Warnings Methods (==) :: AllowWarnings -> AllowWarnings -> Bool # (/=) :: AllowWarnings -> AllowWarnings -> Bool #

data WarningCode Source #

Constructors

WCSourceCleanupFailed
WCIllegalEventTriggerName
WCTimeLimitExceededSystemLimit
WCTrackTableFailed
WCUntrackTableFailed

Instances

Instances details

ToJSON WarningCode Source #
Instance details Defined in Hasura.RQL.DDL.Warnings Methods toJSON :: WarningCode -> Value Source # toEncoding :: WarningCode -> Encoding Source # toJSONList :: [WarningCode] -> Value Source # toEncodingList :: [WarningCode] -> Encoding Source #
Eq WarningCode Source #
Instance details Defined in Hasura.RQL.DDL.Warnings Methods (==) :: WarningCode -> WarningCode -> Bool # (/=) :: WarningCode -> WarningCode -> Bool #
Ord WarningCode Source #
Instance details Defined in Hasura.RQL.DDL.Warnings Methods compare :: WarningCode -> WarningCode -> Ordering # (<) :: WarningCode -> WarningCode -> Bool # (<=) :: WarningCode -> WarningCode -> Bool # (>) :: WarningCode -> WarningCode -> Bool # (>=) :: WarningCode -> WarningCode -> Bool # max :: WarningCode -> WarningCode -> WarningCode # min :: WarningCode -> WarningCode -> WarningCode #

data MetadataWarning Source #

Constructors

MetadataWarning
Fields _mwCode :: WarningCode _mwMetadataObj :: MetadataObjId _mwMessage :: Text

Instances

Instances details

ToJSON MetadataWarning Source #
Instance details Defined in Hasura.RQL.DDL.Warnings Methods toJSON :: MetadataWarning -> Value Source # toEncoding :: MetadataWarning -> Encoding Source # toJSONList :: [MetadataWarning] -> Value Source # toEncodingList :: [MetadataWarning] -> Encoding Source #
Eq MetadataWarning Source #
Instance details Defined in Hasura.RQL.DDL.Warnings Methods (==) :: MetadataWarning -> MetadataWarning -> Bool # (/=) :: MetadataWarning -> MetadataWarning -> Bool #
Ord MetadataWarning Source #
Instance details Defined in Hasura.RQL.DDL.Warnings Methods compare :: MetadataWarning -> MetadataWarning -> Ordering # (<) :: MetadataWarning -> MetadataWarning -> Bool # (<=) :: MetadataWarning -> MetadataWarning -> Bool # (>) :: MetadataWarning -> MetadataWarning -> Bool # (>=) :: MetadataWarning -> MetadataWarning -> Bool # max :: MetadataWarning -> MetadataWarning -> MetadataWarning # min :: MetadataWarning -> MetadataWarning -> MetadataWarning #
Monad m => MonadWarnings (StateT MetadataWarnings m) Source #
Instance details Defined in Hasura.RQL.DDL.Warnings Methods warn :: MetadataWarning -> StateT MetadataWarnings m () Source #

type MetadataWarnings = Seq MetadataWarning Source #

class Monad m => MonadWarnings m where Source #

Methods

warn :: MetadataWarning -> m () Source #

Add a warning to the current context

Instances

Instances details

Monad m => MonadWarnings (StateT MetadataWarnings m) Source #
Instance details Defined in Hasura.RQL.DDL.Warnings Methods warn :: MetadataWarning -> StateT MetadataWarnings m () Source #

runMetadataWarnings :: StateT MetadataWarnings m a -> m (a, MetadataWarnings) Source #

mkSuccessResponseWithWarnings :: MetadataWarnings -> EncJSON Source #

successMsgWithWarnings :: Monad m => StateT MetadataWarnings m () -> m EncJSON Source #