Safe Haskell	Safe-Inferred
Language	Haskell2010

Hasura.Function.API

Description

Synopsis

newtype TrackFunction b = TrackFunction {
- tfName :: FunctionName b
}
trackFunctionP1 :: forall b m. (CacheRM m, QErrM m, Backend b) => SourceName -> FunctionName b -> m ()
trackFunctionP2 :: forall b m. (MonadError QErr m, CacheRWM m, MetadataM m, BackendMetadata b) => SourceName -> FunctionName b -> FunctionConfig b -> Maybe Text -> m EncJSON
getSingleUniqueFunctionOverload :: forall b m. (QErrM m, Backend b) => FunctionName b -> FunctionOverloads b -> m (RawFunctionInfo b)
runTrackFunc :: forall b m. (MonadError QErr m, CacheRWM m, MetadataM m, BackendMetadata b) => TrackFunction b -> m EncJSON
data TrackFunctionV2 (b :: BackendType) = TrackFunctionV2 {
- _tfv2Source :: SourceName
- _tfv2Function :: FunctionName b
- _tfv2Configuration :: FunctionConfig b
- _tfv2Comment :: Maybe Text
}
runTrackFunctionV2 :: forall b m. (BackendMetadata b, QErrM m, CacheRWM m, MetadataM m) => TrackFunctionV2 b -> m EncJSON
data UnTrackFunction b = UnTrackFunction {
- _utfFunction :: FunctionName b
- _utfSource :: SourceName
}
runUntrackFunc :: forall b m. (CacheRWM m, MonadError QErr m, MetadataM m, BackendMetadata b) => UnTrackFunction b -> m EncJSON
data FunctionPermissionArgument b = FunctionPermissionArgument {
- _afpFunction :: FunctionName b
- _afpSource :: SourceName
- _afpRole :: RoleName
}
runCreateFunctionPermission :: forall b m. (CacheRWM m, MonadError QErr m, MetadataM m, BackendMetadata b) => FunctionPermissionArgument b -> m EncJSON
dropFunctionPermissionInMetadata :: forall b. BackendMetadata b => SourceName -> FunctionName b -> RoleName -> MetadataModifier
doesFunctionPermissionExist :: forall b. BackendMetadata b => Metadata -> SourceName -> FunctionName b -> RoleName -> Bool
runDropFunctionPermission :: forall m b. (CacheRWM m, MonadError QErr m, MetadataM m, BackendMetadata b) => FunctionPermissionArgument b -> m EncJSON
data SetFunctionCustomization b = SetFunctionCustomization {
- _sfcSource :: SourceName
- _sfcFunction :: FunctionName b
- _sfcConfiguration :: FunctionConfig b
}
runSetFunctionCustomization :: forall b m. (QErrM m, CacheRWM m, MetadataM m, Backend b) => SetFunctionCustomization b -> m EncJSON

Documentation

newtype TrackFunction b Source #

Constructors

TrackFunction
Fields tfName :: FunctionName b

Instances

Instances details

Backend b => FromJSON (TrackFunction b) Source #
Instance details Defined in Hasura.Function.API Methods parseJSON :: Value -> Parser (TrackFunction b) Source # parseJSONList :: Value -> Parser [TrackFunction b] Source #
Backend b => ToJSON (TrackFunction b) Source #
Instance details Defined in Hasura.Function.API Methods toJSON :: TrackFunction b -> Value Source # toEncoding :: TrackFunction b -> Encoding Source # toJSONList :: [TrackFunction b] -> Value Source # toEncodingList :: [TrackFunction b] -> Encoding Source #

trackFunctionP1 :: forall b m. (CacheRM m, QErrM m, Backend b) => SourceName -> FunctionName b -> m () Source #

Track function, Phase 1: Validate function tracking operation. Fails if function is already being tracked, or if a table with the same name is being tracked.

trackFunctionP2 :: forall b m. (MonadError QErr m, CacheRWM m, MetadataM m, BackendMetadata b) => SourceName -> FunctionName b -> FunctionConfig b -> Maybe Text -> m EncJSON Source #

getSingleUniqueFunctionOverload :: forall b m. (QErrM m, Backend b) => FunctionName b -> FunctionOverloads b -> m (RawFunctionInfo b) Source #

runTrackFunc :: forall b m. (MonadError QErr m, CacheRWM m, MetadataM m, BackendMetadata b) => TrackFunction b -> m EncJSON Source #

