Safe Haskell	None
Language	Haskell2010

Hasura.Server.API.Metadata

Description

The RQL metadata query ('v1metadata')

Synopsis

data RQLMetadataV1
parseQueryType :: MonadFail m => Text -> m (AnyBackend BackendSourceKind, Text)
data RQLMetadataV2
- = RMV2ReplaceMetadata !ReplaceMetadataV2
- | RMV2ExportMetadata !ExportMetadata
data RQLMetadataRequest
- = RMV1 !RQLMetadataV1
- | RMV2 !RQLMetadataV2
data RQLMetadata = RQLMetadata {
- _rqlMetadataResourceVersion :: !(Maybe MetadataResourceVersion)
- _rqlMetadata :: !RQLMetadataRequest
}
runMetadataQuery :: (MonadIO m, MonadBaseControl IO m, MonadTrace m, MonadMetadataStorage m, MonadResolveSource m) => Environment -> Logger Hasura -> InstanceId -> UserInfo -> Manager -> ServerConfigCtx -> RebuildableSchemaCache -> RQLMetadata -> m (EncJSON, RebuildableSchemaCache)
queryModifiesMetadata :: RQLMetadataRequest -> Bool
runMetadataQueryM :: (MonadIO m, MonadBaseControl IO m, CacheRWM m, MonadTrace m, UserInfoM m, HasHttpManagerM m, MetadataM m, MonadMetadataStorageQueryAPI m, HasServerConfigCtx m, MonadReader r m, Has (Logger Hasura) r) => Environment -> MetadataResourceVersion -> RQLMetadataRequest -> m EncJSON
runMetadataQueryV1M :: forall m r. (MonadIO m, MonadBaseControl IO m, CacheRWM m, MonadTrace m, UserInfoM m, HasHttpManagerM m, MetadataM m, MonadMetadataStorageQueryAPI m, HasServerConfigCtx m, MonadReader r m, Has (Logger Hasura) r) => Environment -> MetadataResourceVersion -> RQLMetadataV1 -> m EncJSON
runMetadataQueryV2M :: (MonadIO m, CacheRWM m, MetadataM m, MonadMetadataStorageQueryAPI m, MonadReader r m, Has (Logger Hasura) r) => MetadataResourceVersion -> RQLMetadataV2 -> m EncJSON

Documentation

data RQLMetadataV1 Source #

Constructors

