view release on metacpan or  search on metacpan

lib/App/DiffDBSchemaUtils.pm  view on Meta::CPAN

package App::DiffDBSchemaUtils;

our $DATE = '2018-12-03'; # DATE
our $VERSION = '0.002'; # VERSION

use 5.010001;
use strict;
use warnings;

our %SPEC;

our %args_dbconnect = (
    dsn1 => {
        schema => 'str*',
        req => 1,
        pos => 0,
        tags => ['category:db-connection'],
    },
    username1 => {
        schema => 'str*',
        tags => ['category:db-connection'],
    },
    password1 => {
        schema => 'str*',
        tags => ['category:db-connection'],
    },
    dsn2 => {
        schema => 'str*',
        req => 1,
        pos => 1,
        tags => ['category:db-connection'],
    },
    username2 => {
        schema => 'str*',
        tags => ['category:db-connection'],
    },
    password2 => {
        schema => 'str*',
        tags => ['category:db-connection'],
    },
);

our %args_dbconnect_mysql = %args_dbconnect;
delete $args_dbconnect_mysql{dsn1};
delete $args_dbconnect_mysql{dsn2};
%args_dbconnect_mysql = (
    %args_dbconnect_mysql,
    db1 => {
        summary => 'Name of the first MySQL database',
        schema => 'str*',
        req => 1,
        pos => 0,
        tags => ['category:db-connection'],
    },
    db2 => {
        summary => 'Name of the second MySQL database',
        schema => 'str*',
        req => 1,
        pos => 1,
        tags => ['category:db-connection'],
    },
);

our %args_dbconnect_pg = %args_dbconnect;
delete $args_dbconnect_pg{dsn1};
delete $args_dbconnect_pg{dsn2};
%args_dbconnect_pg = (
    %args_dbconnect_pg,
    db1 => {
        summary => 'Name of the first PostgreSQL database',
        schema => 'str*',
        req => 1,
        pos => 0,
        tags => ['category:db-connection'],
    },
    db2 => {
        summary => 'Name of the second PostgreSQL database',
        schema => 'str*',
        req => 1,
        pos => 1,
        tags => ['category:db-connection'],
    },
);

our %args_dbconnect_sqlite = %args_dbconnect;
delete $args_dbconnect_sqlite{dsn1};
delete $args_dbconnect_sqlite{dsn2};
%args_dbconnect_sqlite = (
    %args_dbconnect_sqlite,
    db1 => {
        summary => 'Path to the first SQLite database',
        schema => 'str*',
        req => 1,
        pos => 0,
        tags => ['category:db-connection'],
    },
    db2 => {
        summary => 'Path to the second SQLite database',
        schema => 'str*',
        req => 1,
        pos => 1,
        tags => ['category:db-connection'],
    },
);

#$SPEC{dump_db_schema} = {
#    v => 1.1,
#    args => {
#        %args_dbconnect,
#    },
#};
#sub dump_db_schema {
#    require DBIx::Connect::Any;
#
#    my %args = @_;
#
#    my $dbh = DBIx::Connect::Any->connect(
#        $args{dsn}, $args{username}, $args{password},
#        {RaiseError=>1});
#
#}

$SPEC{diff_db_schema} = {
    v => 1.1,
    summary => 'Diff two database schemas',
    args => {
        %args_dbconnect,
    },
};
sub diff_db_schema {
    require DBIx::Connect::Any;

    my %args = @_;

    my $dbh1 = DBIx::Connect::Any->connect(
        $args{dsn1}, $args{username1}, $args{password1},
        {RaiseError=>1});
    my $dbh2 = DBIx::Connect::Any->connect(
        $args{dsn2}, $args{username2}, $args{password2},
        {RaiseError=>1});

    require DBIx::Diff::Schema;

    my $res = DBIx::Diff::Schema::diff_db_schema($dbh1, $dbh2);
    [200, "OK", $res];
}

$SPEC{diff_mysql_schema} = {
    v => 1.1,
    summary => 'Diff two MySQL database schemas',
    description => <<'_',

Convenient thin wrapper for `diff_db_schema`, when you have two MySQL databases.
Instead of having to specify two DSN's, you just specify two database names.

_
    args => {
        %args_dbconnect_mysql,
    },
};
sub diff_mysql_schema {
    my %args = @_;

    $args{dsn1} = "DBI:mysql:database=".(delete $args{db1});
    $args{dsn2} = "DBI:mysql:database=".(delete $args{db2});
    diff_db_schema(%args);
}

$SPEC{diff_pg_schema} = {
    v => 1.1,
    summary => 'Diff two PostgreSQL database schemas',
    description => <<'_',

Convenient thin wrapper for `diff_db_schema`, when you have two PostgreSQL
databases. Instead of having to specify two DSN's, you just specify two database
names.

_
    args => {
        %args_dbconnect_pg,
    },
};
sub diff_pg_schema {
    my %args = @_;

    $args{dsn1} = "DBI:Pg:dbname=".(delete $args{db1});
    $args{dsn2} = "DBI:Pg:dbname=".(delete $args{db2});
    diff_db_schema(%args);
}

