/ 
App-CSVUtils-0.004
River stage one • 3 direct dependents • 4 total dependents
/ App::CSVUtils

NAME

App::CSVUtils - CLI utilities related to CSV

VERSION

This document describes version 0.004 of App::CSVUtils (from Perl distribution App-CSVUtils), released on 2016-11-03.

DESCRIPTION

This distribution contains the following CLI utilities:

FUNCTIONS

csv_add_field(%args) -> [status, msg, result, meta]

Add a field to CSV file.

This command:

% csv-add-field FILE.CSV FIELDNAME 'perl code'

is equivalent to:

% csvutil add-field FILE.CSV -F FIELDNAME -e 'perl code'

Your Perl code should return the value for the field. $main::row is available and contains the current row, while $main::rownum contains the row number (1 means the header row, 2 means the first data row). Field will be added as the last field.

This function is not exported.

Arguments ('*' denotes required arguments):

  • 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_delete_field(%args) -> [status, msg, result, meta]

Delete a field from CSV file.

This command:

% csv-delete-field FILE.CSV FIELDNAME

is equivalent to:

% csvutil delete-field FILE.CSV -F FIELDNAME

Field must exist and there must be at least one remaining field after deletion.

This function is not exported.

Arguments ('*' denotes required arguments):

  • 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_list_field_names(%args) -> [status, msg, result, meta]

List field names of CSV file.

This function is not exported.

Arguments ('*' denotes required arguments):

  • 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_munge_field(%args) -> [status, msg, result, meta]

Munge a field in every row of CSV file.

This command:

% csv-munge-field FILE.CSV FIELDNAME 'perl code'

is equivalent to:

% csvutil munge-field FILE.CSV -F FIELDNAME -e 'perl code'

Perl code will be called for each row and $_ will contain the value of the field FIELDNAME, which the Perl code is expected to modify. $main::row will contain the current row array and $main::rownum contains the row number (1 means the header row, 2 means the first data row).

This function is not exported.

Arguments ('*' denotes required arguments):

  • 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_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').

This function is not exported.

Arguments ('*' denotes required arguments):

  • filename* => filename

    Input CSV file.

  • with => str (default: " ")

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_sort_fields(%args) -> [status, msg, result, meta]

Sort CSV fields.

This function is not exported.

Arguments ('*' denotes required arguments):

  • ci => bool

  • example => array[str]

  • filename* => filename

    Input CSV file.

  • reverse => bool

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)

csvutil(%args) -> [status, msg, result, meta]

Perform action on a CSV file.

This function is not exported.

Arguments ('*' denotes required arguments):

  • action* => str

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

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

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 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.