csv-setop - Set operation against several CSV files
This document describes version 0.037 of csv-setop (from Perl distribution App-CSVUtils), released on 2022-03-27.
Usage:
% csv-setop [--compare-fields=str] [--escape-char=str] [--format=name|--json] [--header|--input-header|--no-header|--noheader] [--ignore-case|-i|--no-ignore-case|--noignore-case] [--(no)naked-res] [--op=str] [--output-escape-char=str] [--output-header|--no-output-header|--nooutput-header] [--output-quote-char=str] [--output-sep-char=str] [--output-tsv|--no-output-tsv|--nooutput-tsv] [--page-result[=program]|--view-result[=program]] [--quote-char=str] [--result-fields=str] [--sep-char=str] [--tsv|--input-tsv|--no-tsv|--notsv] [--diff|--intersect|--symdiff|--union] -- <filenames> ...
Example input:
# file1.csv a,b,c 1,2,3 4,5,6 7,8,9 # file2.csv a,b,c 1,2,3 4,5,7 7,8,9
Output of intersection (--intersect file1.csv file2.csv), which will return common rows between the two files:
--intersect file1.csv file2.csv
a,b,c 1,2,3 7,8,9
Output of union (--union file1.csv file2.csv), which will return all rows with duplicate removed:
--union file1.csv file2.csv
a,b,c 1,2,3 4,5,6 4,5,7 7,8,9
Output of difference (--diff file1.csv file2.csv), which will return all rows in the first file but not in the second:
--diff file1.csv file2.csv
a,b,c 4,5,6
Output of symmetric difference (--symdiff file1.csv file2.csv), which will return all rows in the first file not in the second, as well as rows in the second not in the first:
--symdiff file1.csv file2.csv
a,b,c 4,5,6 4,5,7
You can specify --compare-fields to only consider some fields only, for example --union --compare-fields a,b file1.csv file2.csv:
--compare-fields
--union --compare-fields a,b file1.csv file2.csv
a,b,c 1,2,3 4,5,6 7,8,9
Each field specified in --compare-fields can be specified using F1:OTHER1,F2:OTHER2,... format to refer to different field names or indexes in each file, for example if file3.csv is:
F1:OTHER1,F2:OTHER2,...
file3.csv
# file3.csv Ei,Si,Bi 1,3,2 4,7,5 7,9,8
Then --union --compare-fields a:Ei,b:Bi file1.csv file3.csv will result in:
--union --compare-fields a:Ei,b:Bi file1.csv file3.csv
Finally you can print out certain fields using --result-fields.
--result-fields
Common notes for the utilities
Encoding: The utilities in this module/distribution accept and emit UTF8 text.
* marks required options.
*
Shortcut for --op=diff.
See --op.
--op
Shortcut for --op=intersect.
Set operation to perform.
Valid values:
["intersect","union","diff","symdiff"]
Shortcut for --op=symdiff.
Shortcut for --op=union.
Specify character to escape value in field in input CSV, will be passed to Text::CSV_XS.
Defaults to `\\` (backslash). Overrides `--tsv` option.
Input CSV files.
Use `-` to read from stdin.
Can also be specified as the 1st command-line argument and onwards.
Can be specified multiple times.
Input CSV files (JSON-encoded).
See --filename.
--filename
By default (`--header`), the first row of the CSV will be assumed to contain field names (and the second row contains the first data row). When you declare that CSV does not have header row (`--no-header`), the first row of the CSV is assumed to contain the first data row. Fields will be named `field1`, `field2`, and so on.
Specify field quote character in input CSV, will be passed to Text::CSV_XS.
Defaults to `"` (double quote). Overrides `--tsv` option.
Specify field separator character in input CSV, will be passed to Text::CSV_XS.
Defaults to `,` (comma). Overrides `--tsv` option.
Inform that input file is in TSV (tab-separated) format instead of CSV.
Overriden by `--sep-char`, `--quote-char`, `--escape-char` options. If one of those options is specified, then `--tsv` will be ignored.
Choose output format, e.g. json, text.
Default value:
undef
Set output format to json.
When outputing as JSON, strip result envelope.
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 `--naked-res` so you just get:
[1,2,3]
Specify character to escape value in field in output CSV, will be passed to Text::CSV_XS.
This is like `--escape-char` option but for output instead of input.
Defaults to `\\` (backslash). Overrides `--output-tsv` option.
Whether output CSV should have a header row.
By default, a header row will be output *if* input CSV has header row. Under `--output-header`, a header row will be output even if input CSV does not have header row (value will be something like "col0,col1,..."). Under `--no-output-header`, header row will *not* be printed even if input CSV has header row. So this option can be used to unconditionally add or remove header row.
Specify field quote character in output CSV, will be passed to Text::CSV_XS.
This is like `--quote-char` option but for output instead of input.
Defaults to `"` (double quote). Overrides `--output-tsv` option.
Specify field separator character in output CSV, will be passed to Text::CSV_XS.
This is like `--sep-char` option but for output instead of input.
Defaults to `,` (comma). Overrides `--output-tsv` option.
Inform that output file is TSV (tab-separated) format instead of CSV.
This is like `--tsv` option but for output instead of input.
Overriden by `--output-sep-char`, `--output-quote-char`, `--output-escape-char` options. If one of those options is specified, then `--output-tsv` will be ignored.
Filter output through a pager.
View output using a viewer.
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 csv-setop csv-setop
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 csv-setop 'p/*/`csv-setop`/'
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.
Please visit the project's homepage at https://metacpan.org/release/App-CSVUtils.
Source repository is at https://github.com/perlancar/perl-App-CSVUtils.
setop.
perlancar <perlancar@cpan.org>
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 Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2022, 2021, 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.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-CSVUtils
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.
To install App::CSVUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::CSVUtils
CPAN shell
perl -MCPAN -e shell install App::CSVUtils
For more information on module installation, please visit the detailed CPAN module installation guide.