/ 
Pg-CLI-0.14
River stage one • 2 direct dependents • 4 total dependents
/ Pg::CLI::createdb

NAME

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

VERSION

version 0.14

SYNOPSIS

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

$createdb->run(
    database => 'NewDB',
    options  => [
        '--encoding', 'UTF-8',
        '--owner',    'alice',
    ],
);

DESCRIPTION

This class provides a wrapper for the createdb utility.

METHODS

This class provides the following methods:

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

The constructor accepts a number of parameters:

  • executable

    The path to createdb. By default, this will look for createdb 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.

$createdb->run( database => $db, ... )

This method runs the createdb command with the given options.

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.

Most notably, you can pass scalar references to pipe data in via the stdin parameter or capture output sent to stdout or stderr

This method accepts the following arguments:

  • database

    The name of the database to create. Required.

  • options

    A list of additional options to pass to the command. Optional.

SUPPORT

Bugs may be submitted at http://rt.cpan.org/Public/Dist/Display.html?Name=Pg-CLI or via email to bug-pg-cli@rt.cpan.org.

I am also usually active on IRC as 'autarch' on irc://irc.perl.org.

SOURCE

The source code repository for Pg-CLI can be found at https://github.com/houseabsolute/Pg-CLI.

AUTHOR

Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2018 by Dave Rolsky.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)

The full text of the license can be found in the LICENSE file included with this distribution.