napkin-0.5.14

Safe Haskell	Safe-Inferred
Language	GHC2021

Napkin.Run.Effects.Types

Synopsis

type SpecProgram' b a = Sem (SpecProgramEffects b) a
type HookProgram' b a = Sem (HookProgramEffects b) a
type HookProgram b = HookProgram' b ()
type GlobalHookProgram' b a = Sem (GlobalHookProgramEffects b) a
type GlobalHookProgram b = GlobalHookProgram' b ()
type SpecProgram b = SpecProgram' b ()
newtype HookProgramWithArgParser b = HookProgramWithArgParser (Object -> Parser (SpecProgramArguments, HookProgram b))
parserlessHook :: HookProgram b -> HookProgramWithArgParser b
newtype SpecProgramWithArgParser b = SpecProgramWithArgParser (Object -> Parser (SpecProgramArguments, SpecProgram b))
parserlessSpec :: SpecProgram b -> SpecProgramWithArgParser b
type SpecProgramEffects b = '[RecreateTable b, Output ExtraDependencies, Reader HiddenDependencies, Reader HiddenArtifacts, Assertion, BackendSpecificEffect b] ++ TableEffects b
type GlobalHookProgramEffects b = '[Assertion, Embed IO, BackendSpecificEffect b] ++ Core b
type HookProgramEffects b = GlobalHookProgramEffects b ++ TableEffects b
type TableEffects b = '[Reader TargetName, Input TemporaryTableName, Reader ConnectionString, External] ++ Core b
type Core b = [FatalError, Input RandomToken, Time, Output LogLine, SqlRender, SqlParse, SqlRead b, SqlWrite b, AnnotateRead b, AnnotateWrite b, LocalFile, Template, LoadQuery, Reader QueryTransformer, Input MetaArguments, Reader SQLDialect, Fail]
class RunBackendEffect b where
- runBackendEffectReal :: (Members (Core b) r, Member (Embed IO) r) => BackendConn b -> Sem (BackendSpecificEffect b : r) a -> Sem r a
- runBackendEffectFake :: (Members (Core b) r, Member (Embed IO) r) => Sem (BackendSpecificEffect b : r) a -> Sem r a
askRefRenamer :: Member (Reader QueryTransformer) r => Sem r (Ref Table -> Ref Table)
askQueryRewriter :: Member (Reader QueryTransformer) r => Sem r (Query -> Query)
askQueryRewriterData :: forall a r. (Data a, Member (Reader QueryTransformer) r) => Sem r (a -> a)

Documentation

type SpecProgram' b a = Sem (SpecProgramEffects b) a #

type HookProgram' b a = Sem (HookProgramEffects b) a #

Programs packaged up for use in Specs. Intended for use in providing introspectable CustomCreate actions in specs.

type HookProgram b = HookProgram' b () #

Hooks have different capabilities than specs

type GlobalHookProgram' b a = Sem (GlobalHookProgramEffects b) a #

type GlobalHookProgram b = GlobalHookProgram' b () #

type SpecProgram b = SpecProgram' b () #

newtype HookProgramWithArgParser b #

Constructors

HookProgramWithArgParser (Object -> Parser (SpecProgramArguments, HookProgram b))

parserlessHook :: HookProgram b -> HookProgramWithArgParser b #

newtype SpecProgramWithArgParser b #

Constructors

SpecProgramWithArgParser (Object -> Parser (SpecProgramArguments, SpecProgram b))

parserlessSpec :: SpecProgram b -> SpecProgramWithArgParser b #

type SpecProgramEffects b = '[RecreateTable b, Output ExtraDependencies, Reader HiddenDependencies, Reader HiddenArtifacts, Assertion, BackendSpecificEffect b] ++ TableEffects b #

type GlobalHookProgramEffects b = '[Assertion, Embed IO, BackendSpecificEffect b] ++ Core b #

type HookProgramEffects b = GlobalHookProgramEffects b ++ TableEffects b #

type TableEffects b = '[Reader TargetName, Input TemporaryTableName, Reader ConnectionString, External] ++ Core b #

