Documentation

Fields

• description :: Text
   
• argumentType :: YamlArgumentType
   
• defaultValue :: Maybe Value
   

Fields

• packageType :: HaskellPackageType
   
• path :: FilePath
   
• library :: Maybe Text
   

Fields

• appName :: AppName

  indicate folders within project to scan for SQL and other app-namespace

• sqlFolder :: FilePath

  source files. By default should be sql

• connectionURL :: ConnectionString

  URL to indicate how to create the database connection

• metadataConnectionURL :: Maybe KVSConnectionString

  URL to indicate where metadata should be stored

• tableSpecs :: Map SpecTableName (YamlTableSpec b)
   
• backend :: DbBackendOptions b

  indicate backend to be used in this spec

• parserDialect :: SQLDialect
   
• specPreprocessors :: [YamlPreprocessor b]

  specify a function to run as the napkin spec preprocessor

• validator :: Maybe (Typed CustomValidator ModuleFunction)
   
• cli :: Maybe (Typed (CLIProgram b) ModuleFunction)

  specify a function to run as the napkin validator

• haskellPackage :: Maybe HaskellPackage

  specify the source directory for the hpack or cabal file

• haskellFolders :: Set FilePath

  folders used to find the Haskell source code. When not provided, assumed to be haskell/

• extraHaskellDependencies :: Set Package

  specify additional packages which should be exposed to the haskell functions in the YAML spec

• defaultHaskellLanguageExtensions :: Set YamlHaskellExtension

  specify default haskell language extensions enabled in haskell modules

• extraHaskellModules :: [Module]

  specify extra haskell module that should be loaded into interpreter environment, they can be referenced in mustache templates

• haskellSpec :: Maybe (Typed (Spec b ()) ModuleFunction)

  specify extra haskell modules that should be loaded into interpreter environment, they can be referenced in mustache templates

• haskellSpecs :: [Typed (Spec b ()) ModuleFunction]

  specify an additional Haskell function to run in the Spec monad after all the TableSpecs.

• arguments :: Map Text YamlArgument

  definition of the meta arguments to use in a spec.

• externalTables :: Maybe [Text]

  Un-managed tables specified in spec as un-managed.

• mergeStrategy :: SpecFileArrayMergeStrategy

  Strategy to use when merging multiple spec files together.

Fields

• createAction :: YamlSpecProgram b
   
• preHooks :: [YamlHook b]
   
• postHooks :: [YamlHook b]
   
• updateStrategy :: [UpdateStrategy]
   
• tags :: [TableSpecTag]
   
• deps :: [Ref Table]
   
• hiddenDeps :: [Ref Table]
   
• parserDialect :: Maybe SQLDialect
   
• notes :: Map (Ref SExp) Text
   
• description :: Maybe Text
   

Fields

• extension :: HaskellExtension