Safe Haskell	Safe-Inferred
Language	Haskell2010

Hasura.StoredProcedure.API

Description

Define and handle v1/metadata API operations to track, untrack, and get stored procedures.

Synopsis

data TrackStoredProcedure (b :: BackendType) = TrackStoredProcedure {
- tspSource :: SourceName
- tspStoredProcedure :: FunctionName b
- tspConfig :: StoredProcedureConfig
- tspArguments :: HashMap ArgumentName (NullableScalarType b)
- tspDescription :: Maybe Text
- tspReturns :: LogicalModelName
}
data GetStoredProcedure (b :: BackendType) = GetStoredProcedure {
- gspSource :: SourceName
}
runGetStoredProcedure :: forall b m. (BackendMetadata b, MetadataM m) => GetStoredProcedure b -> m EncJSON
runTrackStoredProcedure :: forall b m. (BackendMetadata b, MonadError QErr m, CacheRWM m, MetadataM m) => TrackStoredProcedure b -> m EncJSON
data UntrackStoredProcedure (b :: BackendType) = UntrackStoredProcedure {
- utspSource :: SourceName
- utspStoredProcedure :: FunctionName b
}
runUntrackStoredProcedure :: forall b m. (BackendMetadata b, MonadError QErr m, CacheRWM m, MetadataM m) => UntrackStoredProcedure b -> m EncJSON
dropStoredProcedureInMetadata :: forall b. BackendMetadata b => SourceName -> FunctionName b -> MetadataModifier

Documentation

data TrackStoredProcedure (b :: BackendType) Source #

Default implementation of the track_stored_procedure_query request payload.

Constructors

TrackStoredProcedure
Fields tspSource :: SourceName tspStoredProcedure :: FunctionName b tspConfig :: StoredProcedureConfig tspArguments :: HashMap ArgumentName (NullableScalarType b) tspDescription :: Maybe Text tspReturns :: LogicalModelName

Instances

Instances details

Backend b => FromJSON (TrackStoredProcedure b) Source #
Instance details Defined in Hasura.StoredProcedure.API Methods parseJSON :: Value -> Parser (TrackStoredProcedure b) Source # parseJSONList :: Value -> Parser [TrackStoredProcedure b] Source #
Backend b => ToJSON (TrackStoredProcedure b) Source #
Instance details Defined in Hasura.StoredProcedure.API Methods toJSON :: TrackStoredProcedure b -> Value Source # toEncoding :: TrackStoredProcedure b -> Encoding Source # toJSONList :: [TrackStoredProcedure b] -> Value Source # toEncodingList :: [TrackStoredProcedure b] -> Encoding Source #
Backend b => HasCodec (TrackStoredProcedure b) Source #
Instance details Defined in Hasura.StoredProcedure.API Methods codec :: JSONCodec (TrackStoredProcedure b) Source # listCodecForStringCompatibility :: JSONCodec [TrackStoredProcedure b] Source #

data GetStoredProcedure (b :: BackendType) Source #

API payload for the get_stored_procedure endpoint.

Constructors

GetStoredProcedure
Fields gspSource :: SourceName

Instances

Instances details

Backend b => FromJSON (GetStoredProcedure b) Source #
Instance details Defined in Hasura.StoredProcedure.API Methods parseJSON :: Value -> Parser (GetStoredProcedure b) Source # parseJSONList :: Value -> Parser [GetStoredProcedure b] Source #
Backend b => ToJSON (GetStoredProcedure b) Source #
Instance details Defined in Hasura.StoredProcedure.API Methods toJSON :: GetStoredProcedure b -> Value Source # toEncoding :: GetStoredProcedure b -> Encoding Source # toJSONList :: [GetStoredProcedure b] -> Value Source # toEncodingList :: [GetStoredProcedure b] -> Encoding Source #
Backend b => Show (GetStoredProcedure b) Source #
Instance details Defined in Hasura.StoredProcedure.API Methods showsPrec :: Int -> GetStoredProcedure b -> ShowS # show :: GetStoredProcedure b -> String # showList :: [GetStoredProcedure b] -> ShowS #
Backend b => Eq (GetStoredProcedure b) Source #
Instance details Defined in Hasura.StoredProcedure.API Methods (==) :: GetStoredProcedure b -> GetStoredProcedure b -> Bool # (/=) :: GetStoredProcedure b -> GetStoredProcedure b -> Bool #

runGetStoredProcedure :: forall b m. (BackendMetadata b, MetadataM m) => GetStoredProcedure b -> m EncJSON Source #

Handler for the get_stored_procedure endpoint.

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

Handler for the track_stored_procedure endpoint. The type 'TrackStoredProcedure b' (appearing here in wrapped as 'BackendTrackStoredProcedure b' for AnyBackend compatibility) is defined in 'class StoredProcedureMetadata'.

data UntrackStoredProcedure (b :: BackendType) Source #

API payload for the untrack_stored_procedure endpoint.

Constructors

UntrackStoredProcedure
Fields utspSource :: SourceName utspStoredProcedure :: FunctionName b

Instances

Instances details

Backend b => FromJSON (UntrackStoredProcedure b) Source #
Instance details Defined in Hasura.StoredProcedure.API Methods parseJSON :: Value -> Parser (UntrackStoredProcedure b) Source # parseJSONList :: Value -> Parser [UntrackStoredProcedure b] Source #
Backend b => ToJSON (UntrackStoredProcedure b) Source #
Instance details Defined in Hasura.StoredProcedure.API Methods toJSON :: UntrackStoredProcedure b -> Value Source # toEncoding :: UntrackStoredProcedure b -> Encoding Source # toJSONList :: [UntrackStoredProcedure b] -> Value Source # toEncodingList :: [UntrackStoredProcedure b] -> Encoding Source #
Backend b => Show (UntrackStoredProcedure b) Source #
Instance details Defined in Hasura.StoredProcedure.API Methods showsPrec :: Int -> UntrackStoredProcedure b -> ShowS # show :: UntrackStoredProcedure b -> String # showList :: [UntrackStoredProcedure b] -> ShowS #
Backend b => Eq (UntrackStoredProcedure b) Source #
Instance details Defined in Hasura.StoredProcedure.API Methods (==) :: UntrackStoredProcedure b -> UntrackStoredProcedure b -> Bool # (/=) :: UntrackStoredProcedure b -> UntrackStoredProcedure b -> Bool #

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

Handler for the untrack_stored_procedure endpoint.

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