graphql-engine-1.0.0: GraphQL API over Postgres
Safe HaskellNone
LanguageHaskell2010

Hasura.Session

Synopsis

Documentation

newtype RoleName Source #

Constructors

RoleName 

Fields

Instances

Instances details
Eq RoleName Source # 
Instance details

Defined in Hasura.Session

Methods

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

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

Ord RoleName Source # 
Instance details

Defined in Hasura.Session

Methods

compare :: RoleName -> RoleName -> Ordering #

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

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

(>) :: RoleName -> RoleName -> Bool #

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

max :: RoleName -> RoleName -> RoleName #

min :: RoleName -> RoleName -> RoleName #

Show RoleName Source # 
Instance details

Defined in Hasura.Session

Methods

showsPrec :: Int -> RoleName -> ShowS #

show :: RoleName -> String #

showList :: [RoleName] -> ShowS #

Generic RoleName Source # 
Instance details

Defined in Hasura.Session

Associated Types

type Rep RoleName :: Type -> Type #

Methods

from :: RoleName -> Rep RoleName x #

to :: Rep RoleName x -> RoleName #

NFData RoleName Source # 
Instance details

Defined in Hasura.Session

Methods

rnf :: RoleName -> () #

Hashable RoleName Source # 
Instance details

Defined in Hasura.Session

Methods

hashWithSalt :: Int -> RoleName -> Int

hash :: RoleName -> Int

FromJSONKey RoleName Source # 
Instance details

Defined in Hasura.Session

Methods

fromJSONKey :: FromJSONKeyFunction RoleName

fromJSONKeyList :: FromJSONKeyFunction [RoleName]

FromJSON RoleName Source # 
Instance details

Defined in Hasura.Session

Methods

parseJSON :: Value -> Parser RoleName

parseJSONList :: Value -> Parser [RoleName]

ToJSONKey RoleName Source # 
Instance details

Defined in Hasura.Session

Methods

toJSONKey :: ToJSONKeyFunction RoleName

toJSONKeyList :: ToJSONKeyFunction [RoleName]

ToJSON RoleName Source # 
Instance details

Defined in Hasura.Session

Methods

toJSON :: RoleName -> Value

toEncoding :: RoleName -> Encoding

toJSONList :: [RoleName] -> Value

toEncodingList :: [RoleName] -> Encoding

ToTxt RoleName Source # 
Instance details

Defined in Hasura.Session

Methods

toTxt :: RoleName -> Text Source #

FromCol RoleName Source # 
Instance details

Defined in Hasura.Session

Methods

fromCol :: Maybe ByteString -> Either Text RoleName

ToPrepArg RoleName Source # 
Instance details

Defined in Hasura.Session

Methods

toPrepVal :: RoleName -> PrepArg

Cacheable RoleName Source # 
Instance details

Defined in Hasura.Session

Methods

unchanged :: Accesses -> RoleName -> RoleName -> Bool Source #

FromEnv RoleName Source # 
Instance details

Defined in Hasura.Server.Init.Env

Methods

fromEnv :: String -> Either String RoleName Source #

type Rep RoleName Source # 
Instance details

Defined in Hasura.Session

