Safe Haskell	None
Language	Haskell2010

Database.Postgres.Temp.Internal

Synopsis

getFreePort :: IO Int
waitForDB :: String -> IO ()
withLock :: MVar a -> IO b -> IO b
data DB = DB {
- mainDir :: FilePath
- connectionString :: String
- extraOptions :: [(String, String)]
- stdErr :: Handle
- stdOut :: Handle
- pidLock :: MVar ()
- port :: Int
- socketClass :: SocketClass
- pid :: IORef (Maybe ProcessHandle)
}
data SocketClass
- = Localhost
- | Unix
start :: [(String, String)] -> IO (Either StartError DB)
startLocalhost :: [(String, String)] -> IO (Either StartError DB)
fourth :: (a, b, c, d) -> d
procWith :: Handle -> Handle -> String -> [String] -> CreateProcess
config :: Maybe FilePath -> String
data StartError
- = InitDBFailed ExitCode
- | CreateDBFailed [String] ExitCode
- | StartPostgresFailed [String] ExitCode
- | StartPostgresDisappeared [String]
throwIfError :: (ExitCode -> StartError) -> ExitCode -> IO ()
pidString :: ProcessHandle -> IO String
runProcessWith :: Handle -> Handle -> String -> String -> [String] -> IO ExitCode
startWithHandles :: SocketClass -> [(String, String)] -> Handle -> Handle -> IO (Either StartError DB)
startWithHandlesAndDir :: SocketClass -> [(String, String)] -> FilePath -> Handle -> Handle -> IO (Either StartError DB)
data AnotherPostgresProcessActive = AnotherPostgresProcessActive
waitOnPostgres :: DB -> IO ()
reloadConfig :: DB -> IO ()
startPostgres :: DB -> IO ()
stopPostgres :: DB -> IO (Maybe ExitCode)
makePostgresOptions :: [(String, String)] -> FilePath -> Int -> [String]
runPostgres :: Handle -> Handle -> [String] -> IO ProcessHandle
data Event
- = InitDB
- | WriteConfig
- | FreePort
- | StartPostgres
- | WaitForDB
- | CreateDB
- | Finished
rmDirIgnoreErrors :: FilePath -> IO ()
startWithLogger :: (Event -> IO ()) -> SocketClass -> [(String, String)] -> FilePath -> Handle -> Handle -> IO (Either StartError DB)
startAndLogToTmp :: [(String, String)] -> IO (Either StartError DB)
terminateConnections :: DB -> IO ()
stop :: DB -> IO (Maybe ExitCode)

Documentation

getFreePort :: IO Int Source #

waitForDB :: String -> IO () Source #

withLock :: MVar a -> IO b -> IO b Source #

data DB Source #

Constructors

DB

Fields

mainDir :: FilePath
Temporary directory where the unix socket, logs and data directory live.
connectionString :: String
PostgreSQL connection string.
extraOptions :: [(String, String)]
Additionally options passed to the postgres command line
stdErr :: Handle
The Handle used to standard error
stdOut :: Handle
The Handle used to standard output
pidLock :: MVar ()
A lock used internally to makes sure access to pid is serialized
port :: Int
The port postgres is listening on
socketClass :: SocketClass
The SocketClass used for starting postgres
pid :: IORef (Maybe ProcessHandle)
The process handle for the postgres process.

data SocketClass Source #

Constructors

Localhost
Unix

Instances

