—

              
#!perl
# Note: This script is a CLI for Riap function /App/MysqlUtils/mysql_copy_rows_adjust_pk
# and generated automatically using Perinci::CmdLine::Gen version 0.502
use 5.010001;
use strict;
use warnings;
use Log::ger;
use Perinci::CmdLine::Any;
our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2022-10-19'; # DATE
our $DIST = 'App-MysqlUtils'; # DIST
our $VERSION = '0.022'; # VERSION
my $cmdline = Perinci::CmdLine::Any->new(
    url => "/App/MysqlUtils/mysql_copy_rows_adjust_pk",
    program_name => "mysql-copy-rows-adjust-pk",
    log => 1,
    log_level => "info",
    pass_cmdline_object => 1,
    config_filename => "mysqlutils.conf",
);
$cmdline->run;
# ABSTRACT: Copy rows from one table to another, adjust PK column if necessary
# PODNAME: mysql-copy-rows-adjust-pk
__END__
HideShow 452 lines of Pod
=pod
=encoding UTF-8
=head1 NAME
mysql-copy-rows-adjust-pk - Copy rows from one table to another, adjust PK column if necessary
=head1 VERSION
This document describes version 0.022 of mysql-copy-rows-adjust-pk (from Perl distribution App-MysqlUtils), released on 2022-10-19.
=head1 SYNOPSIS
B<mysql-copy-rows-adjust-pk> L<--help|/"--help, -h, -v"> (or L<-h|/"--help, -h, -v">, L<-?|/"--help, -h, -v">)
B<mysql-copy-rows-adjust-pk> L<--version|/"--version, -v"> (or L<-v|/"--version, -v">)
B<mysql-copy-rows-adjust-pk> [L<--adjust|/"--adjust=s*">=I<str>] [L<--config-path|/"--config-path=s, -c">=I<path>|L<-c|/"--config-path=s, -c">|L<--no-config|/"--no-config, -C">|L<-C|/"--no-config, -C">] [L<--config-profile|/"--config-profile=s, -P">=I<profile>|L<-P|/"--config-profile=s, -P">] [L<--debug|/"--debug">|L<--log-level|/"--log-level=s">=I<level>|L<--quiet|/"--quiet">|L<--trace|/"--trace">|L<--verbose|/"--verbose">] [L<--dry-run|/"--dry-run, -n">|L<-n|/"--dry-run, -n">] [L<--format|/"--format=s">=I<name>|L<--json|/"--json">] [L<--from|/"--from=s*">=I<str>] [L<--host|/"--host=s">=I<str>] [L<--(no)naked-res|/"--naked-res">] [L<--no-env|/"--no-env">] [L<--page-result|/"--page-result">[=I<program>]|L<--view-result|/"--view-result">[=I<program>]] [L<--password|/"--password=s">=I<str>] [L<--pk-column|/"--pk-column=s*">=I<str>] [L<--port|/"--port=s">=I<int>] [L<--to|/"--to=s*">=I<str>] [L<--username|/"--username=s">=I<str>] -- E<lt>L<database|/"--database=s*">E<gt>
=head1 DESCRIPTION
This utility can be used when you have rows in one table that you want to insert
to another table, but the PK might clash. When that happens, the value of the
other columns are inspected. When all the values of the other columns match, the
row is assumed to be a duplicate and skipped. If some values of the other column
differ, then the row is assumed to be different and a new value of the PK column
is chosen (there are several choices on how to select the new PK).
An example:
 % mysql-copy-rows-adjust-pk db1 --from t1 --to t2 --pk-column id --adjust "add 1000"
Suppose these are the rows in table C<t1>:
 id    date                 description        user
 --    ----                 -----------        ----
  1    2018-12-03 12:01:01  Created user u1    admin1
  2    2018-12-03 12:44:33  Removed user u1    admin1
And here are the rows in table C<t2>:
 id    date                 description        user
 --    ----                 -----------        ----
  1    2018-12-03 12:01:01  Created user u1    admin1
  2    2018-12-03 13:00:45  Rebooted machine1  admin1
  3    2018-12-03 13:05:00  Created user u2    admin2
