Default expectation safe interface. Equivalent to withConfig the defaultConfig

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.

Default start behavior. Equivalent to calling startConfig with the defaultConfig

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 the postgres process and cleanup any temporary directories that might have been created.

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"

   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.

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

defaultPostgresConf extra = defaultConfig <> mempty
  { configPlan = mempty
    { partialPlanConfig = extra
    }
  }

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

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.

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

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

Exception safe version of restart

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

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

Convert a DB to a connection Options type.

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

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.

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.

Display a DB

The high level options for overriding default behavior.

Display a Config.

A type to track whether a file is temporary and needs to be cleaned up.

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.

A type for configuring the listening address of the postgres process. postgres can listen on several types of sockets simulatanously but we don't support that behavior. One can either listen on a IP based socket or a UNIX domain socket.

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

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

A type to help combine command line arguments.

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

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

PartialPostgresPlan

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

The output of calling startPostgresProcess.

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

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.