Safe Haskell	None
Language	Haskell2010

Database.Postgres.Temp

Contents

Exception safe interface
Separate start and stop interface.
Main resource handle
Configuration
Internal events passed to the logger .
Errors

Description

This module provides functions for creating a temporary postgres instance. By default it will create a temporary data directory and a temporary directory for a UNIX domain socket for postgres to listen on.

Here is an example using the expection safe with function:

with $ \db -> bracket
   (connectPostgreSQL (toConnectionString db))
   close $
   \conn -> execute_ conn "CREATE TABLE foo (id int)"

To extend or override the defaults use withConfig (or startConfig).

tmp-postgres ultimately calls (optionally) initdb, postgres and (optionally) createdb.

All of the command line, environment variables and configuration files that are generated by default for the respective executables can be extended.

In general tmp-postgres is useful if you want a clean temporary postgres and do not want to worry about clashing with an existing postgres instance (or needing to ensure postgres is already running).

Here are some different use cases for tmp-postgres and their respective configurations:

The default with and start functions can be used to make a sandboxed temporary database for testing.
By disabling initdb one could run a temporary isolated postgres on a base backup to test a migration.
By using the stopPostgres and withRestart functions one can test backup strategies.

WARNING!! Ubuntu's PostgreSQL installation does not put initdb on the PATH. We need to add it manually. The necessary binaries are in the /usr/lib/postgresql/VERSION/bin/ directory, and should be added to the PATH

echo "export PATH=$PATH:/usr/lib/postgresql/VERSION/bin/" >> /home/ubuntu/.bashrc

Synopsis

with :: (DB -> IO a) -> IO (Either StartError a)
withConfig :: Config -> (DB -> IO a) -> IO (Either StartError a)
withRestart :: DB -> (DB -> IO a) -> IO (Either StartError a)
start :: IO (Either StartError DB)
startConfig :: Config -> IO (Either StartError DB)
stop :: DB -> IO ()
restart :: DB -> IO (Either StartError DB)
stopPostgres :: DB -> IO ExitCode
data DB
toConnectionString :: DB -> ByteString
toConnectionOptions :: DB -> Options
toDataDirectory :: DB -> FilePath
toTemporaryDirectory :: DB -> FilePath
makeDataDirPermanent :: DB -> DB
reloadConfig :: DB -> IO ()
prettyPrintDB :: DB -> String
defaultConfig :: Config
defaultPostgresConf :: [String] -> Config
standardProcessConfig :: ProcessConfig
silentConfig :: Config
silentProcessConfig :: ProcessConfig
optionsToDefaultConfig :: Options -> Config
data Config = Config {
- plan :: Plan
- socketClass :: SocketClass
- dataDirectory :: DirectoryType
- port :: Last (Maybe Int)
- temporaryDirectory :: Last FilePath
}
prettyPrintConfig :: Config -> String
planL :: Lens' Config Plan
socketClassL :: Lens' Config SocketClass
dataDirectoryL :: Lens' Config DirectoryType
portL :: Lens' Config (Last (Maybe Int))
connectionTimeoutL :: Lens' Plan (Last Int)
data Plan = Plan {
- logger :: Last Logger
- initDbConfig :: Maybe ProcessConfig
- createDbConfig :: Maybe ProcessConfig
- postgresPlan :: PostgresPlan
- postgresConfigFile :: [String]
- dataDirectoryString :: Last String
- connectionTimeout :: Last Int
}
postgresConfigFileL :: Lens' Plan [String]
createDbConfigL :: Lens' Plan (Maybe ProcessConfig)
dataDirectoryStringL :: Lens' Plan (Last String)
initDbConfigL :: Lens' Plan (Maybe ProcessConfig)
loggerL :: Lens' Plan (Last Logger)
postgresPlanL :: Lens' Plan PostgresPlan
data PostgresPlan = PostgresPlan {
- postgresConfig :: ProcessConfig
- connectionOptions :: Options
}
connectionOptionsL :: Lens' PostgresPlan Options
postgresConfigL :: Lens' PostgresPlan ProcessConfig
data ProcessConfig = ProcessConfig {
- environmentVariables :: EnvironmentVariables
- commandLine :: CommandLineArgs
- stdIn :: Last Handle
- stdOut :: Last Handle
- stdErr :: Last Handle
}
commandLineL :: Lens' ProcessConfig CommandLineArgs
environmentVariablesL :: Lens' ProcessConfig EnvironmentVariables
stdErrL :: Lens' ProcessConfig (Last Handle)
stdInL :: Lens' ProcessConfig (Last Handle)
stdOutL :: Lens' ProcessConfig (Last Handle)
data EnvironmentVariables = EnvironmentVariables {
- inherit :: Last Bool
- specific :: Map String String
}
inheritL :: Lens' EnvironmentVariables (Last Bool)
specificL :: Lens' EnvironmentVariables (Map String String)
data CommandLineArgs = CommandLineArgs {
- keyBased :: Map String (Maybe String)
- indexBased :: Map Int String
}
indexBasedL :: Lens' CommandLineArgs (Map Int String)
keyBasedL :: Lens' CommandLineArgs (Map String (Maybe String))
data DirectoryType
- = Permanent FilePath
- | Temporary
data SocketClass
- = IpSocket (Last String)
- | UnixSocket DirectoryType
type Logger = Event -> IO ()
data Event
- = StartPlan String
- | StartPostgres
- | WaitForDB
- | TryToConnect
data StartError
- = StartPostgresFailed ExitCode
- | InitDbFailed {
  - startErrorStdOut :: String
  - startErrorStdErr :: String
  - startErrorExitCode :: ExitCode
  }
