nick-prater / pgobject-util-dbadmin Goto Github PK

PGObject-Util-DBAdmin

This module provides a basic interface to command line utilities.  With it
you can create and drop databases, list databases, take and restore backups,
and run sql files against databases.

INSTALLATION

To install this module, run the following commands:

	perl Makefile.PL
	make
	make test
	make install


TESTING

By default, tests which interact with a database are not run. To run the
full test suite, set environment variable DB_TESTING=1.  The database
password may be set with environment variable PGPASSWORD.

For example:

	 DB_TESTING=1 PGPASSWORD=XXXXX make test

Database tests are run using a database named `pgobject_test_db`, which
will be dropped if it already exists.


SUPPORT AND DOCUMENTATION

After installing, you can find documentation for this module with the
perldoc command.

    perldoc PGObject::Util::DBAdmin

You can also look for information at:

    RT, CPAN's request tracker (report bugs here)
        http://rt.cpan.org/NoAuth/Bugs.html?Dist=PGObject-Util-DBAdmin

    AnnoCPAN, Annotated CPAN documentation
        http://annocpan.org/dist/PGObject-Util-DBAdmin

    CPAN Ratings
        http://cpanratings.perl.org/d/PGObject-Util-DBAdmin

    Search CPAN
        http://search.cpan.org/dist/PGObject-Util-DBAdmin/

    GitHub source code repository (contribute patches here)
        https://github.com/ledgersmb/PGObject-Util-DBAdmin


LICENSE AND COPYRIGHT

Copyright (C) 2014-2018 Chris Travers

This program is distributed under the (Revised) BSD License:
L<http://www.opensource.org/licenses/BSD-3-Clause>

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

* Neither the name of Chris Travers's Organization
nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written
permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.