You can see that row id=1 in both tables are identical. This will be skipped. On
the other hand, row id=2 in C<t1> is different with row id=2 in C<t2>. This row
will be adjusted: C<id> will be changed to 2+1000=1002. So the final rows in
table C<t2> will be (sorted by date):
 id    date                 description        user
 --    ----                 -----------        ----
  1    2018-12-03 12:01:01  Created user u1    admin1
  1002 2018-12-03 12:44:33  Removed user u1    admin1
  2    2018-12-03 13:00:45  Rebooted machine1  admin1
  3    2018-12-03 13:05:00  Created user u2    admin2
So basically this utility is similar to MySQL's INSERT ... ON DUPLICATE KEY
UPDATE, but will avoid inserting identical rows.
If the adjusted PK column clashes with another row in the target table, the row
is skipped.
=head1 OPTIONS
C<*> marks required options.
=head2 Main options
=over
=item B<--adjust>=I<s>*
How to adjust the value of the PK column.
Currently the choices are:
=over
=item * "add N" add N to the original value.
=item * "subtract N" subtract N from the original value.
=back
=item B<--database>=I<s>*
(No description)
Can also be specified as the 1st command-line argument.
=item B<--from>=I<s>*
Name of source table.
=item B<--pk-column>=I<s>*
Name of PK column.
=item B<--to>=I<s>*
Name of target table.
=back
=head2 Configuration options
=over
=item B<--config-path>=I<s>, B<-c>
Set path to configuration file.
Can actually be specified multiple times to instruct application to read from
multiple configuration files (and merge them).
=item B<--config-profile>=I<s>, B<-P>
Set configuration profile to use.
A single configuration file can contain profiles, i.e. alternative sets of
values that can be selected. For example:
 [profile=dev]
 username=foo
 pass=beaver
  
 [profile=production]
 username=bar
 pass=honey
When you specify C<--config-profile=dev>, C<username> will be set to C<foo> and
C<password> to C<beaver>. When you specify C<--config-profile=production>,
C<username> will be set to C<bar> and C<password> to C<honey>.
=item B<--no-config>, B<-C>
Do not use any configuration file.
If you specify C<--no-config>, the application will not read any configuration
file.
=back
=head2 Connection options
=over
=item B<--host>=I<s>
Default value:
 "localhost"
=item B<--password>=I<s>
Will try to get default from C<~/.my.cnf>.
=item B<--port>=I<s>
Default value:
 3306
=item B<--username>=I<s>
Will try to get default from C<~/.my.cnf>.
=back
=head2 Environment options
=over
=item B<--no-env>
Do not read environment for default options.
If you specify C<--no-env>, the application wil not read any environment
variable.
=back
=head2 Logging options
=over
=item B<--debug>
Shortcut for --log-level=debug.
=item B<--log-level>=I<s>
Set log level.
By default, these log levels are available (in order of increasing level of
importance, from least important to most): C<trace>, C<debug>, C<info>,
C<warn>/C<warning>, C<error>, C<fatal>. By default, the level is usually set to
C<warn>, which means that log statements with level C<info> and less important
levels will not be shown. To increase verbosity, choose C<info>, C<debug>, or
C<trace>.
For more details on log level and logging, as well as how new logging levels can
be defined or existing ones modified, see L<Log::ger>.
=item B<--quiet>
Shortcut for --log-level=error.
=item B<--trace>
Shortcut for --log-level=trace.
=item B<--verbose>
Shortcut for --log-level=info.
=back
=head2 Output options
=over
=item B<--format>=I<s>
Choose output format, e.g. json, text.
Default value:
 undef
Output can be displayed in multiple formats, and a suitable default format is
chosen depending on the application and/or whether output destination is
interactive terminal (i.e. whether output is piped). This option specifically
chooses an output format.
=item B<--json>
Set output format to json.
=item B<--naked-res>
When outputing as JSON, strip result envelope.
Default value:
 0
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
 [200,"OK",[1,2,3],{"func.extra"=>4}]
The reason is so you can get the status (1st element), status message (2nd
element) as well as result metadata/extra result (4th element) instead of just
the result (3rd element). However, sometimes you want just the result, e.g. when
you want to pipe the result for more post-processing. In this case you can use
C<--naked-res> so you just get:
 [1,2,3]
