Default expectation safe interface. Equivalent to

  with = withConfig defaultConfig

Since: 1.15.0.0

Exception safe database create with options. See startConfig for more details. Calls stop even in the face of exceptions.

Since: 1.15.0.0

Exception safe version of restart.

Since: 1.12.0.0

Equivalent to withDbCacheConfig with the CacheConfig defaultCacheConfig makes.

Since: 1.20.0.0

Enable initdb data directory caching. This can lead to a 4x speedup.

Exception safe version of setupInitDbCache. Equivalent to

   withDbCacheConfig = bracket (setupInitDbCache config) cleanupInitDbCache

Since: 1.20.0.0

Exception safe method for taking a file system level copy of the database cluster.

Snapshots are useful if you would like to start every test from a migrated database and the migration process is more time consuming then copying the additional data.

Since: 1.20.0.0

Default start behavior. Equivalent to calling startConfig with the defaultConfig.

Since: 1.12.0.0

Create zero or more temporary resources and use them to make a Config.

The passed in config is inspected and a generated config is created. The final config is built by

  generated <> extra

Based on the value of socketDirectory a "postgresql.conf" is created with:

  listen_addresses = '127.0.0.1, ::1'
  unix_socket_directories = 'SOCKET_DIRECTORY'

Additionally the generated Config also does the following:

• Sets a connectionTimeout of one minute.
• Logs internal Events.
• Sets the processes to use the standard input and output handles.
• Sets the dataDirectoryString to file path generated from dataDirectory.

All of these values can be overrided by the extra config.

The returned DB requires cleanup. startConfig should be used with a bracket and stop, e.g.

  withConfig :: Config -> (DB -> IO a) -> IO (Either StartError a)
  withConfig plan f = bracket (startConfig plan) (either mempty stop) $
     either (pure . Left) (fmap Right . f)

or just use withConfig. If you are calling startConfig you probably want withConfig anyway.

Since: 1.15.0.0

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

Since: 1.12.0.0

Restart the postgres from DB using the prior Plan.

Since: 1.12.0.0

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

Since: 1.12.0.0

Only stop the postgres process but leave any temporary resources. In contrast to stopPostgres this function makes sure postgres has time to properly write files to the data directory.

Since: 1.16.1.0

Setup the initdb cache folder.

Cleanup the cache directory if it was Temporary.

Since: 1.20.0.0

Shutdown the database and copy the directory to a folder.

Since: 1.20.0.0

Cleanup any temporary resources used for the snapshot.

Since: 1.20.0.0

Handle for holding temporary resources, the postgres process handle and postgres connection information. The DB also includes the final plan used to start initdb, createdb and postgres. See toConnectionString or toConnectionOptions for converting a DB to postgresql connection string.

Since: 1.12.0.0

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

Since: 1.12.0.0

Convert a DB to a connection Options type.

Since: 1.12.0.0

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

Since: 1.12.0.0

Get the directory that is used to create other temporary directories

Since: 1.12.0.0

Make the data directory permanent. Useful for debugging. If you are using with or withConfig this function will not modify the DB that is passed for cleanup. You will need to setup your own bracket like

   bracket (fmap makeDataDirPermanent start) (either mempty stop)

Since: 1.12.0.0

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

Since: 1.12.0.0

Display a DB.

Since: 1.12.0.0

A type to track a possibly temporary snapshot directory

Since: 1.20.0.0

A handle to cache temporary resources and configuration.

Since: 1.20.0.0

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.

Since: 1.12.0.0

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 the following "postgresql.conf" which is optimized for performance.

   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.

The defaultConfig also disables the logging of internal Events.

To append additional lines to "postgresql.conf" file create a custom Config like the following.

 custom = defaultConfig <> mempty
   { plan = mempty
     { postgresConfigFile =
         [ "wal_level = replica"
         , "archive_mode = on"
         , "max_wal_senders = 2"
         , "fsync = on"
         , "synchronous_commit = on"
         ]
     }
   }

Or using the provided lenses and your favorite lens library:

 custom = defaultConfig & planL . postgresConfigFileL <>~
   [ "wal_level = replica"
   , "archive_mode = on"
   , "max_wal_senders = 2"
   , "fsync = on"
   , "synchronous_commit = on"
   ]

This is common enough there is defaultPostgresConf which is a helper to do this.

As an alternative to using defaultConfig one could create a config from connections parameters using optionsToDefaultConfig.

Since: 1.12.0.0

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

defaultPostgresConf extra = defaultConfig <> mempty
  { plan = mempty
    { postgresConfigFile = extra
    }
  }

or with lenses:

defaultPostgresConf extra = defaultConfig & planL . postgresConfigFileL <>~ extra

Since: 1.12.0.0

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

Since: 1.12.0.0

The similar to defaultConfig but all the handles are set to /dev/null. and uses a postgresql.conf which disables logging:

  shared_buffers = 12MB
  fsync = off
  synchronous_commit = off
  full_page_writes = off
  log_min_messages = PANIC
  log_min_error_statement = PANIC
  log_statement = none
  client_min_messages = ERROR

See silentProcessConfig as well.

Since: 1.14.0.0

silentProcessConfig sets the handles to /dev/null and inherits the environment variables from the calling process.

Since: 1.12.0.0

defaultCacheConfig attempts to determine if the cp on the path supports "copy on write" flags and if it does, sets cacheUseCopyOnWrite to True.

It sets cacheDirectoryType to Permanent ~/.tmp-postgres and cacheTemporaryDirectory to /tmp (but this is not used when Permanent is set).

Since: 1.19.0.0

Convert a snapshot into a Config that includes a copyConfig for copying the snapshot directory to a temporary directory.

Since: 1.20.0.0

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.

Since: 1.15.0.0

Configuration for the initdb data directory cache.

Since: 1.20.0.0