Safe Haskell	None
Language	Haskell2010

Moo.Core

Synopsis

type AppT a = ReaderT AppState IO a
type CommandHandler = StoreData -> AppT ()
data CommandOptions = CommandOptions {
- _configFilePath :: Maybe String
- _test :: Bool
- _noAsk :: Bool
}
data Command = Command {
- _cName :: String
- _cRequired :: [String]
- _cOptional :: [String]
- _cAllowedOptions :: [String]
- _cDescription :: String
- _cHandler :: CommandHandler
}
data AppState = AppState {
- _appOptions :: CommandOptions
- _appCommand :: Command
- _appRequiredArgs :: [Text]
- _appOptionalArgs :: [Text]
- _appBackend :: Backend
- _appStore :: MigrationStore
- _appStoreData :: StoreData
- _appLinearMigrations :: Bool
- _appTimestampFilenames :: Bool
}
data Configuration = Configuration {
- _connectionString :: String
- _migrationStorePath :: FilePath
- _linearMigrations :: Bool
- _timestampFilenames :: Bool
}
makeParameters :: Configuration -> Backend -> ExecutableParameters
data ExecutableParameters = ExecutableParameters {
}
envDatabaseName :: String
envLinearMigrations :: String
envStoreName :: String
loadConfiguration :: Maybe FilePath -> IO (Either String Configuration)

Documentation

type AppT a = ReaderT AppState IO a Source #

The monad in which the application runs.

type CommandHandler = StoreData -> AppT () Source #

The type of actions that are invoked to handle specific commands

data CommandOptions Source #

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 Source #

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 Source #

Application state which can be accessed by any command handler.

Constructors

AppState
Fields _appOptions :: CommandOptions _appCommand :: Command _appRequiredArgs :: [Text] _appOptionalArgs :: [Text] _appBackend :: Backend _appStore :: MigrationStore _appStoreData :: StoreData _appLinearMigrations :: Bool _appTimestampFilenames :: Bool

data Configuration Source #

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

Instances details

Show Configuration Source #
Instance details Defined in Moo.Core Methods showsPrec :: Int -> Configuration -> ShowS # show :: Configuration -> String # showList :: [Configuration] -> ShowS #

makeParameters :: Configuration -> Backend -> ExecutableParameters Source #

data ExecutableParameters Source #

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

Instances details

Show ExecutableParameters Source #
Instance details Defined in Moo.Core Methods showsPrec :: Int -> ExecutableParameters -> ShowS # show :: ExecutableParameters -> String # showList :: [ExecutableParameters] -> ShowS #

envDatabaseName :: String Source #

envLinearMigrations :: String Source #

envStoreName :: String Source #

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

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