Safe Haskell	None
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 ()
data HookSyncOrAsync
- = HookSync
- | HookAsync
data Hook b = Hook {
- async :: HookSyncOrAsync
- hookProgram :: HookProgram b
}
pattern AsyncHook :: HookProgram b -> Hook b
pattern SyncHook :: HookProgram b -> Hook 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 :: (Type -> Type) -> Type -> Type, Output ExtraDependencies :: (Type -> Type) -> Type -> Type, Reader HiddenDependencies, Reader HiddenArtifacts, Assertion :: (Type -> Type) -> Type -> Type, BackendSpecificEffect b] ++ TableEffects b
type GlobalHookProgramEffects b = '[Assertion :: (Type -> Type) -> Type -> Type, Embed IO, BackendSpecificEffect b] ++ Core b
type HookProgramEffects b = GlobalHookProgramEffects b ++ TableEffects b
type TableEffects b = '[Reader TargetName, Input TemporaryTableName :: (Type -> Type) -> Type -> Type, Reader ConnectionString, External :: (Type -> Type) -> Type -> Type] ++ Core b
type Core b = '[FatalError :: (Type -> Type) -> Type -> Type, Input RandomToken :: (Type -> Type) -> Type -> Type, Time :: (Type -> Type) -> Type -> Type, Output LogLine :: (Type -> Type) -> Type -> Type, SqlRender :: (Type -> Type) -> Type -> Type, SqlParse :: (Type -> Type) -> Type -> Type, SqlRead b :: (Type -> Type) -> Type -> Type, SqlWrite b :: (Type -> Type) -> Type -> Type, AnnotateRead b :: (Type -> Type) -> Type -> Type, AnnotateWrite b :: (Type -> Type) -> Type -> Type, LocalFile :: (Type -> Type) -> Type -> Type, Template :: (Type -> Type) -> Type -> Type, LoadQuery :: (Type -> Type) -> Type -> Type, Reader QueryTransformer, Input MetaArguments :: (Type -> Type) -> Type -> Type, Reader SQLDialect, Fail :: (Type -> Type) -> Type -> Type]
class RunBackendEffect b where
- runBackendEffectReal :: forall (m :: Type -> Type) (r :: EffectRow) a. (Members '[FatalError :: (Type -> Type) -> Type -> Type, Embed m] r, MonadNapkin b m, SqlIO m, LocalQueryStats b m) => BackendConn b -> Sem (BackendSpecificEffect b ': r) a -> Sem r a
- runBackendEffectFake :: forall (r :: EffectRow) a. Members '[Reader HiddenDependencies, State IState :: (Type -> Type) -> Type -> Type, FatalError :: (Type -> Type) -> Type -> Type] r => Sem (BackendSpecificEffect b ': r) a -> Sem r a
- interceptBackendEffectDiscoverDependencies :: forall (r :: EffectRow) a. Members '[Input (Transformed HiddenDependencies) :: (Type -> Type) -> Type -> Type, Output Dependencies :: (Type -> Type) -> Type -> Type, BackendSpecificEffect b] r => Sem r a -> Sem r a
- interceptBackendEffectApplyQueryTransformer :: forall (r :: EffectRow) a. Members '[Output ExtraDependencies :: (Type -> Type) -> Type -> Type, Reader QueryTransformer, BackendSpecificEffect b] r => Sem r a -> Sem r a
askRefRenamer :: forall (r :: EffectRow). Member (Reader QueryTransformer) r => Sem r (Ref Table -> Ref Table)
askQueryRewriter :: forall (r :: EffectRow). Member (Reader QueryTransformer) r => Sem r (Query -> Query)
askQueryRewriterData :: forall a (r :: EffectRow). (Data a, Member (Reader QueryTransformer) r) => Sem r (a -> a)
data ProgramDependenciesAndQueries (b :: k)
- = SinglePath (DryRunResult b)
- | MultiplePaths {
  - createPath :: DryRunResult b
  - updatePath :: DryRunResult b
  }
summarize :: forall {k} (b :: k). ProgramDependenciesAndQueries b -> DryRunResult b
data DryRunResult (b :: k) = DryRunResult {
- dependencies :: Dependencies
- artifacts :: Artifacts
- queries :: [DumpItem b]
- loadedSqlQueries :: [(FilePath, Query)]
- assertions :: AssertionLog
}

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

