Copyright	(c) Soostone Inc 2020
License	AllRightsReserved
Stability	experimental
Portability	POSIX
Safe Haskell	Safe-Inferred
Language	GHC2021

Napkin.Spec.Types.Spec

Description

Synopsis

data SpecTarget b
- = SpecTable (BackendTableMeta b)
- | SpecView (BackendViewMeta b)
- | SpecMaterializedView (BackendMaterializedViewMeta b)
data TableSpec b = TableSpec {
- _specTable :: SpecTableName
- _specAction :: SpecProgram b
- _specPreHooks :: [HookProgram b]
- _specPostHooks :: [HookProgram b]
- _specUpdate :: [UpdateStrategy]
- _specGrants :: [([Privilege], [Actor])]
- _specTags :: Set TableSpecTag
}
type TableSpecTag = Text
data UpdateStrategy
- = UpdateAlways
- | UpdatePeriodically NominalDiffTime
- | UpdateWithDependency
- | UpdateIfMissing
- | UpdateIfErroredLastRun
type SpecTableMap b = Map SpecTableName (TableSpec b)
data Specs b = Specs {
- _specsTables :: SpecTableMap b
- _specsHooks :: [(Text, [SpecTableName], GlobalHookProgram b)]
- _specsMetaArgs :: SpecMetaArgs
- _specsTransformer :: QueryTransformer
}
newtype Spec b a = Spec {
- _runSpec :: ReaderT SpecPaths (StateT (Specs b) IO) a
}
newtype CustomValidator = CustomValidator {
- unCustomValidator :: SpecMetaArgs -> Ref Table -> Maybe FilePath -> Query -> [Text]
}
newtype ExternMacros = ExternMacros (Map (Ref Function) (ExternFun -> SExp))
newtype SpecPreprocessorWithArgParser b = SpecPreprocessorWithArgParser (Object -> Parser (SpecProgramArguments, SpecPreprocessor b))
parserlessPreprocessor :: SpecPreprocessor b -> SpecPreprocessorWithArgParser b
data SpecDependency
- = Managed SpecTableName
- | UnManaged (Ref Table)
toRef :: SpecDependency -> Ref Table
toSpecTable :: SpecDependency -> Maybe SpecTableName
isManaged :: SpecDependency -> Bool
type SpecsDeps = Map SpecTableName (Set SpecDependency)
type DepsValidator = (SpecDependency -> Ref Table) -> SpecsDeps -> [Text]
type SpecPreprocessor b = Sem [Input SpecPaths, Input MetaArguments, State (Specs b), Output DepsValidator, FatalError, Embed IO, Log] ()
type SpecPreprocessorFunc bk = SpecMetaArgs -> Specs bk -> Specs bk
runSpec :: SpecPaths -> Spec b a -> IO (Specs b)
runSpecE :: SpecPaths -> ExceptT e (Spec b) a -> IO (Either e (Specs b))
runSpecE' :: SpecPaths -> Specs b -> ExceptT e (Spec b) a -> IO (Either e (a, Specs b))
specUpdate :: forall b. Lens' (TableSpec b) [UpdateStrategy]
specTags :: forall b. Lens' (TableSpec b) (Set TableSpecTag)
specTable :: forall b. Lens' (TableSpec b) SpecTableName
specPreHooks :: forall b. Lens' (TableSpec b) [HookProgram b]
specPostHooks :: forall b. Lens' (TableSpec b) [HookProgram b]
specGrants :: forall b. Lens' (TableSpec b) [([Privilege], [Actor])]
specAction :: forall b. Lens' (TableSpec b) (SpecProgram b)
specsTransformer :: forall b. Lens' (Specs b) QueryTransformer
specsTables :: forall b. Lens' (Specs b) (SpecTableMap b)
specsMetaArgs :: forall b. Lens' (Specs b) SpecMetaArgs
specsHooks :: forall b. Lens' (Specs b) [(Text, [SpecTableName], GlobalHookProgram b)]
allSpecsTables :: Specs b -> Set SpecTableName
defineTable :: TableSpec b -> Spec b ()
specAddPreHooks :: [HookProgram b] -> TableSpec b -> TableSpec b
specAddPostHooks :: [HookProgram b] -> TableSpec b -> TableSpec b

Documentation

data SpecTarget b #

Constructors

SpecTable (BackendTableMeta b)
SpecView (BackendViewMeta b)
SpecMaterializedView (BackendMaterializedViewMeta b)

data TableSpec b #

Constructors

TableSpec
Fields _specTable :: SpecTableName Unaltered table name (as specified in Spec) _specAction :: SpecProgram b _specPreHooks :: [HookProgram b] _specPostHooks :: [HookProgram b] _specUpdate :: [UpdateStrategy] _specGrants :: [([Privilege], [Actor])] _specTags :: Set TableSpecTag allows subgraph execution

