Safe Haskell	None
Language	Haskell2010

Database.Postgres.Temp.Internal.Config

Description

This module provides types and functions for combining partial configs into a complete configs to ultimately make a CompletePlan.

This module has two classes of types.

Types like ProcessConfig that could be used by any library that needs to combine process options.

Finally it has types and functions for creating CompletePlans that use temporary resources. This is used to create the default behavior of startConfig and related functions. |

Synopsis

data Accum a
- = DontCare
- | Zlich
- | Merge a
data EnvironmentVariables = EnvironmentVariables {
- inherit :: Last Bool
- specific :: Map String String
}
completeEnvironmentVariables :: [(String, String)] -> EnvironmentVariables -> Either [String] [(String, String)]
data CommandLineArgs = CommandLineArgs {
- keyBased :: Map String (Maybe String)
- indexBased :: Map Int String
}
completeCommandLineArgs :: CommandLineArgs -> [String]
data ProcessConfig = ProcessConfig {
- environmentVariables :: EnvironmentVariables
- commandLine :: CommandLineArgs
- stdIn :: Last Handle
- stdOut :: Last Handle
- stdErr :: Last Handle
}
standardProcessConfig :: ProcessConfig
devNull :: Handle
silentProcessConfig :: ProcessConfig
completeProcessConfig :: [(String, String)] -> ProcessConfig -> Either [String] CompleteProcessConfig
data CompleteDirectoryType
- = CPermanent FilePath
- | CTemporary FilePath
toFilePath :: CompleteDirectoryType -> FilePath
data DirectoryType
- = Permanent FilePath
- | Temporary
setupDirectoryType :: String -> String -> DirectoryType -> IO CompleteDirectoryType
cleanupDirectoryType :: CompleteDirectoryType -> IO ()
data PostgresPlan = PostgresPlan {
- postgresConfig :: ProcessConfig
- connectionOptions :: Options
}
completePostgresPlan :: [(String, String)] -> PostgresPlan -> Either [String] CompletePostgresPlan
data Plan = Plan {
- logger :: Last Logger
- initDbConfig :: Accum ProcessConfig
- copyConfig :: Last (Maybe CopyDirectoryCommand)
- createDbConfig :: Accum ProcessConfig
- postgresPlan :: PostgresPlan
- postgresConfigFile :: [String]
- dataDirectoryString :: Last String
- connectionTimeout :: Last Int
}
completePlan :: [(String, String)] -> Plan -> Either [String] CompletePlan
data Config = Config {
- plan :: Plan
- socketDirectory :: DirectoryType
- dataDirectory :: DirectoryType
- port :: Last (Maybe Int)
- temporaryDirectory :: Last FilePath
- initDbCache :: Last (Maybe (Bool, FilePath))
}
data CopyDirectoryCommand = CopyDirectoryCommand {
- sourceDirectory :: FilePath
- destinationDirectory :: Maybe FilePath
- useCopyOnWrite :: Bool
}
toPlan :: Bool -> Bool -> Int -> FilePath -> FilePath -> Plan
combinePlans :: Plan -> Plan -> Plan
setupConfig :: Config -> IO Resources
cleanupConfig :: Resources -> IO ()
prettyPrintConfig :: Config -> String
data Resources = Resources {
- resourcesPlan :: CompletePlan
- resourcesSocketDirectory :: CompleteDirectoryType
- resourcesDataDir :: CompleteDirectoryType
- resourcesTemporaryDir :: FilePath
- resourcesInitDbCache :: Maybe (Bool, FilePath)
}
makeResourcesDataDirPermanent :: Resources -> Resources
optionsToConfig :: Options -> Config
type Lens s t a b = forall f. Functor f => (a -> f b) -> s -> f t
type Lens' s a = Lens s s a a
inheritL :: Lens' EnvironmentVariables (Last Bool)
specificL :: Lens' EnvironmentVariables (Map String String)
commandLineL :: Lens' ProcessConfig CommandLineArgs
environmentVariablesL :: Lens' ProcessConfig EnvironmentVariables
stdErrL :: Lens' ProcessConfig (Last Handle)
stdInL :: Lens' ProcessConfig (Last Handle)
stdOutL :: Lens' ProcessConfig (Last Handle)
connectionOptionsL :: Lens' PostgresPlan Options
postgresConfigL :: Lens' PostgresPlan ProcessConfig
postgresConfigFileL :: Lens' Plan [String]
createDbConfigL :: Lens' Plan (Accum ProcessConfig)
dataDirectoryStringL :: Lens' Plan (Last String)
copyConfigL :: Lens' Plan (Last (Maybe CopyDirectoryCommand))
initDbConfigL :: Lens' Plan (Accum ProcessConfig)
loggerL :: Lens' Plan (Last Logger)
postgresPlanL :: Lens' Plan PostgresPlan
connectionTimeoutL :: Lens' Plan (Last Int)
resourcesDataDirL :: Lens' Resources CompleteDirectoryType
resourcesPlanL :: Lens' Resources CompletePlan
resourcesSocketDirectoryL :: Lens' Resources CompleteDirectoryType
dataDirectoryL :: Lens' Config DirectoryType
planL :: Lens' Config Plan
portL :: Lens' Config (Last (Maybe Int))
socketDirectoryL :: Lens' Config DirectoryType
temporaryDirectoryL :: Lens' Config (Last FilePath)
indexBasedL :: Lens' CommandLineArgs (Map Int String)
keyBasedL :: Lens' CommandLineArgs (Map String (Maybe String))
sourceDirectoryL :: Lens' CopyDirectoryCommand FilePath
destinationDirectoryL :: Lens' CopyDirectoryCommand (Maybe FilePath)
useCopyOnWriteL :: Lens' CopyDirectoryCommand Bool

