Refurb.Cli

Module with optparse-applicative parsers for and datatypes to represent the command line arguments.

Documentation

newtype GoNoGo

Newtype wrapper for the --execute boolean (True if given, False if omitted)

Constructors

GoNoGo Bool

Instances

Eq GoNoGo

Methods

(==) :: GoNoGo -> GoNoGo -> Bool

(/=) :: GoNoGo -> GoNoGo -> Bool

Show GoNoGo

Methods

showsPrec :: Int -> GoNoGo -> ShowS

show :: GoNoGo -> String

showList :: [GoNoGo] -> ShowS

newtype PreMigrationBackup

Newtype wrapper for the --backup-first option to the migrate command.

Constructors

PreMigrationBackup FilePath

Instances

Eq PreMigrationBackup

Methods

(==) :: PreMigrationBackup -> PreMigrationBackup -> Bool

(/=) :: PreMigrationBackup -> PreMigrationBackup -> Bool

Show PreMigrationBackup

Methods

showsPrec :: Int -> PreMigrationBackup -> ShowS

show :: PreMigrationBackup -> String

showList :: [PreMigrationBackup] -> ShowS

newtype InstallSeedData

Newtype wrapper for the --seed boolean (True if given, False if omitted)

Constructors

InstallSeedData Bool

Instances

Eq InstallSeedData

Methods

(==) :: InstallSeedData -> InstallSeedData -> Bool

(/=) :: InstallSeedData -> InstallSeedData -> Bool

Show InstallSeedData

Methods

showsPrec :: Int -> InstallSeedData -> ShowS

show :: InstallSeedData -> String

showList :: [InstallSeedData] -> ShowS

data Command

The various top level commands that can be requested by the user

Constructors

CommandMigrate GoNoGo (Maybe PreMigrationBackup) InstallSeedData

Migrate the database or show what migrations would be applied, possibly backing up beforehand.

CommandShowLog

Show the migration status.

CommandShowMigration FQualifiedKey

Show status of a particular migration with its log output.

CommandBackup FilePath

Back up the database.

Instances

Eq Command

Methods

(==) :: Command -> Command -> Bool

(/=) :: Command -> Command -> Bool

Show Command

Methods

showsPrec :: Int -> Command -> ShowS

show :: Command -> String

showList :: [Command] -> ShowS

commandMigrateParser :: ParserInfo Command

Option parser for the migrate command

commandShowLogParser :: ParserInfo Command

Option parser for the show-log command

commandShowMigrationParser :: ParserInfo Command

Option parser for the show-migration command

commandBackupParser :: ParserInfo Command

Option parser for the backup command

data Opts

Structure holding the parsed command line arguments and options.

Constructors

Opts

Fields

• debug :: Bool

  Whether to turn on debug logging to the console

• colorize :: Bool

  Whether to colorize console output

• configFile :: FilePath

  The configuration file where (presumably) the database connection information is stored

• command :: Command

  Which command the user chose and the options for that command

optsParser :: ParserInfo Opts

Parser for the command line arguments