Database.Postgres.Temp.Internal

This module provides the high level functions that are re-exported by Database.Postgres.Temp. Additionally it includes some identifiers that are used for testing but are not exported.

Documentation

data DB

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.

Constructors

DB

Fields

• dbResources :: Resources

  Temporary resources and the final Plan.

• dbPostgresProcess :: PostgresProcess

  postgres process handle and the connection options.

toConnectionString :: DB -> ByteString

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

defaultPostgresConfig :: [String]

Default postgres options

defaultConfig :: Config

The default configuration. This will create a database called "test" and create a temporary directory for the data and a temporary directory for a unix socket on a random port. If you would like to customize this behavior you can start with the defaultConfig and overwrite fields or combine the Config with another config using <> (mappend). If you would like complete control over the behavior of initdb, postgres and createdb you can call the internal function initPlan directly although this should not be necessary.

standardConfig :: IO Config

standardConfig makes a default config with standardProcessConfig. It is used by default but can be overriden by the extra config.

startWith

Arguments

:: Config

extraConfiguration that is mappended to the generated Config. The extra config is mappended 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

start :: IO (Either StartError DB)

Default start behavior. Equivalent to calling startWith with the defaultConfig

stop :: DB -> IO ()

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

stopPostgres :: DB -> IO ExitCode

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

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

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

reloadConfig :: DB -> IO ()

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

withPlan

Arguments

:: Config

extraConfiguration. Combined with the generated Config. See startWith 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 postgresProcessClientConfig). All of the database resources are automatically cleaned up on completion even in the face of exceptions.

with

Arguments

:: (DB -> IO a)

action continuation.

-> IO (Either StartError a)

Default expectation safe interface. Equivalent to withPlan the defaultConfig

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

Exception safe version of restart

optionsToDefaultConfig :: Options -> Config

Attempt to create a config from a Options. This is useful if want to create a database owned by a specific user you will also log in as among other use cases. It is possible some Options are not supported so don't hesitate to open an issue on github if you find one.