type Core b = [FatalError, Input RandomToken, Time, Output LogLine, SqlRender, SqlParse, SqlRead b, SqlWrite b, AnnotateRead b, AnnotateWrite b, LocalFile, Template, LoadQuery, Reader QueryTransformer, Input MetaArguments, Reader SQLDialect, Fail] #

class RunBackendEffect b where #

Minimal complete definition

runBackendEffectFake

Methods

runBackendEffectReal :: (Members (Core b) r, Member (Embed IO) r) => BackendConn b -> Sem (BackendSpecificEffect b : r) a -> Sem r a #

default runBackendEffectReal :: (Members (Core b) r, Member (Embed IO) r) => BackendConn b -> Sem (BackendSpecificEffect b : r) a -> Sem r a #

runBackendEffectFake :: (Members (Core b) r, Member (Embed IO) r) => Sem (BackendSpecificEffect b : r) a -> Sem r a #

Instances

Instances details

RunBackendEffect BigQuery #
Instance details Defined in Napkin.Run.Effects.Interpreters.Backend.BigQuery Methods runBackendEffectReal :: forall (r :: EffectRow) a. (Members (Core BigQuery) r, Member (Embed IO) r) => BackendConn BigQuery -> Sem (BackendSpecificEffect BigQuery ': r) a -> Sem r a # runBackendEffectFake :: forall (r :: EffectRow) a. (Members (Core BigQuery) r, Member (Embed IO) r) => Sem (BackendSpecificEffect BigQuery ': r) a -> Sem r a #
RunBackendEffect MsSql #
Instance details Defined in Napkin.Run.Effects.Interpreters.Backend.MsSql Methods runBackendEffectReal :: forall (r :: EffectRow) a. (Members (Core MsSql) r, Member (Embed IO) r) => BackendConn MsSql -> Sem (BackendSpecificEffect MsSql ': r) a -> Sem r a # runBackendEffectFake :: forall (r :: EffectRow) a. (Members (Core MsSql) r, Member (Embed IO) r) => Sem (BackendSpecificEffect MsSql ': r) a -> Sem r a #
RunBackendEffect Postgres #
Instance details Defined in Napkin.Run.Effects.Interpreters.Backend.Postgres Methods runBackendEffectReal :: forall (r :: EffectRow) a. (Members (Core Postgres) r, Member (Embed IO) r) => BackendConn Postgres -> Sem (BackendSpecificEffect Postgres ': r) a -> Sem r a # runBackendEffectFake :: forall (r :: EffectRow) a. (Members (Core Postgres) r, Member (Embed IO) r) => Sem (BackendSpecificEffect Postgres ': r) a -> Sem r a #
RunBackendEffect Redshift #
Instance details Defined in Napkin.Run.Effects.Interpreters.Backend.Redshift Methods runBackendEffectReal :: forall (r :: EffectRow) a. (Members (Core Redshift) r, Member (Embed IO) r) => BackendConn Redshift -> Sem (BackendSpecificEffect Redshift ': r) a -> Sem r a # runBackendEffectFake :: forall (r :: EffectRow) a. (Members (Core Redshift) r, Member (Embed IO) r) => Sem (BackendSpecificEffect Redshift ': r) a -> Sem r a #
RunBackendEffect Sqlite #
Instance details Defined in Napkin.Run.Effects.Interpreters.Backend.Sqlite Methods runBackendEffectReal :: forall (r :: EffectRow) a. (Members (Core Sqlite) r, Member (Embed IO) r) => BackendConn Sqlite -> Sem (BackendSpecificEffect Sqlite ': r) a -> Sem r a # runBackendEffectFake :: forall (r :: EffectRow) a. (Members (Core Sqlite) r, Member (Embed IO) r) => Sem (BackendSpecificEffect Sqlite ': r) a -> Sem r a #

askRefRenamer :: Member (Reader QueryTransformer) r => Sem r (Ref Table -> Ref Table) #

askQueryRewriter :: Member (Reader QueryTransformer) r => Sem r (Query -> Query) #

askQueryRewriterData :: forall a r. (Data a, Member (Reader QueryTransformer) r) => Sem r (a -> a) #