Documentation

data Accum a Source #

Accum is a monoid.

It's <> behavior is analogous to 1 and 0 with *. Think of DontCare as 1 and Zlich as 0.

The behavior of Merge is like Justs.

Since: 1.17.0.0

Constructors

DontCare
Zlich
Merge a

Instances

Functor Accum Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods fmap :: (a -> b) -> Accum a -> Accum b # (<$) :: a -> Accum b -> Accum a #
Applicative Accum Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods pure :: a -> Accum a # (<>) :: Accum (a -> b) -> Accum a -> Accum b # liftA2 :: (a -> b -> c) -> Accum a -> Accum b -> Accum c # (>) :: Accum a -> Accum b -> Accum b # (<*) :: Accum a -> Accum b -> Accum a #
Eq a => Eq (Accum a) Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods (==) :: Accum a -> Accum a -> Bool # (/=) :: Accum a -> Accum a -> Bool #
Ord a => Ord (Accum a) Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods compare :: Accum a -> Accum a -> Ordering # (<) :: Accum a -> Accum a -> Bool # (<=) :: Accum a -> Accum a -> Bool # (>) :: Accum a -> Accum a -> Bool # (>=) :: Accum a -> Accum a -> Bool # max :: Accum a -> Accum a -> Accum a # min :: Accum a -> Accum a -> Accum a #
Show a => Show (Accum a) Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods showsPrec :: Int -> Accum a -> ShowS # show :: Accum a -> String # showList :: [Accum a] -> ShowS #
Semigroup a => Semigroup (Accum a) Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods (<>) :: Accum a -> Accum a -> Accum a # sconcat :: NonEmpty (Accum a) -> Accum a # stimes :: Integral b => b -> Accum a -> Accum a #
Monoid a => Monoid (Accum a) Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods mempty :: Accum a # mappend :: Accum a -> Accum a -> Accum a # mconcat :: [Accum a] -> Accum a #

data EnvironmentVariables Source #

The environment variables can be declared to inherit from the running process or they can be specifically added.

Since: 1.12.0.0

Constructors

EnvironmentVariables
Fields inherit :: Last Bool specific :: Map String String

Instances

