csv-grep - Only output row(s) where Perl expression returns true
This document describes version 0.017 of csv-grep (from Perl distribution App-CSVUtils), released on 2019-04-23.
Usage:
% csv-grep [options] <filename>
Examples:
Only show rows where the amount field is divisible by 7:
% csv-grep -He '$_->{amount} % 7 ? 1:0' file.csv
Only show rows where date is a Wednesday:
% csv-grep -He 'BEGIN { use DateTime::Format::Natural; $parser = DateTime::Format::Natural->new } $dt = $parser->parse_datetime($_->{date}); $dt->day_of_week == 3' file.csv
This is like Perl's grep performed over rows of CSV. In $_, your Perl code will find the CSV row as an arrayref (or, if you specify -H, as a hashref). $main::row is also set to the row (always as arrayref), while $main::rownum contains the row number (2 means the first data row). $main::field_idxs is also available for additional information.
grep
$_
-H
$main::row
$main::rownum
$main::field_idxs
Your code is then free to return true or false based on some criteria. Only rows where Perl expression returns true will be included in the result.
* marks required options.
*
Perl code.
Input CSV file.
Provide row in $_ as hashref instead of arrayref.
When you declare that CSV does not have header row (`--no-header`), the fields will be named `field1`, `field2`, and so on.
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]
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-grep csv-grep
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-grep 'p/*/`csv-grep`/'
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.
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.
csvgrep.
perlancar <perlancar@cpan.org>
This software is copyright (c) 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.
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.