- | CreateDbFailed {
  - startErrorStdOut :: String
  - startErrorStdErr :: String
  - startErrorExitCode :: ExitCode
  }
- | CompletePlanFailed String [String]
- | ConnectionTimedOut

Exception safe interface

with Source #

Arguments

:: (DB -> IO a)	`action` continuation.
-> IO (Either StartError a)

Default expectation safe interface. Equivalent to

  with = withConfig defaultConfig

withConfig Source #

Arguments

:: Config	`extra`. `Config` combined with the generated `Config`. See `startConfig` for more info
-> (DB -> IO a)	`action` continuation
-> IO (Either StartError a)

Exception safe database create with options. See startConfig for more details. Calls stop even in the face of exceptions.

withRestart :: DB -> (DB -> IO a) -> IO (Either StartError a) Source #

Exception safe version of restart

Separate start and stop interface.

start :: IO (Either StartError DB) Source #

Default start behavior. Equivalent to calling startConfig with the defaultConfig

startConfig Source #

Arguments

:: Config	`extra` configuration that is `mappend`ed last to the generated `Config`. `generated <> extra`
-> IO (Either StartError DB)

Create zero or more temporary resources and use them to make a Config.

The passed in config is inspected and a generated config is created. The final config is built by

  generated <> extra

Returns a DB that requires cleanup. startConfig should be used with a bracket and stop, e.g.

  withConfig :: Config -> (DB -> IO a) -> IO (Either StartError a)
  withConfig plan f = bracket (startConfig plan) (either mempty stop) $
     either (pure . Left) (fmap Right . f)

or just use withConfig. If you are calling startConfig you probably want withConfig anyway.

Based on the value of socketClass a "postgresql.conf" is created with

  listen_addresses = 'IP_ADDRESS'

if it is IpSocket. If is UnixSocket then the lines

  listen_addresses = ''
  unix_socket_directories = 'SOCKET_DIRECTORY'

are added.

stop :: DB -> IO () Source #

Stop the postgres process and cleanup any temporary resources that might have been created.

restart :: DB -> IO (Either StartError DB) Source #

Restart the postgres from DB using the prior Plan

stopPostgres :: DB -> IO ExitCode Source #

Only stop the postgres process but leave any temporary resources. Useful for testing backup strategies when used in conjunction with restart or withRestart.

Main resource handle

data DB Source #

Handle for holding temporary resources, the postgres process handle and postgres connection information. The DB also includes the final plan used to start initdb, createdb and postgres. See toConnectionString or toConnectionOptions for converting a DB to postgresql connection string.

Instances

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

`DB` accessors

toConnectionString :: DB -> ByteString Source #

Convert a DB to a connection string. Alternatively one can access the Options using toConnectionOptions

toConnectionOptions :: DB -> Options Source #

Convert a DB to a connection Options type.

toDataDirectory :: DB -> FilePath Source #

Access the data directory. This was either generated or specified explicitly when creating the Config

toTemporaryDirectory :: DB -> FilePath Source #