Bounded SocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal Methods minBound :: SocketClass # maxBound :: SocketClass #
Enum SocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal Methods succ :: SocketClass -> SocketClass # pred :: SocketClass -> SocketClass # toEnum :: Int -> SocketClass # fromEnum :: SocketClass -> Int # enumFrom :: SocketClass -> [SocketClass] # enumFromThen :: SocketClass -> SocketClass -> [SocketClass] # enumFromTo :: SocketClass -> SocketClass -> [SocketClass] # enumFromThenTo :: SocketClass -> SocketClass -> SocketClass -> [SocketClass] #
Eq SocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal Methods (==) :: SocketClass -> SocketClass -> Bool # (/=) :: SocketClass -> SocketClass -> Bool #
Ord SocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal 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 #
Read SocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal Methods readsPrec :: Int -> ReadS SocketClass # readList :: ReadS [SocketClass] # readPrec :: ReadPrec SocketClass # readListPrec :: ReadPrec [SocketClass] #
Show SocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal Methods showsPrec :: Int -> SocketClass -> ShowS # show :: SocketClass -> String # showList :: [SocketClass] -> ShowS #
Generic SocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal Associated Types type Rep SocketClass :: Type -> Type # Methods from :: SocketClass -> Rep SocketClass x # to :: Rep SocketClass x -> SocketClass #
type Rep SocketClass Source #
Instance details Defined in Database.Postgres.Temp.Internal type Rep SocketClass = D1 (MetaData "SocketClass" "Database.Postgres.Temp.Internal" "tmp-postgres-0.2.0.0-HXohU4A6IH11w6h0dwcEyn" False) (C1 (MetaCons "Localhost" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Unix" PrefixI False) (U1 :: Type -> Type))

start Source #

Arguments

:: [(String, String)]	Extra options which override the defaults
-> IO (Either StartError DB)

start postgres and use the current processes stdout and stderr

startLocalhost Source #

Arguments

:: [(String, String)]	Extra options which override the defaults
-> IO (Either StartError DB)

start postgres and use the current processes stdout and stderr but use TCP on localhost instead of a unix socket.

fourth :: (a, b, c, d) -> d Source #

procWith :: Handle -> Handle -> String -> [String] -> CreateProcess Source #

config :: Maybe FilePath -> String Source #

data StartError Source #

Constructors

InitDBFailed ExitCode
CreateDBFailed [String] ExitCode
StartPostgresFailed [String] ExitCode
StartPostgresDisappeared [String]

Instances

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

throwIfError :: (ExitCode -> StartError) -> ExitCode -> IO () Source #

pidString :: ProcessHandle -> IO String Source #

runProcessWith :: Handle -> Handle -> String -> String -> [String] -> IO ExitCode Source #

startWithHandles Source #

Arguments

:: SocketClass
-> [(String, String)]	Extra options which override the defaults
-> Handle	stdout
-> Handle	stderr
-> IO (Either StartError DB)

Start postgres and pass in handles for stdout and stderr

startWithHandlesAndDir :: SocketClass -> [(String, String)] -> FilePath -> Handle -> Handle -> IO (Either StartError DB) Source #

data AnotherPostgresProcessActive Source #

This error is thrown is startPostgres is called twice without calling stopPostgres first.

Constructors

AnotherPostgresProcessActive

Instances

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

waitOnPostgres :: DB -> IO () Source #

reloadConfig :: DB -> IO () Source #

Send the SIGHUP signal to the postgres process to start a config reload

startPostgres :: DB -> IO () Source #

This throws AnotherPostgresProcessActive if the postgres has not been stopped using stopPostgres. This function attempts to the pidLock before running. If postgres process fails this throws StartPostgresFailed. If the postgres process becomes Nothing while starting this function throws StartPostgresDisappeared.

stopPostgres :: DB -> IO (Maybe ExitCode) Source #

Stop the postgres process. This function attempts to the pidLock before running. stopPostgres will terminate all connections before shutting down postgres. stopPostgres is useful for testing backup strategies.

makePostgresOptions :: [(String, String)] -> FilePath -> Int -> [String] Source #

runPostgres :: Handle -> Handle -> [String] -> IO ProcessHandle Source #

data Event Source #

Constructors

InitDB
WriteConfig
FreePort
StartPostgres
WaitForDB
CreateDB
Finished

Instances

Bounded Event Source #
Instance details Defined in Database.Postgres.Temp.Internal Methods minBound :: Event # maxBound :: Event #
Enum Event Source #
Instance details Defined in Database.Postgres.Temp.Internal Methods succ :: Event -> Event # pred :: Event -> Event # toEnum :: Int -> Event # fromEnum :: Event -> Int # enumFrom :: Event -> [Event] # enumFromThen :: Event -> Event -> [Event] # enumFromTo :: Event -> Event -> [Event] # enumFromThenTo :: Event -> Event -> Event -> [Event] #
Eq Event Source #
Instance details Defined in Database.Postgres.Temp.Internal Methods (==) :: Event -> Event -> Bool # (/=) :: Event -> Event -> Bool #
Ord Event Source #
Instance details Defined in Database.Postgres.Temp.Internal 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 Methods showsPrec :: Int -> Event -> ShowS # show :: Event -> String # showList :: [Event] -> ShowS #

rmDirIgnoreErrors :: FilePath -> IO () Source #

startWithLogger :: (Event -> IO ()) -> SocketClass -> [(String, String)] -> FilePath -> Handle -> Handle -> IO (Either StartError DB) Source #

startAndLogToTmp Source #

Arguments

:: [(String, String)]	Extra options which override the defaults
-> IO (Either StartError DB)

Start postgres and log it's all stdout to {mainDir}/output.txt and {mainDir}/error.txt

terminateConnections :: DB -> IO () Source #

Force all connections to the database to close. Can be useful in some testing situations. Called during shutdown as well.

stop :: DB -> IO (Maybe ExitCode) Source #

Stop postgres and clean up the temporary database folder.