Moduletmp-postgres-1.35.0.0Haskell2010

Database.Postgres.Temp.Internal.Config

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

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 Plans that use temporary resources. This is used to create the default behavior of Database.Postgres.Temp.startConfig and related functions. |

9 types
46 values

Packagetmp-postgres-1.35.0.0
Exports55
LanguageHaskell2010
LicenceBSD-3-Clause
SourceConfig.hs

datadata Accum a

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.

Constructors

DontCare
Zlich
Merge a

Instances7Functor, Applicative, Eq, Ord, Show, Semigroup, …

Functor AccumDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Applicative AccumDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Eq a => Eq (Accum a)Defined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Ord a => Ord (Accum a)Defined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Show a => Show (Accum a)Defined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Semigroup a => Semigroup (Accum a)Defined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Monoid a => Monoid (Accum a)Defined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config

valuegetAccum :: Accum a -> Maybe a

valueprettyMap :: (Pretty a, Pretty b) => Map a b -> Doc ann

datadata EnvironmentVariables

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

Constructors

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

Instances7Eq, Show, Generic, Semigroup, Monoid, Pretty, …

Eq EnvironmentVariablesDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Show EnvironmentVariablesDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Generic EnvironmentVariablesDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Semigroup EnvironmentVariablesDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Monoid EnvironmentVariablesDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Pretty EnvironmentVariablesDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
type Rep EnvironmentVariables = D1 ('MetaData "EnvironmentVariables" "Database.Postgres.Temp.Internal.Config" "tmp-postgres-1.35.0.0-8d3UBzJp08JWt8Eyo3xTt" '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))))Defined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config

valuecompleteEnvironmentVariables

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

datadata CommandLineArgs

A type to help combine command line Args.

Constructors

CommandLineArgs
- 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.

Instances7Eq, Show, Generic, Semigroup, Monoid, Pretty, …

Eq CommandLineArgsDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Show CommandLineArgsDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Generic CommandLineArgsDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Semigroup CommandLineArgsDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Monoid CommandLineArgsDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Pretty CommandLineArgsDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
type Rep CommandLineArgs = D1 ('MetaData "CommandLineArgs" "Database.Postgres.Temp.Internal.Config" "tmp-postgres-1.35.0.0-8d3UBzJp08JWt8Eyo3xTt" '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))))Defined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config

valuetakeWhileInSequence :: [(Int, a)] -> [a]

valuecompleteCommandLineArgs :: CommandLineArgs -> [String]

This convert the CommandLineArgs to '[String]'.

datadata ProcessConfig

Process configuration

Constructors

ProcessConfig
- 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.
- createGroup :: Any
  A monoid for combining boolean create process group flag. The first True value wins.

Instances7Eq, Show, Generic, Semigroup, Monoid, Pretty, …