Get the directory that is used to create other temporary directories

`DB` mutators

makeDataDirPermanent :: DB -> DB Source #

Make the data directory permanent. Useful for debugging. If you are using with or withConfig this function will not modify the DB that is passed for cleanup. You will need to setup your own bracket like

   bracket (fmap makeDataDirPermanent start) (either mempty stop)

reloadConfig :: DB -> IO () Source #

Reload the configuration file without shutting down. Calls pg_reload_conf().

`DB` debugging

prettyPrintDB :: DB -> String Source #

Display a DB

Configuration

Defaults

defaultConfig :: Config Source #

The default configuration. This will create a database called "postgres" via initdb (it's default behavior). It will create a temporary directory for the data and a temporary directory for a unix socket on a random port. Additionally it will use the following "postgresql.conf" which is optimized for performance.

   shared_buffers = 12MB
   fsync = off
   synchronous_commit = off
   full_page_writes = off
   log_min_duration_statement = 0
   log_connections = on
   log_disconnections = on
   client_min_messages = ERROR

defaultConfig also passes the --no-sync flag to initdb.

If you would like to customize this behavior you can start with the defaultConfig and overwrite fields or combine a defaultConfig with another Config using <> (mappend).

Alternatively you can eschew defaultConfig altogether, however your postgres might start and run faster if you use defaultConfig.

defaultConfig also sets the initDbConfig to pure standardProcessConfig and postgresConfig to standardProcessConfig.

To append additional lines to "postgresql.conf" file create a custom Config like the following.

 custom = defaultConfig <> mempty
   { plan = mempty
     { postgresConfigFile =
         [ "wal_level = replica"
         , "archive_mode = on"
         , "max_wal_senders = 2"
         , "fsync = on"
         , "synchronous_commit = on"
         ]
     }
   }

Or using the provided lenses and your favorite lens library

 custom = defaultConfig & planL . postgresConfigFile <>~
   [ "wal_level = replica"
   , "archive_mode = on"
   , "max_wal_senders = 2"
   , "fsync = on"
   , "synchronous_commit = on"
   ]

This is common enough there is defaultPostgresConf which is a helper to do this.

As an alternative to using defaultConfig one could create a config from connections parameters using optionsToDefaultConfig

defaultPostgresConf :: [String] -> Config Source #

mappend the defaultConfig with a Config that provides additional "postgresql.conf" lines. Equivalent to

defaultPostgresConf extra = defaultConfig <> mempty
  { plan = mempty
    { postgresConfigFile = extra
    }
  }

or with lenses

defaultPostgresConf extra = defaultConfig & planL . postgresConfigFile <>~ extra

standardProcessConfig :: ProcessConfig Source #

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

silentConfig :: Config Source #

The same as defaultConfig but all the handles are set to "devnull". See silentProcessConfig as well.

silentProcessConfig :: ProcessConfig Source #

silentProcessConfig sets the handles to "devnull" and inherits the environment variables from the calling process

Custom Config builder helpers

optionsToDefaultConfig :: Options -> Config Source #

Attempt to create a Config from a Options. Useful if you want to create a database owned by a specific user you will also login with among other use cases.

`Config`

data Config Source #

The high level options for overriding default behavior.

Constructors

Config

Fields

plan :: Plan
Extend or replace any of the configuration used to create a final CompletePlan
socketClass :: SocketClass
Override the default CompleteSocketClass by setting this.
dataDirectory :: DirectoryType
Override the default temporary data directory by passing in 'CPermanent 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".

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.10.0.0-5HkUVmrNB8Z6hfdPHQZ5mq" False) (C1 (MetaCons "Config" PrefixI True) ((S1 (MetaSel (Just "plan") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Plan) :: S1 (MetaSel (Just "socketClass") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SocketClass)) :: (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))))))

prettyPrintConfig :: Config -> String Source #

Display a Config.

`Config` Lenses

planL :: Lens' Config Plan Source #

Lens for plan

socketClassL :: Lens' Config SocketClass Source #

Lens for socketClass

dataDirectoryL :: Lens' Config DirectoryType Source #

Lens for dataDirectory

portL :: Lens' Config (Last (Maybe Int)) Source #

Lens for port

connectionTimeoutL :: Lens' Plan (Last Int) Source #

Lens for connectionTimeout

`Plan`

data Plan Source #

Describe how to run initdb, createdb and postgres

Constructors

Plan
Fields logger :: Last Logger initDbConfig :: Maybe ProcessConfig createDbConfig :: Maybe 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.10.0.0-5HkUVmrNB8Z6hfdPHQZ5mq" False) (C1 (MetaCons "Plan" PrefixI True) ((S1 (MetaSel (Just "logger") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last Logger)) :: (S1 (MetaSel (Just "initDbConfig") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ProcessConfig)) :: S1 (MetaSel (Just "createDbConfig") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe 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))))))

`Plan` lenses

postgresConfigFileL :: Lens' Plan [String] Source #

Lens for postgresConfigFile

createDbConfigL :: Lens' Plan (Maybe ProcessConfig) Source #

Lens for createDbConfig

dataDirectoryStringL :: Lens' Plan (Last String) Source #

Lens for dataDirectoryString

initDbConfigL :: Lens' Plan (Maybe ProcessConfig) Source #

Lens for initDbConfig

loggerL :: Lens' Plan (Last Logger) Source #

Lens for logger

postgresPlanL :: Lens' Plan PostgresPlan Source #

Lens for postgresPlan

`PostgresPlan`

data PostgresPlan Source #

postgres process config and corresponding client connection Options.

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.10.0.0-5HkUVmrNB8Z6hfdPHQZ5mq" False) (C1 (MetaCons "PostgresPlan" PrefixI True) (S1 (MetaSel (Just "postgresConfig") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ProcessConfig) :*: S1 (MetaSel (Just "connectionOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Options)))