RMAddSource !(AnyBackend AddSource)
RMDropSource DropSource
RMRenameSource !RenameSource
RMUpdateSource !(AnyBackend UpdateSource)
RMTrackTable !(AnyBackend TrackTableV2)
RMUntrackTable !(AnyBackend UntrackTable)
RMSetTableCustomization !(AnyBackend SetTableCustomization)
RMSetApolloFederationConfig (AnyBackend SetApolloFederationConfig)
RMPgSetTableIsEnum !SetTableIsEnum
RMCreateInsertPermission !(AnyBackend (CreatePerm InsPerm))
RMCreateSelectPermission !(AnyBackend (CreatePerm SelPerm))
RMCreateUpdatePermission !(AnyBackend (CreatePerm UpdPerm))
RMCreateDeletePermission !(AnyBackend (CreatePerm DelPerm))
RMDropInsertPermission !(AnyBackend DropPerm)
RMDropSelectPermission !(AnyBackend DropPerm)
RMDropUpdatePermission !(AnyBackend DropPerm)
RMDropDeletePermission !(AnyBackend DropPerm)
RMSetPermissionComment !(AnyBackend SetPermComment)
RMCreateObjectRelationship !(AnyBackend CreateObjRel)
RMCreateArrayRelationship !(AnyBackend CreateArrRel)
RMDropRelationship !(AnyBackend DropRel)
RMSetRelationshipComment !(AnyBackend SetRelComment)
RMRenameRelationship !(AnyBackend RenameRel)
RMCreateRemoteRelationship !(AnyBackend CreateFromSourceRelationship)
RMUpdateRemoteRelationship !(AnyBackend CreateFromSourceRelationship)
RMDeleteRemoteRelationship !(AnyBackend DeleteFromSourceRelationship)
RMTrackFunction !(AnyBackend TrackFunctionV2)
RMUntrackFunction !(AnyBackend UnTrackFunction)
RMSetFunctionCustomization (AnyBackend SetFunctionCustomization)
RMCreateFunctionPermission !(AnyBackend FunctionPermissionArgument)
RMDropFunctionPermission !(AnyBackend FunctionPermissionArgument)
RMAddComputedField !(AnyBackend AddComputedField)
RMDropComputedField !(AnyBackend DropComputedField)
RMCreateEventTrigger !(AnyBackend (Unvalidated1 CreateEventTriggerQuery))
RMDeleteEventTrigger !(AnyBackend DeleteEventTriggerQuery)
RMRedeliverEvent !(AnyBackend RedeliverEventQuery)
RMInvokeEventTrigger !(AnyBackend InvokeEventTriggerQuery)
RMAddRemoteSchema !AddRemoteSchemaQuery
RMUpdateRemoteSchema !AddRemoteSchemaQuery
RMRemoveRemoteSchema !RemoteSchemaNameQuery
RMReloadRemoteSchema !RemoteSchemaNameQuery
RMIntrospectRemoteSchema !RemoteSchemaNameQuery
RMAddRemoteSchemaPermissions !AddRemoteSchemaPermission
RMDropRemoteSchemaPermissions !DropRemoteSchemaPermissions
RMCreateRemoteSchemaRemoteRelationship CreateRemoteSchemaRemoteRelationship
RMUpdateRemoteSchemaRemoteRelationship CreateRemoteSchemaRemoteRelationship
RMDeleteRemoteSchemaRemoteRelationship DeleteRemoteSchemaRemoteRelationship
RMCreateCronTrigger !(Unvalidated CreateCronTrigger)
RMDeleteCronTrigger !ScheduledTriggerName
RMCreateScheduledEvent !CreateScheduledEvent
RMDeleteScheduledEvent !DeleteScheduledEvent
RMGetScheduledEvents !GetScheduledEvents
RMGetEventInvocations !GetEventInvocations
RMGetCronTriggers
RMCreateAction !(Unvalidated CreateAction)
RMDropAction !DropAction
RMUpdateAction !(Unvalidated UpdateAction)
RMCreateActionPermission !CreateActionPermission
RMDropActionPermission !DropActionPermission
RMCreateQueryCollection !CreateCollection
RMRenameQueryCollection !RenameCollection
RMDropQueryCollection !DropCollection
RMAddQueryToCollection !AddQueryToCollection
RMDropQueryFromCollection !DropQueryFromCollection
RMAddCollectionToAllowlist !AllowlistEntry
RMDropCollectionFromAllowlist !DropCollectionFromAllowlist
RMUpdateScopeOfCollectionInAllowlist !UpdateScopeOfCollectionInAllowlist
RMCreateRestEndpoint !CreateEndpoint
RMDropRestEndpoint !DropEndpoint
RMDCAddAgent !DCAddAgent
RMDCDeleteAgent !DCDeleteAgent
RMListSourceKinds !ListSourceKinds
RMSetCustomTypes !CustomTypes
RMSetApiLimits !ApiLimit
RMRemoveApiLimits
RMSetMetricsConfig !MetricsConfig
RMRemoveMetricsConfig
RMAddInheritedRole !InheritedRole
RMDropInheritedRole !DropInheritedRole
RMReplaceMetadata !ReplaceMetadata
RMExportMetadata !ExportMetadata
RMClearMetadata !ClearMetadata
RMReloadMetadata !ReloadMetadata
RMGetInconsistentMetadata !GetInconsistentMetadata
RMDropInconsistentMetadata !DropInconsistentMetadata
RMSetGraphqlSchemaIntrospectionOptions !SetGraphqlIntrospectionOptions
RMAddHostToTLSAllowlist !AddHostToTLSAllowlist
RMDropHostFromTLSAllowlist !DropHostFromTLSAllowlist
RMSetQueryTagsConfig !SetQueryTagsConfig
RMDumpInternalState !DumpInternalState
RMGetCatalogState !GetCatalogState
RMSetCatalogState !SetCatalogState
RMTestWebhookTransform !(Unvalidated TestWebhookTransform)
RMBulk [RQLMetadataRequest]

