graphql-engine-1.0.0: GraphQL API over Postgres
Safe HaskellSafe-Inferred
LanguageHaskell2010

Hasura.RQL.Types.Session

Synopsis

Documentation

newtype SessionVariable Source #

Constructors

SessionVariable 

Fields

Instances

Instances details
FromJSON SessionVariable Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

parseJSON :: Value -> Parser SessionVariable Source #

parseJSONList :: Value -> Parser [SessionVariable] Source #

FromJSONKey SessionVariable Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

fromJSONKey :: FromJSONKeyFunction SessionVariable Source #

fromJSONKeyList :: FromJSONKeyFunction [SessionVariable] Source #

ToJSON SessionVariable Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

toJSON :: SessionVariable -> Value Source #

toEncoding :: SessionVariable -> Encoding Source #

toJSONList :: [SessionVariable] -> Value Source #

toEncodingList :: [SessionVariable] -> Encoding Source #

ToJSONKey SessionVariable Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

toJSONKey :: ToJSONKeyFunction SessionVariable Source #

toJSONKeyList :: ToJSONKeyFunction [SessionVariable] Source #

Data SessionVariable Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SessionVariable -> c SessionVariable #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SessionVariable #

toConstr :: SessionVariable -> Constr #

dataTypeOf :: SessionVariable -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SessionVariable) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SessionVariable) #

gmapT :: (forall b. Data b => b -> b) -> SessionVariable -> SessionVariable #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SessionVariable -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SessionVariable -> r #

gmapQ :: (forall d. Data d => d -> u) -> SessionVariable -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SessionVariable -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SessionVariable -> m SessionVariable #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SessionVariable -> m SessionVariable #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SessionVariable -> m SessionVariable #

IsString SessionVariable Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

fromString :: String -> SessionVariable #

Show SessionVariable Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

showsPrec :: Int -> SessionVariable -> ShowS #

show :: SessionVariable -> String #

showList :: [SessionVariable] -> ShowS #

NFData SessionVariable Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

rnf :: SessionVariable -> () #

Eq SessionVariable Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

(==) :: SessionVariable -> SessionVariable -> Bool #

(/=) :: SessionVariable -> SessionVariable -> Bool #

Ord SessionVariable Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

compare :: SessionVariable -> SessionVariable -> Ordering #

(<) :: SessionVariable -> SessionVariable -> Bool #

(<=) :: SessionVariable -> SessionVariable -> Bool #

(>) :: SessionVariable -> SessionVariable -> Bool #

(>=) :: SessionVariable -> SessionVariable -> Bool #

max :: SessionVariable -> SessionVariable -> SessionVariable #

min :: SessionVariable -> SessionVariable -> SessionVariable #

Hashable SessionVariable Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

hashWithSalt :: Int -> SessionVariable -> Int Source #

hash :: SessionVariable -> Int Source #

ToTxt SessionVariable Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

toTxt :: SessionVariable -> Text Source #

type SessionVariableValue = Text Source #

sessionVariablePrefix :: Text Source #

isSessionVariable :: Text -> Bool Source #

parseSessionVariable :: Text -> Parser SessionVariable Source #

sessionVariableToText :: SessionVariable -> Text Source #

mkSessionVariable :: Text -> SessionVariable Source #

newtype SessionVariables Source #

Constructors

SessionVariables 

Fields

Instances

Instances details
FromJSON SessionVariables Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

parseJSON :: Value -> Parser SessionVariables Source #

parseJSONList :: Value -> Parser [SessionVariables] Source #

ToJSON SessionVariables Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

toJSON :: SessionVariables -> Value Source #

toEncoding :: SessionVariables -> Encoding Source #

toJSONList :: [SessionVariables] -> Value Source #

toEncodingList :: [SessionVariables] -> Encoding Source #

Monoid SessionVariables Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

mempty :: SessionVariables #

mappend :: SessionVariables -> SessionVariables -> SessionVariables #

mconcat :: [SessionVariables] -> SessionVariables #

Semigroup SessionVariables Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

(<>) :: SessionVariables -> SessionVariables -> SessionVariables #

sconcat :: NonEmpty SessionVariables -> SessionVariables #

stimes :: Integral b => b -> SessionVariables -> SessionVariables #

Show SessionVariables Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

