Moo.Core

Documentation

type AppT a = ReaderT AppState IO a

The monad in which the application runs.

type CommandHandler = StoreData -> AppT ()

The type of actions that are invoked to handle specific commands

data CommandOptions

CommandOptions are those options that can be specified at the command prompt to modify the behavior of a command.

Constructors

CommandOptions

Fields

• _configFilePath :: Maybe String
• _test :: Bool
• _noAsk :: Bool

data Command

A command has a name, a number of required arguments' labels, a number of optional arguments' labels, and an action to invoke.

Constructors

Command

Fields

• _cName :: String
• _cRequired :: [String]
• _cOptional :: [String]
• _cAllowedOptions :: [String]
• _cDescription :: String
• _cHandler :: CommandHandler

data AppState

Application state which can be accessed by any command handler.

Constructors

AppState

Fields

• _appOptions :: CommandOptions
• _appCommand :: Command
• _appRequiredArgs :: [String]
• _appOptionalArgs :: [String]
• _appBackend :: Backend
• _appStore :: MigrationStore
• _appStoreData :: StoreData
• _appLinearMigrations :: Bool
• _appTimestampFilenames :: Bool

data Configuration

Loading the configuration from a file or having it specified via environment |variables results in a value of type Configuration.

Constructors

Configuration

Fields

• _connectionString :: String
• _migrationStorePath :: FilePath
• _linearMigrations :: Bool
• _timestampFilenames :: Bool

Instances

Show Configuration

Methods

showsPrec :: Int -> Configuration -> ShowS

show :: Configuration -> String

showList :: [Configuration] -> ShowS

makeParameters :: Configuration -> Backend -> ExecutableParameters

data ExecutableParameters

A value of type ExecutableParameters is what a moo executable (moo-postgresql, |moo-mysql, etc.) pass to the core package when they want to execute a |command.

Constructors

ExecutableParameters

Fields

• _parametersBackend :: Backend
• _parametersMigrationStorePath :: FilePath
• _parametersLinearMigrations :: Bool
• _parametersTimestampFilenames :: Bool

Instances

Show ExecutableParameters

Methods

showsPrec :: Int -> ExecutableParameters -> ShowS

show :: ExecutableParameters -> String

showList :: [ExecutableParameters] -> ShowS

envDatabaseName :: String

envLinearMigrations :: String

envStoreName :: String

loadConfiguration :: Maybe FilePath -> IO (Either String Configuration)

Loads config file (falling back to default one if not specified) and then overrides configuration with an environment.