Eq EnvironmentVariables Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods (==) :: EnvironmentVariables -> EnvironmentVariables -> Bool # (/=) :: EnvironmentVariables -> EnvironmentVariables -> Bool #
Show EnvironmentVariables Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods showsPrec :: Int -> EnvironmentVariables -> ShowS # show :: EnvironmentVariables -> String # showList :: [EnvironmentVariables] -> ShowS #
Generic EnvironmentVariables Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Associated Types type Rep EnvironmentVariables :: Type -> Type # Methods from :: EnvironmentVariables -> Rep EnvironmentVariables x # to :: Rep EnvironmentVariables x -> EnvironmentVariables #
Semigroup EnvironmentVariables Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods (<>) :: EnvironmentVariables -> EnvironmentVariables -> EnvironmentVariables # sconcat :: NonEmpty EnvironmentVariables -> EnvironmentVariables # stimes :: Integral b => b -> EnvironmentVariables -> EnvironmentVariables #
Monoid EnvironmentVariables Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods mempty :: EnvironmentVariables # mappend :: EnvironmentVariables -> EnvironmentVariables -> EnvironmentVariables # mconcat :: [EnvironmentVariables] -> EnvironmentVariables #
Pretty EnvironmentVariables Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods pretty :: EnvironmentVariables -> Doc # prettyList :: [EnvironmentVariables] -> Doc #
type Rep EnvironmentVariables Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config type Rep EnvironmentVariables = D1 (MetaData "EnvironmentVariables" "Database.Postgres.Temp.Internal.Config" "tmp-postgres-1.18.0.0-3zAVDgGXkhX8ftoAHhxe1t" False) (C1 (MetaCons "EnvironmentVariables" PrefixI True) (S1 (MetaSel (Just "inherit") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last Bool)) :*: S1 (MetaSel (Just "specific") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map String String))))

completeEnvironmentVariables :: [(String, String)] -> EnvironmentVariables -> Either [String] [(String, String)] Source #

Combine the current environment (if indicated by inherit) with specific.

Since: 1.12.0.0

data CommandLineArgs Source #

A type to help combine command line Args.

Since: 1.12.0.0

Constructors

CommandLineArgs

Fields

keyBased :: Map String (Maybe String)
Args of the form -h foo, --host=foo and --switch. The key is mappended with value so the key should include the space or equals (as shown in the first two examples respectively). The Dual monoid is used so the last key wins.
indexBased :: Map Int String
Args that appear at the end of the key based Args. The Dual monoid is used so the last key wins.

Instances

Eq CommandLineArgs Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods (==) :: CommandLineArgs -> CommandLineArgs -> Bool # (/=) :: CommandLineArgs -> CommandLineArgs -> Bool #
Show CommandLineArgs Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods showsPrec :: Int -> CommandLineArgs -> ShowS # show :: CommandLineArgs -> String # showList :: [CommandLineArgs] -> ShowS #
Generic CommandLineArgs Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Associated Types type Rep CommandLineArgs :: Type -> Type # Methods from :: CommandLineArgs -> Rep CommandLineArgs x # to :: Rep CommandLineArgs x -> CommandLineArgs #
Semigroup CommandLineArgs Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods (<>) :: CommandLineArgs -> CommandLineArgs -> CommandLineArgs # sconcat :: NonEmpty CommandLineArgs -> CommandLineArgs # stimes :: Integral b => b -> CommandLineArgs -> CommandLineArgs #
Monoid CommandLineArgs Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods mempty :: CommandLineArgs # mappend :: CommandLineArgs -> CommandLineArgs -> CommandLineArgs # mconcat :: [CommandLineArgs] -> CommandLineArgs #
Pretty CommandLineArgs Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods pretty :: CommandLineArgs -> Doc # prettyList :: [CommandLineArgs] -> Doc #
type Rep CommandLineArgs Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config type Rep CommandLineArgs = D1 (MetaData "CommandLineArgs" "Database.Postgres.Temp.Internal.Config" "tmp-postgres-1.18.0.0-3zAVDgGXkhX8ftoAHhxe1t" False) (C1 (MetaCons "CommandLineArgs" PrefixI True) (S1 (MetaSel (Just "keyBased") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map String (Maybe String))) :*: S1 (MetaSel (Just "indexBased") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map Int String))))

completeCommandLineArgs :: CommandLineArgs -> [String] Source #

This convert the CommandLineArgs to '[String]'.

Since: 1.12.0.0

data ProcessConfig Source #

Process configuration

Since: 1.12.0.0

Constructors

ProcessConfig

Fields

environmentVariables :: EnvironmentVariables
A monoid for combine environment variables or replacing them. for the maps the Dual monoid is used. So the last key wins.
commandLine :: CommandLineArgs
A monoid for combine command line Args or replacing them.
stdIn :: Last Handle
A monoid for configuring the standard input Handle.
stdOut :: Last Handle
A monoid for configuring the standard output Handle.
stdErr :: Last Handle
A monoid for configuring the standard error Handle.

Instances

