Database.PostgreSQL.Tmp

Create temporary postgresql databases.

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

Documentation

defaultDB :: ByteString

Connection string for the postgres database owned by the postgres user

data DBInfo

The data necessary to connect to the temporary database

Constructors

DBInfo

Fields

• dbName :: Text
• roleName :: Text

Instances

Eq DBInfo

Methods

(==) :: DBInfo -> DBInfo -> Bool

(/=) :: DBInfo -> DBInfo -> Bool

Ord DBInfo

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

Methods

readsPrec :: Int -> ReadS DBInfo

readList :: ReadS [DBInfo]

readPrec :: ReadPrec DBInfo

readListPrec :: ReadPrec [DBInfo]

Show DBInfo

Methods

showsPrec :: Int -> DBInfo -> ShowS

show :: DBInfo -> String

showList :: [DBInfo] -> ShowS

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

Convenience wrapper for withTmpDB' using defaultDB

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

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)

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 ()

Destroy the database and the role created by createTmpDB.

newRole :: Connection -> IO Text

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

Drop the role.

newDB :: Connection -> Text -> IO Text

Create a new database that is owned by the user.

dropDB :: Connection -> Text -> IO Int64

Drop the database.