NAME

App::LedgerSMB::Admin::Database - Administer LedgerSMB Databases

SYNOPSIS

Upgrading to 1.4 from 1.3, after updating 1.3 instance to latest:

use App::LedgerSMB::Admin;
use App::LedgerSMB::Admin::Database;
App::LedgerSMB::Admin->add_paths(
   '1.3' => '/usr/local/ledgersmb_1.3',
   '1.4' => '/usr/local/ledgersmb_1.4',
); # setting the version paths
my $db = App::LedgerSMB::Admin::Database->new(
   username  => 'postgres',
   password  => 'secretpassword',
   host      => 'localhost',
   port      => '5432',
   dbname    => 'mycompany',
);
if ($db->major_version eq '1.3') {
    $db->reload;
    $db->upgrade_to('1.4');
}

VERSION

0.01

PROPERTIES INHERITED FROM PGObject::Util::DBAdmin

Please see the docs for PGObject::Util::DBAdmin.

username

password

host

port

dbname

ADDITIONAL PROPERTIES

version

Returns the version number of the database.

major_version

Major versions are generally understood to be not backwards compatible. In LedgerSMB, as with PostgreSQL, major versions are based on the second numbers in the version, so 1.2, 1.3, and 1.4 are major versions.

METHODS INHERITED

Please see the docs for PGObject::Util::DBAdmin

create

connect

drop

run_file

backup

restore_backup

NEW METHODS

load($major_version)

Loads the db schema for the major version requested.

reload

Reloads all modules in a LedgerSMB instance.

process_loadorder($sql_path, $loadorder_path);

Processes a specific loadorder. Useful for installing extensions to LedgerSMB

Dies if any SQL files produce errors except from a file starting with "Fixes."

process_old_roles($rolefile)

Processes an old-style (1.3-era) roles file and runes it on the database.

upgrade_to($major_version)

Upgrades to the major version specified. Provides an error if the upgrade file is not found.

LICENSE AND COPYRIGHT

Copyright 2014 Chris Travers.

This program is distributed under the (Revised) BSD License: 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.