Safe Haskell	None
Language	Haskell2010

Database.Postgres.Temp.Internal.Core

Description

This module provides the low level functionality for running initdb, postgres and createdb to make a database.

See startPlan for more details.

Synopsis

data Event
- = StartPostgres
- | WaitForDB
- | StartPlan String
- | TryToConnect
data StartError
- = StartPostgresFailed ExitCode
- | InitDbFailed ExitCode
- | CreateDbFailed ExitCode
- | CompletePlanFailed String [String]
type Logger = Event -> IO ()
waitForDB :: Logger -> Options -> IO ()
data ProcessConfig = ProcessConfig {
- processConfigEnvVars :: [(String, String)]
- processConfigCmdLine :: [String]
- processConfigStdIn :: Handle
- processConfigStdOut :: Handle
- processConfigStdErr :: Handle
}
startProcess :: String -> ProcessConfig -> IO ProcessHandle
executeProcess :: String -> ProcessConfig -> IO ExitCode
data PostgresPlan = PostgresPlan {
- postgresPlanProcessConfig :: ProcessConfig
- postgresPlanClientOptions :: Options
}
data PostgresProcess = PostgresProcess {
- postgresProcessClientOptions :: Options
- postgresProcessHandle :: ProcessHandle
}
stopPostgresProcess :: PostgresProcess -> IO ExitCode
startPostgresProcess :: Logger -> PostgresPlan -> IO PostgresProcess
data Plan = Plan {
- planLogger :: Logger
- planInitDb :: Maybe ProcessConfig
- planCreateDb :: Maybe ProcessConfig
- planPostgres :: PostgresPlan
- planConfig :: String
- planDataDirectory :: FilePath
}
startPlan :: Plan -> IO PostgresProcess
stopPlan :: PostgresProcess -> IO ExitCode

Documentation

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 #

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 #

type Logger = Event -> IO () Source #

A way to log internal Events

waitForDB :: Logger -> Options -> IO () Source #

postgres is not ready until we are able to successfully connect. waitForDB attempts to connect over and over again and returns after the first successful connection.

data ProcessConfig Source #

ProcessConfig contains the configuration necessary for starting a process. It is essentially a stripped down CreateProcess.

Constructors

ProcessConfig
Fields processConfigEnvVars :: [(String, String)] Environment variables processConfigCmdLine :: [String] Command line arguements processConfigStdIn :: Handle The `Handle` for standard input processConfigStdOut :: Handle The `Handle` for standard output processConfigStdErr :: Handle The `Handle` for standard error

Instances

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

startProcess Source #

Arguments

:: String	Process name
-> ProcessConfig	Process config
-> IO ProcessHandle

Start a process interactively and return the ProcessHandle

executeProcess Source #

Arguments

:: String	Process name
-> ProcessConfig	Process config
-> IO ExitCode

Start a process and block until it finishes return the ExitCode.

data PostgresPlan Source #

PostgresPlan is used be startPostgresProcess to start the postgres and then attempt to connect to it.

Constructors

PostgresPlan
Fields postgresPlanProcessConfig :: ProcessConfig The process config for `postgres` postgresPlanClientOptions :: Options Connection options. Used to verify that `postgres` is ready.

Instances

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

data PostgresProcess Source #

The output of calling startPostgresProcess.

Constructors

PostgresProcess
Fields postgresProcessClientOptions :: Options Connection options postgresProcessHandle :: ProcessHandle `postgres` process handle

Instances

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

stopPostgresProcess :: PostgresProcess -> IO ExitCode Source #

Stop the postgres process after attempting to terminate all the connections.

startPostgresProcess :: Logger -> PostgresPlan -> IO PostgresProcess Source #

Start the postgres process and block until a successful connection occurs. A separate thread we continously check to see if the postgres process has crashed.

data Plan Source #

Plan is the low level configuration necessary for creating a database starting postgres and creating a database. There is no validation done on the Plan. It is recommend that one use the higher level functions such as start which will generate plans that are valid. Plans are used internally but are exposed if the higher level plan generation is not sufficent.

Constructors

Plan
Fields planLogger :: Logger planInitDb :: Maybe ProcessConfig planCreateDb :: Maybe ProcessConfig planPostgres :: PostgresPlan planConfig :: String planDataDirectory :: FilePath

Instances

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

startPlan :: Plan -> IO PostgresProcess Source #

startPlan optionally calls initdb, optionally calls createdb and unconditionally calls postgres. Additionally it writes a "postgresql.conf" and does not return until the postgres process is ready. See startPostgresProcess for more details.

stopPlan :: PostgresProcess -> IO ExitCode Source #

Stop the postgres process. See stopPostgresProcess for more details.