Safe Haskell	None
Language	Haskell2010

Database.PostgreSQL.Tmp

Contents

Low level APIs

Description

Create temporary postgresql databases.

The main usecase for this are tests where you don’t want to assume that a certain database exists.

Synopsis

Documentation

defaultDB :: ByteString Source #

Connection string for the postgres database owned by the postgres user

data DBInfo Source #

The data necessary to connect to the temporary database

Constructors

DBInfo
Fields dbName :: Text roleName :: Text

Instances

Eq DBInfo Source #
Methods (==) :: DBInfo -> DBInfo -> Bool # (/=) :: DBInfo -> DBInfo -> Bool #
Ord DBInfo Source #
Methods compare :: DBInfo -> DBInfo -> Ordering # (<) :: DBInfo -> DBInfo -> Bool # (<=) :: DBInfo -> DBInfo -> Bool # (>) :: DBInfo -> DBInfo -> Bool # (>=) :: DBInfo -> DBInfo -> Bool # max :: DBInfo -> DBInfo -> DBInfo # min :: DBInfo -> DBInfo -> DBInfo #
Read DBInfo Source #
Methods readsPrec :: Int -> ReadS DBInfo # readList :: ReadS [DBInfo] # readPrec :: ReadPrec DBInfo # readListPrec :: ReadPrec [DBInfo] #
Show DBInfo Source #
Methods showsPrec :: Int -> DBInfo -> ShowS # show :: DBInfo -> String # showList :: [DBInfo] -> ShowS #

withTmpDB :: (DBInfo -> IO a) -> IO a Source #

Convenience wrapper for withTmpDB' using defaultDB

withTmpDB' :: ByteString -> (DBInfo -> IO a) -> IO a Source #

Create a temporary database and a temporary role that the callback can operate on. After the action has finished the database and the role are destroyed.

This is a bracket-style wrapper around createTmpDB and dropTmpDB

This function assumes that the connection string points to a database containing the tables called pg_roles and pg_database and that the user has the CREATEDB and CREATEROLE privileges.

Low level APIs

createTmpDB :: ByteString -> IO (Connection, DBInfo) Source #

Create a temporary database and a temporary role.

To destroy the database and the role use dropTmpDB.

This function assumes that the connection string points to a database containing the tables called pg_roles and pg_database and that the user has the CREATEDB and CREATEROLE privileges.

dropTmpDB :: (Connection, DBInfo) -> IO () Source #

Destroy the database and the role created by createTmpDB.

newRole :: Connection -> IO Text Source #

Create a new role that does not already exist and return its name.

The new role does not have a password and has the CREATEDB privilege. The database that the connection points to is assumed to contain a table called pg_roles with a rolname column.

dropRole :: Connection -> Text -> IO Int64 Source #

Drop the role.

newDB :: Connection -> Text -> IO Text Source #

Create a new database that is owned by the user.

dropDB :: Connection -> Text -> IO Int64 Source #

Drop the database.