Safe Haskell	Safe-Inferred
Language	Haskell2010

Hasura.LogicalModel.API

Description

Define and handle v1/metadata API operations to track, untrack, and get logical models.

Synopsis

data TrackLogicalModel (b :: BackendType) = TrackLogicalModel {
- tlmSource :: SourceName
- tlmName :: LogicalModelName
- tlmDescription :: Maybe Text
- tlmFields :: InsOrdHashMap (Column b) (LogicalModelField b)
}
data GetLogicalModel (b :: BackendType) = GetLogicalModel {
- glmSource :: SourceName
}
runGetLogicalModel :: forall b m. (BackendMetadata b, MonadError QErr m, MetadataM m) => GetLogicalModel b -> m EncJSON
execTrackLogicalModel :: forall b m. (BackendMetadata b, MonadError QErr m) => TrackLogicalModel b -> Metadata -> m (MetadataObjId, MetadataModifier)
data UntrackLogicalModel (b :: BackendType) = UntrackLogicalModel {
- utlmSource :: SourceName
- utlmName :: LogicalModelName
}
execUntrackLogicalModel :: forall b m. (BackendMetadata b, MonadError QErr m) => UntrackLogicalModel b -> Metadata -> m (MetadataObjId, MetadataModifier)
data CreateLogicalModelPermission a (b :: BackendType) = CreateLogicalModelPermission {
- clmpSource :: SourceName
- clmpName :: LogicalModelName
- clmpInfo :: PermDef b a
}
runCreateSelectLogicalModelPermission :: forall b m. (Backend b, CacheRWM m, MetadataM m, MonadError QErr m) => CreateLogicalModelPermission SelPerm b -> m EncJSON
data DropLogicalModelPermission (b :: BackendType) = DropLogicalModelPermission {
- dlmpSource :: SourceName
- dlmpName :: LogicalModelName
- dlmpRole :: RoleName
}
runDropSelectLogicalModelPermission :: forall b m. (Backend b, CacheRWM m, MetadataM m, MonadError QErr m) => DropLogicalModelPermission b -> m EncJSON
dropLogicalModelInMetadata :: forall b. BackendMetadata b => SourceName -> LogicalModelName -> MetadataModifier

Documentation

data TrackLogicalModel (b :: BackendType) Source #

Default implementation of the track_logical_model request payload.

Constructors

TrackLogicalModel
Fields tlmSource :: SourceName tlmName :: LogicalModelName tlmDescription :: Maybe Text tlmFields :: InsOrdHashMap (Column b) (LogicalModelField b)

Instances

Instances details

Backend b => FromJSON (TrackLogicalModel b) Source #
Instance details Defined in Hasura.LogicalModel.API Methods parseJSON :: Value -> Parser (TrackLogicalModel b) Source # parseJSONList :: Value -> Parser [TrackLogicalModel b] Source #
Backend b => ToJSON (TrackLogicalModel b) Source #
Instance details Defined in Hasura.LogicalModel.API Methods toJSON :: TrackLogicalModel b -> Value Source # toEncoding :: TrackLogicalModel b -> Encoding Source # toJSONList :: [TrackLogicalModel b] -> Value Source # toEncodingList :: [TrackLogicalModel b] -> Encoding Source #
Backend b => HasCodec (TrackLogicalModel b) Source #
Instance details Defined in Hasura.LogicalModel.API Methods codec :: JSONCodec (TrackLogicalModel b) Source # listCodecForStringCompatibility :: JSONCodec [TrackLogicalModel b] Source #

data GetLogicalModel (b :: BackendType) Source #

API payload for the get_logical_model endpoint.

Constructors

GetLogicalModel
Fields glmSource :: SourceName

Instances

Instances details

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

runGetLogicalModel :: forall b m. (BackendMetadata b, MonadError QErr m, MetadataM m) => GetLogicalModel b -> m EncJSON Source #

Handler for the get_logical_model endpoint.

execTrackLogicalModel :: forall b m. (BackendMetadata b, MonadError QErr m) => TrackLogicalModel b -> Metadata -> m (MetadataObjId, MetadataModifier) Source #

Handler for the track_logical_model endpoint. The type 'TrackLogicalModel b' (appearing here in wrapped as 'BackendTrackLogicalModel b' for AnyBackend compatibility) is defined in 'class LogicalModelMetadata'.