Eq ProcessConfig Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods (==) :: ProcessConfig -> ProcessConfig -> Bool # (/=) :: ProcessConfig -> ProcessConfig -> Bool #
Show ProcessConfig Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods showsPrec :: Int -> ProcessConfig -> ShowS # show :: ProcessConfig -> String # showList :: [ProcessConfig] -> ShowS #
Generic ProcessConfig Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Associated Types type Rep ProcessConfig :: Type -> Type # Methods from :: ProcessConfig -> Rep ProcessConfig x # to :: Rep ProcessConfig x -> ProcessConfig #
Semigroup ProcessConfig Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods (<>) :: ProcessConfig -> ProcessConfig -> ProcessConfig # sconcat :: NonEmpty ProcessConfig -> ProcessConfig # stimes :: Integral b => b -> ProcessConfig -> ProcessConfig #
Monoid ProcessConfig Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods mempty :: ProcessConfig # mappend :: ProcessConfig -> ProcessConfig -> ProcessConfig # mconcat :: [ProcessConfig] -> ProcessConfig #
Pretty ProcessConfig Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods pretty :: ProcessConfig -> Doc # prettyList :: [ProcessConfig] -> Doc #
type Rep ProcessConfig Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config type Rep ProcessConfig = D1 (MetaData "ProcessConfig" "Database.Postgres.Temp.Internal.Config" "tmp-postgres-1.18.0.0-3zAVDgGXkhX8ftoAHhxe1t" False) (C1 (MetaCons "ProcessConfig" PrefixI True) ((S1 (MetaSel (Just "environmentVariables") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 EnvironmentVariables) :: S1 (MetaSel (Just "commandLine") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CommandLineArgs)) :: (S1 (MetaSel (Just "stdIn") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last Handle)) :: (S1 (MetaSel (Just "stdOut") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last Handle)) :: S1 (MetaSel (Just "stdErr") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last Handle))))))

standardProcessConfig :: ProcessConfig Source #

The standardProcessConfig sets the handles to stdin, stdout and stderr and inherits the environment variables from the calling process.

Since: 1.12.0.0

devNull :: Handle Source #

A global reference to /dev/null Handle.

Since: 1.12.0.0

silentProcessConfig :: ProcessConfig Source #

silentProcessConfig sets the handles to /dev/null and inherits the environment variables from the calling process.

Since: 1.12.0.0

completeProcessConfig :: [(String, String)] -> ProcessConfig -> Either [String] CompleteProcessConfig Source #

Turn a ProcessConfig into a ProcessConfig. Fails if any values are missing.

Since: 1.12.0.0

data CompleteDirectoryType Source #

A type to track whether a file is temporary and needs to be cleaned up.

Since: 1.12.0.0

Constructors

CPermanent FilePath
CTemporary FilePath

Instances

Eq CompleteDirectoryType Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods (==) :: CompleteDirectoryType -> CompleteDirectoryType -> Bool # (/=) :: CompleteDirectoryType -> CompleteDirectoryType -> Bool #
Ord CompleteDirectoryType Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods compare :: CompleteDirectoryType -> CompleteDirectoryType -> Ordering # (<) :: CompleteDirectoryType -> CompleteDirectoryType -> Bool # (<=) :: CompleteDirectoryType -> CompleteDirectoryType -> Bool # (>) :: CompleteDirectoryType -> CompleteDirectoryType -> Bool # (>=) :: CompleteDirectoryType -> CompleteDirectoryType -> Bool # max :: CompleteDirectoryType -> CompleteDirectoryType -> CompleteDirectoryType # min :: CompleteDirectoryType -> CompleteDirectoryType -> CompleteDirectoryType #
Show CompleteDirectoryType Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods showsPrec :: Int -> CompleteDirectoryType -> ShowS # show :: CompleteDirectoryType -> String # showList :: [CompleteDirectoryType] -> ShowS #
Generic CompleteDirectoryType Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Associated Types type Rep CompleteDirectoryType :: Type -> Type # Methods from :: CompleteDirectoryType -> Rep CompleteDirectoryType x # to :: Rep CompleteDirectoryType x -> CompleteDirectoryType #
Pretty CompleteDirectoryType Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods pretty :: CompleteDirectoryType -> Doc # prettyList :: [CompleteDirectoryType] -> Doc #
NFData CompleteDirectoryType Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods rnf :: CompleteDirectoryType -> () #
type Rep CompleteDirectoryType Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config type Rep CompleteDirectoryType = D1 (MetaData "CompleteDirectoryType" "Database.Postgres.Temp.Internal.Config" "tmp-postgres-1.18.0.0-3zAVDgGXkhX8ftoAHhxe1t" False) (C1 (MetaCons "CPermanent" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :+: C1 (MetaCons "CTemporary" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)))

