Safe Haskell	None
Language	Haskell2010

Database.Postgres.Temp

Contents

Exception safe interface
Separate start and stop interface.
- Custom Config builder helpers
Starting and Stopping postgres without removing the temporary directory
Reloading the config
Main resource handle
- DB manipulation
Monoidial Configuration Types
Internal events passed to the partialPlanLogger .
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)
start :: IO (Either StartError DB)
startConfig :: Config -> IO (Either StartError DB)
stop :: DB -> IO ()
defaultConfig :: Config
defaultPostgresConf :: [String] -> Config
standardProcessConfig :: PartialProcessConfig
optionsToDefaultConfig :: Options -> Config
restart :: DB -> IO (Either StartError DB)
stopPostgres :: DB -> IO ExitCode
withRestart :: DB -> (DB -> IO a) -> IO (Either StartError a)
reloadConfig :: DB -> IO ()
data DB
prettyPrintDB :: DB -> String
toConnectionString :: DB -> ByteString
toConnectionOptions :: DB -> Options
toDataDirectory :: DB -> FilePath
makeDataDirPermanent :: DB -> DB
data Config = Config {
- configPlan :: PartialPlan
- configSocket :: PartialSocketClass
- configDataDir :: PartialDirectoryType
- configPort :: Last (Maybe Int)
}
prettyPrintConfig :: Config -> String
configPlanL :: Lens' Config PartialPlan
configSocketL :: Lens' Config PartialSocketClass
configDataDirL :: Lens' Config PartialDirectoryType
configPortL :: Lens' Config (Last (Maybe Int))
data PartialPlan = PartialPlan {
- partialPlanLogger :: Last Logger
- partialPlanInitDb :: Maybe PartialProcessConfig
- partialPlanCreateDb :: Maybe PartialProcessConfig
- partialPlanPostgres :: PartialPostgresPlan
- partialPlanConfig :: [String]
- partialPlanDataDirectory :: Last String
}
partialPlanConfigL :: Lens' PartialPlan [String]
partialPlanCreateDbL :: Lens' PartialPlan (Maybe PartialProcessConfig)
partialPlanDataDirectoryL :: Lens' PartialPlan (Last String)
partialPlanInitDbL :: Lens' PartialPlan (Maybe PartialProcessConfig)
partialPlanLoggerL :: Lens' PartialPlan (Last Logger)
partialPlanPostgresL :: Lens' PartialPlan PartialPostgresPlan
data PartialPostgresPlan = PartialPostgresPlan {
- partialPostgresPlanProcessConfig :: PartialProcessConfig
- partialPostgresPlanClientConfig :: Options
}
partialPostgresPlanClientConfigL :: Lens' PartialPostgresPlan Options
partialPostgresPlanProcessConfigL :: Lens' PartialPostgresPlan PartialProcessConfig
data PartialProcessConfig = PartialProcessConfig {
- partialProcessConfigEnvVars :: PartialEnvVars
- partialProcessConfigCmdLine :: PartialCommandLineArgs
- partialProcessConfigStdIn :: Last Handle
- partialProcessConfigStdOut :: Last Handle
- partialProcessConfigStdErr :: Last Handle
}
partialProcessConfigCmdLineL :: Lens' PartialProcessConfig PartialCommandLineArgs
partialProcessConfigEnvVarsL :: Lens' PartialProcessConfig PartialEnvVars
partialProcessConfigStdErrL :: Lens' PartialProcessConfig (Last Handle)
partialProcessConfigStdInL :: Lens' PartialProcessConfig (Last Handle)
partialProcessConfigStdOutL :: Lens' PartialProcessConfig (Last Handle)
data PartialEnvVars = PartialEnvVars {
- partialEnvVarsInherit :: Last Bool
- partialEnvVarsSpecific :: Map String String
}
partialEnvVarsInheritL :: Lens' PartialEnvVars (Last Bool)
partialEnvVarsSpecificL :: Lens' PartialEnvVars (Map String String)
data PartialCommandLineArgs = PartialCommandLineArgs {
- partialCommandLineArgsKeyBased :: Map String (Maybe String)
- partialCommandLineArgsIndexBased :: Map Int String
}
partialCommandLineArgsIndexBasedL :: Lens' PartialCommandLineArgs (Map Int String)
partialCommandLineArgsKeyBasedL :: Lens' PartialCommandLineArgs (Map String (Maybe String))
data PartialDirectoryType
- = PPermanent FilePath
- | PTemporary
data PartialSocketClass
- = PIpSocket (Last String)
- | PUnixSocket PartialDirectoryType
type Logger = Event -> IO ()
data Event
- = StartPostgres
- | WaitForDB
- | StartPlan String
- | TryToConnect
data StartError
- = StartPostgresFailed ExitCode
- | InitDbFailed ExitCode
- | CreateDbFailed ExitCode
- | CompletePlanFailed String [String]