=item B<--page-result>
Filter output through a pager.
This option will pipe the output to a specified pager program. If pager program
is not specified, a suitable default e.g. C<less> is chosen.
=item B<--view-result>
View output using a viewer.
This option will first save the output to a temporary file, then open a viewer
program to view the temporary file. If a viewer program is not chosen, a
suitable default, e.g. the browser, is chosen.
=back
=head2 Other options
=over
=item B<--dry-run>, B<-n>
Run in simulation mode (also via DRY_RUN=1).
=item B<--help>, B<-h>, B<-?>
Display help message and exit.
=item B<--version>, B<-v>
Display program's version and exit.
=back
=head1 COMPLETION
This script has shell tab completion capability with support for several
shells.
=head2 bash
To activate bash completion for this script, put:
 complete -C mysql-copy-rows-adjust-pk mysql-copy-rows-adjust-pk
in your bash startup (e.g. F<~/.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 L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.
=head2 tcsh
To activate tcsh completion for this script, put:
 complete mysql-copy-rows-adjust-pk 'p/*/`mysql-copy-rows-adjust-pk`/'
in your tcsh startup (e.g. F<~/.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 L<shcompgen> (see above).
=head2 other shells
For fish and zsh, install L<shcompgen> as described above.
=head1 CONFIGURATION FILE
This script can read configuration files. Configuration files are in the format of L<IOD>, which is basically INI with some extra features.
By default, these names are searched for configuration filenames (can be changed using C<--config-path>): F</home/u1/.config/mysqlutils.conf>, F</home/u1/mysqlutils.conf>, or F</etc/mysqlutils.conf>.
All found files will be read and merged.
To disable searching for configuration files, pass C<--no-config>.
You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]> or C<[SOMESECTION profile=SOMENAME]>. Those sections will only be read if you specify the matching C<--config-profile SOMENAME>.
You can also put configuration for multiple programs inside a single file, and use filter C<program=NAME> in section names, e.g. C<[program=NAME ...]> or C<[SOMESECTION program=NAME]>. The section will then only be used when the reading program matches.
You can also filter a section by environment variable using the filter C<env=CONDITION> in section names. For example if you only want a section to be read if a certain environment variable is true: C<[env=SOMEVAR ...]> or C<[SOMESECTION env=SOMEVAR ...]>. If you only want a section to be read when the value of an environment variable equals some string: C<[env=HOSTNAME=blink ...]> or C<[SOMESECTION env=HOSTNAME=blink ...]>. If you only want a section to be read when the value of an environment variable does not equal some string: C<[env=HOSTNAME!=blink ...]> or C<[SOMESECTION env=HOSTNAME!=blink ...]>. If you only want a section to be read when the value of an environment variable includes some string: C<[env=HOSTNAME*=server ...]> or C<[SOMESECTION env=HOSTNAME*=server ...]>. If you only want a section to be read when the value of an environment variable does not include some string: C<[env=HOSTNAME!*=server ...]> or C<[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.
To load and configure plugins, you can use either the C<-plugins> parameter (e.g. C<< -plugins=DumpArgs >> or C<< -plugins=DumpArgs@before_validate_args >>), or use the C<[plugin=NAME ...]> sections, for example:
 [plugin=DumpArgs]
 -event=before_validate_args
 -prio=99
  
 [plugin=Foo]
 -event=after_validate_args
 arg1=val1
 arg2=val2
  
which is equivalent to setting C<< -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2 >>.
List of available configuration parameters:
 adjust (see --adjust)
 database (see --database)
 format (see --format)
 from (see --from)
 host (see --host)
 log_level (see --log-level)
 naked_res (see --naked-res)
 password (see --password)
 pk_column (see --pk-column)
 port (see --port)
 to (see --to)
 username (see --username)
=head1 ENVIRONMENT
=head2 MYSQL_COPY_ROWS_ADJUST_PK_OPT
String. Specify additional command-line options.
=head1 FILES
=head2 /home/u1/.config/mysqlutils.conf
=head2 /home/u1/mysqlutils.conf
=head2 /etc/mysqlutils.conf
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/App-MysqlUtils>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-App-MysqlUtils>.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 CONTRIBUTING
To contribute, you can send patches by email/via RT, or send pull requests on
GitHub.
Most of the time, you don't need to build the distribution yourself. You can
simply modify the code, then test via:
 % prove -l
If you want to build the distribution (e.g. to try to install it locally on your
system), you can install L<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>,
L<Pod::Weaver::PluginBundle::Author::PERLANCAR>, and sometimes one or two other
Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond
that are considered a bug and can be reported to me.
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2022, 2020, 2019, 2018, 2017, 2016 by perlancar <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.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-MysqlUtils>
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.
=cut