`PostgresPlan` lenses

connectionOptionsL :: Lens' PostgresPlan Options Source #

Lens for connectionOptions

postgresConfigL :: Lens' PostgresPlan ProcessConfig Source #

Lens for postgresConfig

`ProcessConfig`

data ProcessConfig Source #

Process configuration

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.10.0.0-5HkUVmrNB8Z6hfdPHQZ5mq" 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))))))

`ProcessConfig` Lenses

commandLineL :: Lens' ProcessConfig CommandLineArgs Source #

Lens for commandLine

environmentVariablesL :: Lens' ProcessConfig EnvironmentVariables Source #

Lens for environmentVariables

stdErrL :: Lens' ProcessConfig (Last Handle) Source #

Lens for stdErr

stdInL :: Lens' ProcessConfig (Last Handle) Source #

Lens for stdIn

stdOutL :: Lens' ProcessConfig (Last Handle) Source #

Lens for stdOut

`EnvironmentVariables`

data EnvironmentVariables Source #

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

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.10.0.0-5HkUVmrNB8Z6hfdPHQZ5mq" 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))))

`EnvironmentVariables` Lenses

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

Lens for inherit

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

Lens for specific

`CommandLineArgs`

data CommandLineArgs Source #

A type to help combine command line Args.

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.10.0.0-5HkUVmrNB8Z6hfdPHQZ5mq" 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))))

`CommandLineArgs` Lenses

indexBasedL :: Lens' CommandLineArgs (Map Int String) Source #

Lens for indexBased

keyBasedL :: Lens' CommandLineArgs (Map String (Maybe String)) Source #

Lens for keyBased

`DirectoryType`

data DirectoryType Source #

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.

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 #

`SocketClass`

data SocketClass Source #

The monoidial version of CompleteSocketClass. Used to combine overrides with defaults when creating a CompleteSocketClass. The monoid instance and combines the

Constructors

IpSocket (Last String)	The monoid for combining IP address configuration
UnixSocket DirectoryType	The monoid for combining UNIX socket configuration

Instances

