diffdb-sqlite - Compare two SQLite databases, line by line
This document describes version 0.004 of diffdb-sqlite (from Perl distribution App-diffdb), released on 2020-05-06.
Usage:
% diffdb-sqlite [-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] [--page-result[=program]] [--quiet] [--row-as=s] [--sql=s] [-t=s+] [--trace] [--verbose] [dbpath1] [dbpath2]
This utility compares two SQLite databases and displays the result as the familiar colored unified-style diff.
* marks required options.
*
Default value:
"diff"
"json-one-line"
Valid values:
["json-one-line","json-card"]
Can be specified multiple times.
See --exclude-column.
--exclude-column
See --include-column.
--include-column
Set path to configuration file.
Set configuration profile to use.
Do not use any configuration file.
First SQLite database file.
Second SQLite database file.
Do not read environment for default options.
Shortcut for --log-level=debug.
Set log level.
Shortcut for --log-level=error.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
Filter output through a pager.
See --exclude-table.
--exclude-table
See --include-table.
--include-table
Compare the result of SQL select query, instead of tables.
Display help message and exit.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C diffdb-sqlite diffdb-sqlite
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.
To activate tcsh completion for this script, put:
complete diffdb-sqlite 'p/*/`diffdb-sqlite`/'
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).
For fish and zsh, install shcompgen as described above.
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-sqlite.conf, ~/diffdb-sqlite.conf, or /etc/diffdb-sqlite.conf.
--config-path
All found files will be read and merged.
To disable searching for configuration files, pass --no-config.
--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.
[profile=SOMENAME]
[SOMESECTION profile=SOMENAME]
--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.
program=NAME
[program=NAME ...]
[SOMESECTION program=NAME]
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.
env=CONDITION
[env=SOMEVAR ...]
[SOMESECTION env=SOMEVAR ...]
[env=HOSTNAME=blink ...]
[SOMESECTION env=HOSTNAME=blink ...]
[env=HOSTNAME!=blink ...]
[SOMESECTION env=HOSTNAME!=blink ...]
[env=HOSTNAME*=server ...]
[SOMESECTION env=HOSTNAME*=server ...]
List of available configuration parameters:
dbpath1 (see --dbpath1) dbpath2 (see --dbpath2) diff_command (see --diff-command) 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) row_as (see --row-as) sql (see --sql)
Specify additional command-line options.
~/.config/diffdb-sqlite.conf
~/diffdb-sqlite.conf
/etc/diffdb-sqlite.conf
Please visit the project's homepage at https://metacpan.org/release/App-diffdb.
Source repository is at https://github.com/perlancar/perl-App-diffdb.
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.
perlancar <perlancar@cpan.org>
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.
To install App::diffdb, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::diffdb
CPAN shell
perl -MCPAN -e shell install App::diffdb
For more information on module installation, please visit the detailed CPAN module installation guide.