App::CSVUtils::csv_sorted_rows - Check that CSV rows are sorted
This document describes version 1.034 of App::CSVUtils::csv_sorted_rows (from Perl distribution App-CSVUtils), released on 2024-02-02.
Usage:
csv_sorted_rows(%args) -> [$status_code, $reason, $payload, \%result_meta]
Check that CSV rows are sorted.
This utility checks that rows in the CSV are sorted according to specified sorting rule(s). Example input.csv:
input.csv
name,age Andy,20 Dennis,15 Ben,30 Jerry,30
Example check command:
% csv-sorted-rows input.csv --by-field name; # check if name is ascibetically sorted ERROR 400: Rows are NOT sorted
Example input2.csv:
input2.csv
name,age Andy,20 Ben,30 Dennis,15 Jerry,30 % csv-sorted-rows input2.csv --by-field name; # check if name is ascibetically sorted Rows are sorted % csv-sorted-rows input2.csv --by-field ~name; # check if name is ascibetically sorted in descending order ERROR 400: Rows are NOT sorted
See csv-sort-rows for details on sorting options.
This function is not exported.
Arguments ('*' denotes required arguments):
by_code => str|code
Sort by using Perl code.
$a and $b (or the first and second argument) will contain the two rows to be compared. Which are arrayrefs; or if --hash (-H) is specified, hashrefs; or if --key is specified, whatever the code in --key returns.
$a
$b
--hash
-H
--key
by_fields => array[str]
Sort by a list of field specifications.
Each field specification is a field name with an optional prefix. FIELD (without prefix) means sort asciibetically ascending (smallest to largest), ~FIELD means sort asciibetically descending (largest to smallest), +FIELD means sort numerically ascending, -FIELD means sort numerically descending.
FIELD
~FIELD
+FIELD
-FIELD
by_sortsub => str
Sort using a Sort::Sub routine.
When sorting rows, usually combined with --key because most Sort::Sub routine expects a string to be compared against.
When sorting fields, the Sort::Sub routine will get the field name as argument.
ci => bool
(No description)
hash => bool
Provide row in $_ as hashref instead of arrayref.
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-tsv
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.
--no-input-header
field1
field2
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.
--input-sep-char
--input-quote-char
--input-escape-char
key => str|code
Generate sort keys with this Perl code.
If specified, then will compute sort keys using Perl code and sort using the keys. Relevant when sorting using --by-code or --by-sortsub. If specified, then instead of row when sorting rows, the code (or Sort::Sub routine) will receive these sort keys to sort against.
--by-code
--by-sortsub
The code will receive the row (arrayref, or if -H is specified, hashref) as the argument.
quiet => bool
If set to true, do not show messages.
Normally a message will be printed to stdout saying whether the rows are sorted or not, i.e. one of:
Rows are sorted Rows are NOT sorted
If this option is specified, then no message will be printed. Instead, you can find out whether things are sorted via exit code (or status code in the enveloped result, if you request JSON or call this utility as a Perl function).
reverse => bool
sortsub_args => hash
Arguments to pass to Sort::Sub routine.
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)
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) 2024, 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.