Safe Haskell	Safe-Inferred
Language	Haskell2010

Hasura.Backends.Postgres.Execute.Types

Description

Postgres Execute Types

Execution context and source configuration for Postgres databases. Provides support for things such as read-only transactions and read replicas.

Synopsis

data PGExecCtx = PGExecCtx {
- _pecRunTx :: PGExecCtxInfo -> RunTx
- _pecDestroyConnections :: IO ()
- _pecResizePools :: ServerReplicas -> IO SourceResizePoolSummary
}
data PGExecCtxInfo = PGExecCtxInfo {
- _peciTxType :: PGExecTxType
- _peciFrom :: PGExecFrom
}
data PGExecTxType
- = NoTxRead
- | Tx TxAccess (Maybe TxIsolation)
data PGExecFrom
- = GraphQLQuery (Maybe PostgresResolvedConnectionTemplate)
- | RunSQLQuery
- | InternalRawQuery
- | LegacyRQLQuery
mkPGExecCtx :: TxIsolation -> PGPool -> ResizePoolStrategy -> PGExecCtx
resizePostgresPool :: PGPool -> Int -> ServerReplicas -> IO ()
defaultTxErrorHandler :: PGTxErr -> QErr
dmlTxErrorHandler :: PGTxErr -> QErr
mkTxErrorHandler :: (PGErrorType -> Bool) -> PGTxErr -> QErr
data ConnectionTemplateConfig
- = ConnTemplate_NotApplicable
- | ConnTemplate_NotConfigured
- | ConnTemplate_Resolver ConnectionTemplateResolver
connectionTemplateConfigResolver :: ConnectionTemplateConfig -> Maybe ConnectionTemplateResolver
newtype ConnectionTemplateResolver = ConnectionTemplateResolver {
- _runResolver :: forall m. MonadError QErr m => SessionVariables -> [Header] -> Maybe QueryContext -> m PostgresResolvedConnectionTemplate
}
data PGSourceConfig = PGSourceConfig {
- _pscExecCtx :: PGExecCtx
- _pscConnInfo :: ConnInfo
- _pscReadReplicaConnInfos :: Maybe (NonEmpty ConnInfo)
- _pscPostDropHook :: IO ()
- _pscExtensionsSchema :: ExtensionsSchema
- _pscConnectionSet :: HashMap PostgresConnectionSetMemberName ConnInfo
- _pscConnectionTemplateConfig :: ConnectionTemplateConfig
}
runPgSourceReadTx :: (MonadIO m, MonadBaseControl IO m) => PGSourceConfig -> TxET QErr m a -> m (Either QErr a)
runPgSourceWriteTx :: (MonadIO m, MonadBaseControl IO m) => PGSourceConfig -> PGExecFrom -> TxET QErr m a -> m (Either QErr a)
applyConnectionTemplateResolverNonAdmin :: MonadError QErr m => Maybe ConnectionTemplateResolver -> UserInfo -> [Header] -> Maybe QueryContext -> m (Maybe PostgresResolvedConnectionTemplate)
pgResolveConnectionTemplate :: MonadError QErr m => PGSourceConfig -> RequestContext -> Maybe ConnectionTemplate -> m EncJSON
resolvePostgresConnectionTemplate :: MonadError QErr m => ConnectionTemplate -> [PostgresConnectionSetMemberName] -> SessionVariables -> [Header] -> Maybe QueryContext -> m PostgresResolvedConnectionTemplate
sourceConfigNumReadReplicas :: PGSourceConfig -> Int
sourceConfigConnectonTemplateEnabled :: PGSourceConfig -> Bool

Documentation

data PGExecCtx Source #

Constructors

PGExecCtx
Fields _pecRunTx :: PGExecCtxInfo -> RunTx Run a PG transaction using the information provided by PGExecCtxInfo _pecDestroyConnections :: IO () Destroy connection pools _pecResizePools :: ServerReplicas -> IO SourceResizePoolSummary Resize pools based on number of server instances and return the summary

data PGExecCtxInfo Source #

Holds the information required to exceute a PG transaction

Constructors

PGExecCtxInfo
Fields _peciTxType :: PGExecTxType The tranasction mode for executing the transaction _peciFrom :: PGExecFrom The level from where the PG transaction is being executed from

data PGExecTxType Source #

The tranasction mode (isolation level, transaction access) for executing the transaction

Constructors

NoTxRead	a transaction without an explicit tranasction block
Tx TxAccess (Maybe TxIsolation)	a transaction block with custom transaction access and isolation level. Choose defaultIsolationLevel defined in `SourceConnConfiguration` if Nothing is provided for isolation level.

data PGExecFrom Source #

The level from where the transaction is being run

Constructors

GraphQLQuery (Maybe PostgresResolvedConnectionTemplate)	transaction initated via a GraphQLRequest
RunSQLQuery	transaction initiated during run_sql
InternalRawQuery	custom transaction Hasura runs on the database. This is usually used in event_trigger and actions
LegacyRQLQuery	transactions initiated via other API's other than `run_sql` in v1query or v2query

mkPGExecCtx :: TxIsolation -> PGPool -> ResizePoolStrategy -> PGExecCtx Source #

Creates a Postgres execution context for a single Postgres master pool

resizePostgresPool :: PGPool -> Int -> ServerReplicas -> IO () Source #

