# ABSTRACT: A gentle introduction to Geoffrey
package Geoffrey::Manual;
$Geoffrey::Manual::VERSION = '0.000205';
__END__

=pod

=head1 NAME

Geoffrey::Manual - A gentle introduction to Geoffrey

=head1 VERSION

Version 0.000205


=head1 DESCRIPTION

Continuous Database Migration
Package to databases in sync with the development of the application to keep.

=encoding utf8

=head1 INSTALL

Installation of Geoffrey is simple:

    perl -MCPAN -e 'install Geoffrey'

Thanks to the magic of cpanminus, if you do not have CPAN.pm configured, or just
want a quickfire way to get running, the following should work, at least on
Unix-like systems:

    wget -O - http://cpanmin.us | sudo perl - Geoffrey

(If you don't have root access, omit the 'sudo', and cpanminus will install
Geoffrey and prereqs into C<~/perl5>.)

=head1 MAIN CHANGELOG

=head2 Implement sub changelog files

There are two type of changelog files.
The main changelog which must be called changelog and the specific file end

    ...
    changelog.yml
    changelog.json
    ...

The sub changelog files are in the same directory as the main changelog file.
The difference is that the sub changelog files are defined by postfix.

In the changelog file:

    changelogs: 
  - "01"
  - "..."

The sub changelog is:

    changelog-01.yml
    changelog-....yml

=head2 Define Template

=head1 sub changelog ACTIONS

As long the specific converters is it supporting the following actions are possible.

    - add
    - alter
    - drop

=head2 Column

=head2 Constraint

=head2 Default

=head2 Index

=head2 Sequence

=head2 Table

=head2 View

=head2 Sql

It is possible to run custom sql statements.
WARNING: Execute sql statements can lead very likely to incompatibilities.
To run a sql statement add following entry:

    - action: sql
      as:  'SELECT * FROM "user"'


=head1 sub changelog COMMANDS

=head2 Changeset

To create a new changelog project call:

    geoffrey -c -dir=/path/to/directory

=head2 converter

If a specific converter is missing it is possible to add a new cpan module.
By calling:

    geoffrey -md --author='Author' -email='mail@cpan.org' -converter=MySQL -dir=/path/to/directory

=head2 File

If a specific file reader is missing it is possible to add a new cpan module.
The changelog reader expects a hashref for each changeset
By calling:

    geoffrey -mf -a='Author' -@='mail@cpan.org' -t=XML -dir=/path/to/directory

=head1 AUTHOR

Mario Zieschang, C<< <mziescha at cpan.org> >>

=head1 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:

L<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.


=cut
