Safe Haskell	None
Language	Haskell2010

Napkin.Spec.Yaml.Types

Contents

Orphan instances

Documentation

data YamlSpec b #

Constructors

YamlSpec

Fields

_yamlSpec_appName :: Maybe AppName
indicate folders within project to scan for SQL and other app-namespace
_yamlSpec_sqlFolder :: FilePath
_yamlSpec_connectionURL :: String
URL to indicate how to create the database connection
_yamlSpec_metadataConnectionURL :: Maybe ConnectionString
URL to indicate where metadata should be stored
_yamlSpec_haskellFolder :: FilePath
folder used to find the Haskell source code. When not provided, assumed to be haskell/
_yamlSpec_tableSpecs :: Map (Ref Table) (YamlTableSpec b)
_yamlSpec_backend :: DbBackendOptions b
indicate backend to be used in this spec
_yamlSpec_specPreprocessors :: [YamlPreprocessor b]
specify a function to run as the napkin spec preprocessor
_yamlSpec_validator :: Maybe (Typed CustomValidator ModuleFunction)
specify a function to run as the napkin validator
_yamlSpec_extraHaskellPackages :: [Package]
specify additional packages which should be exposed to the haskell functions in the YAML spec
_yamlSpec_extraHaskellModules :: [Module]
specify extra haskell modules that should be loaded into interpreter environment, they can be referenced in mustache templates
_yamlSpec_defaultHaskellLanguageExtensions :: [YamlHaskellExtension]
specify default haskell language extensions enabled in haskell modules
_yamlSpec_haskellSpec :: Maybe (Typed (Spec b ()) ModuleFunction)
specify an additional Haskell function to run in the Spec monad after all the TableSpecs.
_yamlSpec_functionMacros :: Maybe (Typed ExternMacros ModuleFunction)
specify a Haskell function to implement function macros

Instances

Instances details

