NAME

       Test::PostgreSQL - PostgreSQL runner for tests

SYNOPSIS

         use DBI;
         use Test::PostgreSQL;
         use Test::More;

         # optionally
         # (if not already set at shell):
         #
         # $ENV{POSTGRES_HOME} = '/path/to/my/pgsql/installation';

         my $pgsql = Test::PostgreSQL->new()
             or plan skip_all => $Test::PostgreSQL::errstr;

         plan tests => XXX;

         my $dbh = DBI->connect($pgsql->dsn);

DESCRIPTION

       "Test::PostgreSQL" automatically setups a PostgreSQL instance in a temporary directory, and destroys it
       when the perl script exits.

       This module is a fork of Test::postgresql, which was abandoned by its author several years ago.

FUNCTIONS

   new
       Create and run a PostgreSQL instance.  The instance is terminated when the returned object is being
       DESTROYed.  If required programs (initdb and postmaster) were not found, the function returns undef and
       sets appropriate message to $Test::PostgreSQL::errstr.

   base_dir
       Returns directory under which the PostgreSQL instance is being created.  The property can be set as a
       parameter of the "new" function, in which case the directory will not be removed at exit.

   initdb
   postmaster
       Path to "initdb" and "postmaster" which are part of the PostgreSQL distribution.  If not set, the
       programs are automatically searched by looking up $PATH and other prefixed directories. Since
       "postmaster" is deprecated in newer PostgreSQL versions "postgres" is used in preference to "postmaster".

   pg_ctl
       Path to "pg_ctl" which is part of the PostgreSQL distribution.

       Starting with PostgreSQL version 9.0 <pg_ctl> can be used to start/stop postgres without having to use
       fork/pipe and will be chosen automatically if "pg_ctl" is not set but the program is found and the
       version is recent enough.

       NOTE: do NOT use this with PostgreSQL versions prior to version 9.0.

   initdb_args
       Defaults to "-U postgres -A trust"

   extra_initdb_args
       Extra args to be appended to "initdb_args"

   postmaster_args
       Defaults to "-h 127.0.0.1 -F"

   extra_postmaster_args
       Extra args to be appended to "postmaster_args"

   dsn
       Builds and returns dsn by using given parameters (if any).  Default username is 'postgres', and dbname is
       'test' (an empty database).

   uri
       Builds and returns a connection URI using the given parameters (if any). See URI::db for details about
       the format.

       Default username is 'postgres', and dbname is 'test' (an empty database).

   pid
       Returns process id of PostgreSQL (or undef if not running).

   port
       Returns TCP port number on which postmaster is accepting connections (or undef if not running).

   start
       Starts postmaster.

   stop
       Stops postmaster.

   setup
       Setups the PostgreSQL instance.

ENVIRONMENT

   POSTGRES_HOME
       If your postgres installation is not located in a well known path, or you have many versions installed
       and want to run your tests against particular one, set this environment variable to the desired path. For
       example:

        export POSTGRES_HOME='/usr/local/pgsql94beta'

       This is the same idea and variable name which is used by the installer of DBD::Pg.

AUTHOR

       Toby Corkindale, Kazuho Oku, Peter Mottram, plus various contributors.

COPYRIGHT

       Current version copyright © 2012-2015 Toby Corkindale.

       Previous versions copyright (C) 2009 Cybozu Labs, Inc.

LICENSE

       This module is free software, released under the Perl Artistic License 2.0.  See
       <http://www.perlfoundation.org/artistic_license_2_0> for more information.