tmp-postgres
Start and stop a temporary postgres
http://github.com/jfischoff/tmp-postgres#readme
| Version on this page: | 1.34.1.0 |
| LTS Haskell 21.25: | 1.34.1.0 |
| Stackage Nightly 2023-06-21: | 1.34.1.0 |
| Latest on Hackage: | 1.34.1.0@rev:1 |
tmp-postgres-1.34.1.0@sha256:7d6fd2e6f737890857aa60be1ba2828093c057db272e16180e99cd51566fead7,4753Module documentation for 1.34.1.0
tmp-postgres
tmp-postgres provides functions for creating a temporary postgres instance.
By default it will create a temporary data directory and
a temporary directory for a UNIX domain socket for postgres to listen on.
Here is an example using the expection safe ‘with’ function:
with $ \db -> bracket
(connectPostgreSQL (toConnectionString db))
close $
\conn -> execute_ conn "CREATE TABLE foo (id int)"
To extend or override the defaults use withConfig (or startConfig).
tmp-postgres ultimately calls initdb (optionally) , postgres and
createdb (optionally).
All of the command line, environment variables and configuration files that are generated by default for the respective executables can be extended.
In general tmp-postgres is useful if you want a clean temporary
postgres and do not want to worry about clashing with an existing
postgres instance (or needing to ensure postgres is already running).
Here are some different use cases for tmp-postgres and their respective
configurations:
- The default ‘with’ and ‘start’ functions can be used to make a sandboxed temporary database for testing.
- By disabling
initdbone could run a temporary isolated postgres on a base backup to test a migration. - By using the ‘stopPostgres’ and ‘withRestart’ functions one can test backup strategies.
WARNING!!
Ubuntu’s PostgreSQL installation does not put initdb on the PATH. We need to add it manually.
The necessary binaries are in the /usr/lib/postgresql/VERSION/bin/ directory, and should be added to the PATH
echo “export PATH=$PATH:/usr/lib/postgresql/VERSION/bin/” >> /home/ubuntu/.bashrc
Installation
macOS
$ brew install postgres
$ stack install tmp-postgres
Ubuntu
Ubuntu’s PostgreSQL installation does not put initdb on the PATH. We need to add it manually.
$ sudo apt-get install postgresql-VERSION
$ echo "export PATH=$PATH:/usr/lib/postgresql/VERSION/bin/" >> /home/ubuntu/.bashrc
$ stack install tmp-postgres