Safe Haskell	Safe-Inferred
Language	Haskell2010

Hasura.RQL.Types.Metadata.Common

Description

In order to avoid circular dependencies while splitting Metadata into multiple modules, some definitions must be moved out of that module. This module is the bucket for definitions that have not been specifically moved elsewhere.

Synopsis

type EventTriggers b = InsOrdHashMap TriggerName (EventTriggerConf b)
type RemoteSchemaMetadata = RemoteSchemaMetadataG RemoteRelationshipDefinition
type RemoteSchemas = InsOrdHashMap RemoteSchemaName RemoteSchemaMetadata
type Tables b = InsOrdHashMap (TableName b) (TableMetadata b)
type Functions b = InsOrdHashMap (FunctionName b) (FunctionMetadata b)
type NativeQueries b = InsOrdHashMap NativeQueryName (NativeQueryMetadata b)
type StoredProcedures b = InsOrdHashMap (FunctionName b) (StoredProcedureMetadata b)
type LogicalModels b = InsOrdHashMap LogicalModelName (LogicalModelMetadata b)
type Endpoints = InsOrdHashMap EndpointName CreateEndpoint
type Actions = InsOrdHashMap ActionName ActionMetadata
type CronTriggers = InsOrdHashMap TriggerName CronTriggerMetadata
type InheritedRoles = InsOrdHashMap RoleName InheritedRole
data SourceMetadata b = SourceMetadata {
- _smName :: SourceName
- _smKind :: BackendSourceKind b
- _smTables :: Tables b
- _smFunctions :: Functions b
- _smNativeQueries :: NativeQueries b
- _smStoredProcedures :: StoredProcedures b
- _smLogicalModels :: LogicalModels b
- _smConfiguration :: SourceConnConfiguration b
- _smQueryTags :: Maybe QueryTagsConfig
- _smCustomization :: SourceCustomization
- _smHealthCheckConfig :: Maybe (HealthCheckConfig b)
}
smTables :: forall b. Lens' (SourceMetadata b) (Tables b)
smStoredProcedures :: forall b. Lens' (SourceMetadata b) (StoredProcedures b)
smQueryTags :: forall b. Lens' (SourceMetadata b) (Maybe QueryTagsConfig)
smNativeQueries :: forall b. Lens' (SourceMetadata b) (NativeQueries b)
smName :: forall b. Lens' (SourceMetadata b) SourceName
smLogicalModels :: forall b. Lens' (SourceMetadata b) (LogicalModels b)
smKind :: forall b. Lens' (SourceMetadata b) (BackendSourceKind b)
smHealthCheckConfig :: forall b. Lens' (SourceMetadata b) (Maybe (HealthCheckConfig b))
smFunctions :: forall b. Lens' (SourceMetadata b) (Functions b)
smCustomization :: forall b. Lens' (SourceMetadata b) SourceCustomization
smConfiguration :: forall b. Lens' (SourceMetadata b) (SourceConnConfiguration b)
backendSourceMetadataCodec :: JSONCodec BackendSourceMetadata
mkSourceMetadata :: forall (b :: BackendType). Backend b => SourceName -> BackendSourceKind b -> SourceConnConfiguration b -> SourceCustomization -> Maybe (HealthCheckConfig b) -> BackendSourceMetadata
newtype BackendSourceMetadata = BackendSourceMetadata {
- unBackendSourceMetadata :: AnyBackend SourceMetadata
}
toSourceMetadata :: forall b. Backend b => Prism' BackendSourceMetadata (SourceMetadata b)
getSourceName :: BackendSourceMetadata -> SourceName
type Sources = InsOrdHashMap SourceName BackendSourceMetadata
sourcesCodec :: JSONCodec Sources
parseNonSourcesMetadata :: Object -> Parser (RemoteSchemas, QueryCollections, MetadataAllowlist, CustomTypes, Actions, CronTriggers, ApiLimit, MetricsConfig, InheritedRoles, SetGraphqlIntrospectionOptions)
newtype BackendConfigWrapper b = BackendConfigWrapper {
- unBackendConfigWrapper :: BackendConfig b
}
data CatalogStateType
- = CSTCli
- | CSTConsole
data SetCatalogState = SetCatalogState {
- _scsType :: CatalogStateType
- _scsState :: Value
}
data CatalogState = CatalogState {
- _csId :: Text
- _csCliState :: Value
- _csConsoleState :: Value
}
data GetCatalogState = GetCatalogState

Documentation

type EventTriggers b = InsOrdHashMap TriggerName (EventTriggerConf b) Source #

type RemoteSchemaMetadata = RemoteSchemaMetadataG RemoteRelationshipDefinition Source #

