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.

initdb_args

postmaster_args

Arguments passed to "initdb" and "postmaster". Following example adds --encoding=utf8 option to "initdb_args".

  my $pgsql = Test::postgresql->new(
      initdb_args
          => $Test::postgresql::Defaults{initdb_args} . ' --encoding=utf8'
  ) or plan skip_all => $Test::postgresql::errstr;

dsn

Builds and returns dsn by using given parameters (if any). 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.