data TrackFunctionV2 (b :: BackendType) Source #

JSON API payload for v2 of track_function:

https://hasura.io/docs/latest/graphql/core/api-reference/schema-metadata-api/custom-functions.html#track-function-v2

Constructors

TrackFunctionV2
Fields _tfv2Source :: SourceName _tfv2Function :: FunctionName b _tfv2Configuration :: FunctionConfig b _tfv2Comment :: Maybe Text

Instances

Instances details

Backend b => FromJSON (TrackFunctionV2 b) Source #
Instance details Defined in Hasura.Function.API Methods parseJSON :: Value -> Parser (TrackFunctionV2 b) Source # parseJSONList :: Value -> Parser [TrackFunctionV2 b] Source #

runTrackFunctionV2 :: forall b m. (BackendMetadata b, QErrM m, CacheRWM m, MetadataM m) => TrackFunctionV2 b -> m EncJSON Source #

data UnTrackFunction b Source #

JSON API payload for untrack_function:

https://hasura.io/docs/latest/graphql/core/api-reference/schema-metadata-api/custom-functions.html#untrack-function

Constructors

UnTrackFunction
Fields _utfFunction :: FunctionName b _utfSource :: SourceName

Instances

Instances details

Backend b => FromJSON (UnTrackFunction b) Source #
Instance details Defined in Hasura.Function.API Methods parseJSON :: Value -> Parser (UnTrackFunction b) Source # parseJSONList :: Value -> Parser [UnTrackFunction b] Source #

runUntrackFunc :: forall b m. (CacheRWM m, MonadError QErr m, MetadataM m, BackendMetadata b) => UnTrackFunction b -> m EncJSON Source #

data FunctionPermissionArgument b Source #

Constructors

FunctionPermissionArgument
Fields _afpFunction :: FunctionName b _afpSource :: SourceName _afpRole :: RoleName

Instances

Instances details

Backend b => FromJSON (FunctionPermissionArgument b) Source #
Instance details Defined in Hasura.Function.API Methods parseJSON :: Value -> Parser (FunctionPermissionArgument b) Source # parseJSONList :: Value -> Parser [FunctionPermissionArgument b] Source #

runCreateFunctionPermission :: forall b m. (CacheRWM m, MonadError QErr m, MetadataM m, BackendMetadata b) => FunctionPermissionArgument b -> m EncJSON Source #

dropFunctionPermissionInMetadata :: forall b. BackendMetadata b => SourceName -> FunctionName b -> RoleName -> MetadataModifier Source #

doesFunctionPermissionExist :: forall b. BackendMetadata b => Metadata -> SourceName -> FunctionName b -> RoleName -> Bool Source #

runDropFunctionPermission :: forall m b. (CacheRWM m, MonadError QErr m, MetadataM m, BackendMetadata b) => FunctionPermissionArgument b -> m EncJSON Source #

data SetFunctionCustomization b Source #

Represents the payload of the API command pg_set_function_customization.

See the Hasura API reference for a detailed description.

Constructors

SetFunctionCustomization
Fields _sfcSource :: SourceName _sfcFunction :: FunctionName b _sfcConfiguration :: FunctionConfig b

Instances

Instances details

Backend b => FromJSON (SetFunctionCustomization b) Source #
Instance details Defined in Hasura.Function.API Methods parseJSON :: Value -> Parser (SetFunctionCustomization b) Source # parseJSONList :: Value -> Parser [SetFunctionCustomization b] Source #
Backend b => Show (SetFunctionCustomization b) Source #
Instance details Defined in Hasura.Function.API Methods showsPrec :: Int -> SetFunctionCustomization b -> ShowS # show :: SetFunctionCustomization b -> String # showList :: [SetFunctionCustomization b] -> ShowS #
Backend b => Eq (SetFunctionCustomization b) Source #
Instance details Defined in Hasura.Function.API Methods (==) :: SetFunctionCustomization b -> SetFunctionCustomization b -> Bool # (/=) :: SetFunctionCustomization b -> SetFunctionCustomization b -> Bool #

runSetFunctionCustomization :: forall b m. (QErrM m, CacheRWM m, MetadataM m, Backend b) => SetFunctionCustomization b -> m EncJSON Source #

Changes the custom names of a function. Used in the API command pg_set_function_customization.