Eq SocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods (==) :: SocketClass -> SocketClass -> Bool # (/=) :: SocketClass -> SocketClass -> Bool #
Ord SocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods compare :: SocketClass -> SocketClass -> Ordering # (<) :: SocketClass -> SocketClass -> Bool # (<=) :: SocketClass -> SocketClass -> Bool # (>) :: SocketClass -> SocketClass -> Bool # (>=) :: SocketClass -> SocketClass -> Bool # max :: SocketClass -> SocketClass -> SocketClass # min :: SocketClass -> SocketClass -> SocketClass #
Show SocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods showsPrec :: Int -> SocketClass -> ShowS # show :: SocketClass -> String # showList :: [SocketClass] -> ShowS #
Generic SocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Associated Types type Rep SocketClass :: Type -> Type # Methods from :: SocketClass -> Rep SocketClass x # to :: Rep SocketClass x -> SocketClass #
Semigroup SocketClass Source #	Last `IpSocket` wins. `UnixSocket` `DirectoryType` as `mappend`ed together.
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods (<>) :: SocketClass -> SocketClass -> SocketClass # sconcat :: NonEmpty SocketClass -> SocketClass # stimes :: Integral b => b -> SocketClass -> SocketClass #
Monoid SocketClass Source #	Treats 'UnixSocket mempty' as `mempty`
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods mempty :: SocketClass # mappend :: SocketClass -> SocketClass -> SocketClass # mconcat :: [SocketClass] -> SocketClass #
Pretty SocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config Methods pretty :: SocketClass -> Doc # prettyList :: [SocketClass] -> Doc #
type Rep SocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal.Config type Rep SocketClass = D1 (MetaData "SocketClass" "Database.Postgres.Temp.Internal.Config" "tmp-postgres-1.10.0.0-5HkUVmrNB8Z6hfdPHQZ5mq" False) (C1 (MetaCons "IpSocket" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last String))) :+: C1 (MetaCons "UnixSocket" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 DirectoryType)))

`Logger`

type Logger = Event -> IO () Source #

A way to log internal Events

Internal events passed to the `logger` .

data Event Source #

Internal events for debugging

Constructors

StartPlan String	The first event. This useful for debugging what is actual passed to the `initdb`, `createdb` and `postgres`.
StartPostgres	The second event. Postgres is about to get called
WaitForDB	The third event. Postgres started. We are now about to setup a reconnect loop (racing with a process checker)
TryToConnect	The fourth event and (possibly all subsequent events). We are looping trying to successfully connect to the `postgres` process.

Instances

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

Errors

data StartError Source #

A list of failures that can occur when starting. This is not and exhaustive list but covers the errors that the system catches for the user.

Constructors

StartPostgresFailed ExitCode	`postgres` failed before a connection succeeded. Most likely this is due to invalid configuration
InitDbFailed	`initdb` failed. This can be from invalid configuration or using a non-empty data directory
Fields startErrorStdOut :: String startErrorStdErr :: String startErrorExitCode :: ExitCode
CreateDbFailed	`createdb` failed. This can be from invalid configuration or the database might already exist.
Fields startErrorStdOut :: String startErrorStdErr :: String startErrorExitCode :: ExitCode
CompletePlanFailed String [String]	The `Plan` was missing info and a complete `CompletePlan` could not be created.
ConnectionTimedOut

Instances

Eq StartError Source #
Instance details Defined in Database.Postgres.Temp.Internal.Core Methods (==) :: StartError -> StartError -> Bool # (/=) :: StartError -> StartError -> Bool #
Ord StartError Source #
Instance details Defined in Database.Postgres.Temp.Internal.Core Methods compare :: StartError -> StartError -> Ordering # (<) :: StartError -> StartError -> Bool # (<=) :: StartError -> StartError -> Bool # (>) :: StartError -> StartError -> Bool # (>=) :: StartError -> StartError -> Bool # max :: StartError -> StartError -> StartError # min :: StartError -> StartError -> StartError #
Show StartError Source #
Instance details Defined in Database.Postgres.Temp.Internal.Core Methods showsPrec :: Int -> StartError -> ShowS # show :: StartError -> String # showList :: [StartError] -> ShowS #
Exception StartError Source #
Instance details Defined in Database.Postgres.Temp.Internal.Core Methods toException :: StartError -> SomeException # fromException :: SomeException -> Maybe StartError # displayException :: StartError -> String #

Exception safe interface

Separate start and stop interface.

Main resource handle

DB accessors

DB mutators

DB debugging

Configuration

Defaults

Custom Config builder helpers

Config Lenses

Plan lenses

PostgresPlan lenses

ProcessConfig Lenses

EnvironmentVariables Lenses

CommandLineArgs Lenses

Internal events passed to the logger .

Errors

`DB` accessors

`DB` mutators

`DB` debugging

`Config` Lenses

`Plan` lenses

`PostgresPlan` lenses

`ProcessConfig` Lenses

`EnvironmentVariables` Lenses

`CommandLineArgs` Lenses

Internal events passed to the `logger` .