NAME

Geoffrey - Continuous Database Migration

VERSION

Version 0.000204

DESCRIPTION

Geoffrey is a pure Perl module.

Continuous Database Migration

A package which allows a continuous development with an application that hold the appropriate database system synchronously.

SYNOPSIS

    use DBI;
    use Geoffrey;

    my $dbh = DBI->connect( "dbi:SQLite:database=league.sqlite" );
    Geoffrey->new( dbh => $dbh )->read( $FindBin::Bin . '/../changelog' );

    ...
    
    my $dbh = DBI->connect( "dbi:Pg:dbname=database;host=127.0.0.1", "user", "password" );
    Geoffrey->new( 
        dbh => $dbh,
        converter_name => 'Pg'
    )->read( $FindBin::Bin . '/../changelog' );

SUBROUTINES/METHODS

new

Run to check converter version with installed db converter.

reader

Instantiates Geoffrey::Read object if none is the in the internal key 'reader' and returns it

writer

Instantiates Geoffrey::Write object if none is the in the internal key 'write' and returns it

read

Read main changelog file and sub changelog files Creates changelog table if it's not existing.

write

Write main changelog file and sub changelog files

delete

Delete a specific changeset as long there's no md5hash yet.

insert

Insert a new changeset

rewrite

The sub delete and insert combined

load_changeset

Get the value of a changeset by given changeset id.

MOTIVATION

When working with several people on a large project that is bound to a database. If you there and back the databases have different levels of development.

You can keep in sync with SQL statements, but these are then incompatible with other database systems.

It also should give the posibility to generate the same db schema on several databases without changing some sql scripts.

Constructor and initialization

new(...) returns an object of type Geoffrey.

This is the class's constructor.

Usage: Geoffrey->new().

This method takes a set of parameters. Only the dbh parameter is mandatory.

For each parameter you wish to use, call new as new(param_1 => value_1, ...).

dbh

This is a database handle, returned from DBI's connect() call.

This parameter is mandatory.

There is no default.

verbose

Method: read()

path to changelog folder

DIAGNOSTICS

CONFIGURATION AND ENVIRONMENT

DEPENDENCIES

INCOMPATIBILITIES

BUGS AND LIMITATIONS

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

    perldoc Geoffrey

You can also look for information at:

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

    AnnoCPAN, Annotated CPAN documentation
        http://annocpan.org/dist/Geoffrey

    CPAN Ratings
        http://cpanratings.perl.org/d/Geoffrey

    Search CPAN
        http://search.cpan.org/dist/Geoffrey/

SEE ALSO

DBIx::Admin::CreateTable

    The package from which the idea originated.

AUTHOR

Mario Zieschang, <mziescha at cpan.org>

LICENSE AND COPYRIGHT

Copyright 2015 Mario Zieschang.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, trade name, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANT ABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.