/ 
App-diffdb-0.004
River stage one • 1 direct dependent • 1 total dependent
/ diffdb

NAME

diffdb - Compare two databases, line by line

VERSION

This document describes version 0.004 of diffdb (from Perl distribution App-diffdb), released on 2020-05-06.

SYNOPSIS

Usage:

% diffdb [-C=s+] [-T=s+] [-c=s+] [--config-path=path+] [--config-profile=profile | -P] [--debug] [--diff-command=s] [--exclude-column=s+] [--exclude-columns-json=s] [--exclude-table=s+] [--exclude-tables-json=s] [--include-column=s+] [--include-columns-json=s] [--include-table=s+] [--include-tables-json=s] [--log-level=level] [--no-config] [--no-env] [--order-by=s] [-p=s] [--page-result[=program]] [--password1=s] [--password2=s] [--password=s] [--quiet] [--row-as=s] [--sql=s] [-t=s+] [--trace] [-u=s] [--user1=s] [--user2=s] [--user=s] [--verbose] [dsn1] [dsn2]

DESCRIPTION

This utility compares two databases and displays the result as the familiar colored unified-style diff.

OPTIONS

* marks required options.

Main options

--diff-command=s

Default value:

"diff"
--row-as=s

Default value:

"json-one-line"

Valid values:

["json-one-line","json-card"]

Column selection options

--exclude-column=s@, -C

Can be specified multiple times.

--exclude-columns-json=s

See --exclude-column.

--include-column=s@, -c

Can be specified multiple times.

--include-columns-json=s

See --include-column.

Configuration options

--config-path=s

Set path to configuration file.

Can be specified multiple times.

--config-profile=s, -P

Set configuration profile to use.

--no-config

Do not use any configuration file.

Connection options

--dsn1=s

DBI data source, e.g. "dbi:SQLite:dbname=/path/to/db1.db".

--dsn2=s

DBI data source, e.g. "dbi:SQLite:dbname=/path/to/db1.db".

--password1=s, --password, -p

You might want to specify this parameter in a configuration file instead of directly as command-line option.

--password2=s

Will default to `password1` if `password1` is specified.

You might want to specify this parameter in a configuration file instead of directly as command-line option.

--user1=s, --user, -u
--user2=s

Will default to `user1` if `user1` is specified.

Environment options

--no-env

Do not read environment for default options.

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

Set log level.

--quiet

Shortcut for --log-level=error.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

Output options

--page-result

Filter output through a pager.

Row ordering options

--order-by=s

Table selection options

--exclude-table=s@, -T

Can be specified multiple times.

--exclude-tables-json=s

See --exclude-table.

--include-table=s@, -t

Can be specified multiple times.

--include-tables-json=s

See --include-table.

--sql=s

Compare the result of SQL select query, instead of tables.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C diffdb diffdb

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete diffdb 'p/*/`diffdb`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/diffdb.conf, ~/diffdb.conf, or /etc/diffdb.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

diff_command (see --diff-command)
dsn1 (see --dsn1)
dsn2 (see --dsn2)
exclude_columns (see --exclude-column)
exclude_tables (see --exclude-table)
include_columns (see --include-column)
include_tables (see --include-table)
log_level (see --log-level)
order_by (see --order-by)
password1 (see --password1)
password2 (see --password2)
row_as (see --row-as)
sql (see --sql)
user1 (see --user1)
user2 (see --user2)

ENVIRONMENT

DIFFDB_OPT => str

Specify additional command-line options.

FILES

~/.config/diffdb.conf

~/diffdb.conf

/etc/diffdb.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-diffdb.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-diffdb.

BUGS

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

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2020 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.