showsPrec :: Int -> SessionVariables -> ShowS #

show :: SessionVariables -> String #

showList :: [SessionVariables] -> ShowS #

Eq SessionVariables Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

(==) :: SessionVariables -> SessionVariables -> Bool #

(/=) :: SessionVariables -> SessionVariables -> Bool #

Hashable SessionVariables Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

hashWithSalt :: Int -> SessionVariables -> Int Source #

hash :: SessionVariables -> Int Source #

mkSessionVariablesText :: HashMap Text Text -> SessionVariables Source #

data UserAdminSecret Source #

Represent the admin secret state; whether the secret is sent in the request or if actually authorization is not configured.

Constructors

UAdminSecretSent 
UAdminSecretNotSent 
UAuthNotSet 

Instances

Instances details
Show UserAdminSecret Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

showsPrec :: Int -> UserAdminSecret -> ShowS #

show :: UserAdminSecret -> String #

showList :: [UserAdminSecret] -> ShowS #

Eq UserAdminSecret Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

(==) :: UserAdminSecret -> UserAdminSecret -> Bool #

(/=) :: UserAdminSecret -> UserAdminSecret -> Bool #

data BackendOnlyFieldAccess Source #

Represents the 'X-Hasura-Use-Backend-Only-Permissions' session variable and request made with 'X-Hasura-Admin-Secret' if any auth configured. For more details see Note [Backend only permissions]

Constructors

BOFAAllowed 
BOFADisallowed 

Instances

Instances details
FromJSON BackendOnlyFieldAccess Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

parseJSON :: Value -> Parser BackendOnlyFieldAccess Source #

parseJSONList :: Value -> Parser [BackendOnlyFieldAccess] Source #

ToJSON BackendOnlyFieldAccess Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

toJSON :: BackendOnlyFieldAccess -> Value Source #

toEncoding :: BackendOnlyFieldAccess -> Encoding Source #

toJSONList :: [BackendOnlyFieldAccess] -> Value Source #

toEncodingList :: [BackendOnlyFieldAccess] -> Encoding Source #

Generic BackendOnlyFieldAccess Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Associated Types

type Rep BackendOnlyFieldAccess :: Type -> Type #

Methods

from :: BackendOnlyFieldAccess -> Rep BackendOnlyFieldAccess x #

to :: Rep BackendOnlyFieldAccess x -> BackendOnlyFieldAccess #

Show BackendOnlyFieldAccess Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

showsPrec :: Int -> BackendOnlyFieldAccess -> ShowS #

show :: BackendOnlyFieldAccess -> String #

showList :: [BackendOnlyFieldAccess] -> ShowS #

Eq BackendOnlyFieldAccess Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

(==) :: BackendOnlyFieldAccess -> BackendOnlyFieldAccess -> Bool #

(/=) :: BackendOnlyFieldAccess -> BackendOnlyFieldAccess -> Bool #

Hashable BackendOnlyFieldAccess Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

hashWithSalt :: Int -> BackendOnlyFieldAccess -> Int Source #

hash :: BackendOnlyFieldAccess -> Int Source #

type Rep BackendOnlyFieldAccess Source # 
Instance details

Defined in Hasura.RQL.Types.Session

