view release on metacpan or  search on metacpan

README.md  view on Meta::CPAN

# NAME

DBIx::TempDB - Create a temporary database

# VERSION

0.16

# SYNOPSIS

    use Test::More;
    use DBIx::TempDB;
    use DBI;

    # provide credentials with environment variables
    plan skip_all => 'TEST_PG_DSN=postgresql://postgres@localhost' unless $ENV{TEST_PG_DSN};

    # create a temp database
    my $tmpdb = DBIx::TempDB->new($ENV{TEST_PG_DSN});

    # print complete url to db server with database name
    diag $tmpdb->url;

    # useful for reading in fixtures
    $tmpdb->execute("create table users (name text)");
    $tmpdb->execute_file("path/to/file.sql");

    # connect to the temp database
    my $db = DBI->connect($tmpdb->dsn);

    # run tests...

    done_testing;
    # database is cleaned up when test exit

# DESCRIPTION

[DBIx::TempDB](https://metacpan.org/pod/DBIx%3A%3ATempDB) is a module which allows you to create a temporary database,
which only lives as long as your process is alive. This can be very
convenient when you want to run tests in parallel, without messing up the
state between tests.

This module currently support PostgreSQL, MySQL and SQLite by installing the optional
[DBD::Pg](https://metacpan.org/pod/DBD%3A%3APg), [DBD::mysql](https://metacpan.org/pod/DBD%3A%3Amysql) and/or [DBD::SQLite](https://metacpan.org/pod/DBD%3A%3ASQLite) modules.

Please create an [issue](https://github.com/jhthorsen/dbix-tempdb/issues)
or pull request for more backend support.

# CAVEAT

Creating a database is easy, but making sure it gets clean up when your
process exit is a totally different ball game. This means that
[DBIx::TempDB](https://metacpan.org/pod/DBIx%3A%3ATempDB) might fill up your server with random databases, unless
you choose the right "drop strategy". Have a look at the ["drop\_from\_child"](#drop_from_child)
parameter you can give to ["new"](#new) and test the different values and select
the one that works for you.

# ENVIRONMENT VARIABLES

## DBIX\_TEMP\_DB\_KEEP\_DATABASE

Setting this variable will disable the core feature in this module:
A unique database will be created, but it will not get dropped/deleted.

## DBIX\_TEMP\_DB\_URL

This variable is set by ["create\_database"](#create_database) and contains the complete
URL pointing to the temporary database.

Note that calling ["create\_database"](#create_database) on different instances of
[DBIx::TempDB](https://metacpan.org/pod/DBIx%3A%3ATempDB) will overwrite `DBIX_TEMP_DB_URL`.

# METHODS

## create\_database

    $tmpdb = $tmpdb->create_database;

This method will create a temp database for the current process. Calling this
method multiple times will simply do nothing. This method is normally
automatically called by ["new"](#new).

The database name generate is defined by the ["template"](#template) parameter passed to
["new"](#new), but normalization will be done to make it work for the given database.

## drop\_databases

    $tmpdb->drop_databases;
    $tmpdb->drop_databases({tmpdb => "include"});
    $tmpdb->drop_databases({tmpdb => "only"});
    $tmpdb->drop_databases({name => "some_database_name"});

Used to drop either sibling databases (default), sibling databases and the
current database or a given database by name.

## dsn

    ($dsn, $user, $pass, $attrs) = $tmpdb->dsn;