napkin-0.5.13
Copyright(c) Soostone Inc 2020
LicenseAllRightsReserved
Stabilityexperimental
PortabilityPOSIX
Safe HaskellNone
LanguageHaskell2010

Napkin.Spec.Dump

Description

dump Specs as dot or SQL files

Documentation

type OutputDirectory = FilePath #

type Force = Bool #

type HtmlOutput = Bool #

type DumpSpec b = (ReifiesBackend b, MustacheBackend b, RunBackendEffect b, DumpBackendRequirements b) #

runDump :: DumpSpec b => RuntimeEnv -> RawInterpretedSpec b -> OutputDirectory -> IncludeUnmanagedTables -> Force -> HtmlOutput -> DumpNameMode -> IO (Either (NonEmpty ValidationError) ()) #

data DumpNameMode #

Constructors

UseSpecNames 
UseDbNames 

Instances

Instances details
Eq DumpNameMode # 
Instance details

Defined in Napkin.Spec.Dump

Methods

(==) :: DumpNameMode -> DumpNameMode -> Bool #

(/=) :: DumpNameMode -> DumpNameMode -> Bool #

Show DumpNameMode # 
Instance details

Defined in Napkin.Spec.Dump

Methods

showsPrec :: Int -> DumpNameMode -> ShowS #

show :: DumpNameMode -> String #

showList :: [DumpNameMode] -> ShowS #

type WriteLog = (LText, [(LText, LText)]) #

renderTableSpec :: forall b. (DumpSpec b, Eq (DryRunResult b)) => RuntimeEnv -> InterpretedSpecEnvironment -> TableSpec b -> IO (Either WriteLog (WriteLog, WriteLog)) #

storeDependencyGraph :: SpecDepGraph -> FilePath -> HtmlOutput -> IO () #

specGraphAsDot :: SpecDepGraph -> DotGraph Int #

tableau10Colors :: [Color] #

tableau20Colors :: [Color] #

specGraphAsDotText :: SpecDepGraph -> Text #

newtype GraphJSON #

Constructors

GraphJSON 

Fields

Instances

Instances details
Generic GraphJSON # 
Instance details

Defined in Napkin.Spec.Dump

Associated Types

type Rep GraphJSON :: Type -> Type #

Methods

from :: GraphJSON -> Rep GraphJSON x #

to :: Rep GraphJSON x -> GraphJSON #

ToJSON GraphJSON # 
Instance details

Defined in Napkin.Spec.Dump

Methods

toJSON :: GraphJSON -> Value #

toEncoding :: GraphJSON -> Encoding #

toJSONList :: [GraphJSON] -> Value #

toEncodingList :: [GraphJSON] -> Encoding #

type Rep GraphJSON # 
Instance details

Defined in Napkin.Spec.Dump

type Rep GraphJSON = D1 ('MetaData "GraphJSON" "Napkin.Spec.Dump" "napkin-0.5.13-8705pBGlgyp7AIaYGNE2fM" 'True) (C1 ('MetaCons "GraphJSON" 'PrefixI 'True) (S1 ('MetaSel ('Just "managedTables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map (Ref Table) ManagedTable))))

data ManagedTable #

Constructors

ManagedTable 

Fields

Instances

Instances details
Generic ManagedTable # 
Instance details

Defined in Napkin.Spec.Dump

Associated Types

type Rep ManagedTable :: Type -> Type #

Methods

from :: ManagedTable -> Rep ManagedTable x #

to :: Rep ManagedTable x -> ManagedTable #

ToJSON ManagedTable # 
Instance details

Defined in Napkin.Spec.Dump

Methods

toJSON :: ManagedTable -> Value #

toEncoding :: ManagedTable -> Encoding #

toJSONList :: [ManagedTable] -> Value #

toEncodingList :: [ManagedTable] -> Encoding #

type Rep ManagedTable # 
Instance details

Defined in Napkin.Spec.Dump

type Rep ManagedTable = D1 ('MetaData "ManagedTable" "Napkin.Spec.Dump" "napkin-0.5.13-8705pBGlgyp7AIaYGNE2fM" 'False) (C1 ('MetaCons "ManagedTable" 'PrefixI 'True) (S1 ('MetaSel ('Just "dependencies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set (Ref Table))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set TableSpecTag)) :*: S1 ('MetaSel ('Just "artifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set (Ref Table))))))

toGraphJSON :: Specs b -> Map (Ref Table) (ProgramDependenciesAndQueries b) -> GraphJSON #

Orphan instances