Safe Haskell	Safe-Inferred
Language	Haskell2010

Hasura.NativeQuery.API

Description

Define and handle v1/metadata API operations to track, untrack, and get native queries.

Synopsis

data TrackNativeQuery (b :: BackendType) = TrackNativeQuery {
- tnqSource :: SourceName
- tnqRootFieldName :: NativeQueryName
- tnqCode :: Text
- tnqArguments :: HashMap ArgumentName (NullableScalarType b)
- tnqArrayRelationships :: InsOrdHashMap RelName (RelDef (RelManualNativeQueryConfig b))
- tnqObjectRelationships :: InsOrdHashMap RelName (RelDef (RelManualNativeQueryConfig b))
- tnqDescription :: Maybe Text
- tnqReturns :: LogicalModelIdentifier b
}
data GetNativeQuery (b :: BackendType) = GetNativeQuery {
- gnqSource :: SourceName
}
runGetNativeQuery :: forall b m. (BackendMetadata b, MetadataM m, MonadError QErr m) => GetNativeQuery b -> m EncJSON
execTrackNativeQuery :: forall b m. (BackendMetadata b, MonadError QErr m) => TrackNativeQuery b -> Metadata -> m (MetadataObjId, MetadataModifier)
data UntrackNativeQuery (b :: BackendType) = UntrackNativeQuery {
- utnqSource :: SourceName
- utnqRootFieldName :: NativeQueryName
}
execUntrackNativeQuery :: forall b m. (BackendMetadata b, MonadError QErr m) => UntrackNativeQuery b -> Metadata -> m (MetadataObjId, MetadataModifier)
dropNativeQueryInMetadata :: forall b. BackendMetadata b => SourceName -> NativeQueryName -> MetadataModifier

Documentation

data TrackNativeQuery (b :: BackendType) Source #

Default implementation of the track_native_query request payload.

Constructors

TrackNativeQuery
Fields tnqSource :: SourceName tnqRootFieldName :: NativeQueryName tnqCode :: Text tnqArguments :: HashMap ArgumentName (NullableScalarType b) tnqArrayRelationships :: InsOrdHashMap RelName (RelDef (RelManualNativeQueryConfig b)) tnqObjectRelationships :: InsOrdHashMap RelName (RelDef (RelManualNativeQueryConfig b)) tnqDescription :: Maybe Text tnqReturns :: LogicalModelIdentifier b

Instances

Instances details

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

data GetNativeQuery (b :: BackendType) Source #

API payload for the get_native_query endpoint.

Constructors

GetNativeQuery
Fields gnqSource :: SourceName

Instances

Instances details

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

runGetNativeQuery :: forall b m. (BackendMetadata b, MetadataM m, MonadError QErr m) => GetNativeQuery b -> m EncJSON Source #

Handler for the get_native_query endpoint.

execTrackNativeQuery :: forall b m. (BackendMetadata b, MonadError QErr m) => TrackNativeQuery b -> Metadata -> m (MetadataObjId, MetadataModifier) Source #

Handler for the track_native_query endpoint. The type 'TrackNativeQuery b' (appearing here in wrapped as 'BackendTrackNativeQuery b' for AnyBackend compatibility) is defined in 'class NativeQueryMetadata'.

data UntrackNativeQuery (b :: BackendType) Source #

API payload for the untrack_native_query endpoint.

Constructors

UntrackNativeQuery
Fields utnqSource :: SourceName utnqRootFieldName :: NativeQueryName

Instances

Instances details

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

execUntrackNativeQuery :: forall b m. (BackendMetadata b, MonadError QErr m) => UntrackNativeQuery b -> Metadata -> m (MetadataObjId, MetadataModifier) Source #

Handler for the untrack_native_query endpoint.

dropNativeQueryInMetadata :: forall b. BackendMetadata b => SourceName -> NativeQueryName -> MetadataModifier Source #