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

NAME

App::CSVUtils::csv_find_values - Find specified values in a CSV field

VERSION

This document describes version 1.033 of App::CSVUtils::csv_find_values (from Perl distribution App-CSVUtils), released on 2023-09-06.

FUNCTIONS

csv_find_values

Usage:

csv_find_values(%args) -> [$status_code, $reason, $payload, \%result_meta]

Find specified values in a CSV field.

Example input:

# product.csv
sku,name,is_active,description
SKU1,foo,1,blah
SK2,bar,1,blah
SK3B,baz,0,blah
SKU2,qux,1,blah
SKU3,quux,1,blah
SKU14,corge,0,blah

Check whether specified values are found in the sku field, print message when they are (search case-insensitively):

% csv-find-values product.csv sku sku1 sk3b sku15 -i
'sku1' is found in field 'sku' row 2
'sk3b' is found in field 'sku' row 4

Print message when values are not found instead:

% csv-find-values product.csv sku sku1 sk3b sku15 -i --print-when=not_found
'sku15' is NOT found in field 'sku'

Always print message:

% csv-find-values product.csv sku sku1 sk3b sku15 -i --print-when=always
'sku1' is found in field 'sku' row 2
'sk3b' is found in field 'sku' row 4
'sku15' is NOT found in field 'sku'

Do custom action with Perl code, code will receive $_ (the value being evaluated), $found (bool, whether it is found in the field), $rownum (the row number the value is found in), $data_rownum (the data row number the value is found in, equals $rownum - 1):

% csv-find-values product.csv sku1 sk3b sku15 -i -e 'if ($found) { print "$_ found\n" } else { print "$_ NOT found\n" }'
sku1 found
sk3b found
sku15 NOT found

There is an option to do fuzzy matching, where similar values will be suggested when exact match is not found.

This function is not exported.

Arguments ('*' denotes required arguments):

  • eval => str|code

    Perl code.

  • field* => str

    Field name.

  • fuzzy => true

    (No description)

  • ignore_case => bool

    (No description)

  • input_escape_char => str

    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_filename => filename (default: "-")

    Input CSV file.

    Use - to read from stdin.

    Encoding of input file is assumed to be UTF-8.

  • input_header => bool (default: 1)

    Specify whether input CSV has 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.

  • input_quote_char => str

    Specify field quote character in input CSV, will be passed to Text::CSV_XS.

    Defaults to " (double quote). Overrides --input-tsv option.

  • input_sep_char => str

    Specify field separator character in input CSV, will be passed to Text::CSV_XS.

    Defaults to , (comma). Overrides --input-tsv option.

  • input_tsv => true

    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.

  • print_when => str (default: "found")

    Overriden by the --eval option.

  • values* => array[str]

    (No description)

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

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.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

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.

COPYRIGHT AND LICENSE

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.

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.