Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Hasura.Server.Types
Synopsis
- newtype RequestId = RequestId {
- unRequestId :: Text
- getRequestId :: MonadIO m => [Header] -> m (RequestId, [Header])
- newtype DbUid = DbUid {}
- newtype DbVersion = DbVersion Text
- newtype PGVersion = PGVersion Int
- pgToDbVersion :: PGVersion -> DbVersion
- newtype MetadataDbId = MetadataDbId {}
- mdDbIdToDbUid :: MetadataDbId -> DbUid
- newtype InstanceId = InstanceId {}
- generateInstanceId :: IO InstanceId
- data ExperimentalFeature
- experimentalFeatureKey :: ExperimentalFeature -> Text
- data MaintenanceMode a
- data ReadOnlyMode
- data EventingMode
- data ApolloFederationStatus
- isApolloFederationEnabled :: ApolloFederationStatus -> Bool
- data GranularPrometheusMetricsState
- data CloseWebsocketsOnMetadataChangeStatus
- isCloseWebsocketsOnMetadataChangeStatusEnabled :: CloseWebsocketsOnMetadataChangeStatus -> Bool
- class Monad m => MonadGetPolicies m where
Documentation
Constructors
RequestId | |
Fields
|
A uuid of a source database.
pgToDbVersion :: PGVersion -> DbVersion Source #
newtype MetadataDbId Source #
A uuid of the postgres metadata db.
Constructors
MetadataDbId | |
Fields |
Instances
FromJSON MetadataDbId Source # | |
Defined in Hasura.Server.Types Methods parseJSON :: Value -> Parser MetadataDbId Source # parseJSONList :: Value -> Parser [MetadataDbId] Source # | |
ToJSON MetadataDbId Source # | |
Defined in Hasura.Server.Types Methods toJSON :: MetadataDbId -> Value Source # toEncoding :: MetadataDbId -> Encoding Source # toJSONList :: [MetadataDbId] -> Value Source # toEncodingList :: [MetadataDbId] -> Encoding Source # | |
Show MetadataDbId Source # | |
Defined in Hasura.Server.Types Methods showsPrec :: Int -> MetadataDbId -> ShowS # show :: MetadataDbId -> String # showList :: [MetadataDbId] -> ShowS # | |
Eq MetadataDbId Source # | |
Defined in Hasura.Server.Types | |
FromCol MetadataDbId Source # | |
Defined in Hasura.Server.Types Methods fromCol :: Maybe ByteString -> Either Text MetadataDbId Source # | |
ToPrepArg MetadataDbId Source # | |
Defined in Hasura.Server.Types Methods toPrepVal :: MetadataDbId -> PrepArg Source # |
mdDbIdToDbUid :: MetadataDbId -> DbUid Source #
newtype InstanceId Source #
A UUID for each running instance of graphql-engine, generated fresh each time graphql-engine starts up
Constructors
InstanceId | |
Fields |
Instances
FromJSON InstanceId Source # | |
Defined in Hasura.Server.Types Methods parseJSON :: Value -> Parser InstanceId Source # parseJSONList :: Value -> Parser [InstanceId] Source # | |
ToJSON InstanceId Source # | |
Defined in Hasura.Server.Types Methods toJSON :: InstanceId -> Value Source # toEncoding :: InstanceId -> Encoding Source # toJSONList :: [InstanceId] -> Value Source # toEncodingList :: [InstanceId] -> Encoding Source # | |
Show InstanceId Source # | |
Defined in Hasura.Server.Types Methods showsPrec :: Int -> InstanceId -> ShowS # show :: InstanceId -> String # showList :: [InstanceId] -> ShowS # | |
Eq InstanceId Source # | |
Defined in Hasura.Server.Types | |
FromCol InstanceId Source # | |
Defined in Hasura.Server.Types Methods fromCol :: Maybe ByteString -> Either Text InstanceId Source # | |
ToPrepArg InstanceId Source # | |
Defined in Hasura.Server.Types Methods toPrepVal :: InstanceId -> PrepArg Source # |
generateInstanceId :: IO InstanceId Source #
Generate an InstanceId
from a UUID
data ExperimentalFeature Source #
Constructors
Instances
data MaintenanceMode a Source #
Constructors
MaintenanceModeEnabled a | |
MaintenanceModeDisabled |
Instances
FromJSON (MaintenanceMode ()) Source # | |
Defined in Hasura.Server.Types Methods parseJSON :: Value -> Parser (MaintenanceMode ()) Source # parseJSONList :: Value -> Parser [MaintenanceMode ()] Source # | |
ToJSON (MaintenanceMode ()) Source # | |
Defined in Hasura.Server.Types Methods toJSON :: MaintenanceMode () -> Value Source # toEncoding :: MaintenanceMode () -> Encoding Source # toJSONList :: [MaintenanceMode ()] -> Value Source # toEncodingList :: [MaintenanceMode ()] -> Encoding Source # | |
Show a => Show (MaintenanceMode a) Source # | |
Defined in Hasura.Server.Types Methods showsPrec :: Int -> MaintenanceMode a -> ShowS # show :: MaintenanceMode a -> String # showList :: [MaintenanceMode a] -> ShowS # | |
Eq a => Eq (MaintenanceMode a) Source # | |
Defined in Hasura.Server.Types Methods (==) :: MaintenanceMode a -> MaintenanceMode a -> Bool # (/=) :: MaintenanceMode a -> MaintenanceMode a -> Bool # | |
FromEnv (MaintenanceMode ()) Source # | |
Defined in Hasura.Server.Init.Env |
data ReadOnlyMode Source #
See Note [ReadOnly Mode]
Constructors
ReadOnlyModeEnabled | |
ReadOnlyModeDisabled |
Instances
Show ReadOnlyMode Source # | |
Defined in Hasura.Server.Types Methods showsPrec :: Int -> ReadOnlyMode -> ShowS # show :: ReadOnlyMode -> String # showList :: [ReadOnlyMode] -> ShowS # | |
Eq ReadOnlyMode Source # | |
Defined in Hasura.Server.Types |
data EventingMode Source #
EventingMode decides whether the eventing subsystem should be enabled or disabled.
EventDisabled
mode disables Event Triggers, Async Actions, Scheduled Events and source catalaog migrations.
This is an internal feature and will not be exposed to users.
Constructors
EventingEnabled | |
EventingDisabled |
Instances
Show EventingMode Source # | |
Defined in Hasura.Server.Types Methods showsPrec :: Int -> EventingMode -> ShowS # show :: EventingMode -> String # showList :: [EventingMode] -> ShowS # | |
Eq EventingMode Source # | |
Defined in Hasura.Server.Types |
data ApolloFederationStatus Source #
Whether or not to enable apollo federation fields.
Constructors
ApolloFederationEnabled | |
ApolloFederationDisabled |
Instances
data GranularPrometheusMetricsState Source #
Whether or not to enable granular metrics for Prometheus.
GranularMetricsOn
will enable the dynamic labels for the metrics.
GranularMetricsOff
will disable the dynamic labels for the metrics.
- *Warning**: Enabling dynamic labels for Prometheus metrics can cause cardinality issues and can cause memory usage to increase.
Constructors
GranularMetricsOff | |
GranularMetricsOn |
Instances
FromJSON GranularPrometheusMetricsState Source # | |
Defined in Hasura.Server.Types Methods parseJSON :: Value -> Parser GranularPrometheusMetricsState Source # parseJSONList :: Value -> Parser [GranularPrometheusMetricsState] Source # | |
ToJSON GranularPrometheusMetricsState Source # | |
Defined in Hasura.Server.Types | |
Show GranularPrometheusMetricsState Source # | |
Defined in Hasura.Server.Types Methods showsPrec :: Int -> GranularPrometheusMetricsState -> ShowS # show :: GranularPrometheusMetricsState -> String # showList :: [GranularPrometheusMetricsState] -> ShowS # | |
Eq GranularPrometheusMetricsState Source # | |
Defined in Hasura.Server.Types | |
FromEnv GranularPrometheusMetricsState Source # | |
Defined in Hasura.Server.Init.Env |
data CloseWebsocketsOnMetadataChangeStatus Source #
Whether or not to close websocket connections on metadata change.
Constructors
CWMCEnabled | |
CWMCDisabled |
Instances
isCloseWebsocketsOnMetadataChangeStatusEnabled :: CloseWebsocketsOnMetadataChangeStatus -> Bool Source #
class Monad m => MonadGetPolicies m where Source #
Methods
runGetApiTimeLimit :: m (Maybe MaxTime) Source #
runGetPrometheusMetricsGranularity :: m (IO GranularPrometheusMetricsState) Source #