Safe Haskell	None
Language	Haskell2010

Hasura.RQL.DDL.Metadata.Types

Description

Types related to metadata management API

Synopsis

data ClearMetadata = ClearMetadata
data ExportMetadata = ExportMetadata
data ReloadSpec a
- = RSReloadAll
- | RSReloadList (HashSet a)
type ReloadRemoteSchemas = ReloadSpec RemoteSchemaName
type ReloadSources = ReloadSpec SourceName
reloadAllRemoteSchemas :: ReloadRemoteSchemas
reloadAllSources :: ReloadSources
data ReloadMetadata = ReloadMetadata {
}
data DumpInternalState = DumpInternalState
data GetInconsistentMetadata = GetInconsistentMetadata
data DropInconsistentMetadata = DropInconsistentMetadata
data AllowInconsistentMetadata
- = AllowInconsistentMetadata
- | NoAllowInconsistentMetadata
data ReplaceMetadataV1
- = RMWithSources Metadata
- | RMWithoutSources MetadataNoSources
data ReplaceMetadataV2 = ReplaceMetadataV2 {
- _rmv2AllowInconsistentMetadata :: AllowInconsistentMetadata
- _rmv2Metadata :: ReplaceMetadataV1
}
data ReplaceMetadata
- = RMReplaceMetadataV1 ReplaceMetadataV1
- | RMReplaceMetadataV2 ReplaceMetadataV2
data WebHookUrl
- = EnvVar String
- | URL Text
data TestWebhookTransform = TestWebhookTransform {
- _twtEnv :: Environment
- _twtHeaders :: [Header]
- _twtWebhookUrl :: WebHookUrl
- _twtPayload :: Value
- _twtTransformer :: RequestTransform
- _twtResponseTransformer :: Maybe MetadataResponseTransform
- _twtSessionVariables :: Maybe SessionVariables
}
twtTransformer :: Lens' TestWebhookTransform RequestTransform

Documentation

data ClearMetadata Source #

ClearMetadata can be used to reset the state of Hasura -- clean the current state by forgetting the tables tracked, relationships, permissions, event triggers etc.

https://hasura.io/docs/latest/api-reference/metadata-api/manage-metadata/#metadata-clear-metadata

Constructors

ClearMetadata

Instances

Instances details

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

data ExportMetadata Source #

ExportMetadata is used to export the current metadata from the server as a JSON file.

https://hasura.io/docs/latest/api-reference/metadata-api/manage-metadata/#metadata-export-metadata

Constructors

ExportMetadata

Instances

Instances details

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

data ReloadSpec a Source #

Constructors

RSReloadAll
RSReloadList (HashSet a)

Instances

Instances details

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

type ReloadRemoteSchemas = ReloadSpec RemoteSchemaName Source #

type ReloadSources = ReloadSpec SourceName Source #

reloadAllRemoteSchemas :: ReloadRemoteSchemas Source #

reloadAllSources :: ReloadSources Source #

data ReloadMetadata Source #

ReloadMetadata should be used when there is a change in underlying Postgres database that Hasura should be aware of. Example: a new column is added to a table using psql and this column should now be added to the GraphQL schema.

https://hasura.io/docs/latest/api-reference/metadata-api/manage-metadata/#metadata-reload-metadata

Constructors

ReloadMetadata

Fields

_rmReloadRemoteSchemas :: ReloadRemoteSchemas
_rmReloadSources :: ReloadSources
_rmRecreateEventTriggers :: ReloadSources
Provides a way for the user to allow to explicitly recreate event triggers for some or all the sources. This is useful when a user may have fiddled with the SQL trigger in the source and they'd simply want the event trigger to be recreated without deleting and creating the event trigger. By default, no source's event triggers will be recreated.

Instances

Instances details

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

data DumpInternalState Source #

Undocumented Metadata API action which serializes the entire SchemaCache.

Constructors

DumpInternalState

Instances

Instances details

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

data GetInconsistentMetadata Source #

GetInconsistentMetadata can be used to fetch all inconsistent metadata objects.

https://hasura.io/docs/latest/api-reference/schema-metadata-api/manage-metadata/#schema-metadata-get-inconsistent-metadata

Constructors

GetInconsistentMetadata

Instances

Instances details

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

data DropInconsistentMetadata Source #

DropInconsistentMetadata can be used to purge all inconsistent objects from the metadata.

https://hasura.io/docs/latest/api-reference/metadata-api/manage-metadata/#metadata-drop-inconsistent-metadata

Constructors

DropInconsistentMetadata

Instances

Instances details

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

data AllowInconsistentMetadata Source #

Constructors

AllowInconsistentMetadata
NoAllowInconsistentMetadata

Instances

Instances details

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

data ReplaceMetadataV1 Source #

Replace metadata either with or without metadata sources.

Constructors

RMWithSources Metadata
RMWithoutSources MetadataNoSources

Instances

Instances details

Eq ReplaceMetadataV1 Source #
Instance details Defined in Hasura.RQL.DDL.Metadata.Types Methods (==) :: ReplaceMetadataV1 -> ReplaceMetadataV1 -> Bool # (/=) :: ReplaceMetadataV1 -> ReplaceMetadataV1 -> Bool #
FromJSON ReplaceMetadataV1 Source #
Instance details Defined in Hasura.RQL.DDL.Metadata.Types Methods parseJSON :: Value -> Parser ReplaceMetadataV1 parseJSONList :: Value -> Parser [ReplaceMetadataV1]
ToJSON ReplaceMetadataV1 Source #
Instance details Defined in Hasura.RQL.DDL.Metadata.Types Methods toJSON :: ReplaceMetadataV1 -> Value toEncoding :: ReplaceMetadataV1 -> Encoding toJSONList :: [ReplaceMetadataV1] -> Value toEncodingList :: [ReplaceMetadataV1] -> Encoding

