/ 
App-CSVUtils-0.030
River stage one • 3 direct dependents • 4 total dependents
/ csv-sort-rows

NAME

csv-sort-rows - Sort CSV rows

VERSION

This document describes version 0.030 of csv-sort-rows (from Perl distribution App-CSVUtils), released on 2020-07-30.

SYNOPSIS

Usage:

% csv-sort-rows [-H] [--by-code-json=s] [--by-code=s] [--by-fields=s]
    [--by-sortsub=s] [--ci] [--escape-char=s] [--format=name] [--hash]
    [--header] [-i] [--json] [-k=s] [--key-json=s] [--key=s]
    [--(no)naked-res] [--no-header] [--no-tsv] [--noheader] [--notsv]
    [--page-result[=program]] [--quote-char=s] [-r] [--reverse]
    [--sep-char=s] [--sortsub-args-json=s] [--sortsub-args key=s] [--tsv]
    <filename>

DESCRIPTION

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-fields +age which means by age numerically and ascending):

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

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

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

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

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

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

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

Example output CSV (using --by-fields +age,~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-fields you can use --by-code:

Example output --by-code '$a->[1] <=> $b->[1] || $b->[0] cmp $a->[0]' (which is equivalent to --by-fields +age,~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

OPTIONS

* marks required options.

Main options

--by-code-json=s

Sort using Perl code (JSON-encoded).

See --by-code.

--by-code=s

Sort 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=s

Sort by a comma-separated list of field specification.

`+FIELD` to mean sort numerically ascending, `-FIELD` to sort numerically descending, `FIELD` to mean sort ascibetically ascending, `~FIELD` to mean sort ascibetically descending.

--by-sortsub=s

Sort using a Sort::Sub routine.

Usually combined with `--key` because most Sort::Sub routine expects a string to be compared against.

--ci, -i
--escape-char=s

Specify character to escape value in field, will be passed to Text::CSV_XS.

Defaults to `\\` (backslash). Overrides `--tsv` option.

--filename=s*, -f

Input CSV file.

Use `-` to read from stdin.

--hash, -H

Provide row in $_ as hashref instead of arrayref.

--key-json=s, -k

Generate sort keys with this Perl code (JSON-encoded).

See --key.

--key=s

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 rows the code/Sort::Sub routine will receive these sort keys to sort against.

The code will receive the row as the argument.

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

--quote-char=s

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

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

--reverse, -r
--sep-char=s

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

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

--sortsub-args-json=s

Arguments to pass to Sort::Sub routine (JSON-encoded).

See --sortsub-args.

--sortsub-args=s%

Arguments to pass to Sort::Sub routine.

Each value is a name-value pair, use key=value syntax. Can be specified multiple times.

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

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

undef
--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

[200,"OK",[1,2,3],{"func.extra"=>4}]

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:

[1,2,3]
--page-result

Filter output through a pager.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C csv-sort-rows csv-sort-rows

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.

tcsh

To activate tcsh completion for this script, put:

complete csv-sort-rows 'p/*/`csv-sort-rows`/'

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

other shells

For fish and zsh, install shcompgen as described above.

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2020, 2019, 2018, 2017, 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.