Resize Postgres pool by setting the number of connections equal to allowed maximum connections across all server instances divided by number of instances

defaultTxErrorHandler :: PGTxErr -> QErr Source #

dmlTxErrorHandler :: PGTxErr -> QErr Source #

Constructs a transaction error handler tailored for the needs of RQL's DML.

mkTxErrorHandler :: (PGErrorType -> Bool) -> PGTxErr -> QErr Source #

Constructs a transaction error handler given a predicate that determines which errors are expected and should be reported to the user. All other errors are considered internal errors.

data ConnectionTemplateConfig Source #

Constructors

ConnTemplate_NotApplicable	Connection templates are disabled for Hasura CE
ConnTemplate_NotConfigured
ConnTemplate_Resolver ConnectionTemplateResolver

connectionTemplateConfigResolver :: ConnectionTemplateConfig -> Maybe ConnectionTemplateResolver Source #

newtype ConnectionTemplateResolver Source #

A hook to resolve connection template

Constructors

ConnectionTemplateResolver
Fields _runResolver :: forall m. MonadError QErr m => SessionVariables -> [Header] -> Maybe QueryContext -> m PostgresResolvedConnectionTemplate Runs the connection template resolver.

data PGSourceConfig Source #

Constructors

PGSourceConfig
Fields _pscExecCtx :: PGExecCtx _pscConnInfo :: ConnInfo _pscReadReplicaConnInfos :: Maybe (NonEmpty ConnInfo) _pscPostDropHook :: IO () _pscExtensionsSchema :: ExtensionsSchema _pscConnectionSet :: HashMap PostgresConnectionSetMemberName ConnInfo _pscConnectionTemplateConfig :: ConnectionTemplateConfig

Instances

Instances details

ToJSON PGSourceConfig Source #
Instance details Defined in Hasura.Backends.Postgres.Execute.Types Methods toJSON :: PGSourceConfig -> Value Source # toEncoding :: PGSourceConfig -> Encoding Source # toJSONList :: [PGSourceConfig] -> Value Source # toEncodingList :: [PGSourceConfig] -> Encoding Source #
Generic PGSourceConfig Source #
Instance details Defined in Hasura.Backends.Postgres.Execute.Types Associated Types type Rep PGSourceConfig :: Type -> Type # Methods from :: PGSourceConfig -> Rep PGSourceConfig x # to :: Rep PGSourceConfig x -> PGSourceConfig #
Show PGSourceConfig Source #
Instance details Defined in Hasura.Backends.Postgres.Execute.Types Methods showsPrec :: Int -> PGSourceConfig -> ShowS # show :: PGSourceConfig -> String # showList :: [PGSourceConfig] -> ShowS #
Eq PGSourceConfig Source #
Instance details Defined in Hasura.Backends.Postgres.Execute.Types Methods (==) :: PGSourceConfig -> PGSourceConfig -> Bool # (/=) :: PGSourceConfig -> PGSourceConfig -> Bool #
Has () PGSourceConfig Source #
Instance details Defined in Hasura.Backends.Postgres.Execute.Types Methods getter :: PGSourceConfig -> () Source # modifier :: (() -> ()) -> PGSourceConfig -> PGSourceConfig Source # hasLens :: Lens PGSourceConfig () Source #
type Rep PGSourceConfig Source #
Instance details Defined in Hasura.Backends.Postgres.Execute.Types type Rep PGSourceConfig = D1 ('MetaData "PGSourceConfig" "Hasura.Backends.Postgres.Execute.Types" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "PGSourceConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_pscExecCtx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PGExecCtx) :: (S1 ('MetaSel ('Just "_pscConnInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConnInfo) :: S1 ('MetaSel ('Just "_pscReadReplicaConnInfos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ConnInfo))))) :: ((S1 ('MetaSel ('Just "_pscPostDropHook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (IO ())) :: S1 ('MetaSel ('Just "_pscExtensionsSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExtensionsSchema)) :: (S1 ('MetaSel ('Just "_pscConnectionSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap PostgresConnectionSetMemberName ConnInfo)) :: S1 ('MetaSel ('Just "_pscConnectionTemplateConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConnectionTemplateConfig)))))

runPgSourceReadTx :: (MonadIO m, MonadBaseControl IO m) => PGSourceConfig -> TxET QErr m a -> m (Either QErr a) Source #

runPgSourceWriteTx :: (MonadIO m, MonadBaseControl IO m) => PGSourceConfig -> PGExecFrom -> TxET QErr m a -> m (Either QErr a) Source #

applyConnectionTemplateResolverNonAdmin :: MonadError QErr m => Maybe ConnectionTemplateResolver -> UserInfo -> [Header] -> Maybe QueryContext -> m (Maybe PostgresResolvedConnectionTemplate) Source #

Resolve connection templates only for non-admin roles

pgResolveConnectionTemplate :: MonadError QErr m => PGSourceConfig -> RequestContext -> Maybe ConnectionTemplate -> m EncJSON Source #

resolvePostgresConnectionTemplate :: MonadError QErr m => ConnectionTemplate -> [PostgresConnectionSetMemberName] -> SessionVariables -> [Header] -> Maybe QueryContext -> m PostgresResolvedConnectionTemplate Source #

sourceConfigNumReadReplicas :: PGSourceConfig -> Int Source #

sourceConfigConnectonTemplateEnabled :: PGSourceConfig -> Bool Source #