data HookSyncOrAsync #

Constructors

HookSync
HookAsync

Instances

Instances details

Generic HookSyncOrAsync #

Instance details

Defined in Napkin.Run.Effects.Types

Associated Types

type Rep HookSyncOrAsync
Instance details Defined in Napkin.Run.Effects.Types type Rep HookSyncOrAsync = D1 ('MetaData "HookSyncOrAsync" "Napkin.Run.Effects.Types" "napkin-1.0.0-5YkWAC9Wc776PT0LDghaFb" 'False) (C1 ('MetaCons "HookSync" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HookAsync" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: HookSyncOrAsync -> Rep HookSyncOrAsync x #

to :: Rep HookSyncOrAsync x -> HookSyncOrAsync #

Show HookSyncOrAsync #

Instance details

Defined in Napkin.Run.Effects.Types

Methods

showsPrec :: Int -> HookSyncOrAsync -> ShowS #

show :: HookSyncOrAsync -> String #

showList :: [HookSyncOrAsync] -> ShowS #

type Rep HookSyncOrAsync #

Instance details

Defined in Napkin.Run.Effects.Types

type Rep HookSyncOrAsync = D1 ('MetaData "HookSyncOrAsync" "Napkin.Run.Effects.Types" "napkin-1.0.0-5YkWAC9Wc776PT0LDghaFb" 'False) (C1 ('MetaCons "HookSync" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HookAsync" 'PrefixI 'False) (U1 :: Type -> Type))

data Hook b #

Constructors

Hook
Fields async :: HookSyncOrAsync hookProgram :: HookProgram b

Instances

Instances details

Generic (Hook b) #

Instance details

Defined in Napkin.Run.Effects.Types

Associated Types

type Rep (Hook b)

Instance details

Defined in Napkin.Run.Effects.Types

type Rep (Hook b) = D1 ('MetaData "Hook" "Napkin.Run.Effects.Types" "napkin-1.0.0-5YkWAC9Wc776PT0LDghaFb" 'False) (C1 ('MetaCons "Hook" 'PrefixI 'True) (S1 ('MetaSel ('Just "async") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HookSyncOrAsync) :*: S1 ('MetaSel ('Just "hookProgram") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HookProgram b))))

Methods

from :: Hook b -> Rep (Hook b) x #

to :: Rep (Hook b) x -> Hook b #

type Rep (Hook b) #

Instance details

Defined in Napkin.Run.Effects.Types

type Rep (Hook b) = D1 ('MetaData "Hook" "Napkin.Run.Effects.Types" "napkin-1.0.0-5YkWAC9Wc776PT0LDghaFb" 'False) (C1 ('MetaCons "Hook" 'PrefixI 'True) (S1 ('MetaSel ('Just "async") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HookSyncOrAsync) :*: S1 ('MetaSel ('Just "hookProgram") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HookProgram b))))

pattern AsyncHook :: HookProgram b -> Hook b #

pattern SyncHook :: HookProgram b -> Hook b #

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 :: (Type -> Type) -> Type -> Type, Output ExtraDependencies :: (Type -> Type) -> Type -> Type, Reader HiddenDependencies, Reader HiddenArtifacts, Assertion :: (Type -> Type) -> Type -> Type, BackendSpecificEffect b] ++ TableEffects b #

type GlobalHookProgramEffects b = '[Assertion :: (Type -> Type) -> Type -> Type, Embed IO, BackendSpecificEffect b] ++ Core b #

type HookProgramEffects b = GlobalHookProgramEffects b ++ TableEffects b #

type TableEffects b = '[Reader TargetName, Input TemporaryTableName :: (Type -> Type) -> Type -> Type, Reader ConnectionString, External :: (Type -> Type) -> Type -> Type] ++ Core b #

class RunBackendEffect b where #

Methods

runBackendEffectReal :: forall (m :: Type -> Type) (r :: EffectRow) a. (Members '[FatalError :: (Type -> Type) -> Type -> Type, Embed m] r, MonadNapkin b m, SqlIO m, LocalQueryStats b m) => BackendConn b -> Sem (BackendSpecificEffect b ': r) a -> Sem r a #

runBackendEffectFake :: forall (r :: EffectRow) a. Members '[Reader HiddenDependencies, State IState :: (Type -> Type) -> Type -> Type, FatalError :: (Type -> Type) -> Type -> Type] r => Sem (BackendSpecificEffect b ': r) a -> Sem r a #

interceptBackendEffectDiscoverDependencies :: forall (r :: EffectRow) a. Members '[Input (Transformed HiddenDependencies) :: (Type -> Type) -> Type -> Type, Output Dependencies :: (Type -> Type) -> Type -> Type, BackendSpecificEffect b] r => Sem r a -> Sem r a #

interceptBackendEffectApplyQueryTransformer :: forall (r :: EffectRow) a. Members '[Output ExtraDependencies :: (Type -> Type) -> Type -> Type, Reader QueryTransformer, BackendSpecificEffect b] r => Sem r a -> Sem r a #

Instances

Instances details

RunBackendEffect BigQuery #
Instance details Defined in Napkin.Run.Effects.Interpreters.Backend.BigQuery Methods runBackendEffectReal :: forall (m :: Type -> Type) (r :: EffectRow) a. (Members '[FatalError :: (Type -> Type) -> Type -> Type, Embed m] r, MonadNapkin BigQuery m, SqlIO m, LocalQueryStats BigQuery m) => BackendConn BigQuery -> Sem (BackendSpecificEffect BigQuery ': r) a -> Sem r a # runBackendEffectFake :: forall (r :: EffectRow) a. Members '[Reader HiddenDependencies, State IState :: (Type -> Type) -> Type -> Type, FatalError :: (Type -> Type) -> Type -> Type] r => Sem (BackendSpecificEffect BigQuery ': r) a -> Sem r a # interceptBackendEffectDiscoverDependencies :: forall (r :: EffectRow) a. Members '[Input (Transformed HiddenDependencies) :: (Type -> Type) -> Type -> Type, Output Dependencies :: (Type -> Type) -> Type -> Type, BackendSpecificEffect BigQuery] r => Sem r a -> Sem r a # interceptBackendEffectApplyQueryTransformer :: forall (r :: EffectRow) a. Members '[Output ExtraDependencies :: (Type -> Type) -> Type -> Type, Reader QueryTransformer, BackendSpecificEffect BigQuery] r => Sem r a -> Sem r a #
RunBackendEffect MsSql #
Instance details Defined in Napkin.Run.Effects.Interpreters.Backend.MsSql Methods runBackendEffectReal :: forall (m :: Type -> Type) (r :: EffectRow) a. (Members '[FatalError :: (Type -> Type) -> Type -> Type, Embed m] r, MonadNapkin MsSql m, SqlIO m, LocalQueryStats MsSql m) => BackendConn MsSql -> Sem (BackendSpecificEffect MsSql ': r) a -> Sem r a # runBackendEffectFake :: forall (r :: EffectRow) a. Members '[Reader HiddenDependencies, State IState :: (Type -> Type) -> Type -> Type, FatalError :: (Type -> Type) -> Type -> Type] r => Sem (BackendSpecificEffect MsSql ': r) a -> Sem r a # interceptBackendEffectDiscoverDependencies :: forall (r :: EffectRow) a. Members '[Input (Transformed HiddenDependencies) :: (Type -> Type) -> Type -> Type, Output Dependencies :: (Type -> Type) -> Type -> Type, BackendSpecificEffect MsSql] r => Sem r a -> Sem r a # interceptBackendEffectApplyQueryTransformer :: forall (r :: EffectRow) a. Members '[Output ExtraDependencies :: (Type -> Type) -> Type -> Type, Reader QueryTransformer, BackendSpecificEffect MsSql] r => Sem r a -> Sem r a #
RunBackendEffect Postgres #
Instance details Defined in Napkin.Run.Effects.Interpreters.Backend.Postgres Methods runBackendEffectReal :: forall (m :: Type -> Type) (r :: EffectRow) a. (Members '[FatalError :: (Type -> Type) -> Type -> Type, Embed m] r, MonadNapkin Postgres m, SqlIO m, LocalQueryStats Postgres m) => BackendConn Postgres -> Sem (BackendSpecificEffect Postgres ': r) a -> Sem r a # runBackendEffectFake :: forall (r :: EffectRow) a. Members '[Reader HiddenDependencies, State IState :: (Type -> Type) -> Type -> Type, FatalError :: (Type -> Type) -> Type -> Type] r => Sem (BackendSpecificEffect Postgres ': r) a -> Sem r a # interceptBackendEffectDiscoverDependencies :: forall (r :: EffectRow) a. Members '[Input (Transformed HiddenDependencies) :: (Type -> Type) -> Type -> Type, Output Dependencies :: (Type -> Type) -> Type -> Type, BackendSpecificEffect Postgres] r => Sem r a -> Sem r a # interceptBackendEffectApplyQueryTransformer :: forall (r :: EffectRow) a. Members '[Output ExtraDependencies :: (Type -> Type) -> Type -> Type, Reader QueryTransformer, BackendSpecificEffect Postgres] r => Sem r a -> Sem r a #
RunBackendEffect Redshift #
Instance details Defined in Napkin.Run.Effects.Interpreters.Backend.Redshift Methods runBackendEffectReal :: forall (m :: Type -> Type) (r :: EffectRow) a. (Members '[FatalError :: (Type -> Type) -> Type -> Type, Embed m] r, MonadNapkin Redshift m, SqlIO m, LocalQueryStats Redshift m) => BackendConn Redshift -> Sem (BackendSpecificEffect Redshift ': r) a -> Sem r a # runBackendEffectFake :: forall (r :: EffectRow) a. Members '[Reader HiddenDependencies, State IState :: (Type -> Type) -> Type -> Type, FatalError :: (Type -> Type) -> Type -> Type] r => Sem (BackendSpecificEffect Redshift ': r) a -> Sem r a # interceptBackendEffectDiscoverDependencies :: forall (r :: EffectRow) a. Members '[Input (Transformed HiddenDependencies) :: (Type -> Type) -> Type -> Type, Output Dependencies :: (Type -> Type) -> Type -> Type, BackendSpecificEffect Redshift] r => Sem r a -> Sem r a # interceptBackendEffectApplyQueryTransformer :: forall (r :: EffectRow) a. Members '[Output ExtraDependencies :: (Type -> Type) -> Type -> Type, Reader QueryTransformer, BackendSpecificEffect Redshift] r => Sem r a -> Sem r a #
RunBackendEffect Sqlite #
Instance details Defined in Napkin.Run.Effects.Interpreters.Backend.Sqlite Methods runBackendEffectReal :: forall (m :: Type -> Type) (r :: EffectRow) a. (Members '[FatalError :: (Type -> Type) -> Type -> Type, Embed m] r, MonadNapkin Sqlite m, SqlIO m, LocalQueryStats Sqlite m) => BackendConn Sqlite -> Sem (BackendSpecificEffect Sqlite ': r) a -> Sem r a # runBackendEffectFake :: forall (r :: EffectRow) a. Members '[Reader HiddenDependencies, State IState :: (Type -> Type) -> Type -> Type, FatalError :: (Type -> Type) -> Type -> Type] r => Sem (BackendSpecificEffect Sqlite ': r) a -> Sem r a # interceptBackendEffectDiscoverDependencies :: forall (r :: EffectRow) a. Members '[Input (Transformed HiddenDependencies) :: (Type -> Type) -> Type -> Type, Output Dependencies :: (Type -> Type) -> Type -> Type, BackendSpecificEffect Sqlite] r => Sem r a -> Sem r a # interceptBackendEffectApplyQueryTransformer :: forall (r :: EffectRow) a. Members '[Output ExtraDependencies :: (Type -> Type) -> Type -> Type, Reader QueryTransformer, BackendSpecificEffect Sqlite] r => Sem r a -> Sem r a #

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

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

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

data ProgramDependenciesAndQueries (b :: k) #

Constructors

SinglePath (DryRunResult b)
MultiplePaths
Fields createPath :: DryRunResult b updatePath :: DryRunResult b

summarize :: forall {k} (b :: k). ProgramDependenciesAndQueries b -> DryRunResult b #

data DryRunResult (b :: k) #

Constructors

DryRunResult
Fields dependencies :: Dependencies artifacts :: Artifacts queries :: [DumpItem b] loadedSqlQueries :: [(FilePath, Query)] assertions :: AssertionLog