type Rep BackendOnlyFieldAccess = D1 ('MetaData "BackendOnlyFieldAccess" "Hasura.RQL.Types.Session" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "BOFAAllowed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BOFADisallowed" 'PrefixI 'False) (U1 :: Type -> Type))

data UserInfo Source #

Constructors

UserInfo 

Fields

Instances

Instances details
FromJSON UserInfo Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

parseJSON :: Value -> Parser UserInfo Source #

parseJSONList :: Value -> Parser [UserInfo] Source #

ToJSON UserInfo Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

toJSON :: UserInfo -> Value Source #

toEncoding :: UserInfo -> Encoding Source #

toJSONList :: [UserInfo] -> Value Source #

toEncodingList :: [UserInfo] -> Encoding Source #

Generic UserInfo Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Associated Types

type Rep UserInfo :: Type -> Type #

Methods

from :: UserInfo -> Rep UserInfo x #

to :: Rep UserInfo x -> UserInfo #

Show UserInfo Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

showsPrec :: Int -> UserInfo -> ShowS #

show :: UserInfo -> String #

showList :: [UserInfo] -> ShowS #

Eq UserInfo Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

(==) :: UserInfo -> UserInfo -> Bool #

(/=) :: UserInfo -> UserInfo -> Bool #

Hashable UserInfo Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

hashWithSalt :: Int -> UserInfo -> Int Source #

hash :: UserInfo -> Int Source #

type Rep UserInfo Source # 
Instance details

Defined in Hasura.RQL.Types.Session

type Rep UserInfo = D1 ('MetaData "UserInfo" "Hasura.RQL.Types.Session" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "UserInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "_uiRole") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RoleName) :*: (S1 ('MetaSel ('Just "_uiSession") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SessionVariables) :*: S1 ('MetaSel ('Just "_uiBackendOnlyFieldAccess") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BackendOnlyFieldAccess))))

class Monad m => UserInfoM m where Source #

Methods

askUserInfo :: m UserInfo Source #

Instances

Instances details
UserInfoM m => UserInfoM (CacheRWT m) Source # 
Instance details

Defined in Hasura.RQL.DDL.Schema.Cache

Methods

askUserInfo :: CacheRWT m UserInfo Source #

UserInfoM m => UserInfoM (MetadataT m) Source # 
Instance details

Defined in Hasura.RQL.Types.SchemaCache.Build

Methods

askUserInfo :: MetadataT m UserInfo Source #

Monad m => UserInfoM (Handler m) Source # 
Instance details

Defined in Hasura.Server.App

Methods

askUserInfo :: Handler m UserInfo Source #

UserInfoM m => UserInfoM (TraceT m) Source # 
Instance details

Defined in Hasura.Tracing.Monad

Methods

askUserInfo :: TraceT m UserInfo Source #

UserInfoM m => UserInfoM (TableCacheRT b m) Source # 
Instance details

Defined in Hasura.RQL.Types.SchemaCache

Methods

askUserInfo :: TableCacheRT b m UserInfo Source #

UserInfoM m => UserInfoM (ExceptT r m) Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

askUserInfo :: ExceptT r m UserInfo Source #

UserInfoM m => UserInfoM (ReaderT r m) Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

askUserInfo :: ReaderT r m UserInfo Source #

UserInfoM m => UserInfoM (StateT s m) Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

askUserInfo :: StateT s m UserInfo Source #

data ExtraUserInfo Source #

extra information used to identify a Hasura User

Constructors

ExtraUserInfo 

Fields

Instances

Instances details
Generic ExtraUserInfo Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Associated Types

type Rep ExtraUserInfo :: Type -> Type #

Methods

from :: ExtraUserInfo -> Rep ExtraUserInfo x #

to :: Rep ExtraUserInfo x -> ExtraUserInfo #

Show ExtraUserInfo Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

showsPrec :: Int -> ExtraUserInfo -> ShowS #

show :: ExtraUserInfo -> String #

showList :: [ExtraUserInfo] -> ShowS #

Eq ExtraUserInfo Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

(==) :: ExtraUserInfo -> ExtraUserInfo -> Bool #

(/=) :: ExtraUserInfo -> ExtraUserInfo -> Bool #

type Rep ExtraUserInfo Source # 
Instance details

Defined in Hasura.RQL.Types.Session

type Rep ExtraUserInfo = D1 ('MetaData "ExtraUserInfo" "Hasura.RQL.Types.Session" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "ExtraUserInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "_euiUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

data UserRoleBuild Source #

Represents how to build a role from the session variables

Constructors

URBFromSessionVariables

Look for `x-hasura-role` session variable value and absence will raise an exception

URBFromSessionVariablesFallback !RoleName

Look for `x-hasura-role` session variable value, if absent fall back to given role

URBPreDetermined !RoleName

Use only the pre-determined role

Instances

Instances details
Show UserRoleBuild Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

showsPrec :: Int -> UserRoleBuild -> ShowS #

show :: UserRoleBuild -> String #

showList :: [UserRoleBuild] -> ShowS #

Eq UserRoleBuild Source # 
Instance details

Defined in Hasura.RQL.Types.Session

Methods

(==) :: UserRoleBuild -> UserRoleBuild -> Bool #

(/=) :: UserRoleBuild -> UserRoleBuild -> Bool #