csv-add-fields - Add one or more fields to CSV file
This document describes version 1.004 of csv-add-fields (from Perl distribution App-CSVUtils), released on 2023-02-01.
csv-add-fields --help (or -h, -?)
csv-add-fields --version (or -v)
csv-add-fields [--after=str] [--at=posint] [--before=str] [--debug|--log-level=level|--quiet|--trace|--verbose] [--eval=any|--eval-json=json|-e=any] [(--field=str)+|--fields-json=json|(-f=str)+] [--format=name|--json] [--hash|-H] [--input-escape-char=str] [--input-header|--no-input-header|--noinput-header] [--input-quote-char=str] [--input-sep-char=str] [--input-tsv] [--(no)naked-res] [--output-escape-char=str] [--output-filename=filename|-o=filename] [--output-header|--no-output-header|--nooutput-header] [--output-quote-char=str] [--output-sep-char=str] [--output-tsv|--no-output-tsv|--nooutput-tsv] [--overwrite|-O|--no-overwrite|--nooverwrite] [--page-result[=program]|--view-result[=program]] -- [input_filename] <field> ...
See examples in the "EXAMPLES" section.
The new fields by default will be added at the end, 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 the first field). The new fields will be clustered together though, you currently cannot set the position of each new field. But you can later reorder fields using csv-sort-fields.
--after
--before
--at
If supplied, your Perl code (-e) will be called for each row (excluding the header row) and should return the value for the new fields (either as a list or as an arrayref). $_ contains the current row (as arrayref, or if you specify -H, as a hashref). $main::row is available and contains the current row (always as an arrayref). $main::rownum contains the row number (2 means the first data row). $csv is the Text::CSV_XS object. $main::fields_idx is also available for additional information.
-e
$_
-H
$main::row
$main::rownum
$csv
$main::fields_idx
If -e is not supplied, the new fields will be getting the default value of empty string ('').
''
* marks required options.
*
Put the new field(s) after specified field.
Put the new field(s) at specific position (1 means at the front of all others).
Put the new field(s) before specified field.
Perl code (JSON-encoded).
See --eval.
--eval
Perl code.
Field name.
Can also be specified as the 2nd command-line argument and onwards.
Can be specified multiple times.
Field names (JSON-encoded).
See --field.
--field
Provide row in $_ as hashref instead of arrayref.
Specify character to escape value in field in input CSV, will be passed to Text::CSV_XS.
Defaults to \\ (backslash). Overrides --input-tsv option.
\\
--input-tsv
Input CSV file.
Default value:
"-"
Use - to read from stdin.
-
Encoding of input file is assumed to be UTF-8.
Can also be specified as the 1st command-line argument.
Specify field quote character in input CSV, will be passed to Text::CSV_XS.
Defaults to " (double quote). Overrides --input-tsv option.
"
Specify field separator character in input CSV, will be passed to Text::CSV_XS.
Defaults to , (comma). Overrides --input-tsv option.
,
Inform that input file is in TSV (tab-separated) format instead of CSV.
Overriden by --input-sep-char, --input-quote-char, --input-escape-char options. If one of those options is specified, then --input-tsv will be ignored.
--input-sep-char
--input-quote-char
--input-escape-char
Specify that input CSV does not have a header row.
By default, the first row of the input CSV will be assumed to contain field names (and the second row contains the first data row). When you declare that input CSV does not have header row (--no-input-header), the first row of the CSV is assumed to contain the first data row. Fields will be named field1, field2, and so on.
--no-input-header
field1
field2
Shortcut for --log-level=debug.
Set log level.
By default, these log levels are available (in order of increasing level of importance, from least important to most): trace, debug, info, warn/warning, error, fatal. By default, the level is usually set to warn, which means that log statements with level info and less important levels will not be shown. To increase verbosity, choose info, debug, or trace.
trace
debug
info
warn
warning
error
fatal
For more details on log level and logging, as well as how new logging levels can be defined or existing ones modified, see Log::ger.
Shortcut for --log-level=error.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
Choose output format, e.g. json, text.
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.
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:
--naked-res
[1,2,3]
Specify character to escape value in field in output CSV, will be passed to Text::CSV_XS.
This is like --input-escape-char option but for output instead of input.
Defaults to \\ (backslash). Overrides --output-tsv option.
--output-tsv
Output filename.
Use - to output to stdout (the default if you don't specify this option).
Encoding of output file is assumed to be UTF-8.
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.
--output-header
--no-output-header
Specify field quote character in output CSV, will be passed to Text::CSV_XS.
This is like --input-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 --input-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 --input-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.
--output-sep-char
--output-quote-char
--output-escape-char
Whether to override existing output file.
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. less is chosen.
less
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.
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-add-fields csv-add-fields
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-add-fields 'p/*/`csv-add-fields`/'
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.
% csv-add-fields file.csv field4 field6 field5
% csv-add-fields file.csv field4 field6 field5 --after field2
% csv-add-fields file.csv after_tax -e '$main::row->[5] * 1.11'
% csv-add-fields file.csv tax_rate after_tax -e '(0.11, $main::row->[5] * 1.11)'
Please visit the project's homepage at https://metacpan.org/release/App-CSVUtils.
Source repository is at https://github.com/perlancar/perl-App-CSVUtils.
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, 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.
This software is copyright (c) 2023, 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.