data UntrackLogicalModel (b :: BackendType) Source #

API payload for the untrack_logical_model endpoint.

Constructors

UntrackLogicalModel
Fields utlmSource :: SourceName utlmName :: LogicalModelName

Instances

Instances details

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

execUntrackLogicalModel :: forall b m. (BackendMetadata b, MonadError QErr m) => UntrackLogicalModel b -> Metadata -> m (MetadataObjId, MetadataModifier) Source #

Handler for the untrack_logical_model endpoint.

data CreateLogicalModelPermission a (b :: BackendType) Source #

A permission for logical models is tied to a specific name and source. This wrapper adds both of those things to the JSON object that describes the permission.

Constructors

CreateLogicalModelPermission
Fields clmpSource :: SourceName clmpName :: LogicalModelName clmpInfo :: PermDef b a

Instances

Instances details

FromJSON (PermDef b a) => FromJSON (CreateLogicalModelPermission a b) Source #
Instance details Defined in Hasura.LogicalModel.API Methods parseJSON :: Value -> Parser (CreateLogicalModelPermission a b) Source # parseJSONList :: Value -> Parser [CreateLogicalModelPermission a b] Source #
Generic (CreateLogicalModelPermission a b) Source #
Instance details Defined in Hasura.LogicalModel.API Associated Types type Rep (CreateLogicalModelPermission a b) :: Type -> Type # Methods from :: CreateLogicalModelPermission a b -> Rep (CreateLogicalModelPermission a b) x # to :: Rep (CreateLogicalModelPermission a b) x -> CreateLogicalModelPermission a b #
type Rep (CreateLogicalModelPermission a b) Source #
Instance details Defined in Hasura.LogicalModel.API type Rep (CreateLogicalModelPermission a b) = D1 ('MetaData "CreateLogicalModelPermission" "Hasura.LogicalModel.API" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "CreateLogicalModelPermission" 'PrefixI 'True) (S1 ('MetaSel ('Just "clmpSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SourceName) :: (S1 ('MetaSel ('Just "clmpName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LogicalModelName) :: S1 ('MetaSel ('Just "clmpInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (PermDef b a)))))

runCreateSelectLogicalModelPermission :: forall b m. (Backend b, CacheRWM m, MetadataM m, MonadError QErr m) => CreateLogicalModelPermission SelPerm b -> m EncJSON Source #

data DropLogicalModelPermission (b :: BackendType) Source #

To drop a permission, we need to know the source and name of the logical model, as well as the role whose permission we want to drop.

Constructors

DropLogicalModelPermission
Fields dlmpSource :: SourceName dlmpName :: LogicalModelName dlmpRole :: RoleName

Instances

Instances details

FromJSON (DropLogicalModelPermission b) Source #
Instance details Defined in Hasura.LogicalModel.API Methods parseJSON :: Value -> Parser (DropLogicalModelPermission b) Source # parseJSONList :: Value -> Parser [DropLogicalModelPermission b] Source #
Generic (DropLogicalModelPermission b) Source #
Instance details Defined in Hasura.LogicalModel.API Associated Types type Rep (DropLogicalModelPermission b) :: Type -> Type # Methods from :: DropLogicalModelPermission b -> Rep (DropLogicalModelPermission b) x # to :: Rep (DropLogicalModelPermission b) x -> DropLogicalModelPermission b #
type Rep (DropLogicalModelPermission b) Source #
Instance details Defined in Hasura.LogicalModel.API type Rep (DropLogicalModelPermission b) = D1 ('MetaData "DropLogicalModelPermission" "Hasura.LogicalModel.API" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "DropLogicalModelPermission" 'PrefixI 'True) (S1 ('MetaSel ('Just "dlmpSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SourceName) :: (S1 ('MetaSel ('Just "dlmpName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LogicalModelName) :: S1 ('MetaSel ('Just "dlmpRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RoleName))))

runDropSelectLogicalModelPermission :: forall b m. (Backend b, CacheRWM m, MetadataM m, MonadError QErr m) => DropLogicalModelPermission b -> m EncJSON Source #

dropLogicalModelInMetadata :: forall b. BackendMetadata b => SourceName -> LogicalModelName -> MetadataModifier Source #

TODO: should this cascade and also delete associated permissions?