NAME

App::CSVUtils::csv_sort_rows - Sort CSV rows

VERSION

This document describes version 1.034 of App::CSVUtils::csv_sort_rows (from Perl distribution App-CSVUtils), released on 2024-02-02.

FUNCTIONS

csv_sort_rows

Usage:

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

Sort CSV rows.

This utility sorts the rows in the CSV. Example input CSV:

name,age
Andy,20
Dennis,15
Ben,30
Jerry,30

Example output CSV (using --by-field +age which means by age numerically and ascending):

name,age
Dennis,15
Andy,20
Ben,30
Jerry,30

Example output CSV (using --by-field -age, which means by age numerically and descending):

name,age
Ben,30
Jerry,30
Andy,20
Dennis,15

Example output CSV (using --by-field name, which means by name ascibetically and ascending):

name,age
Andy,20
Ben,30
Dennis,15
Jerry,30

Example output CSV (using --by-field ~name, which means by name ascibetically and descending):

name,age
Jerry,30
Dennis,15
Ben,30
Andy,20

Example output CSV (using --by-field +age --by-field ~name):

name,age
Dennis,15
Andy,20
Jerry,30
Ben,30

You can also reverse the sort order (-r) or sort case-insensitively (-i).

For more flexibility, instead of --by-field you can use --by-code:

Example output --by-code '$a->[1] <=> $b->[1] || $b->[0] cmp $a->[0]' (which is equivalent to --by-field +age --by-field ~name):

name,age
Dennis,15
Andy,20
Jerry,30
Ben,30

If you use --hash, your code will receive the rows to be compared as hashref, e.g. `--hash --by-code '$a->{age} <=> $b->{age} || $b->{name} cmp $a->{name}'.

A third alternative is to sort using Sort::Sub routines. Example output (using --by-sortsub 'by_length<r>' --key '$_->[0]', which is to say to sort by descending length of name):

name,age
Dennis,15
Jerry,30
Andy,20
Ben,30

If none of the --by-* options are specified, the utility will bail unless there's a default that can be used, e.g. when CSV has a single field then that field will be used.

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.

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

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

• inplace => true

  Output to the same file as input.

  Normally, you output to a different file than input. If you try to output to the same file (-o INPUT.csv -O) you will clobber the input file; thus the utility prevents you from doing it. However, with this --inplace option, you can output to the same file. Like perl's -i option, this will first output to a temporary file in the same directory as the input file then rename to the final file at the end. You cannot specify output file (-o) when using this option, but you can specify backup extension with -b option.

  Some caveats:

  • if input file is a symbolic link, it will be replaced with a regular file;

  • renaming (implemented using rename()) can fail if input filename is too long;

  • value specified in -b is currently not checked for acceptable characters;

  • things can also fail if permissions are restrictive;

• inplace_backup_ext => str (default: "")

  Extension to add for backup of input file.

  In inplace mode (--inplace), if this option is set to a non-empty string, will rename the input file using this extension as a backup. The old existing backup will be overwritten, if any.

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

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

  The code will receive the row (arrayref, or if -H is specified, hashref) as the argument.

• output_always_quote => bool (default: 0)

  Whether to always quote values.

  When set to false (the default), values are quoted only when necessary:

  field1,field2,"field three contains comma (,)",field4

  When set to true, then all values will be quoted:

  "field1","field2","field three contains comma (,)","field4"

• output_escape_char => str

  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_filename => filename

  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.

• output_header => bool

  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_quote_char => str

  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.

• output_quote_empty => bool (default: 0)

  Whether to quote empty values.

  When set to false (the default), empty values are not quoted:

  field1,field2,,field4

  When set to true, then empty values will be quoted:

  field1,field2,"",field4

• output_sep_char => str

  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.

• output_tsv => bool

  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.

• overwrite => bool

  Whether to override existing output file.

• reverse => bool

  (No description)

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

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

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.

cpanm App::CSVUtils

perl -MCPAN -e shell
install App::CSVUtils