$SPEC{diff_sqlite_schema} = {
    v => 1.1,
    summary => 'Diff two SQLite database schemas',
    description => <<'_',

Convenient thin wrapper for `diff_db_schema`, when you have two SQLite
databases. Instead of having to specify two DSN's, you just specify two database
paths.

lib/App/DiffDBSchemaUtils.pm  view on Meta::CPAN

    $args{dsn1} = "DBI:SQLite:dbname=".(delete $args{db1});
    $args{dsn2} = "DBI:SQLite:dbname=".(delete $args{db2});
    diff_db_schema(%args);
}

1;
# ABSTRACT: Utilities related to diff-ing DB schemas

__END__

=pod

=encoding UTF-8

=head1 NAME

App::DiffDBSchemaUtils - Utilities related to diff-ing DB schemas

=head1 VERSION

This document describes version 0.002 of App::DiffDBSchemaUtils (from Perl distribution App-DiffDBSchemaUtils), released on 2018-12-03.

=head1 DESCRIPTION

This distribution includes several utilities:

=over

=item * L<diff-db-schema>

=item * L<diff-mysql-schema>

=item * L<diff-pg-schema>

=item * L<diff-sqlite-schema>

=back

=head1 FUNCTIONS


=head2 diff_db_schema

Usage:

 diff_db_schema(%args) -> [status, msg, payload, meta]

Diff two database schemas.

This function is not exported.

Arguments ('*' denotes required arguments):

=over 4

=item * B<dsn1>* => I<str>

=item * B<dsn2>* => I<str>

=item * B<password1> => I<str>

=item * B<password2> => I<str>

=item * B<username1> => I<str>

=item * B<username2> => I<str>

=back

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code
(200 means OK, 4xx caller error, 5xx function error). Second element
(msg) is a string containing error message, or 'OK' if status is
200. Third element (payload) is optional, the actual result. Fourth
element (meta) is called result metadata and is optional, a hash
that contains extra information.

Return value:  (any)


=head2 diff_mysql_schema

Usage:

 diff_mysql_schema(%args) -> [status, msg, payload, meta]

Diff two MySQL database schemas.

Convenient thin wrapper for C<diff_db_schema>, when you have two MySQL databases.
Instead of having to specify two DSN's, you just specify two database names.

This function is not exported.

Arguments ('*' denotes required arguments):

=over 4

=item * B<db1>* => I<str>

Name of the first MySQL database.

=item * B<db2>* => I<str>

Name of the second MySQL database.

=item * B<password1> => I<str>

=item * B<password2> => I<str>

=item * B<username1> => I<str>

=item * B<username2> => I<str>

=back

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code
(200 means OK, 4xx caller error, 5xx function error). Second element
(msg) is a string containing error message, or 'OK' if status is
200. Third element (payload) is optional, the actual result. Fourth
element (meta) is called result metadata and is optional, a hash
that contains extra information.

Return value:  (any)


=head2 diff_pg_schema

Usage:

 diff_pg_schema(%args) -> [status, msg, payload, meta]

Diff two PostgreSQL database schemas.

Convenient thin wrapper for C<diff_db_schema>, when you have two PostgreSQL
databases. Instead of having to specify two DSN's, you just specify two database
names.

This function is not exported.

Arguments ('*' denotes required arguments):

=over 4

=item * B<db1>* => I<str>

Name of the first PostgreSQL database.

=item * B<db2>* => I<str>

Name of the second PostgreSQL database.

=item * B<password1> => I<str>

=item * B<password2> => I<str>

=item * B<username1> => I<str>

=item * B<username2> => I<str>

=back

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code
(200 means OK, 4xx caller error, 5xx function error). Second element
(msg) is a string containing error message, or 'OK' if status is
200. Third element (payload) is optional, the actual result. Fourth
element (meta) is called result metadata and is optional, a hash
that contains extra information.

Return value:  (any)


=head2 diff_sqlite_schema

Usage:

 diff_sqlite_schema(%args) -> [status, msg, payload, meta]

Diff two SQLite database schemas.

Convenient thin wrapper for C<diff_db_schema>, when you have two SQLite
databases. Instead of having to specify two DSN's, you just specify two database
paths.

This function is not exported.

Arguments ('*' denotes required arguments):

=over 4

=item * B<db1>* => I<str>

Name of the first PostgreSQL database.

=item * B<db2>* => I<str>

Name of the second PostgreSQL database.

=item * B<password1> => I<str>

=item * B<password2> => I<str>

=item * B<username1> => I<str>

=item * B<username2> => I<str>

=back

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code
(200 means OK, 4xx caller error, 5xx function error). Second element
(msg) is a string containing error message, or 'OK' if status is
200. Third element (payload) is optional, the actual result. Fourth
element (meta) is called result metadata and is optional, a hash
that contains extra information.

Return value:  (any)

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/App-DiffDBSchemaUtils>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-App-DiffDBSchemaUtils>.

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-DiffDBSchemaUtils>

When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.

=head1 SEE ALSO

L<DBIx::Diff::Schema>

For MySQL: L<MySQL::Diff> and its CLI L<mysqldiff> which can compare live
database schemas or database schemas specified as SQL. Outputs SQL statements
that express the difference.

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2018 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut