/ 
App-CSVUtils-0.030
River stage one • 3 direct dependents • 4 total dependents
/ csv-setop

NAME

csv-setop - Set operation against several CSV files

VERSION

This document describes version 0.030 of csv-setop (from Perl distribution App-CSVUtils), released on 2020-07-30.

SYNOPSIS

Usage:

% csv-setop [--compare-fields=s] [--diff] [--escape-char=s]
    [--format=name] [--header] [-i] [--ignore-case] [--intersect] [--json]
    [--(no)naked-res] [--no-header] [--no-ignore-case] [--no-tsv]
    [--noheader] [--noignore-case] [--notsv] [--op=s]
    [--page-result[=program]] [--quote-char=s] [--result-fields=s]
    [--sep-char=s] [--symdiff] [--tsv] [--union] <filenames> ...

DESCRIPTION

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:

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:

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:

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:

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:

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:

# 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:

a,b,c
1,2,3
4,5,6
7,8,9

Finally you can print out certain fields using --result-fields.

OPTIONS

* marks required options.

Main options

--compare-fields=s
--diff*

Shortcut for --op=diff.

See --op.

--escape-char=s

Specify character to escape value in field, will be passed to Text::CSV_XS.

Defaults to `\\` (backslash). Overrides `--tsv` option.

--filename=s@*, -f

Input CSV files.

Use `-` to read from stdin.

Can be specified multiple times.

--filenames-json=s

Input CSV files (JSON-encoded).

See --filename.

--ignore-case, -i
--intersect*

Shortcut for --op=intersect.

See --op.

--no-header

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.

--op=s*

Set operation to perform.

Valid values:

["intersect","union","diff","symdiff"]
--quote-char=s

Specify field quote character, will be passed to Text::CSV_XS.

Defaults to `"` (double quote). Overrides `--tsv` option.

--result-fields=s
--sep-char=s

Specify field separator character, will be passed to Text::CSV_XS.

Defaults to `,` (comma). Overrides `--tsv` option.

--symdiff*

Shortcut for --op=symdiff.

See --op.

--tsv

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.

--union*

Shortcut for --op=union.

See --op.

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

undef
--json

Set output format to json.

--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 `--naked-res` so you just get:

[1,2,3]
--page-result

Filter output through a pager.

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 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.

tcsh

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).

other shells

For fish and zsh, install shcompgen as described above.

HOMEPAGE

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

SOURCE

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

BUGS

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.

SEE ALSO

setop.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2020, 2019, 2018, 2017, 2016 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.