type Rep RoleName = D1 ('MetaData "RoleName" "Hasura.Session" "graphql-engine-1.0.0-inplace" 'True) (C1 ('MetaCons "RoleName" 'PrefixI 'True) (S1 ('MetaSel ('Just "getRoleTxt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NonEmptyText)))

roleNameToTxt :: RoleName -> Text Source #

mkRoleName :: Text -> Maybe RoleName Source #

mkRoleNameSafe :: NonEmptyText -> RoleName Source #

adminRoleName :: RoleName Source #

newtype SessionVariable Source #

Constructors

SessionVariable 

Fields

Instances

Instances details
Eq SessionVariable Source # 
Instance details

Defined in Hasura.Session

Methods

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

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

Data SessionVariable Source # 
Instance details

Defined in Hasura.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 #

Ord SessionVariable Source # 
Instance details

Defined in Hasura.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 #

Show SessionVariable Source # 
Instance details

Defined in Hasura.Session

Methods

showsPrec :: Int -> SessionVariable -> ShowS #

show :: SessionVariable -> String #

showList :: [SessionVariable] -> ShowS #

IsString SessionVariable Source # 
Instance details

Defined in Hasura.Session

Methods

fromString :: String -> SessionVariable #

NFData SessionVariable Source # 
Instance details

Defined in Hasura.Session

Methods

rnf :: SessionVariable -> () #

Hashable SessionVariable Source # 
Instance details

Defined in Hasura.Session

Methods

hashWithSalt :: Int -> SessionVariable -> Int

hash :: SessionVariable -> Int

FromJSONKey SessionVariable Source # 
Instance details

Defined in Hasura.Session

Methods

fromJSONKey :: FromJSONKeyFunction SessionVariable

fromJSONKeyList :: FromJSONKeyFunction [SessionVariable]

FromJSON SessionVariable Source # 
Instance details

Defined in Hasura.Session

Methods

parseJSON :: Value -> Parser SessionVariable

parseJSONList :: Value -> Parser [SessionVariable]

ToJSONKey SessionVariable Source # 
Instance details

Defined in Hasura.Session

Methods

toJSONKey :: ToJSONKeyFunction SessionVariable

toJSONKeyList :: ToJSONKeyFunction [SessionVariable]

ToJSON SessionVariable Source # 
Instance details

Defined in Hasura.Session

Methods

toJSON :: SessionVariable -> Value

toEncoding :: SessionVariable -> Encoding

toJSONList :: [SessionVariable] -> Value

toEncodingList :: [SessionVariable] -> Encoding

ToTxt SessionVariable Source # 
Instance details

Defined in Hasura.Session

Methods

toTxt :: SessionVariable -> Text Source #

Cacheable SessionVariable Source # 
Instance details

Defined in Hasura.Session

Methods

unchanged :: Accesses -> SessionVariable -> SessionVariable -> Bool Source #

sessionVariableToGraphQLName :: SessionVariable -> Maybe Name Source #

Converts a SessionVariable value to a GraphQL name. This will fail if the session variable contains characters that are not valid for a graphql names. It is the caller's responsibility to decide what to do in such a case.

parseSessionVariable :: Text -> Parser SessionVariable Source #

sessionVariableToText :: SessionVariable -> Text Source #

mkSessionVariable :: Text -> SessionVariable Source #

type SessionVariableValue = Text Source #

newtype SessionVariables Source #

Constructors

SessionVariables 

Fields

Instances

Instances details
Eq SessionVariables Source # 
Instance details

Defined in Hasura.Session

Methods

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

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

Show SessionVariables Source # 
Instance details

Defined in Hasura.Session

Methods

showsPrec :: Int -> SessionVariables -> ShowS #

show :: SessionVariables -> String #

showList :: [SessionVariables] -> ShowS #

Semigroup SessionVariables Source # 
Instance details

Defined in Hasura.Session

Methods

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

sconcat :: NonEmpty SessionVariables -> SessionVariables #

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

Monoid SessionVariables Source # 
Instance details

Defined in Hasura.Session

Methods

mempty :: SessionVariables #

mappend :: SessionVariables -> SessionVariables -> SessionVariables #

mconcat :: [SessionVariables] -> SessionVariables #

Hashable SessionVariables Source # 
Instance details

Defined in Hasura.Session

Methods

hashWithSalt :: Int -> SessionVariables -> Int

hash :: SessionVariables -> Int

FromJSON SessionVariables Source # 
Instance details

Defined in Hasura.Session

Methods

parseJSON :: Value -> Parser SessionVariables

parseJSONList :: Value -> Parser [SessionVariables]

ToJSON SessionVariables Source # 
Instance details

Defined in Hasura.Session

Methods

toJSON :: SessionVariables -> Value

toEncoding :: SessionVariables -> Encoding

toJSONList :: [SessionVariables] -> Value

toEncodingList :: [SessionVariables] -> Encoding

filterSessionVariables :: (SessionVariable -> SessionVariableValue -> Bool) -> SessionVariables -> SessionVariables Source #

mkSessionVariablesText :: HashMap Text Text -> SessionVariables Source #

mkSessionVariablesHeaders :: [Header] -> SessionVariables Source #

sessionVariablesToHeaders :: SessionVariables -> [Header] Source #

getSessionVariables :: SessionVariables -> [Text] Source #

getSessionVariablesSet :: SessionVariables -> HashSet SessionVariable Source #

getSessionVariableValue :: SessionVariable -> SessionVariables -> Maybe SessionVariableValue 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
Eq UserAdminSecret Source # 
Instance details

Defined in Hasura.Session

Methods

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

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

Show UserAdminSecret Source # 
Instance details

Defined in Hasura.Session

Methods

showsPrec :: Int -> UserAdminSecret -> ShowS #

show :: UserAdminSecret -> String #

showList :: [UserAdminSecret] -> ShowS #

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
Eq BackendOnlyFieldAccess Source # 
Instance details

Defined in Hasura.Session

Methods

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

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

Show BackendOnlyFieldAccess Source # 
Instance details

Defined in Hasura.Session

Methods

showsPrec :: Int -> BackendOnlyFieldAccess -> ShowS #

show :: BackendOnlyFieldAccess -> String #

showList :: [BackendOnlyFieldAccess] -> ShowS #

Generic BackendOnlyFieldAccess Source # 
Instance details

Defined in Hasura.Session

Associated Types

type Rep BackendOnlyFieldAccess :: Type -> Type #

Methods

from :: BackendOnlyFieldAccess -> Rep BackendOnlyFieldAccess x #

to :: Rep BackendOnlyFieldAccess x -> BackendOnlyFieldAccess #

Hashable BackendOnlyFieldAccess Source # 
Instance details

Defined in Hasura.Session

Methods

hashWithSalt :: Int -> BackendOnlyFieldAccess -> Int

hash :: BackendOnlyFieldAccess -> Int

type Rep BackendOnlyFieldAccess Source # 
Instance details

Defined in Hasura.Session

type Rep BackendOnlyFieldAccess = D1 ('MetaData "BackendOnlyFieldAccess" "Hasura.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
Eq UserInfo Source # 
Instance details

Defined in Hasura.Session

Methods

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

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

Show UserInfo Source # 
Instance details

Defined in Hasura.Session

Methods

showsPrec :: Int -> UserInfo -> ShowS #

show :: UserInfo -> String #

showList :: [UserInfo] -> ShowS #

Generic UserInfo Source # 
Instance details

Defined in Hasura.Session

Associated Types

type Rep UserInfo :: Type -> Type #

Methods

from :: UserInfo -> Rep UserInfo x #

to :: Rep UserInfo x -> UserInfo #

Hashable UserInfo Source # 
Instance details

Defined in Hasura.Session

Methods

hashWithSalt :: Int -> UserInfo -> Int

hash :: UserInfo -> Int

type Rep UserInfo Source # 
Instance details

Defined in Hasura.Session

type Rep UserInfo = D1 ('MetaData "UserInfo" "Hasura.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 (TraceT m) Source # 
Instance details

Defined in Hasura.Session

Methods

askUserInfo :: TraceT 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 (RunT m) Source # 
Instance details

Defined in Hasura.RQL.Types.Run

Methods

askUserInfo :: RunT m UserInfo Source #

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

Defined in Hasura.RQL.DDL.Schema.Cache

Methods

askUserInfo :: CacheRWT m UserInfo Source #

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

Defined in Hasura.Session

Methods

askUserInfo :: ExceptT r m UserInfo Source #

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

Defined in Hasura.Session

Methods

askUserInfo :: ReaderT r m UserInfo Source #

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

Defined in Hasura.Session

Methods

askUserInfo :: StateT s 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 #

askCurRole :: UserInfoM m => m RoleName Source #

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
Eq UserRoleBuild Source # 
Instance details

Defined in Hasura.Session

Methods

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

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

Show UserRoleBuild Source # 
Instance details

Defined in Hasura.Session

Methods

showsPrec :: Int -> UserRoleBuild -> ShowS #

show :: UserRoleBuild -> String #

showList :: [UserRoleBuild] -> ShowS #

mkUserInfo :: forall m. MonadError QErr m => UserRoleBuild -> UserAdminSecret -> SessionVariables -> m UserInfo Source #

Build UserInfo from SessionVariables

maybeRoleFromSessionVariables :: SessionVariables -> Maybe RoleName Source #

adminUserInfo :: UserInfo Source #