toFilePath :: CompleteDirectoryType -> FilePath Source #

Get the file path of a CompleteDirectoryType, regardless if it is a CPermanent or CTemporary type.

Since: 1.12.0.0

data DirectoryType Source #

Used to specify a Temporary folder that is automatically cleaned up or a Permanent folder which is not automatically cleaned up.

Since: 1.12.0.0

Constructors

Permanent FilePath	A permanent file that should not be generated.
Temporary	A temporary file that needs to generated.

Instances

Eq DirectoryType Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods (==) :: DirectoryType -> DirectoryType -> Bool # (/=) :: DirectoryType -> DirectoryType -> Bool #
Ord DirectoryType Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods compare :: DirectoryType -> DirectoryType -> Ordering # (<) :: DirectoryType -> DirectoryType -> Bool # (<=) :: DirectoryType -> DirectoryType -> Bool # (>) :: DirectoryType -> DirectoryType -> Bool # (>=) :: DirectoryType -> DirectoryType -> Bool # max :: DirectoryType -> DirectoryType -> DirectoryType # min :: DirectoryType -> DirectoryType -> DirectoryType #
Show DirectoryType Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods showsPrec :: Int -> DirectoryType -> ShowS # show :: DirectoryType -> String # showList :: [DirectoryType] -> ShowS #
Semigroup DirectoryType Source #	Takes the last `Permanent` value.
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods (<>) :: DirectoryType -> DirectoryType -> DirectoryType # sconcat :: NonEmpty DirectoryType -> DirectoryType # stimes :: Integral b => b -> DirectoryType -> DirectoryType #
Monoid DirectoryType Source #	`Temporary` as `mempty`
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods mempty :: DirectoryType # mappend :: DirectoryType -> DirectoryType -> DirectoryType # mconcat :: [DirectoryType] -> DirectoryType #
Pretty DirectoryType Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods pretty :: DirectoryType -> Doc # prettyList :: [DirectoryType] -> Doc #

setupDirectoryType Source #

Arguments

:: String	Temporary directory configuration
-> String	Directory pattern
-> DirectoryType
-> IO CompleteDirectoryType

Either create aCTemporary directory or do nothing to a CPermanent one.

Since: 1.12.0.0

cleanupDirectoryType :: CompleteDirectoryType -> IO () Source #

Either remove a CTemporary directory or do nothing to a CPermanent one.

data PostgresPlan Source #

postgres process config and corresponding client connection Options.

Since: 1.12.0.0

Constructors

PostgresPlan
Fields postgresConfig :: ProcessConfig Monoid for the `postgres` ProcessConfig. connectionOptions :: Options Monoid for the `postgres` client connection options.

Instances