Instances

Instances details

Generic RQLMetadataV1 Source #
Instance details Defined in Hasura.Server.API.Metadata Associated Types type Rep RQLMetadataV1 :: Type -> Type # Methods from :: RQLMetadataV1 -> Rep RQLMetadataV1 x # to :: Rep RQLMetadataV1 x -> RQLMetadataV1 #
FromJSON RQLMetadataV1 Source #
Instance details Defined in Hasura.Server.API.Metadata Methods parseJSON :: Value -> Parser RQLMetadataV1 parseJSONList :: Value -> Parser [RQLMetadataV1]
type Rep RQLMetadataV1 Source #
Instance details Defined in Hasura.Server.API.Metadata type Rep RQLMetadataV1

parseQueryType :: MonadFail m => Text -> m (AnyBackend BackendSourceKind, Text) Source #

Parse the Metadata API action type returning a tuple of the BackendSourceKind and the action suffix.

For example: "pg_add_source" parses as (PostgresVanillaValue, "add_source")

data RQLMetadataV2 Source #

Constructors

RMV2ReplaceMetadata !ReplaceMetadataV2
RMV2ExportMetadata !ExportMetadata

data RQLMetadataRequest Source #

Constructors

RMV1 !RQLMetadataV1
RMV2 !RQLMetadataV2

data RQLMetadata Source #

The payload for the v1metadata endpoint. See:

https://hasura.io/docs/latest/graphql/core/api-reference/metadata-api/index/

Constructors

RQLMetadata
Fields _rqlMetadataResourceVersion :: !(Maybe MetadataResourceVersion) _rqlMetadata :: !RQLMetadataRequest

Instances

Instances details

FromJSON RQLMetadata Source #
Instance details Defined in Hasura.Server.API.Metadata Methods parseJSON :: Value -> Parser RQLMetadata parseJSONList :: Value -> Parser [RQLMetadata]

runMetadataQuery :: (MonadIO m, MonadBaseControl IO m, MonadTrace m, MonadMetadataStorage m, MonadResolveSource m) => Environment -> Logger Hasura -> InstanceId -> UserInfo -> Manager -> ServerConfigCtx -> RebuildableSchemaCache -> RQLMetadata -> m (EncJSON, RebuildableSchemaCache) Source #

queryModifiesMetadata :: RQLMetadataRequest -> Bool Source #

runMetadataQueryM :: (MonadIO m, MonadBaseControl IO m, CacheRWM m, MonadTrace m, UserInfoM m, HasHttpManagerM m, MetadataM m, MonadMetadataStorageQueryAPI m, HasServerConfigCtx m, MonadReader r m, Has (Logger Hasura) r) => Environment -> MetadataResourceVersion -> RQLMetadataRequest -> m EncJSON Source #

runMetadataQueryV1M :: forall m r. (MonadIO m, MonadBaseControl IO m, CacheRWM m, MonadTrace m, UserInfoM m, HasHttpManagerM m, MetadataM m, MonadMetadataStorageQueryAPI m, HasServerConfigCtx m, MonadReader r m, Has (Logger Hasura) r) => Environment -> MetadataResourceVersion -> RQLMetadataV1 -> m EncJSON Source #

runMetadataQueryV2M :: (MonadIO m, CacheRWM m, MetadataM m, MonadMetadataStorageQueryAPI m, MonadReader r m, Has (Logger Hasura) r) => MetadataResourceVersion -> RQLMetadataV2 -> m EncJSON Source #