App::CSVUtils - CLI utilities related to CSV
This document describes version 0.012 of App::CSVUtils (from Perl distribution App-CSVUtils), released on 2017-04-25.
This distribution contains the following CLI utilities:
csv-add-field
csv-avg
csv-concat
csv-convert-to-hash
csv-delete-field
csv-list-field-names
csv-munge-field
csv-replace-newline
csv-select-fields
csv-select-row
csv-sort-fields
csv-sum
Usage:
csv_add_field(%args) -> [status, msg, result, meta]
Add a field to CSV file.
Your Perl code (-e) will be called for each row (excluding the header row) and should return the value for the new field. $main::row is available and contains the current row, while $main::rownum contains the row number (2 means the first data row).
$main::row
$main::rownum
Field by default will be added as the last field, unless you specify one of --after (to put after a certain field), --before (to put before a certain field), or --at (to put at specific position, 1 means as the first field).
--after
--before
--at
This function is not exported.
Arguments ('*' denotes required arguments):
after => str
Put the new field after specified field.
at => int
Put the new field at specific position (1 means as first field).
before => str
Put the new field before specified field.
eval* => str
Perl code to do munging.
field* => str
Field name.
filename* => filename
Input CSV file.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
csv_avg(%args) -> [status, msg, result, meta]
Output a summary row which are arithmetic averages of data rows.
with_data_rows => bool
Whether to also output data rows.
csv_concat(%args) -> [status, msg, result, meta]
Concatenate several CSV files together, collecting all the fields.
Example, concatenating this CSV:
col1,col2 1,2 3,4
and:
col2,col4 a,b c,d e,f
col3 X Y
will result in:
col1,col2,col4,col3 1,2, 3,4, ,a,b ,c,d ,e,f ,,,X ,,,Y
filenames* => array[filename]
Input CSV files.
csv_convert_to_hash(%args) -> [status, msg, result, meta]
Return a hash of field names as keys and first row as values.
row_number => int (default: 2)
Row number (e.g. 2 for first data row).
csv_delete_field(%args) -> [status, msg, result, meta]
Delete one or more fields from CSV file.
fields* => array[str]
Field names.
csv_list_field_names(%args) -> [status, msg, result, meta]
List field names of CSV file.
csv_munge_field(%args) -> [status, msg, result, meta]
Munge a field in every row of CSV file.
Perl code (-e) will be called for each row (excluding the header row) and $_ will contain the value of the field, and the Perl code is expected to modify it. $main::row will contain the current row array and $main::rownum contains the row number (2 means the first data row).
$_
csv_replace_newline(%args) -> [status, msg, result, meta]
Replace newlines in CSV values.
Some CSV parsers or applications cannot handle multiline CSV values. This utility can be used to convert the newline to something else. There are a few choices: replace newline with space (--with-space, the default), remove newline (--with-nothing), replace with encoded representation (--with-backslash-n), or with characters of your choice (--with 'blah').
--with-space
--with-nothing
--with-backslash-n
--with 'blah'
with => str (default: " ")
csv_select_fields(%args) -> [status, msg, result, meta]
Only output selected field(s).
field_pat => re
Field regex pattern to select.
fields => array[str]
csv_select_row(%args) -> [status, msg, result, meta]
Only output specified row(s).
row_spec* => str
Row number (e.g. 2 for first data row), range (2-7), or comma-separated list of such (2-7,10,20-23).
csv_sort_fields(%args) -> [status, msg, result, meta]
Sort CSV fields.
ci => bool
example => str
A comma-separated list of field names.
reverse => bool
csv_sum(%args) -> [status, msg, result, meta]
Output a summary row which are arithmetic sums of data rows.
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 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.