Generic PostgresPlan Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Associated Types type Rep PostgresPlan :: Type -> Type # Methods from :: PostgresPlan -> Rep PostgresPlan x # to :: Rep PostgresPlan x -> PostgresPlan #
Semigroup PostgresPlan Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods (<>) :: PostgresPlan -> PostgresPlan -> PostgresPlan # sconcat :: NonEmpty PostgresPlan -> PostgresPlan # stimes :: Integral b => b -> PostgresPlan -> PostgresPlan #
Monoid PostgresPlan Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods mempty :: PostgresPlan # mappend :: PostgresPlan -> PostgresPlan -> PostgresPlan # mconcat :: [PostgresPlan] -> PostgresPlan #
Pretty PostgresPlan Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods pretty :: PostgresPlan -> Doc # prettyList :: [PostgresPlan] -> Doc #
type Rep PostgresPlan Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config type Rep PostgresPlan = D1 (MetaData "PostgresPlan" "Database.Postgres.Temp.Internal.Config" "tmp-postgres-1.18.0.0-3zAVDgGXkhX8ftoAHhxe1t" False) (C1 (MetaCons "PostgresPlan" PrefixI True) (S1 (MetaSel (Just "postgresConfig") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ProcessConfig) :*: S1 (MetaSel (Just "connectionOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Options)))

completePostgresPlan :: [(String, String)] -> PostgresPlan -> Either [String] CompletePostgresPlan Source #

Turn a PostgresPlan into a CompletePostgresPlan. Fails if any values are missing.

data Plan Source #

Describe how to run initdb, createdb and postgres

Since: 1.16.0.0

Constructors

Plan
Fields logger :: Last Logger initDbConfig :: Accum ProcessConfig copyConfig :: Last (Maybe CopyDirectoryCommand) createDbConfig :: Accum ProcessConfig postgresPlan :: PostgresPlan postgresConfigFile :: [String] dataDirectoryString :: Last String connectionTimeout :: Last Int Max time to spend attempting to connection to `postgres`. Time is in microseconds.

Instances

Generic Plan Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Associated Types type Rep Plan :: Type -> Type # Methods from :: Plan -> Rep Plan x # to :: Rep Plan x -> Plan #
Semigroup Plan Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods (<>) :: Plan -> Plan -> Plan # sconcat :: NonEmpty Plan -> Plan # stimes :: Integral b => b -> Plan -> Plan #
Monoid Plan Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods mempty :: Plan # mappend :: Plan -> Plan -> Plan # mconcat :: [Plan] -> Plan #
Pretty Plan Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods pretty :: Plan -> Doc # prettyList :: [Plan] -> Doc #
type Rep Plan Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config type Rep Plan = D1 (MetaData "Plan" "Database.Postgres.Temp.Internal.Config" "tmp-postgres-1.18.0.0-3zAVDgGXkhX8ftoAHhxe1t" False) (C1 (MetaCons "Plan" PrefixI True) (((S1 (MetaSel (Just "logger") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last Logger)) :: S1 (MetaSel (Just "initDbConfig") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Accum ProcessConfig))) :: (S1 (MetaSel (Just "copyConfig") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last (Maybe CopyDirectoryCommand))) :: S1 (MetaSel (Just "createDbConfig") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Accum ProcessConfig)))) :: ((S1 (MetaSel (Just "postgresPlan") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostgresPlan) :: S1 (MetaSel (Just "postgresConfigFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])) :: (S1 (MetaSel (Just "dataDirectoryString") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last String)) :*: S1 (MetaSel (Just "connectionTimeout") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last Int))))))

completePlan :: [(String, String)] -> Plan -> Either [String] CompletePlan Source #

Turn a Plan into a CompletePlan. Fails if any values are missing.

data Config Source #

The high level options for overriding default behavior.

Since: 1.16.0.0

Constructors

Config

Fields

plan :: Plan
Extend or replace any of the configuration used to create a final CompletePlan.
socketDirectory :: DirectoryType
Override the default temporary UNIX socket directory by setting this.
dataDirectory :: DirectoryType
Override the default temporary data directory by passing in Permanent DIRECTORY.
port :: Last (Maybe Int)
A monoid for using an existing port (via Just PORT_NUMBER) or requesting a free port (via a Nothing).
temporaryDirectory :: Last FilePath
The directory used to create other temporary directories. Defaults to /tmp.
initDbCache :: Last (Maybe (Bool, FilePath))

Instances

Generic Config Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Associated Types type Rep Config :: Type -> Type # Methods from :: Config -> Rep Config x # to :: Rep Config x -> Config #
Semigroup Config Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods (<>) :: Config -> Config -> Config # sconcat :: NonEmpty Config -> Config # stimes :: Integral b => b -> Config -> Config #
Monoid Config Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods mempty :: Config # mappend :: Config -> Config -> Config # mconcat :: [Config] -> Config #
Pretty Config Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods pretty :: Config -> Doc # prettyList :: [Config] -> Doc #
type Rep Config Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config type Rep Config = D1 (MetaData "Config" "Database.Postgres.Temp.Internal.Config" "tmp-postgres-1.18.0.0-3zAVDgGXkhX8ftoAHhxe1t" False) (C1 (MetaCons "Config" PrefixI True) ((S1 (MetaSel (Just "plan") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Plan) :: (S1 (MetaSel (Just "socketDirectory") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 DirectoryType) :: S1 (MetaSel (Just "dataDirectory") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 DirectoryType))) :: (S1 (MetaSel (Just "port") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last (Maybe Int))) :: (S1 (MetaSel (Just "temporaryDirectory") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last FilePath)) :*: S1 (MetaSel (Just "initDbCache") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last (Maybe (Bool, FilePath))))))))

data CopyDirectoryCommand Source #

Copy command used to create a data directory. If initdb used to create the data directory directly this is not needed.

If destinationDirectory is Nothing then the dataDirectoryString (which might be generated) is used.

Since: 1.16.0.0

Constructors

CopyDirectoryCommand
Fields sourceDirectory :: FilePath destinationDirectory :: Maybe FilePath useCopyOnWrite :: Bool

Instances

Eq CopyDirectoryCommand Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods (==) :: CopyDirectoryCommand -> CopyDirectoryCommand -> Bool # (/=) :: CopyDirectoryCommand -> CopyDirectoryCommand -> Bool #
Ord CopyDirectoryCommand Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods compare :: CopyDirectoryCommand -> CopyDirectoryCommand -> Ordering # (<) :: CopyDirectoryCommand -> CopyDirectoryCommand -> Bool # (<=) :: CopyDirectoryCommand -> CopyDirectoryCommand -> Bool # (>) :: CopyDirectoryCommand -> CopyDirectoryCommand -> Bool # (>=) :: CopyDirectoryCommand -> CopyDirectoryCommand -> Bool # max :: CopyDirectoryCommand -> CopyDirectoryCommand -> CopyDirectoryCommand # min :: CopyDirectoryCommand -> CopyDirectoryCommand -> CopyDirectoryCommand #
Show CopyDirectoryCommand Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods showsPrec :: Int -> CopyDirectoryCommand -> ShowS # show :: CopyDirectoryCommand -> String # showList :: [CopyDirectoryCommand] -> ShowS #
Pretty CopyDirectoryCommand Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods pretty :: CopyDirectoryCommand -> Doc # prettyList :: [CopyDirectoryCommand] -> Doc #

toPlan Source #

Arguments

:: Bool	Make `initdb` options.
-> Bool	Make `createdb` options.
-> Int	The port.
-> FilePath	Socket directory.
-> FilePath	The `postgres` data directory.
-> Plan

Create a Plan that sets the command line options of all processes (initdb, postgres and createdb). This the generated plan that is combined with the extra plan from startConfig.

combinePlans :: Plan -> Plan -> Plan Source #

combinePlans is almost <>. However the Last monoid for createdb and initdb plans are not used. Instead something like Lastoid is.

setupConfig Source #

Arguments

:: Config	`extra` `Config` to `mappend` after the `generated` `Config`.
-> IO Resources

Create all the temporary resources from a Config. This also combines the Plan from toPlan with the extra Config passed in.

cleanupConfig :: Resources -> IO () Source #

Free the temporary resources created by setupConfig.

prettyPrintConfig :: Config -> String Source #

Display a Config.

Since: 1.12.0.0

data Resources Source #

Resources holds a description of the temporary folders (if there are any) and includes the final CompletePlan that can be used with startPlan. See setupConfig for an example of how to create a Resources.

Since: 1.12.0.0

Constructors

Resources

Fields

resourcesPlan :: CompletePlan
Final CompletePlan. See startPlan for information on CompletePlans.
resourcesSocketDirectory :: CompleteDirectoryType
The used to potentially cleanup the temporary unix socket directory.
resourcesDataDir :: CompleteDirectoryType
The data directory. Used to track if a temporary directory was used.
resourcesTemporaryDir :: FilePath
The directory where other temporary directories are created. Usually @/tmp.
resourcesInitDbCache :: Maybe (Bool, FilePath)

Instances

Pretty Resources Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods pretty :: Resources -> Doc # prettyList :: [Resources] -> Doc #

makeResourcesDataDirPermanent :: Resources -> Resources Source #

Make the resourcesDataDir CPermanent so it will not get cleaned up.

Since: 1.12.0.0

optionsToConfig :: Options -> Config Source #

Attempt to create a config from a Options. This is useful if want to create a database owned by a specific user you will also log in as among other use cases. It is possible some Options are not supported so don't hesitate to open an issue on github if you find one.

type Lens s t a b = forall f. Functor f => (a -> f b) -> s -> f t Source #

Local Lens alias.

type Lens' s a = Lens s s a a Source #

Local Lens' alias.

inheritL :: Lens' EnvironmentVariables (Last Bool) Source #

Lens for inherit

Since: 1.12.0.0

specificL :: Lens' EnvironmentVariables (Map String String) Source #

Lens for specific.

Since: 1.12.0.0

commandLineL :: Lens' ProcessConfig CommandLineArgs Source #

Lens for commandLine.