data ReplaceMetadataV2 Source #

Replace metadata while allowing for inconsitency in the metadata object.

https://hasura.io/docs/latest/api-reference/metadata-api/manage-metadata/#metadata-replace-metadata-syntax

Constructors

ReplaceMetadataV2
Fields _rmv2AllowInconsistentMetadata :: AllowInconsistentMetadata _rmv2Metadata :: ReplaceMetadataV1

Instances

Instances details

Eq ReplaceMetadataV2 Source #
Instance details Defined in Hasura.RQL.DDL.Metadata.Types Methods (==) :: ReplaceMetadataV2 -> ReplaceMetadataV2 -> Bool # (/=) :: ReplaceMetadataV2 -> ReplaceMetadataV2 -> Bool #
FromJSON ReplaceMetadataV2 Source #
Instance details Defined in Hasura.RQL.DDL.Metadata.Types Methods parseJSON :: Value -> Parser ReplaceMetadataV2 parseJSONList :: Value -> Parser [ReplaceMetadataV2]
ToJSON ReplaceMetadataV2 Source #
Instance details Defined in Hasura.RQL.DDL.Metadata.Types Methods toJSON :: ReplaceMetadataV2 -> Value toEncoding :: ReplaceMetadataV2 -> Encoding toJSONList :: [ReplaceMetadataV2] -> Value toEncodingList :: [ReplaceMetadataV2] -> Encoding

data ReplaceMetadata Source #

ReplaceMetadata is used to replace/import metadata into Hasura. Existing metadata will be replaced with the new one.

https://hasura.io/docs/latest/api-reference/metadata-api/manage-metadata/#metadata-replace-metadata TODO: If additional API versions are supported in future it would be ideal to include a version field Rather than differentiating on the "metadata" field.

Constructors

RMReplaceMetadataV1 ReplaceMetadataV1
RMReplaceMetadataV2 ReplaceMetadataV2

Instances

Instances details

Eq ReplaceMetadata Source #
Instance details Defined in Hasura.RQL.DDL.Metadata.Types Methods (==) :: ReplaceMetadata -> ReplaceMetadata -> Bool # (/=) :: ReplaceMetadata -> ReplaceMetadata -> Bool #
FromJSON ReplaceMetadata Source #
Instance details Defined in Hasura.RQL.DDL.Metadata.Types Methods parseJSON :: Value -> Parser ReplaceMetadata parseJSONList :: Value -> Parser [ReplaceMetadata]
ToJSON ReplaceMetadata Source #
Instance details Defined in Hasura.RQL.DDL.Metadata.Types Methods toJSON :: ReplaceMetadata -> Value toEncoding :: ReplaceMetadata -> Encoding toJSONList :: [ReplaceMetadata] -> Value toEncodingList :: [ReplaceMetadata] -> Encoding

data WebHookUrl Source #

Constructors

EnvVar String
URL Text

Instances

Instances details

Eq WebHookUrl Source #
Instance details Defined in Hasura.RQL.DDL.Metadata.Types Methods (==) :: WebHookUrl -> WebHookUrl -> Bool # (/=) :: WebHookUrl -> WebHookUrl -> Bool #
FromJSON WebHookUrl Source #
Instance details Defined in Hasura.RQL.DDL.Metadata.Types Methods parseJSON :: Value -> Parser WebHookUrl parseJSONList :: Value -> Parser [WebHookUrl]
ToJSON WebHookUrl Source #
Instance details Defined in Hasura.RQL.DDL.Metadata.Types Methods toJSON :: WebHookUrl -> Value toEncoding :: WebHookUrl -> Encoding toJSONList :: [WebHookUrl] -> Value toEncodingList :: [WebHookUrl] -> Encoding

data TestWebhookTransform Source #

TestWebhookTransform can be used to test out request transformations using mock data.

https://hasura.io/docs/latest/api-reference/metadata-api/manage-metadata/#test-webhook-transform

Constructors

TestWebhookTransform
Fields _twtEnv :: Environment _twtHeaders :: [Header] _twtWebhookUrl :: WebHookUrl _twtPayload :: Value _twtTransformer :: RequestTransform _twtResponseTransformer :: Maybe MetadataResponseTransform _twtSessionVariables :: Maybe SessionVariables

Instances

Instances details

Eq TestWebhookTransform Source #
Instance details Defined in Hasura.RQL.DDL.Metadata.Types Methods (==) :: TestWebhookTransform -> TestWebhookTransform -> Bool # (/=) :: TestWebhookTransform -> TestWebhookTransform -> Bool #
FromJSON TestWebhookTransform Source #
Instance details Defined in Hasura.RQL.DDL.Metadata.Types Methods parseJSON :: Value -> Parser TestWebhookTransform parseJSONList :: Value -> Parser [TestWebhookTransform]
ToJSON TestWebhookTransform Source #
Instance details Defined in Hasura.RQL.DDL.Metadata.Types Methods toJSON :: TestWebhookTransform -> Value toEncoding :: TestWebhookTransform -> Encoding toJSONList :: [TestWebhookTransform] -> Value toEncodingList :: [TestWebhookTransform] -> Encoding

twtTransformer :: Lens' TestWebhookTransform RequestTransform Source #