:: a typeCtrl KGHC 9.10.3 · lts/ghc-9.10.x · c74966e · 2026-09-27
Moduletmp-postgres-1.35.0.0Haskell2010
This module provides the low level functionality for running initdb, postgres and createdb to make a database.
See startPlan for more details.
Internal events for debugging
StartPlan StringThe first event. This useful for debugging
what is actual passed to the initdb, createdb and
postgres.
StartPostgresThe second event. Postgres is about to get called
WaitForDBThe third event. Postgres started. We are now about to setup a reconnect loop (racing with a process checker)
TryToConnectThe fourth event and (possibly all subsequent events).
We are looping trying to successfully connect to the postgres
process.
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.
StartPostgresFailed ExitCodepostgres failed before a connection succeeded. Most likely this
is due to invalid configuration
InitDbFailedinitdb failed. This can be from invalid configuration or using a
non-empty data directory
CreateDbFailedcreatedb failed. This can be from invalid configuration or
the database might already exist.
PlanFailed String [String]CompleteProcessConfigFailed String [String]The Database.Postgres.Temp.Config.ProcessConfig was missing info and a
CompleteProcessConfig could not be created.
ConnectionTimedOutTimed out waiting for postgres to accept a connection
DeleteDbError SqlErrorEmptyDataDirectoryThis will happen if a Database.Postgres.Temp.Config.Plan is missing a
Database.Postgres.Temp.Config.initDbConfig.
CopyCachedInitDbFailed String ExitCodeThis is called if copying a folder cache fails.
FailedToFindDataDirectory StringFailed to find a data directory when trying to get
a cached initdb folder.
SnapshotCopyFailed String ExitCodeWe tried to copy a data directory to a snapshot folder and it failed
Eq StartErrorDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.CoreShow StartErrorDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.CoreException StartErrorDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.CoreA way to log internal Events
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.
CompleteProcessConfig contains the configuration necessary for starting a process. It is essentially a stripped down CreateProcess.
CompleteProcessConfigcompleteProcessConfigEnvVars :: [(String, String)]Environment variables
completeProcessConfigCmdLine :: [String]Command line arguements
completeProcessConfigStdIn :: HandleThe Handle for standard input
completeProcessConfigStdOut :: HandleThe Handle for standard output
completeProcessConfigStdErr :: HandleThe Handle for standard error
completeProcessConfigCreateGroup :: BoolWhether or not to create new process group
Pretty CompleteProcessConfigDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.CoreStart a process interactively and return the ProcessHandle
Stop a ProcessHandle. An alias for waitForProcess
Start a process and block until it finishes return the ExitCode.
executeProcessAndTee Start a process and block until it finishes return the ExitCode and the stderr output.
CompletePostgresPlan is used be startPostgresProcess to start the
postgres and then attempt to connect to it.
CompletePostgresPlancompletePostgresPlanProcessConfig :: CompleteProcessConfigThe process config for postgres
completePostgresPlanClientOptions :: OptionsConnection options. Used to verify that postgres is ready.
Pretty CompletePostgresPlanDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.CoreThe output of calling startPostgresProcess.
PostgresProcesspostgresProcessClientOptions :: OptionsConnection options
postgresProcessHandle :: ProcessHandlepostgres process handle
Pretty PostgresProcessDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.CoreStop the postgres process after attempting to terminate all the
connections.
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.
Eq CompleteCopyDirectoryCommandDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.CoreOrd CompleteCopyDirectoryCommandDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.CoreShow CompleteCopyDirectoryCommandDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.CorePretty CompleteCopyDirectoryCommandDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.CoreCall createdb and tee the output to return if there is an
an exception. Throws CreateDbFailed.
Pretty InitDbCachePlanDefined in tmp-postgres-1.35.0.0 · Database.Postgres.Temp.Internal.CorePlan is the low level configuration necessary for initializing
a database cluster
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 Database.Postgres.Temp.start which will generate plans that
are valid. Plans are used internally but are exposed if the
higher level plan generation is not sufficent.
PlancompletePlanLogger :: LoggercompletePlanInitDb :: Maybe (Either CompleteProcessConfig InitDbCachePlan)completePlanCopy :: Maybe CompleteCopyDirectoryCommandcompletePlanCreateDb :: Maybe CompleteProcessConfigcompletePlanPostgres :: CompletePostgresPlancompletePlanConfig :: StringcompletePlanDataDirectory :: FilePathcompletePlanConnectionTimeout :: IntstartPlan 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.
Stop the postgres process. See stopPostgresProcess for more details.