NAME

Pg::CLI::pg_restore - Wrapper for the pg_restore utility

VERSION

version 0.10

SYNOPSIS

  my $pg_restore = Pg::CLI::pg_restore->new(
      username => 'foo',
      password => 'bar',
      host     => 'pg.example.com',
      port     => 5433,
  );

  $pg_restore->run(
      database => 'database',
      options  => [ '-C' ],
  );

  my $sql;
  $pg_restore->run(
      database => 'database',
      options  => ['-C'],
      stdin    => \$sql,
  );

DESCRIPTION

This class provides a wrapper for the pg_restore utility.

METHODS

This class provides the following methods:

Pg::CLI::pg_restore->new( ... )

The constructor accepts a number of parameters:

executable
The path to pg_restore. By default, this will look for pg_restore in your path and throw an error if it cannot be found.
username
The username to use when connecting to the database. Optional.
password
The password to use when connecting to the database. Optional.
host
The host to use when connecting to the database. Optional.
port
The port to use when connecting to the database. Optional.
require_ssl
If this is true, then the PGSSLMODE environment variable will be set to "require" when connecting to the database.

$pg_restore->run( database => ..., options => [ ... ] )

This method restores the specified database. Any values passed in options will be passed on to pg_restore.

This method also accepts optional stdin, stdout, and stderr parameters. These parameters can be any defined value that could be passed as the relevant parameter to IPC::Run3's run3 subroutine.

Notably, you can capture the restore output in a scalar reference for the stdout output.

$pg_restore->version()

Returns a the three part version as a string.

$pg_restore->two_part_version()

Returns the first two decimal numbers in the version.

BUGS

See Pg::CLI for bug reporting details.

AUTHOR

Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)