- COPYRIGHT AND LICENSE
dump-csv - Dump CSV as data structure (array of array/hash)
This document describes version 0.032 of dump-csv (from Perl distribution App-CSVUtils), released on 2020-08-16.
% dump-csv [-H] [--escape-char=s] [--format=name] [--hash] [--header] [--input-header] [--input-tsv] [--json] [--(no)naked-res] [--no-header] [--no-tsv] [--noheader] [--notsv] [--page-result[=program]] [--quote-char=s] [--sep-char=s] [--tsv] [--view-result[=program]] <filename>
* marks required options.
Specify character to escape value in field in input CSV, will be passed to Text::CSV_XS.
Defaults to `\\` (backslash). Overrides `--tsv` option.
- --filename=s*, -f
Input CSV file.
Use `-` to read from stdin.
- --no-header, --input-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.
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.
- --tsv, --input-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.
Choose output format, e.g. json, text.
Set output format to json.
When outputing as JSON, strip result envelope.
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
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:
Filter output through a pager.
View output using a viewer.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C dump-csv dump-csv
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 dump-csv 'p/*/`dump-csv`/'
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.
This software is copyright (c) 2020, 2019, 2018, 2017, 2016 by firstname.lastname@example.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.