Exception safe interface

with Source #

Arguments

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

Default expectation safe interface. Equivalent to withConfig the defaultConfig

withConfig Source #

Arguments

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

Exception safe default database create. Takes an action continuation which is given a DB it can use to connect to (see toConnectionString or postgresProcessClientOptions). All of the database resources are automatically cleaned up on completion even in the face of exceptions. Based on the value of configSocket 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. This occurs as a side effect of calling withConfig.

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	`extraConfiguration` that is `mappend`ed to the generated `Config`. The extra config is `mappend`ed second, e.g. `generatedConfig <> extraConfiguration`
-> IO (Either StartError DB)

Create temporary resources and use them to make a Config. The generated Config is combined with the passed in extraConfiguration to create a Plan that is used to create a database. The output DB includes references to the temporary resources for cleanup and the final plan that was used to generate the database and processes

stop :: DB -> IO () Source #

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

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 append the following onto the "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 partialPlanInitDb to pure standardProcessConfig and partialPostgresPlanProcessConfig to standardProcessConfig.

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

 custom = defaultConfig <> mempty
   { configPlan = mempty
     { partialPlanConfig =
         [ "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 & configPlanL . partialPlanConfigL <>~
   [ "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
  { configPlan = mempty
    { partialPlanConfig = extra
    }
  }

standardProcessConfig :: PartialProcessConfig Source #

The standardProcessConfig sets the handles to stdin, stdout and stderr 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.

Starting and Stopping postgres without removing the temporary directory

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

Restart the postgres using the Plan from the DB (e.g. resourcesPlan . dbResources)

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.

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

Exception safe version of restart

Reloading the config

reloadConfig :: DB -> IO () Source #

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

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 that was used to start initdb, createdb and postgres. See toConnectionString 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` manipulation

prettyPrintDB :: DB -> String Source #

Display a DB

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

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)

Monoidial Configuration Types

`Config`

data Config Source #

The high level options for overriding default behavior.

Constructors

Config

Fields

configPlan :: PartialPlan
Extend or replace any of the configuration used to create a final Plan
configSocket :: PartialSocketClass
Override the default SocketClass by setting this.
configDataDir :: PartialDirectoryType
Override the default temporary data directory by passing in 'Permanent DIRECTORY'
configPort :: Last (Maybe Int)
A monoid for using an existing port (via 'Just PORT_NUMBER') or requesting a free port (via a Nothing)

Instances

Generic Config Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial 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.Partial 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.Partial Methods mempty :: Config # mappend :: Config -> Config -> Config # mconcat :: [Config] -> Config #
Pretty Config Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Methods pretty :: Config -> Doc # prettyList :: [Config] -> Doc #
type Rep Config Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial type Rep Config = D1 (MetaData "Config" "Database.Postgres.Temp.Internal.Partial" "tmp-postgres-1.7.1.0-Fl2f8QVtDW2J2btYcu2iIC" False) (C1 (MetaCons "Config" PrefixI True) ((S1 (MetaSel (Just "configPlan") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PartialPlan) :: S1 (MetaSel (Just "configSocket") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PartialSocketClass)) :: (S1 (MetaSel (Just "configDataDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PartialDirectoryType) :*: S1 (MetaSel (Just "configPort") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last (Maybe Int))))))

prettyPrintConfig :: Config -> String Source #

Display a Config.

`Config` Lenses

configPlanL :: Lens' Config PartialPlan Source #

Lens for configPlan

configSocketL :: Lens' Config PartialSocketClass Source #

Lens for configSocket

configDataDirL :: Lens' Config PartialDirectoryType Source #

Lens for configDataDir

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

Lens for configPort

`PartialPlan`

data PartialPlan Source #

The monoidial version of Plan. Used to combine overrides with defaults when creating a plan.

Constructors

PartialPlan
Fields partialPlanLogger :: Last Logger partialPlanInitDb :: Maybe PartialProcessConfig partialPlanCreateDb :: Maybe PartialProcessConfig partialPlanPostgres :: PartialPostgresPlan partialPlanConfig :: [String] partialPlanDataDirectory :: Last String

Instances

Generic PartialPlan Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Associated Types type Rep PartialPlan :: Type -> Type # Methods from :: PartialPlan -> Rep PartialPlan x # to :: Rep PartialPlan x -> PartialPlan #
Semigroup PartialPlan Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Methods (<>) :: PartialPlan -> PartialPlan -> PartialPlan # sconcat :: NonEmpty PartialPlan -> PartialPlan # stimes :: Integral b => b -> PartialPlan -> PartialPlan #
Monoid PartialPlan Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Methods mempty :: PartialPlan # mappend :: PartialPlan -> PartialPlan -> PartialPlan # mconcat :: [PartialPlan] -> PartialPlan #
Pretty PartialPlan Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Methods pretty :: PartialPlan -> Doc # prettyList :: [PartialPlan] -> Doc #
type Rep PartialPlan Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial type Rep PartialPlan = D1 (MetaData "PartialPlan" "Database.Postgres.Temp.Internal.Partial" "tmp-postgres-1.7.1.0-Fl2f8QVtDW2J2btYcu2iIC" False) (C1 (MetaCons "PartialPlan" PrefixI True) ((S1 (MetaSel (Just "partialPlanLogger") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last Logger)) :: (S1 (MetaSel (Just "partialPlanInitDb") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe PartialProcessConfig)) :: S1 (MetaSel (Just "partialPlanCreateDb") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe PartialProcessConfig)))) :: (S1 (MetaSel (Just "partialPlanPostgres") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PartialPostgresPlan) :: (S1 (MetaSel (Just "partialPlanConfig") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "partialPlanDataDirectory") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last String))))))

`PartialPlan` lenses

partialPlanConfigL :: Lens' PartialPlan [String] Source #

Lens for partialPlanConfig

partialPlanCreateDbL :: Lens' PartialPlan (Maybe PartialProcessConfig) Source #

Lens for partialPlanCreateDb

partialPlanDataDirectoryL :: Lens' PartialPlan (Last String) Source #

Lens for partialPlanDataDirectory

partialPlanInitDbL :: Lens' PartialPlan (Maybe PartialProcessConfig) Source #

Lens for partialPlanInitDb

partialPlanLoggerL :: Lens' PartialPlan (Last Logger) Source #

Lens for partialPlanLogger

partialPlanPostgresL :: Lens' PartialPlan PartialPostgresPlan Source #

Lens for partialPlanPostgres

`PartialPostgresPlan`

data PartialPostgresPlan Source #

postgres process config and corresponding client connection Options.

Constructors

PartialPostgresPlan
Fields partialPostgresPlanProcessConfig :: PartialProcessConfig Monoid for the `postgres` ProcessConfig. partialPostgresPlanClientConfig :: Options Monoid for the `postgres` client connection options.

Instances

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

`PartialPostgresPlan` lenses

partialPostgresPlanClientConfigL :: Lens' PartialPostgresPlan Options Source #

Lens for partialPostgresPlanClientConfig

partialPostgresPlanProcessConfigL :: Lens' PartialPostgresPlan PartialProcessConfig Source #

Lens for partialPostgresPlanProcessConfig

`PartialProcessConfig`

data PartialProcessConfig Source #

The monoidial version of ProcessConfig. Used to combine overrides with defaults when creating a ProcessConfig.

Constructors

PartialProcessConfig

Fields

partialProcessConfigEnvVars :: PartialEnvVars
A monoid for combine environment variables or replacing them. for the maps the Dual monoid is used. So the last key wins.
partialProcessConfigCmdLine :: PartialCommandLineArgs
A monoid for combine command line arguments or replacing them
partialProcessConfigStdIn :: Last Handle
A monoid for configuring the standard input Handle
partialProcessConfigStdOut :: Last Handle
A monoid for configuring the standard output Handle
partialProcessConfigStdErr :: Last Handle
A monoid for configuring the standard error Handle

Instances

Eq PartialProcessConfig Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Methods (==) :: PartialProcessConfig -> PartialProcessConfig -> Bool # (/=) :: PartialProcessConfig -> PartialProcessConfig -> Bool #
Show PartialProcessConfig Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Methods showsPrec :: Int -> PartialProcessConfig -> ShowS # show :: PartialProcessConfig -> String # showList :: [PartialProcessConfig] -> ShowS #
Generic PartialProcessConfig Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Associated Types type Rep PartialProcessConfig :: Type -> Type # Methods from :: PartialProcessConfig -> Rep PartialProcessConfig x # to :: Rep PartialProcessConfig x -> PartialProcessConfig #
Semigroup PartialProcessConfig Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Methods (<>) :: PartialProcessConfig -> PartialProcessConfig -> PartialProcessConfig # sconcat :: NonEmpty PartialProcessConfig -> PartialProcessConfig # stimes :: Integral b => b -> PartialProcessConfig -> PartialProcessConfig #
Monoid PartialProcessConfig Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Methods mempty :: PartialProcessConfig # mappend :: PartialProcessConfig -> PartialProcessConfig -> PartialProcessConfig # mconcat :: [PartialProcessConfig] -> PartialProcessConfig #
Pretty PartialProcessConfig Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Methods pretty :: PartialProcessConfig -> Doc # prettyList :: [PartialProcessConfig] -> Doc #
type Rep PartialProcessConfig Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial type Rep PartialProcessConfig = D1 (MetaData "PartialProcessConfig" "Database.Postgres.Temp.Internal.Partial" "tmp-postgres-1.7.1.0-Fl2f8QVtDW2J2btYcu2iIC" False) (C1 (MetaCons "PartialProcessConfig" PrefixI True) ((S1 (MetaSel (Just "partialProcessConfigEnvVars") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PartialEnvVars) :: S1 (MetaSel (Just "partialProcessConfigCmdLine") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PartialCommandLineArgs)) :: (S1 (MetaSel (Just "partialProcessConfigStdIn") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last Handle)) :: (S1 (MetaSel (Just "partialProcessConfigStdOut") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last Handle)) :: S1 (MetaSel (Just "partialProcessConfigStdErr") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last Handle))))))

`PartialProcessConfig` Lenses

partialProcessConfigCmdLineL :: Lens' PartialProcessConfig PartialCommandLineArgs Source #

Lens for partialProcessConfigCmdLine

partialProcessConfigEnvVarsL :: Lens' PartialProcessConfig PartialEnvVars Source #

Lens for partialProcessConfigEnvVars

partialProcessConfigStdErrL :: Lens' PartialProcessConfig (Last Handle) Source #

Lens for partialProcessConfigStdErr

partialProcessConfigStdInL :: Lens' PartialProcessConfig (Last Handle) Source #

Lens for partialProcessConfigStdIn

partialProcessConfigStdOutL :: Lens' PartialProcessConfig (Last Handle) Source #

Lens for partialProcessConfigStdOut

`PartialEnvVars`

data PartialEnvVars Source #

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

Constructors

PartialEnvVars
Fields partialEnvVarsInherit :: Last Bool partialEnvVarsSpecific :: Map String String

Instances

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

`PartialEnvVars` Lenses

partialEnvVarsInheritL :: Lens' PartialEnvVars (Last Bool) Source #

Lens for partialEnvVarsInherit

partialEnvVarsSpecificL :: Lens' PartialEnvVars (Map String String) Source #

Lens for partialEnvVarsSpecific

`PartialCommandLineArgs`

data PartialCommandLineArgs Source #

A type to help combine command line arguments.

Constructors

PartialCommandLineArgs

Fields

partialCommandLineArgsKeyBased :: Map String (Maybe String)
Arguments 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.
partialCommandLineArgsIndexBased :: Map Int String
Arguments that appear at the end of the key based arguments. The Dual monoid is used so the last key wins.

Instances

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

`PartialCommandLineArgs` Lenses

partialCommandLineArgsIndexBasedL :: Lens' PartialCommandLineArgs (Map Int String) Source #

Lens for partialCommandLineArgsIndexBased

partialCommandLineArgsKeyBasedL :: Lens' PartialCommandLineArgs (Map String (Maybe String)) Source #

Lens for partialCommandLineArgsKeyBased

`PartialDirectoryType`

data PartialDirectoryType Source #

The monoidial version of DirectoryType. Used to combine overrides with defaults when creating a DirectoryType. The monoid instance treats PTemporary as mempty and takes the last PPermanent value.

Constructors

PPermanent FilePath	A permanent file that should not be generated.
PTemporary	A temporary file that needs to generated.

Instances

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

`PartialSocketClass`

data PartialSocketClass Source #

The monoidial version of SocketClass. Used to combine overrides with defaults when creating a SocketClass. The monoid instance treats 'PUnixSocket mempty' as mempty and combines the

Constructors

PIpSocket (Last String)	The monoid for combining IP address configuration
PUnixSocket PartialDirectoryType	The monoid for combining UNIX socket configuration

Instances

Eq PartialSocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Methods (==) :: PartialSocketClass -> PartialSocketClass -> Bool # (/=) :: PartialSocketClass -> PartialSocketClass -> Bool #
Ord PartialSocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Methods compare :: PartialSocketClass -> PartialSocketClass -> Ordering # (<) :: PartialSocketClass -> PartialSocketClass -> Bool # (<=) :: PartialSocketClass -> PartialSocketClass -> Bool # (>) :: PartialSocketClass -> PartialSocketClass -> Bool # (>=) :: PartialSocketClass -> PartialSocketClass -> Bool # max :: PartialSocketClass -> PartialSocketClass -> PartialSocketClass # min :: PartialSocketClass -> PartialSocketClass -> PartialSocketClass #
Show PartialSocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Methods showsPrec :: Int -> PartialSocketClass -> ShowS # show :: PartialSocketClass -> String # showList :: [PartialSocketClass] -> ShowS #
Generic PartialSocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Associated Types type Rep PartialSocketClass :: Type -> Type # Methods from :: PartialSocketClass -> Rep PartialSocketClass x # to :: Rep PartialSocketClass x -> PartialSocketClass #
Semigroup PartialSocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Methods (<>) :: PartialSocketClass -> PartialSocketClass -> PartialSocketClass # sconcat :: NonEmpty PartialSocketClass -> PartialSocketClass # stimes :: Integral b => b -> PartialSocketClass -> PartialSocketClass #
Monoid PartialSocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Methods mempty :: PartialSocketClass # mappend :: PartialSocketClass -> PartialSocketClass -> PartialSocketClass # mconcat :: [PartialSocketClass] -> PartialSocketClass #
Pretty PartialSocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial Methods pretty :: PartialSocketClass -> Doc # prettyList :: [PartialSocketClass] -> Doc #
type Rep PartialSocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal.Partial type Rep PartialSocketClass = D1 (MetaData "PartialSocketClass" "Database.Postgres.Temp.Internal.Partial" "tmp-postgres-1.7.1.0-Fl2f8QVtDW2J2btYcu2iIC" False) (C1 (MetaCons "PIpSocket" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Last String))) :+: C1 (MetaCons "PUnixSocket" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PartialDirectoryType)))

`Logger`

type Logger = Event -> IO () Source #

A way to log internal Events

Internal events passed to the `partialPlanLogger` .

data Event Source #

Internal events for debugging

Constructors

StartPostgres
WaitForDB
StartPlan String
TryToConnect

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 ExitCode	`initdb` failed. This can be from invalid configuration or using a non-empty data directory
CreateDbFailed ExitCode	`createdb` failed. This can be from invalid configuration or the database might already exist.
CompletePlanFailed String [String]	The `PartialPlan` was missing info and a complete `Plan` could not be created.

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.

Custom Config builder helpers

Starting and Stopping postgres without removing the temporary directory

Reloading the config

Main resource handle

DB manipulation

Monoidial Configuration Types

Config Lenses

PartialPlan lenses

PartialPostgresPlan lenses

PartialProcessConfig Lenses

PartialEnvVars Lenses

PartialCommandLineArgs Lenses

Internal events passed to the partialPlanLogger .

Errors

`DB` manipulation

`Config` Lenses

`PartialPlan` lenses

`PartialPostgresPlan` lenses

`PartialProcessConfig` Lenses

`PartialEnvVars` Lenses

`PartialCommandLineArgs` Lenses

Internal events passed to the `partialPlanLogger` .