Eq ProcessConfigDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Show ProcessConfigDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Generic ProcessConfigDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Semigroup ProcessConfigDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Monoid ProcessConfigDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Pretty ProcessConfigDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
type Rep ProcessConfig = D1 ('MetaData "ProcessConfig" "Database.Postgres.Temp.Internal.Config" "tmp-postgres-1.35.0.0-8d3UBzJp08JWt8Eyo3xTt" '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)) :*: S1 ('MetaSel ('Just "createGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Any)))))Defined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config

valuestandardProcessConfig :: ProcessConfig

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

valuedevNull :: Handle

A global reference to /dev/null Handle.

valuesilentProcessConfig :: ProcessConfig

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

valueaddErrorContext :: String -> Either [String] a -> Either [String] a

valuegetOption :: String -> Last a -> Errors [String] a

valuecompleteProcessConfig

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

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

datadata CompleteDirectoryType

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

Constructors

CPermanent FilePath
CTemporary FilePath

Instances7Eq, Ord, Show, Generic, NFData, Pretty, …

Eq CompleteDirectoryTypeDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Ord CompleteDirectoryTypeDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Show CompleteDirectoryTypeDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Generic CompleteDirectoryTypeDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
NFData CompleteDirectoryTypeDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Pretty CompleteDirectoryTypeDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
type Rep CompleteDirectoryType = D1 ('MetaData "CompleteDirectoryType" "Database.Postgres.Temp.Internal.Config" "tmp-postgres-1.35.0.0-8d3UBzJp08JWt8Eyo3xTt" 'False) (C1 ('MetaCons "CPermanent" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)) :+: C1 ('MetaCons "CTemporary" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))Defined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config

valuetoFilePath :: CompleteDirectoryType -> FilePath

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

valuemakePermanent :: CompleteDirectoryType -> CompleteDirectoryType

datadata DirectoryType

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

Constructors

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

Instances6Eq, Ord, Show, Semigroup, Monoid, Pretty

Eq DirectoryTypeDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Ord DirectoryTypeDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Show DirectoryTypeDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Semigroup DirectoryTypeDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Takes the last Permanent value.
Monoid DirectoryTypeDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Temporary as mempty
Pretty DirectoryTypeDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config

valuefixPath :: FilePath -> IO FilePath

valuesetupDirectoryType

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

Either create aCTemporary directory or do create the directory if it does not exist to a CPermanent one.

valuermDirIgnoreErrors :: FilePath -> IO ()

valuecleanupDirectoryType :: CompleteDirectoryType -> IO ()

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

valuecompletePostgresPlan

:: [(String, String)]
-> Config
-> Either [String] CompletePostgresPlan

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

valueflattenConfig :: [(String, String)] -> String

valuecompletePlan

:: [(String, String)]
-> String
-> Config
-> Either [String] Plan

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

valueremoveDataDirectory :: ProcessConfig -> ProcessConfig

valuecompleteInitDb

:: [(String, String)]
-> FilePath
-> Config
-> Either [String] (Maybe (Either CompleteProcessConfig InitDbCachePlan))

valuehasInitDb :: Config -> Bool

valuehasCreateDb :: Config -> Bool

datadata Config

The high level options for overriding default behavior.

Constructors

Config
- logger :: Last Logger
  Internal Event logger.
- initDbConfig :: Accum ProcessConfig
  Monoid for accumulating initdb configuration.
- copyConfig :: Last (Maybe CopyDirectoryCommand)
  An optional data directory copy command.
- createDbConfig :: Accum ProcessConfig
  Monoid for accumulating createdb configuration.
- postgresConfig :: ProcessConfig
  The postgres process configuration.
- connectionOptions :: Options
  The additional client connection options.
- postgresConfigFile :: [(String, String)]
  The postgresql.conf configuration file.
- connectionTimeout :: Last Int
  The amount of microseconds to attempt to connect to postgres before throwing ConnectionTimedOut
- 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))

Instances5Generic, Semigroup, Monoid, Pretty, Rep

Generic ConfigDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Semigroup ConfigDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Monoid ConfigDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Pretty ConfigDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
type Rep Config = D1 ('MetaData "Config" "Database.Postgres.Temp.Internal.Config" "tmp-postgres-1.35.0.0-8d3UBzJp08JWt8Eyo3xTt" 'False) (C1 ('MetaCons "Config" '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 "postgresConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProcessConfig) :*: S1 ('MetaSel ('Just "connectionOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Options)))) :*: ((S1 ('MetaSel ('Just "postgresConfigFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, String)]) :*: (S1 ('MetaSel ('Just "connectionTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last Int)) :*: 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)))))))))Defined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config

valuesocketDirectoryToConfig :: FilePath -> [(String, String)]

datadata CopyDirectoryCommand

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 dataDirectory (which might be generated) is used.

Constructors

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

Instances4Eq, Ord, Show, Pretty

Eq CopyDirectoryCommandDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Ord CopyDirectoryCommandDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Show CopyDirectoryCommandDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config
Pretty CopyDirectoryCommandDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config

valuecompleteCopyDirectory

valuegetInitDbVersion :: String

valuemakeCommandLine :: String -> CompleteProcessConfig -> String

valuemakeInitDbCommandLine :: CompleteProcessConfig -> String

valuemakeArgumentHash :: String -> String

valuemakeCachePath :: FilePath -> String -> String

valueenvsToKeep :: [String]

valuesplitDataDirectory

:: CompleteProcessConfig
-> (Maybe String, CompleteProcessConfig)

valueaddDataDirectory :: String -> CompleteProcessConfig -> CompleteProcessConfig

valuetoPlan

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

Create a Config 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 Database.Postgres.Temp.startConfig.

valuesetupConfig

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

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

valuecleanupConfig :: Resources -> IO ()

Free the temporary resources created by setupConfig.

valueprettyPrintConfig :: Config -> String

Display a Config.

datadata Resources

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

Constructors

Resources
- resourcesPlan :: Plan
  Final Plan. See startPlan for information on Plans.
- 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)

Instances1Pretty

Pretty ResourcesDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.Config

valuemakeResourcesDataDirPermanent :: Resources -> Resources

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

valueoptionsToConfig :: Options -> Config

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.

valueoptionsToPlan :: Options -> Config

valueclientOptionsToPlan :: Options -> Config

valueuserToPlan :: String -> Config

valuedbnameToPlan :: Maybe String -> Maybe String -> String -> Config

valuepasswordToPlan :: String -> Config

valuehostToSocketClass :: String -> DirectoryType