(Eq (DbBackendOptions b), Eq (BackendTableMeta b), Typeable b) => Eq (YamlSpec b) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods (==) :: YamlSpec b -> YamlSpec b -> Bool # (/=) :: YamlSpec b -> YamlSpec b -> Bool #
(Show (DbBackendOptions b), Show (BackendTableMeta b), Typeable b) => Show (YamlSpec b) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods showsPrec :: Int -> YamlSpec b -> ShowS # show :: YamlSpec b -> String # showList :: [YamlSpec b] -> ShowS #
Generic (YamlSpec b) #
Instance details Defined in Napkin.Spec.Yaml.Types Associated Types type Rep (YamlSpec b) :: Type -> Type # Methods from :: YamlSpec b -> Rep (YamlSpec b) x # to :: Rep (YamlSpec b) x -> YamlSpec b #
(ToDbBackend b, Typeable b, ToJSON (YamlBackendTableMeta b), ToJSON (DbBackendOptions b)) => ToJSON (YamlSpec b) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods toJSON :: YamlSpec b -> Value # toEncoding :: YamlSpec b -> Encoding # toJSONList :: [YamlSpec b] -> Value # toEncodingList :: [YamlSpec b] -> Encoding #
(ToDbBackend b, Typeable b, FromJSON (DbBackendOptions b), Default (BackendTableMeta b), FromJSON (YamlBackendTableMeta b), Default (DbBackendOptions b), ReifiesBackend b, ParseSQL b) => FromJSON (YamlSpec b) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods parseJSON :: Value -> Parser (YamlSpec b) # parseJSONList :: Value -> Parser [YamlSpec b] #
type Rep (YamlSpec b) #
Instance details Defined in Napkin.Spec.Yaml.Types type Rep (YamlSpec b) = D1 ('MetaData "YamlSpec" "Napkin.Spec.Yaml.Types" "napkin-0.5.9-9RVzJKhltBGIJ4XYUA68gX" 'False) (C1 ('MetaCons "YamlSpec" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_yamlSpec_appName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe AppName)) :: (S1 ('MetaSel ('Just "_yamlSpec_sqlFolder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :: S1 ('MetaSel ('Just "_yamlSpec_connectionURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))) :: ((S1 ('MetaSel ('Just "_yamlSpec_metadataConnectionURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ConnectionString)) :: S1 ('MetaSel ('Just "_yamlSpec_haskellFolder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)) :: (S1 ('MetaSel ('Just "_yamlSpec_tableSpecs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map (Ref Table) (YamlTableSpec b))) :: S1 ('MetaSel ('Just "_yamlSpec_backend") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (DbBackendOptions b))))) :: ((S1 ('MetaSel ('Just "_yamlSpec_specPreprocessors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [YamlPreprocessor b]) :: (S1 ('MetaSel ('Just "_yamlSpec_validator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Typed CustomValidator ModuleFunction))) :: S1 ('MetaSel ('Just "_yamlSpec_extraHaskellPackages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Package]))) :: ((S1 ('MetaSel ('Just "_yamlSpec_extraHaskellModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Module]) :: S1 ('MetaSel ('Just "_yamlSpec_defaultHaskellLanguageExtensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [YamlHaskellExtension])) :: (S1 ('MetaSel ('Just "_yamlSpec_haskellSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Typed (Spec b ()) ModuleFunction))) :*: S1 ('MetaSel ('Just "_yamlSpec_functionMacros") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Typed ExternMacros ModuleFunction))))))))

defaultSqlFolder :: FilePath #

defaultHaskellFolder :: FilePath #

dbBackend :: forall b. ToDbBackend b => YamlSpec b -> DbBackend #

newtype YamlBackendTableMeta b #

Constructors

YamlBackendTableMeta
Fields unYamlTableMeta :: BackendTableMeta b

Instances

Instances details

(Eq (BackendTableMeta b), Typeable b) => Eq (YamlBackendTableMeta b) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods (==) :: YamlBackendTableMeta b -> YamlBackendTableMeta b -> Bool # (/=) :: YamlBackendTableMeta b -> YamlBackendTableMeta b -> Bool #
(Show (BackendTableMeta b), Typeable b) => Show (YamlBackendTableMeta b) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods showsPrec :: Int -> YamlBackendTableMeta b -> ShowS # show :: YamlBackendTableMeta b -> String # showList :: [YamlBackendTableMeta b] -> ShowS #
ToJSON (YamlBackendTableMeta Sqlite) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods toJSON :: YamlBackendTableMeta Sqlite -> Value # toEncoding :: YamlBackendTableMeta Sqlite -> Encoding # toJSONList :: [YamlBackendTableMeta Sqlite] -> Value # toEncodingList :: [YamlBackendTableMeta Sqlite] -> Encoding #
ToJSON (YamlBackendTableMeta Redshift) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods toJSON :: YamlBackendTableMeta Redshift -> Value # toEncoding :: YamlBackendTableMeta Redshift -> Encoding # toJSONList :: [YamlBackendTableMeta Redshift] -> Value # toEncodingList :: [YamlBackendTableMeta Redshift] -> Encoding #
ToJSON (YamlBackendTableMeta Postgres) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods toJSON :: YamlBackendTableMeta Postgres -> Value # toEncoding :: YamlBackendTableMeta Postgres -> Encoding # toJSONList :: [YamlBackendTableMeta Postgres] -> Value # toEncodingList :: [YamlBackendTableMeta Postgres] -> Encoding #
ToJSON (YamlBackendTableMeta BigQuery) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods toJSON :: YamlBackendTableMeta BigQuery -> Value # toEncoding :: YamlBackendTableMeta BigQuery -> Encoding # toJSONList :: [YamlBackendTableMeta BigQuery] -> Value # toEncodingList :: [YamlBackendTableMeta BigQuery] -> Encoding #
FromJSON (YamlBackendTableMeta Sqlite) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods parseJSON :: Value -> Parser (YamlBackendTableMeta Sqlite) # parseJSONList :: Value -> Parser [YamlBackendTableMeta Sqlite] #
FromJSON (YamlBackendTableMeta Redshift) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods parseJSON :: Value -> Parser (YamlBackendTableMeta Redshift) # parseJSONList :: Value -> Parser [YamlBackendTableMeta Redshift] #
FromJSON (YamlBackendTableMeta Postgres) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods parseJSON :: Value -> Parser (YamlBackendTableMeta Postgres) # parseJSONList :: Value -> Parser [YamlBackendTableMeta Postgres] #
FromJSON (YamlBackendTableMeta BigQuery) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods parseJSON :: Value -> Parser (YamlBackendTableMeta BigQuery) # parseJSONList :: Value -> Parser [YamlBackendTableMeta BigQuery] #
Default (BackendTableMeta b) => Default (YamlBackendTableMeta b) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods def :: YamlBackendTableMeta b #

data YamlTableSpec b #

Constructors

YamlTableSpec
Fields _yamlTableSpec_targetTableOptions :: Maybe (BackendTableMeta b) _yamlTableSpec_createAction :: YamlSpecProgram b _yamlTableSpec_preHooks :: [YamlHook b] _yamlTableSpec_postHooks :: [YamlHook b] _yamlTableSpec_updateStrategy :: [UpdateStrategy] _yamlTableSpec_tags :: [TableSpecTag] _yamlTableSpec_deps :: [Ref Table] _yamlTableSpec_hiddenDeps :: [Ref Table]

Instances

Instances details

(Eq (BackendTableMeta b), Typeable b) => Eq (YamlTableSpec b) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods (==) :: YamlTableSpec b -> YamlTableSpec b -> Bool # (/=) :: YamlTableSpec b -> YamlTableSpec b -> Bool #
(Show (BackendTableMeta b), Typeable b) => Show (YamlTableSpec b) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods showsPrec :: Int -> YamlTableSpec b -> ShowS # show :: YamlTableSpec b -> String # showList :: [YamlTableSpec b] -> ShowS #
(ToJSON (YamlBackendTableMeta b), Typeable b) => ToJSON (YamlTableSpec b) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods toJSON :: YamlTableSpec b -> Value # toEncoding :: YamlTableSpec b -> Encoding # toJSONList :: [YamlTableSpec b] -> Value # toEncodingList :: [YamlTableSpec b] -> Encoding #
(ReifiesBackend b, ParseSQL b, FromJSON (YamlBackendTableMeta b), Typeable b) => FromJSON (YamlTableSpec b) #
Instance details Defined in Napkin.Spec.Yaml.Types Methods parseJSON :: Value -> Parser (YamlTableSpec b) # parseJSONList :: Value -> Parser [YamlTableSpec b] #

newtype YamlHaskellExtension #

Constructors

YamlHaskellExtension
Fields toExtension :: HaskellExtension

Instances

Instances details

Eq YamlHaskellExtension #
Instance details Defined in Napkin.Spec.Yaml.Types Methods (==) :: YamlHaskellExtension -> YamlHaskellExtension -> Bool # (/=) :: YamlHaskellExtension -> YamlHaskellExtension -> Bool #
Show YamlHaskellExtension #
Instance details Defined in Napkin.Spec.Yaml.Types Methods showsPrec :: Int -> YamlHaskellExtension -> ShowS # show :: YamlHaskellExtension -> String # showList :: [YamlHaskellExtension] -> ShowS #
ToJSON YamlHaskellExtension #
Instance details Defined in Napkin.Spec.Yaml.Types Methods toJSON :: YamlHaskellExtension -> Value # toEncoding :: YamlHaskellExtension -> Encoding # toJSONList :: [YamlHaskellExtension] -> Value # toEncodingList :: [YamlHaskellExtension] -> Encoding #
FromJSON YamlHaskellExtension #
Instance details Defined in Napkin.Spec.Yaml.Types Methods parseJSON :: Value -> Parser YamlHaskellExtension # parseJSONList :: Value -> Parser [YamlHaskellExtension] #

toExtensions :: [YamlHaskellExtension] -> [HaskellExtension] #

allHaskellModules :: Typeable b => YamlSpec b -> [Module] #

Orphan instances

ToJSON SortKey #
Instance details Methods toJSON :: SortKey -> Value # toEncoding :: SortKey -> Encoding # toJSONList :: [SortKey] -> Value # toEncodingList :: [SortKey] -> Encoding #
ToJSON SortStyle #
Instance details Methods toJSON :: SortStyle -> Value # toEncoding :: SortStyle -> Encoding # toJSONList :: [SortStyle] -> Value # toEncodingList :: [SortStyle] -> Encoding #
ToJSON DistStyle #
Instance details Methods toJSON :: DistStyle -> Value # toEncoding :: DistStyle -> Encoding # toJSONList :: [DistStyle] -> Value # toEncodingList :: [DistStyle] -> Encoding #
ToJSON WriteDisposition #
Instance details Methods toJSON :: WriteDisposition -> Value # toEncoding :: WriteDisposition -> Encoding # toJSONList :: [WriteDisposition] -> Value # toEncodingList :: [WriteDisposition] -> Encoding #
ToJSON Partitioning #
Instance details Methods toJSON :: Partitioning -> Value # toEncoding :: Partitioning -> Encoding # toJSONList :: [Partitioning] -> Value # toEncodingList :: [Partitioning] -> Encoding #
ToJSON RangeWithStep #
Instance details Methods toJSON :: RangeWithStep -> Value # toEncoding :: RangeWithStep -> Encoding # toJSONList :: [RangeWithStep] -> Value # toEncodingList :: [RangeWithStep] -> Encoding #
ToJSON DbBackend #
Instance details Methods toJSON :: DbBackend -> Value # toEncoding :: DbBackend -> Encoding # toJSONList :: [DbBackend] -> Value # toEncodingList :: [DbBackend] -> Encoding #
ToJSON UpdateStrategy #
Instance details Methods toJSON :: UpdateStrategy -> Value # toEncoding :: UpdateStrategy -> Encoding # toJSONList :: [UpdateStrategy] -> Value # toEncodingList :: [UpdateStrategy] -> Encoding #
FromJSON SortKey #
Instance details Methods parseJSON :: Value -> Parser SortKey # parseJSONList :: Value -> Parser [SortKey] #
FromJSON SortStyle #
Instance details Methods parseJSON :: Value -> Parser SortStyle # parseJSONList :: Value -> Parser [SortStyle] #
FromJSON DistStyle #
Instance details Methods parseJSON :: Value -> Parser DistStyle # parseJSONList :: Value -> Parser [DistStyle] #
FromJSON WriteDisposition #
Instance details Methods parseJSON :: Value -> Parser WriteDisposition # parseJSONList :: Value -> Parser [WriteDisposition] #
FromJSON Partitioning #
Instance details Methods parseJSON :: Value -> Parser Partitioning # parseJSONList :: Value -> Parser [Partitioning] #
FromJSON RangeWithStep #
Instance details Methods parseJSON :: Value -> Parser RangeWithStep # parseJSONList :: Value -> Parser [RangeWithStep] #
FromJSON DbBackend #
Instance details Methods parseJSON :: Value -> Parser DbBackend # parseJSONList :: Value -> Parser [DbBackend] #
FromJSON UpdateStrategy #
Instance details Methods parseJSON :: Value -> Parser UpdateStrategy # parseJSONList :: Value -> Parser [UpdateStrategy] #