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

Hasura.RQL.DDL.Metadata.Types

Description

Types related to metadata management API

Synopsis

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
FromJSON ClearMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

parseJSON :: Value -> Parser ClearMetadata Source #

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

ToJSON ClearMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

toJSON :: ClearMetadata -> Value Source #

toEncoding :: ClearMetadata -> Encoding Source #

toJSONList :: [ClearMetadata] -> Value Source #

toEncodingList :: [ClearMetadata] -> Encoding Source #

Generic ClearMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Associated Types

type Rep ClearMetadata :: Type -> Type #

Methods

from :: ClearMetadata -> Rep ClearMetadata x #

to :: Rep ClearMetadata x -> ClearMetadata #

Show ClearMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

showsPrec :: Int -> ClearMetadata -> ShowS #

show :: ClearMetadata -> String #

showList :: [ClearMetadata] -> ShowS #

Eq ClearMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

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

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

type Rep ClearMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

type Rep ClearMetadata = D1 ('MetaData "ClearMetadata" "Hasura.RQL.DDL.Metadata.Types" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "ClearMetadata" 'PrefixI 'False) (U1 :: Type -> Type))

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
FromJSON ExportMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

parseJSON :: Value -> Parser ExportMetadata Source #

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

ToJSON ExportMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

toJSON :: ExportMetadata -> Value Source #

toEncoding :: ExportMetadata -> Encoding Source #

toJSONList :: [ExportMetadata] -> Value Source #

toEncodingList :: [ExportMetadata] -> Encoding Source #

Show ExportMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

showsPrec :: Int -> ExportMetadata -> ShowS #

show :: ExportMetadata -> String #

showList :: [ExportMetadata] -> ShowS #

Eq ExportMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

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

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

data ReloadSpec a Source #

Constructors

RSReloadAll 
RSReloadList (HashSet a) 

Instances

Instances details
(FromJSON a, Hashable a) => FromJSON (ReloadSpec a) Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

parseJSON :: Value -> Parser (ReloadSpec a) Source #

parseJSONList :: Value -> Parser [ReloadSpec a] Source #

ToJSON a => ToJSON (ReloadSpec a) Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

toJSON :: ReloadSpec a -> Value Source #

toEncoding :: ReloadSpec a -> Encoding Source #

toJSONList :: [ReloadSpec a] -> Value Source #

toEncodingList :: [ReloadSpec a] -> Encoding Source #

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 #

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 #

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.

  • _rmReloadDataConnectors :: ReloadDataConnectors
     

Instances

Instances details
FromJSON ReloadMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

parseJSON :: Value -> Parser ReloadMetadata Source #

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

ToJSON ReloadMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

toJSON :: ReloadMetadata -> Value Source #

toEncoding :: ReloadMetadata -> Encoding Source #

toJSONList :: [ReloadMetadata] -> Value Source #

toEncodingList :: [ReloadMetadata] -> Encoding Source #

Generic ReloadMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Associated Types

type Rep ReloadMetadata :: Type -> Type #

Methods

from :: ReloadMetadata -> Rep ReloadMetadata x #

to :: Rep ReloadMetadata x -> ReloadMetadata #

Show ReloadMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

showsPrec :: Int -> ReloadMetadata -> ShowS #

show :: ReloadMetadata -> String #

showList :: [ReloadMetadata] -> ShowS #

Eq ReloadMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

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

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

type Rep ReloadMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

type Rep ReloadMetadata

data DumpInternalState Source #

Undocumented Metadata API action which serializes the entire SchemaCache.

Constructors

DumpInternalState 

Instances

Instances details
FromJSON DumpInternalState Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

parseJSON :: Value -> Parser DumpInternalState Source #

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

ToJSON DumpInternalState Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

toJSON :: DumpInternalState -> Value Source #

toEncoding :: DumpInternalState -> Encoding Source #

toJSONList :: [DumpInternalState] -> Value Source #

toEncodingList :: [DumpInternalState] -> Encoding Source #

Generic DumpInternalState Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Associated Types

type Rep DumpInternalState :: Type -> Type #

Methods

from :: DumpInternalState -> Rep DumpInternalState x #

to :: Rep DumpInternalState x -> DumpInternalState #

Show DumpInternalState Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

showsPrec :: Int -> DumpInternalState -> ShowS #

show :: DumpInternalState -> String #

showList :: [DumpInternalState] -> ShowS #

Eq DumpInternalState Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

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

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

type Rep DumpInternalState Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

type Rep DumpInternalState = D1 ('MetaData "DumpInternalState" "Hasura.RQL.DDL.Metadata.Types" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "DumpInternalState" 'PrefixI 'False) (U1 :: Type -> Type))

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
FromJSON GetInconsistentMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

parseJSON :: Value -> Parser GetInconsistentMetadata Source #

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

ToJSON GetInconsistentMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

toJSON :: GetInconsistentMetadata -> Value Source #

toEncoding :: GetInconsistentMetadata -> Encoding Source #

toJSONList :: [GetInconsistentMetadata] -> Value Source #

toEncodingList :: [GetInconsistentMetadata] -> Encoding Source #

Generic GetInconsistentMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Associated Types

type Rep GetInconsistentMetadata :: Type -> Type #

Methods

from :: GetInconsistentMetadata -> Rep GetInconsistentMetadata x #

to :: Rep GetInconsistentMetadata x -> GetInconsistentMetadata #

Show GetInconsistentMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

showsPrec :: Int -> GetInconsistentMetadata -> ShowS #

show :: GetInconsistentMetadata -> String #

showList :: [GetInconsistentMetadata] -> ShowS #

Eq GetInconsistentMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

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

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

type Rep GetInconsistentMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

type Rep GetInconsistentMetadata = D1 ('MetaData "GetInconsistentMetadata" "Hasura.RQL.DDL.Metadata.Types" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "GetInconsistentMetadata" 'PrefixI 'False) (U1 :: Type -> Type))

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
FromJSON DropInconsistentMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

parseJSON :: Value -> Parser DropInconsistentMetadata Source #

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

ToJSON DropInconsistentMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

toJSON :: DropInconsistentMetadata -> Value Source #

toEncoding :: DropInconsistentMetadata -> Encoding Source #

toJSONList :: [DropInconsistentMetadata] -> Value Source #

toEncodingList :: [DropInconsistentMetadata] -> Encoding Source #

Generic DropInconsistentMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Associated Types

type Rep DropInconsistentMetadata :: Type -> Type #

Methods

from :: DropInconsistentMetadata -> Rep DropInconsistentMetadata x #

to :: Rep DropInconsistentMetadata x -> DropInconsistentMetadata #

Show DropInconsistentMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

showsPrec :: Int -> DropInconsistentMetadata -> ShowS #

show :: DropInconsistentMetadata -> String #

showList :: [DropInconsistentMetadata] -> ShowS #

Eq DropInconsistentMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

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

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

type Rep DropInconsistentMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

type Rep DropInconsistentMetadata = D1 ('MetaData "DropInconsistentMetadata" "Hasura.RQL.DDL.Metadata.Types" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "DropInconsistentMetadata" 'PrefixI 'False) (U1 :: Type -> Type))

data AllowInconsistentMetadata Source #

Constructors

AllowInconsistentMetadata 
NoAllowInconsistentMetadata 

Instances

Instances details
FromJSON AllowInconsistentMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

parseJSON :: Value -> Parser AllowInconsistentMetadata Source #

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

ToJSON AllowInconsistentMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

toJSON :: AllowInconsistentMetadata -> Value Source #

toEncoding :: AllowInconsistentMetadata -> Encoding Source #

toJSONList :: [AllowInconsistentMetadata] -> Value Source #

toEncodingList :: [AllowInconsistentMetadata] -> Encoding Source #

Show AllowInconsistentMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

showsPrec :: Int -> AllowInconsistentMetadata -> ShowS #

show :: AllowInconsistentMetadata -> String #

showList :: [AllowInconsistentMetadata] -> ShowS #

Eq AllowInconsistentMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

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

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

data ReplaceMetadataV1 Source #

Replace metadata either with or without metadata sources.

Constructors

RMWithSources Metadata 
RMWithoutSources MetadataNoSources 

Instances

Instances details
FromJSON ReplaceMetadataV1 Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

parseJSON :: Value -> Parser ReplaceMetadataV1 Source #

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

ToJSON ReplaceMetadataV1 Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

toJSON :: ReplaceMetadataV1 -> Value Source #

toEncoding :: ReplaceMetadataV1 -> Encoding Source #

toJSONList :: [ReplaceMetadataV1] -> Value Source #

toEncodingList :: [ReplaceMetadataV1] -> Encoding Source #

Eq ReplaceMetadataV1 Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

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

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

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

Instances

Instances details
FromJSON ReplaceMetadataV2 Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

parseJSON :: Value -> Parser ReplaceMetadataV2 Source #

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

ToJSON ReplaceMetadataV2 Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

toJSON :: ReplaceMetadataV2 -> Value Source #

toEncoding :: ReplaceMetadataV2 -> Encoding Source #

toJSONList :: [ReplaceMetadataV2] -> Value Source #

toEncodingList :: [ReplaceMetadataV2] -> Encoding Source #

Eq ReplaceMetadataV2 Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

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

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

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
FromJSON ReplaceMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

parseJSON :: Value -> Parser ReplaceMetadata Source #

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

ToJSON ReplaceMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

toJSON :: ReplaceMetadata -> Value Source #

toEncoding :: ReplaceMetadata -> Encoding Source #

toJSONList :: [ReplaceMetadata] -> Value Source #

toEncodingList :: [ReplaceMetadata] -> Encoding Source #

Eq ReplaceMetadata Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

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

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

data WebHookUrl Source #

Constructors

EnvVar String 
URL Text 

Instances

Instances details
FromJSON WebHookUrl Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

parseJSON :: Value -> Parser WebHookUrl Source #

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

ToJSON WebHookUrl Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

toJSON :: WebHookUrl -> Value Source #

toEncoding :: WebHookUrl -> Encoding Source #

toJSONList :: [WebHookUrl] -> Value Source #

toEncodingList :: [WebHookUrl] -> Encoding Source #

Eq WebHookUrl Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

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

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

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

Instances

Instances details
FromJSON TestWebhookTransform Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

parseJSON :: Value -> Parser TestWebhookTransform Source #

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

ToJSON TestWebhookTransform Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

toJSON :: TestWebhookTransform -> Value Source #

toEncoding :: TestWebhookTransform -> Encoding Source #

toJSONList :: [TestWebhookTransform] -> Value Source #

toEncodingList :: [TestWebhookTransform] -> Encoding Source #

Eq TestWebhookTransform Source # 
Instance details

Defined in Hasura.RQL.DDL.Metadata.Types

Methods

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

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

twtRequestTransformer :: Lens' TestWebhookTransform RequestTransform Source #

twtResponseTransformer :: Lens' TestWebhookTransform (Maybe MetadataResponseTransform) Source #