type RemoteSchemas = InsOrdHashMap RemoteSchemaName RemoteSchemaMetadata Source #

type Tables b = InsOrdHashMap (TableName b) (TableMetadata b) Source #

type Functions b = InsOrdHashMap (FunctionName b) (FunctionMetadata b) Source #

type NativeQueries b = InsOrdHashMap NativeQueryName (NativeQueryMetadata b) Source #

type StoredProcedures b = InsOrdHashMap (FunctionName b) (StoredProcedureMetadata b) Source #

type LogicalModels b = InsOrdHashMap LogicalModelName (LogicalModelMetadata b) Source #

type Endpoints = InsOrdHashMap EndpointName CreateEndpoint Source #

type Actions = InsOrdHashMap ActionName ActionMetadata Source #

type CronTriggers = InsOrdHashMap TriggerName CronTriggerMetadata Source #

type InheritedRoles = InsOrdHashMap RoleName InheritedRole Source #

data SourceMetadata b Source #

Source configuration for a source of backend type b as stored in the Metadata DB.

Constructors

SourceMetadata

Instances

Instances details

Backend b => HasCodec (SourceMetadata b) Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods codec :: JSONCodec (SourceMetadata b) Source # listCodecForStringCompatibility :: JSONCodec [SourceMetadata b] Source #
Generic (SourceMetadata b) Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Associated Types type Rep (SourceMetadata b) :: Type -> Type # Methods from :: SourceMetadata b -> Rep (SourceMetadata b) x # to :: Rep (SourceMetadata b) x -> SourceMetadata b #
Backend b => Show (SourceMetadata b) Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods showsPrec :: Int -> SourceMetadata b -> ShowS # show :: SourceMetadata b -> String # showList :: [SourceMetadata b] -> ShowS #
Backend b => Eq (SourceMetadata b) Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods (==) :: SourceMetadata b -> SourceMetadata b -> Bool # (/=) :: SourceMetadata b -> SourceMetadata b -> Bool #
Backend b => FromJSONWithContext (BackendSourceKind b) (SourceMetadata b) Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods parseJSONWithContext :: BackendSourceKind b -> Value -> Parser (SourceMetadata b) Source #
type Rep (SourceMetadata b) Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common type Rep (SourceMetadata b) = D1 ('MetaData "SourceMetadata" "Hasura.RQL.Types.Metadata.Common" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "SourceMetadata" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_smName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SourceName) :: S1 ('MetaSel ('Just "_smKind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (BackendSourceKind b))) :: (S1 ('MetaSel ('Just "_smTables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Tables b)) :: (S1 ('MetaSel ('Just "_smFunctions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Functions b)) :: S1 ('MetaSel ('Just "_smNativeQueries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NativeQueries b))))) :: ((S1 ('MetaSel ('Just "_smStoredProcedures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (StoredProcedures b)) :: (S1 ('MetaSel ('Just "_smLogicalModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (LogicalModels b)) :: S1 ('MetaSel ('Just "_smConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (SourceConnConfiguration b)))) :: (S1 ('MetaSel ('Just "_smQueryTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryTagsConfig)) :: (S1 ('MetaSel ('Just "_smCustomization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SourceCustomization) :: S1 ('MetaSel ('Just "_smHealthCheckConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HealthCheckConfig b))))))))

smTables :: forall b. Lens' (SourceMetadata b) (Tables b) Source #

smStoredProcedures :: forall b. Lens' (SourceMetadata b) (StoredProcedures b) Source #

smQueryTags :: forall b. Lens' (SourceMetadata b) (Maybe QueryTagsConfig) Source #

smNativeQueries :: forall b. Lens' (SourceMetadata b) (NativeQueries b) Source #

smName :: forall b. Lens' (SourceMetadata b) SourceName Source #

smLogicalModels :: forall b. Lens' (SourceMetadata b) (LogicalModels b) Source #

smKind :: forall b. Lens' (SourceMetadata b) (BackendSourceKind b) Source #

smHealthCheckConfig :: forall b. Lens' (SourceMetadata b) (Maybe (HealthCheckConfig b)) Source #

smFunctions :: forall b. Lens' (SourceMetadata b) (Functions b) Source #

smCustomization :: forall b. Lens' (SourceMetadata b) SourceCustomization Source #

smConfiguration :: forall b. Lens' (SourceMetadata b) (SourceConnConfiguration b) Source #

backendSourceMetadataCodec :: JSONCodec BackendSourceMetadata Source #

mkSourceMetadata :: forall (b :: BackendType). Backend b => SourceName -> BackendSourceKind b -> SourceConnConfiguration b -> SourceCustomization -> Maybe (HealthCheckConfig b) -> BackendSourceMetadata Source #

newtype BackendSourceMetadata Source #

Source configuration as stored in the Metadata DB for some existentialized backend.

Constructors

BackendSourceMetadata
Fields unBackendSourceMetadata :: AnyBackend SourceMetadata

Instances

Instances details

Show BackendSourceMetadata Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods showsPrec :: Int -> BackendSourceMetadata -> ShowS # show :: BackendSourceMetadata -> String # showList :: [BackendSourceMetadata] -> ShowS #
Eq BackendSourceMetadata Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods (==) :: BackendSourceMetadata -> BackendSourceMetadata -> Bool # (/=) :: BackendSourceMetadata -> BackendSourceMetadata -> Bool #

toSourceMetadata :: forall b. Backend b => Prism' BackendSourceMetadata (SourceMetadata b) Source #

getSourceName :: BackendSourceMetadata -> SourceName Source #

type Sources = InsOrdHashMap SourceName BackendSourceMetadata Source #

sourcesCodec :: JSONCodec Sources Source #

parseNonSourcesMetadata :: Object -> Parser (RemoteSchemas, QueryCollections, MetadataAllowlist, CustomTypes, Actions, CronTriggers, ApiLimit, MetricsConfig, InheritedRoles, SetGraphqlIntrospectionOptions) Source #

newtype BackendConfigWrapper b Source #

This newtype simply wraps the BackendConfig type family so that it can be used with BackendMap in the Metadata type. GHC will not allow the type family to be used directly. :(

Constructors

BackendConfigWrapper
Fields unBackendConfigWrapper :: BackendConfig b

Instances

Instances details

Backend b => FromJSON (BackendConfigWrapper b) Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods parseJSON :: Value -> Parser (BackendConfigWrapper b) Source # parseJSONList :: Value -> Parser [BackendConfigWrapper b] Source #
Backend b => ToJSON (BackendConfigWrapper b) Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods toJSON :: BackendConfigWrapper b -> Value Source # toEncoding :: BackendConfigWrapper b -> Encoding Source # toJSONList :: [BackendConfigWrapper b] -> Value Source # toEncodingList :: [BackendConfigWrapper b] -> Encoding Source #
Backend b => HasCodec (BackendConfigWrapper b) Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods codec :: JSONCodec (BackendConfigWrapper b) Source # listCodecForStringCompatibility :: JSONCodec [BackendConfigWrapper b] Source #
Monoid (BackendConfig b) => Monoid (BackendConfigWrapper b) Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods mempty :: BackendConfigWrapper b # mappend :: BackendConfigWrapper b -> BackendConfigWrapper b -> BackendConfigWrapper b # mconcat :: [BackendConfigWrapper b] -> BackendConfigWrapper b #
Semigroup (BackendConfig b) => Semigroup (BackendConfigWrapper b) Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods (<>) :: BackendConfigWrapper b -> BackendConfigWrapper b -> BackendConfigWrapper b # sconcat :: NonEmpty (BackendConfigWrapper b) -> BackendConfigWrapper b # stimes :: Integral b0 => b0 -> BackendConfigWrapper b -> BackendConfigWrapper b #
Backend b => Show (BackendConfigWrapper b) Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods showsPrec :: Int -> BackendConfigWrapper b -> ShowS # show :: BackendConfigWrapper b -> String # showList :: [BackendConfigWrapper b] -> ShowS #
Backend b => Eq (BackendConfigWrapper b) Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods (==) :: BackendConfigWrapper b -> BackendConfigWrapper b -> Bool # (/=) :: BackendConfigWrapper b -> BackendConfigWrapper b -> Bool #

data CatalogStateType Source #

Constructors

CSTCli
CSTConsole

Instances

Instances details

FromJSON CatalogStateType Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods parseJSON :: Value -> Parser CatalogStateType Source # parseJSONList :: Value -> Parser [CatalogStateType] Source #
ToJSON CatalogStateType Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods toJSON :: CatalogStateType -> Value Source # toEncoding :: CatalogStateType -> Encoding Source # toJSONList :: [CatalogStateType] -> Value Source # toEncodingList :: [CatalogStateType] -> Encoding Source #
Generic CatalogStateType Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Associated Types type Rep CatalogStateType :: Type -> Type # Methods from :: CatalogStateType -> Rep CatalogStateType x # to :: Rep CatalogStateType x -> CatalogStateType #
Show CatalogStateType Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods showsPrec :: Int -> CatalogStateType -> ShowS # show :: CatalogStateType -> String # showList :: [CatalogStateType] -> ShowS #
Eq CatalogStateType Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods (==) :: CatalogStateType -> CatalogStateType -> Bool # (/=) :: CatalogStateType -> CatalogStateType -> Bool #
type Rep CatalogStateType Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common type Rep CatalogStateType = D1 ('MetaData "CatalogStateType" "Hasura.RQL.Types.Metadata.Common" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "CSTCli" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CSTConsole" 'PrefixI 'False) (U1 :: Type -> Type))

data SetCatalogState Source #

Constructors

SetCatalogState
Fields _scsType :: CatalogStateType _scsState :: Value

Instances

Instances details

FromJSON SetCatalogState Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods parseJSON :: Value -> Parser SetCatalogState Source # parseJSONList :: Value -> Parser [SetCatalogState] Source #
ToJSON SetCatalogState Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods toJSON :: SetCatalogState -> Value Source # toEncoding :: SetCatalogState -> Encoding Source # toJSONList :: [SetCatalogState] -> Value Source # toEncodingList :: [SetCatalogState] -> Encoding Source #
Generic SetCatalogState Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Associated Types type Rep SetCatalogState :: Type -> Type # Methods from :: SetCatalogState -> Rep SetCatalogState x # to :: Rep SetCatalogState x -> SetCatalogState #
Show SetCatalogState Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods showsPrec :: Int -> SetCatalogState -> ShowS # show :: SetCatalogState -> String # showList :: [SetCatalogState] -> ShowS #
Eq SetCatalogState Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods (==) :: SetCatalogState -> SetCatalogState -> Bool # (/=) :: SetCatalogState -> SetCatalogState -> Bool #
type Rep SetCatalogState Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common type Rep SetCatalogState = D1 ('MetaData "SetCatalogState" "Hasura.RQL.Types.Metadata.Common" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "SetCatalogState" 'PrefixI 'True) (S1 ('MetaSel ('Just "_scsType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CatalogStateType) :*: S1 ('MetaSel ('Just "_scsState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Value)))

data CatalogState Source #

Constructors

CatalogState
Fields _csId :: Text _csCliState :: Value _csConsoleState :: Value

Instances

Instances details

ToJSON CatalogState Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods toJSON :: CatalogState -> Value Source # toEncoding :: CatalogState -> Encoding Source # toJSONList :: [CatalogState] -> Value Source # toEncodingList :: [CatalogState] -> Encoding Source #
Generic CatalogState Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Associated Types type Rep CatalogState :: Type -> Type # Methods from :: CatalogState -> Rep CatalogState x # to :: Rep CatalogState x -> CatalogState #
Show CatalogState Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods showsPrec :: Int -> CatalogState -> ShowS # show :: CatalogState -> String # showList :: [CatalogState] -> ShowS #
Eq CatalogState Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods (==) :: CatalogState -> CatalogState -> Bool # (/=) :: CatalogState -> CatalogState -> Bool #
type Rep CatalogState Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common type Rep CatalogState = D1 ('MetaData "CatalogState" "Hasura.RQL.Types.Metadata.Common" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "CatalogState" 'PrefixI 'True) (S1 ('MetaSel ('Just "_csId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "_csCliState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Value) :: S1 ('MetaSel ('Just "_csConsoleState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Value))))

data GetCatalogState Source #

Constructors

GetCatalogState

Instances

Instances details

FromJSON GetCatalogState Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods parseJSON :: Value -> Parser GetCatalogState Source # parseJSONList :: Value -> Parser [GetCatalogState] Source #
ToJSON GetCatalogState Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods toJSON :: GetCatalogState -> Value Source # toEncoding :: GetCatalogState -> Encoding Source # toJSONList :: [GetCatalogState] -> Value Source # toEncodingList :: [GetCatalogState] -> Encoding Source #
Generic GetCatalogState Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Associated Types type Rep GetCatalogState :: Type -> Type # Methods from :: GetCatalogState -> Rep GetCatalogState x # to :: Rep GetCatalogState x -> GetCatalogState #
Show GetCatalogState Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods showsPrec :: Int -> GetCatalogState -> ShowS # show :: GetCatalogState -> String # showList :: [GetCatalogState] -> ShowS #
Eq GetCatalogState Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods (==) :: GetCatalogState -> GetCatalogState -> Bool # (/=) :: GetCatalogState -> GetCatalogState -> Bool #
type Rep GetCatalogState Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common type Rep GetCatalogState = D1 ('MetaData "GetCatalogState" "Hasura.RQL.Types.Metadata.Common" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "GetCatalogState" 'PrefixI 'False) (U1 :: Type -> Type))