DBIx::Diff::Schema - Compare schema of two DBI databases
This document describes version 0.097 of DBIx::Diff::Schema (from Perl distribution DBIx-Diff-Schema), released on 2020-05-06.
use DBIx::Diff::Schema qw(diff_db_schema diff_table_schema db_schema_eq table_schema_eq);
To compare schemas of whole databases:
my $res = diff_db_schema($dbh1, $dbh2); say "the two dbs are equal" if db_schema_eq($dbh1, $dbh2);
To compare schemas of a single table from two databases:
my $res = diff_table_schema($dbh1, $dbh2, 'tablename'); say "the two tables are equal" if table_schema_eq($dbh1, $dbh2, 'tablename');
Currently only tested on Postgres and SQLite.
Usage:
db_schema_eq($dbh1, $dbh2) -> any
Return true if two DBI databases have the same schema.
This is basically just a shortcut for:
my $res = diff_db_schema(...); !%$res;
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
$dbh1* => obj
DBI database handle for the first database.
$dbh2* => obj
DBI database handle for the second database.
Return value: (any)
diff_db_schema($dbh1, $dbh2) -> any
Compare schemas of two DBI databases.
This function compares schemas of two DBI databases. You supply two DBI database handles and this function will return a hash:
DBI
{ # list of tables found in first db but missing in second deleted_tables => ['table1', ...], # list of tables found only in the second db added_tables => ['table2', ...], # list of modified tables, with details for each modified_tables => { table3 => { deleted_columns => [...], added_columns => [...], modified_columns => { column1 => { old_type => '...', new_type => '...', ... }, }, }, }, }
diff_table_schema($dbh1, $dbh2, $table1, $table2) -> any
Compare schema of two DBI tables.
This function compares schemas of two DBI tables. You supply two DBI database handles along with table name and this function will return a hash:
{ deleted_columns => [...], added_columns => [...], modified_columns => { column1 => { old_type => '...', new_type => '...', ... }, }, }
$table1* => str
Table name.
$table2 => str
Second table name (assumed to be the same as first table name if unspecified).
table_schema_eq($dbh1, $dbh2, $table1, $table2) -> any
Return true if two DBI tables have the same schema.
my $res = diff_table_schema(...); !%res;
Please visit the project's homepage at https://metacpan.org/release/DBIx-Diff-Schema.
Source repository is at https://github.com/perlancar/perl-DBIx-Diff-Schema.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=DBIx-Diff-Schema
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.
DBIx::Compare to compare database contents.
diffdb from App::diffdb which can compare two database (schema as well as content) and display the result as the familiar colored unified-style diff.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2020, 2018, 2017, 2015, 2014 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.
To install DBIx::Diff::Schema, copy and paste the appropriate command in to your terminal.
cpanm
cpanm DBIx::Diff::Schema
CPAN shell
perl -MCPAN -e shell install DBIx::Diff::Schema
For more information on module installation, please visit the detailed CPAN module installation guide.