Instances

Instances details

ToJSON (TableSpec b) #
Instance details Defined in Napkin.Spec.Types.Spec Methods toJSON :: TableSpec b -> Value # toEncoding :: TableSpec b -> Encoding # toJSONList :: [TableSpec b] -> Value # toEncodingList :: [TableSpec b] -> Encoding #
LogItem (TableSpec b) #
Instance details Defined in Napkin.Spec.Types.Spec Methods payloadKeys :: Verbosity -> TableSpec b -> PayloadSelection #
ToObject (TableSpec b) #
Instance details Defined in Napkin.Spec.Types.Spec Methods toObject :: TableSpec b -> Object #

type TableSpecTag = Text #

data UpdateStrategy #

Each strategy acts independently. For example, if you have only UpdateWithDependency, it wouldn't update even if the table were missing. You need to specify each strategy in the list.

Constructors

UpdateAlways
UpdatePeriodically NominalDiffTime
UpdateWithDependency
UpdateIfMissing
UpdateIfErroredLastRun

Instances

Instances details

FromJSON UpdateStrategy #
Instance details Defined in Napkin.Spec.Yaml.Types Methods parseJSON :: Value -> Parser UpdateStrategy # parseJSONList :: Value -> Parser [UpdateStrategy] #
Data UpdateStrategy #
Instance details Defined in Napkin.Spec.Types.Spec Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateStrategy -> c UpdateStrategy # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateStrategy # toConstr :: UpdateStrategy -> Constr # dataTypeOf :: UpdateStrategy -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateStrategy) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateStrategy) # gmapT :: (forall b. Data b => b -> b) -> UpdateStrategy -> UpdateStrategy # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateStrategy -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateStrategy -> r # gmapQ :: (forall d. Data d => d -> u) -> UpdateStrategy -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateStrategy -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateStrategy -> m UpdateStrategy # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateStrategy -> m UpdateStrategy # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateStrategy -> m UpdateStrategy #
Generic UpdateStrategy #
Instance details Defined in Napkin.Spec.Types.Spec Associated Types type Rep UpdateStrategy :: Type -> Type # Methods from :: UpdateStrategy -> Rep UpdateStrategy x # to :: Rep UpdateStrategy x -> UpdateStrategy #
Show UpdateStrategy #
Instance details Defined in Napkin.Spec.Types.Spec Methods showsPrec :: Int -> UpdateStrategy -> ShowS # show :: UpdateStrategy -> String # showList :: [UpdateStrategy] -> ShowS #
Eq UpdateStrategy #
Instance details Defined in Napkin.Spec.Types.Spec Methods (==) :: UpdateStrategy -> UpdateStrategy -> Bool # (/=) :: UpdateStrategy -> UpdateStrategy -> Bool #
Ord UpdateStrategy #
Instance details Defined in Napkin.Spec.Types.Spec Methods compare :: UpdateStrategy -> UpdateStrategy -> Ordering # (<) :: UpdateStrategy -> UpdateStrategy -> Bool # (<=) :: UpdateStrategy -> UpdateStrategy -> Bool # (>) :: UpdateStrategy -> UpdateStrategy -> Bool # (>=) :: UpdateStrategy -> UpdateStrategy -> Bool # max :: UpdateStrategy -> UpdateStrategy -> UpdateStrategy # min :: UpdateStrategy -> UpdateStrategy -> UpdateStrategy #
type Rep UpdateStrategy #
Instance details Defined in Napkin.Spec.Types.Spec type Rep UpdateStrategy = D1 ('MetaData "UpdateStrategy" "Napkin.Spec.Types.Spec" "napkin-0.5.14-JrXUGmKUOt9J0meJSj0Kh4" 'False) ((C1 ('MetaCons "UpdateAlways" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UpdatePeriodically" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NominalDiffTime))) :+: (C1 ('MetaCons "UpdateWithDependency" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UpdateIfMissing" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UpdateIfErroredLastRun" 'PrefixI 'False) (U1 :: Type -> Type))))

type SpecTableMap b = Map SpecTableName (TableSpec b) #

data Specs b #

Constructors

Specs

Fields

_specsTables :: SpecTableMap b
_specsHooks :: [(Text, [SpecTableName], GlobalHookProgram b)]
independent (global) hooks with a brief description (for UI mode, info messages and logs) that can run as soon as given dependencies are ready
_specsMetaArgs :: SpecMetaArgs
arguments which can be passed to custom creators
_specsTransformer :: QueryTransformer
accumulate query transformer that has been applied to the specs, so it can be used to convert raw references

Instances

Instances details

Generic (Specs b) #
Instance details Defined in Napkin.Spec.Types.Spec Associated Types type Rep (Specs b) :: Type -> Type # Methods from :: Specs b -> Rep (Specs b) x # to :: Rep (Specs b) x -> Specs b #
Default (Specs b) #
Instance details Defined in Napkin.Spec.Types.Spec Methods def :: Specs b #
MonadState (Specs b) (Spec b) #
Instance details Defined in Napkin.Spec.Types.Spec Methods get :: Spec b (Specs b) # put :: Specs b -> Spec b () # state :: (Specs b -> (a, Specs b)) -> Spec b a #
type Rep (Specs b) #
Instance details Defined in Napkin.Spec.Types.Spec type Rep (Specs b) = D1 ('MetaData "Specs" "Napkin.Spec.Types.Spec" "napkin-0.5.14-JrXUGmKUOt9J0meJSj0Kh4" 'False) (C1 ('MetaCons "Specs" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_specsTables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SpecTableMap b)) :: S1 ('MetaSel ('Just "_specsHooks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, [SpecTableName], GlobalHookProgram b)])) :: (S1 ('MetaSel ('Just "_specsMetaArgs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SpecMetaArgs) :*: S1 ('MetaSel ('Just "_specsTransformer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 QueryTransformer))))

newtype Spec b a #

Constructors

Spec
Fields _runSpec :: ReaderT SpecPaths (StateT (Specs b) IO) a

Instances

Instances details

MonadReader SpecPaths (Spec b) #
Instance details Defined in Napkin.Spec.Types.Spec Methods ask :: Spec b SpecPaths # local :: (SpecPaths -> SpecPaths) -> Spec b a -> Spec b a # reader :: (SpecPaths -> a) -> Spec b a #
MonadIO (Spec b) #
Instance details Defined in Napkin.Spec.Types.Spec Methods liftIO :: IO a -> Spec b a #
Applicative (Spec b) #
Instance details Defined in Napkin.Spec.Types.Spec Methods pure :: a -> Spec b a # (<>) :: Spec b (a -> b0) -> Spec b a -> Spec b b0 # liftA2 :: (a -> b0 -> c) -> Spec b a -> Spec b b0 -> Spec b c # (>) :: Spec b a -> Spec b b0 -> Spec b b0 # (<*) :: Spec b a -> Spec b b0 -> Spec b a #
Functor (Spec b) #
Instance details Defined in Napkin.Spec.Types.Spec Methods fmap :: (a -> b0) -> Spec b a -> Spec b b0 # (<$) :: a -> Spec b b0 -> Spec b a #
Monad (Spec b) #
Instance details Defined in Napkin.Spec.Types.Spec Methods (>>=) :: Spec b a -> (a -> Spec b b0) -> Spec b b0 # (>>) :: Spec b a -> Spec b b0 -> Spec b b0 # return :: a -> Spec b a #
MonadCatch (Spec b) #
Instance details Defined in Napkin.Spec.Types.Spec Methods catch :: Exception e => Spec b a -> (e -> Spec b a) -> Spec b a #
MonadMask (Spec b) #
Instance details Defined in Napkin.Spec.Types.Spec Methods mask :: ((forall a. Spec b a -> Spec b a) -> Spec b b0) -> Spec b b0 # uninterruptibleMask :: ((forall a. Spec b a -> Spec b a) -> Spec b b0) -> Spec b b0 # generalBracket :: Spec b a -> (a -> ExitCase b0 -> Spec b c) -> (a -> Spec b b0) -> Spec b (b0, c) #
MonadThrow (Spec b) #
Instance details Defined in Napkin.Spec.Types.Spec Methods throwM :: Exception e => e -> Spec b a #
MonadState (Specs b) (Spec b) #
Instance details Defined in Napkin.Spec.Types.Spec Methods get :: Spec b (Specs b) # put :: Specs b -> Spec b () # state :: (Specs b -> (a, Specs b)) -> Spec b a #

newtype CustomValidator #

CustomValidators are run before namespacing and return a list of errors in the incoming Spec.

TODO. I find this outmoded - it's a very restrictive form of doing custom validations. The new effect machinery is much richer in being able to introspect different types of database interactions under the SqlBackend type. Keeping this for legacy compatibility for now.

Constructors

CustomValidator
Fields unCustomValidator :: SpecMetaArgs -> Ref Table -> Maybe FilePath -> Query -> [Text]

Instances

Instances details

Default CustomValidator #
Instance details Defined in Napkin.Spec.Types.Spec Methods def :: CustomValidator #

newtype ExternMacros #

Constructors

ExternMacros (Map (Ref Function) (ExternFun -> SExp))

Instances

Instances details

Monoid ExternMacros #
Instance details Defined in Napkin.Spec.Types.Spec Methods mempty :: ExternMacros # mappend :: ExternMacros -> ExternMacros -> ExternMacros # mconcat :: [ExternMacros] -> ExternMacros #
Semigroup ExternMacros #
Instance details Defined in Napkin.Spec.Types.Spec Methods (<>) :: ExternMacros -> ExternMacros -> ExternMacros # sconcat :: NonEmpty ExternMacros -> ExternMacros # stimes :: Integral b => b -> ExternMacros -> ExternMacros #
IsList ExternMacros #
Instance details Defined in Napkin.Spec.Types.Spec Associated Types type Item ExternMacros # Methods fromList :: [Item ExternMacros] -> ExternMacros # fromListN :: Int -> [Item ExternMacros] -> ExternMacros # toList :: ExternMacros -> [Item ExternMacros] #
Default ExternMacros #
Instance details Defined in Napkin.Spec.Types.Spec Methods def :: ExternMacros #
type Item ExternMacros #
Instance details Defined in Napkin.Spec.Types.Spec type Item ExternMacros = Item (Map (Ref Function) (ExternFun -> SExp))

newtype SpecPreprocessorWithArgParser b #

Constructors

SpecPreprocessorWithArgParser (Object -> Parser (SpecProgramArguments, SpecPreprocessor b))

parserlessPreprocessor :: SpecPreprocessor b -> SpecPreprocessorWithArgParser b #

data SpecDependency #

Constructors

Managed SpecTableName
UnManaged (Ref Table)

Instances

Instances details

Show SpecDependency #
Instance details Defined in Napkin.Spec.Types.Spec Methods showsPrec :: Int -> SpecDependency -> ShowS # show :: SpecDependency -> String # showList :: [SpecDependency] -> ShowS #
Buildable SpecDependency #
Instance details Defined in Napkin.Spec.Types.Spec Methods build :: SpecDependency -> Builder #
Eq SpecDependency #
Instance details Defined in Napkin.Spec.Types.Spec Methods (==) :: SpecDependency -> SpecDependency -> Bool # (/=) :: SpecDependency -> SpecDependency -> Bool #
Ord SpecDependency #
Instance details Defined in Napkin.Spec.Types.Spec Methods compare :: SpecDependency -> SpecDependency -> Ordering # (<) :: SpecDependency -> SpecDependency -> Bool # (<=) :: SpecDependency -> SpecDependency -> Bool # (>) :: SpecDependency -> SpecDependency -> Bool # (>=) :: SpecDependency -> SpecDependency -> Bool # max :: SpecDependency -> SpecDependency -> SpecDependency # min :: SpecDependency -> SpecDependency -> SpecDependency #

toRef :: SpecDependency -> Ref Table #

toSpecTable :: SpecDependency -> Maybe SpecTableName #

isManaged :: SpecDependency -> Bool #

type SpecsDeps = Map SpecTableName (Set SpecDependency) #

type DepsValidator = (SpecDependency -> Ref Table) -> SpecsDeps -> [Text] #

type SpecPreprocessor b = Sem [Input SpecPaths, Input MetaArguments, State (Specs b), Output DepsValidator, FatalError, Embed IO, Log] () #

type SpecPreprocessorFunc bk = SpecMetaArgs -> Specs bk -> Specs bk #

runSpec :: SpecPaths -> Spec b a -> IO (Specs b) #

runSpecE :: SpecPaths -> ExceptT e (Spec b) a -> IO (Either e (Specs b)) #

runSpecE' :: SpecPaths -> Specs b -> ExceptT e (Spec b) a -> IO (Either e (a, Specs b)) #

specUpdate :: forall b. Lens' (TableSpec b) [UpdateStrategy] #

specTags :: forall b. Lens' (TableSpec b) (Set TableSpecTag) #

specTable :: forall b. Lens' (TableSpec b) SpecTableName #

specPreHooks :: forall b. Lens' (TableSpec b) [HookProgram b] #

specPostHooks :: forall b. Lens' (TableSpec b) [HookProgram b] #

specGrants :: forall b. Lens' (TableSpec b) [([Privilege], [Actor])] #

specAction :: forall b. Lens' (TableSpec b) (SpecProgram b) #

specsTransformer :: forall b. Lens' (Specs b) QueryTransformer #

specsTables :: forall b. Lens' (Specs b) (SpecTableMap b) #

specsMetaArgs :: forall b. Lens' (Specs b) SpecMetaArgs #

specsHooks :: forall b. Lens' (Specs b) [(Text, [SpecTableName], GlobalHookProgram b)] #

allSpecsTables :: Specs b -> Set SpecTableName #

All tables that are being created/managed as part of this spec.

defineTable :: TableSpec b -> Spec b () #

specAddPreHooks :: [HookProgram b] -> TableSpec b -> TableSpec b #

specAddPostHooks :: [HookProgram b] -> TableSpec b -> TableSpec b #

Key	Shortcut
s	Open this search box
esc	Close this search box
↓,ctrl + j	Move down in search results
↑,ctrl + k	Move up in search results
↵	Go to active search result