NAME

bpomfc - Short alias for bpom-list-*f*ood-*c*ategories-rba

VERSION

This document describes version 0.021 of bpomfc (from Perl distribution App-BPOMUtils-Table-FoodCategory), released on 2024-05-15.

SYNOPSIS

bpomfc --help (or -h, -?)

bpomfc --version (or -v)

bpomfc [--code-contains=str] [(--code-in=str)+|--code-in-json=json] [--code-is=str] [--code-isnt=str] [--code-matches=str] [--code-max=str] [--code-min=str] [--code-not-contains=str] [(--code-not-in=str)+|--code-not-in-json=json] [--code-not-matches=str] [--code-xmax=str] [--code-xmin=str] [--code=str] [--debug|--log-level=level|--quiet|--trace|--verbose] [--detail|-l|--no-detail|--nodetail] [(--exclude-field=str)+|--exclude-fields-json=json] [(--field=str)+|--fields-json=json] [--format=name|--json] [--(no)naked-res] [--name-contains=str] [(--name-in=str)+|--name-in-json=json] [--name-is=str] [--name-isnt=str] [--name-matches=str] [--name-max=str] [--name-min=str] [--name-not-contains=str] [(--name-not-in=str)+|--name-not-in-json=json] [--name-not-matches=str] [--name-xmax=str] [--name-xmin=str] [--name=str] [--page-result[=program]|--view-result[=program]] [--query-boolean=str|--and|--or] [(--query=str)+|--queries-json=json|(-q=str)+] [--random|--no-random|--norandom] [--result-limit=int] [--result-start=int] [(--sort=str)+|--sort-json=json] [--status-contains=str] [(--status-in=str)+|--status-in-json=json] [--status-is=str] [--status-isnt=str] [--status-matches=str] [--status-max=str] [--status-min=str] [--status-not-contains=str] [(--status-not-in=str)+|--status-not-in-json=json] [--status-not-matches=str] [--status-xmax=str] [--status-xmin=str] [--status=str] [--summary-contains=str] [(--summary-in=str)+|--summary-in-json=json] [--summary-is=str] [--summary-isnt=str] [--summary-matches=str] [--summary-max=str] [--summary-min=str] [--summary-not-contains=str] [(--summary-not-in=str)+|--summary-not-in-json=json] [--summary-not-matches=str] [--summary-xmax=str] [--summary-xmin=str] [--summary=str] [--with-field-names|--without-field-names] -- [query] ...

See examples in the "EXAMPLES" section.

OPTIONS

* marks required options.

Field selection options

--detail, -l

Return array of full records instead of just ID fields.

By default, only the key (ID) field is returned per result entry.

--exclude-field=s@

Select fields to return.

Can be specified multiple times.

--exclude-fields-json=s

Select fields to return (JSON-encoded).

See --exclude-field.

--field=s@

Select fields to return.

Can be specified multiple times.

--fields-json=s

Select fields to return (JSON-encoded).

See --field.

--with-field-names

Return field names in each record (as hash/associative array).

When enabled, function will return each record as hash/associative array (field name => value pairs). Otherwise, function will return each record as list/array (field value, field value, ...).

Filtering for code options

--code-contains=s

Only return records where the 'code' field contains specified text.

--code-in-json=s

Only return records where the 'code' field is in the specified values (JSON-encoded).

See --code-in.

--code-in=s@

Only return records where the 'code' field is in the specified values.

Can be specified multiple times.

--code-is=s

Only return records where the 'code' field equals specified value.

--code-isnt=s

Only return records where the 'code' field does not equal specified value.

--code-matches=s

Only return records where the 'code' field matches specified regular expression pattern.

--code-max=s

Only return records where the 'code' field is less than or equal to specified value.

--code-min=s

Only return records where the 'code' field is greater than or equal to specified value.

--code-not-contains=s

Only return records where the 'code' field does not contain specified text.

--code-not-in-json=s

Only return records where the 'code' field is not in the specified values (JSON-encoded).

See --code-not-in.

--code-not-in=s@

Only return records where the 'code' field is not in the specified values.

Can be specified multiple times.

--code-not-matches=s

Only return records where the 'code' field does not match specified regular expression.

--code-xmax=s

Only return records where the 'code' field is less than specified value.

--code-xmin=s

Only return records where the 'code' field is greater than specified value.

--code=s

Only return records where the 'code' field equals specified value.

Filtering for name options

--name-contains=s

Only return records where the 'name' field contains specified text.

--name-in-json=s

Only return records where the 'name' field is in the specified values (JSON-encoded).

See --name-in.

--name-in=s@

Only return records where the 'name' field is in the specified values.

Can be specified multiple times.

--name-is=s

Only return records where the 'name' field equals specified value.

--name-isnt=s

Only return records where the 'name' field does not equal specified value.

--name-matches=s

Only return records where the 'name' field matches specified regular expression pattern.

--name-max=s

Only return records where the 'name' field is less than or equal to specified value.

--name-min=s

Only return records where the 'name' field is greater than or equal to specified value.

--name-not-contains=s

Only return records where the 'name' field does not contain specified text.

--name-not-in-json=s

Only return records where the 'name' field is not in the specified values (JSON-encoded).

See --name-not-in.

--name-not-in=s@

Only return records where the 'name' field is not in the specified values.

Can be specified multiple times.

--name-not-matches=s

Only return records where the 'name' field does not match specified regular expression.

--name-xmax=s

Only return records where the 'name' field is less than specified value.

--name-xmin=s

Only return records where the 'name' field is greater than specified value.

--name=s

Only return records where the 'name' field equals specified value.

Filtering for status options

--status-contains=s

Only return records where the 'status' field contains specified text.

--status-in-json=s

Only return records where the 'status' field is in the specified values (JSON-encoded).

See --status-in.

--status-in=s@

Only return records where the 'status' field is in the specified values.

Can be specified multiple times.

--status-is=s

Only return records where the 'status' field equals specified value.

--status-isnt=s

Only return records where the 'status' field does not equal specified value.

--status-matches=s

Only return records where the 'status' field matches specified regular expression pattern.

--status-max=s

Only return records where the 'status' field is less than or equal to specified value.

--status-min=s

Only return records where the 'status' field is greater than or equal to specified value.

--status-not-contains=s

Only return records where the 'status' field does not contain specified text.

--status-not-in-json=s

Only return records where the 'status' field is not in the specified values (JSON-encoded).

See --status-not-in.

--status-not-in=s@

Only return records where the 'status' field is not in the specified values.

Can be specified multiple times.

--status-not-matches=s

Only return records where the 'status' field does not match specified regular expression.

--status-xmax=s

Only return records where the 'status' field is less than specified value.

--status-xmin=s

Only return records where the 'status' field is greater than specified value.

--status=s

Only return records where the 'status' field equals specified value.

Filtering for summary options

--summary-contains=s

Only return records where the 'summary' field contains specified text.

--summary-in-json=s

Only return records where the 'summary' field is in the specified values (JSON-encoded).

See --summary-in.

--summary-in=s@

Only return records where the 'summary' field is in the specified values.

Can be specified multiple times.

--summary-is=s

Only return records where the 'summary' field equals specified value.

--summary-isnt=s

Only return records where the 'summary' field does not equal specified value.

--summary-matches=s

Only return records where the 'summary' field matches specified regular expression pattern.

--summary-max=s

Only return records where the 'summary' field is less than or equal to specified value.

--summary-min=s

Only return records where the 'summary' field is greater than or equal to specified value.

--summary-not-contains=s

Only return records where the 'summary' field does not contain specified text.

--summary-not-in-json=s

Only return records where the 'summary' field is not in the specified values (JSON-encoded).

See --summary-not-in.

--summary-not-in=s@

Only return records where the 'summary' field is not in the specified values.

Can be specified multiple times.

--summary-not-matches=s

Only return records where the 'summary' field does not match specified regular expression.

--summary-xmax=s

Only return records where the 'summary' field is less than specified value.

--summary-xmin=s

Only return records where the 'summary' field is greater than specified value.

--summary=s

Only return records where the 'summary' field equals specified value.

Filtering options

--and

Shortcut for --query-boolean=and.

See --query-boolean.

--or

Shortcut for --query-boolean=or.

See --query-boolean.

--queries-json=s, -q

Search (JSON-encoded).

See --query.

Can also be specified as the 1st command-line argument and onwards.

--query-boolean=s

Whether records must match all search queries ('and') or just one ('or').

Default value:

"and"

Valid values:

["and","or"]

If set to and, all queries must match; if set to or, only one query should match. See the queries option for more details on searching.

--query=s@

Search.

This will search all searchable fields with one or more specified queries. Each query can be in the form of -FOO (dash prefix notation) to require that the fields do not contain specified string, or /FOO/ to use regular expression. All queries must match if the query_boolean option is set to and; only one query should match if the query_boolean option is set to or.

Can also be specified as the 1st command-line argument and onwards.

Can be specified multiple times.

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

Set log level.

By default, these log levels are available (in order of increasing level of importance, from least important to most): trace, debug, info, warn/warning, error, fatal. By default, the level is usually set to warn, which means that log statements with level info and less important levels will not be shown. To increase verbosity, choose info, debug, or trace.

For more details on log level and logging, as well as how new logging levels can be defined or existing ones modified, see Log::ger.

--quiet

Shortcut for --log-level=error.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

Ordering options

--random

Return records in random order.

--sort-json=s

Order records according to certain field(s) (JSON-encoded).

See --sort.

--sort=s@

Order records according to certain field(s).

A list of field names separated by comma. Each field can be prefixed with '-' to specify descending order instead of the default ascending.

Can be specified multiple times.

Output options

--format=s

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

Default value:

undef

Output can be displayed in multiple formats, and a suitable default format is chosen depending on the application and/or whether output destination is interactive terminal (i.e. whether output is piped). This option specifically chooses an output format.

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

This option will pipe the output to a specified pager program. If pager program is not specified, a suitable default e.g. less is chosen.

--view-result

View output using a viewer.

This option will first save the output to a temporary file, then open a viewer program to view the temporary file. If a viewer program is not chosen, a suitable default, e.g. the browser, is chosen.

Paging options

--result-limit=s

Only return a certain number of records.

--result-start=s

Only return starting from the n'th record.

Default value:

1

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

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 bpomfc 'p/*/`bpomfc`/'

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.

EXAMPLES

Print active categories codes matching "cokelat"

% bpomfc --status-is Aktif 'cokelat hitam'
050104000001
050104000002
050104000003
050104000012

Print active records matching "cokelat hitam" in a formatted text table

% bpomfc --status-is Aktif 'cokelat hitam' -l --format text-pretty
.--------+--------------+--------------------------------+--------------------------------------------------------------------------------------------------------------------.
| status |         code | name                           | summary                                                                                                            |
+--------+--------------+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
| Aktif  | 050104000001 | Cokelat Hitam (Dark Chocolate, | Cokelat hitam (dark chocolate, semisweet chocolate, bittersweet chocolate) adalah produk yang diperhitungkan dalam |
|        |              | Semisweet Chocolate,           | kondisi tanpa kandungan air, mengandung tidak kurang dari 35% padatan kakao, tidak kurang dari 18% lemak kakao,    |
|        |              | Bittersweet Chocolate)         | dan tidak kurang dari 14% padatan kakao tanpa lemak.                                                               |
| Aktif  | 050104000002 | Cokelat Hitam Manis (Sweet     | Cokelat hitam manis (sweet chocolate) adalah produk yang diperhitungkan dalam kondisi tanpa kandungan air,         |
|        |              | Chocolate)                     | mengandung tidak kurang dari 30% padatan kakao, tidak kurang dari 18% lemak kakao, dan tidak kurang dari 12%       |
|        |              |                                | padatan kakao tanpa lemak.                                                                                         |
| Aktif  | 050104000003 | Cokelat Hitam Kovertur (Dark   | Cokelat hitam kovertur (dark chocolate couverture) adalah produk yang diperhitungkan dalam kondisi tanpa kandungan |
|        |              | Chocolate Couverture)          | air, mengandung tidak kurang dari 35% padatan kakao, tidak kurang dari 31% lemak kakao, dan tidak kurang dari 2,5% |
|        |              |                                | padatan kakao tanpa lemak.                                                                                         |
| Aktif  | 050104000012 | Truffles                       | Truffles adalah produk cokelat yang dibuat dari campuran cokelat hitam atau cokelat susu dengan lemak kakao,       |
|        |              |                                | minyak nabati dan bahan pangan lain, umumnya berbentuk bulat, kerucut, atau lengkungan, dimana dapat berupa        |
|        |              |                                | cokelat isi (filled chocolate).                                                                                    |
`--------+--------------+--------------------------------+--------------------------------------------------------------------------------------------------------------------'

Print all category records with code 14.1.4.2

% bpomfc --code-matches '^14010402' -l --format text-pretty
.--------+--------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------.
| status |         code | name                      | summary                                                                                                                 |
+--------+--------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------+
| Aktif  | 140104020001 | Punches/Ades              | Definisi : Punches/ades adalah produk minuman yang diperoleh dari campuran sari buah dengan atau tanpa penambahan       |
|        |              |                           | perisa.                                                                                                                 |
| Aktif  | 140104020002 | Crush                     | Definisi : Crush adalah minuman ringan yang mengandung sari buah, bukan untuk minuman citrus comminutes, ditujukan      |
|        |              |                           | untuk dikonsumsi tanpa diencerkan, termasuk cordial yang dikonsumsi tanpa pengenceran.                                  |
|        |              |                           |                                                                                                                         |
|        |              |                           | Karakteristik dasar : Kandungan buah tidak kurang dari 3% dan tidak lebih dari 5% tergantung jenisnya.                  |
| Aktif  | 140104020003 | Minuman Sari Buah         | Definisi : Minuman sari buah adalah minuman yang diperoleh dengan mencampur air minum; sari buah atau campuran sari     |
|        |              |                           | buah yang tidak difermentasi, dengan bagian lain dari satu jenis buah atau lebih, dengan atau tanpa penambahan gula.    |
|        |              |                           | Total sari buah tidak kurang dari 35% (b/v).                                                                            |
| Aktif  | 140104020004 | Minuman Buah              | Definisi : Minuman buah adalah minuman yang terdiri dari satu atau lebih jenis buah, dengan total sari buah 10% sampai  |
|        |              |                           | 35% (b/v).                                                                                                              |
| Aktif  | 140104020005 | Minuman Rasa Buah         | Definisi : Minuman berperisa/rasa buah adalah minuman yang terdiri dari satu atau lebih jenis buah, dengan total sari   |
|        |              |                           | buah kurang dari 10% (b/v).                                                                                             |
| Aktif  | 140104020006 | Minuman Berperisa         | Definisi : Minuman berperisa adalah produk minuman yang diperoleh dari pencampuran air minum dengan bahan perisa dan    |
|        |              |                           | gula dengan atau tanpa penambahan bahan pangan lain melalui proses pemanasan.                                           |
| Aktif  | 140104020007 | Minuman Jeli              | Definisi : Minuman jeli adalah minuman yang menggunakan bahan baku berupa hidrokoloid sebagai komponen utama. Produk    |
|        |              |                           | akhir berupa cairan semi liquid (gel) diperoleh dari proses pencampuran air, hidrokoloid dengan atau tanpa penambahan   |
|        |              |                           | bahan pangan lain.                                                                                                      |
|        |              |                           |                                                                                                                         |
|        |              |                           | Karakteristik dasar :                                                                                                   |
|        |              |                           |                                                                                                                         |
|        |              |                           | \xE2\x80\xA2 Memiliki tekstur/konsistensi gel semi liquid ;                                                                        |
|        |              |                           |                                                                                                                         |
|        |              |                           | \xE2\x80\xA2 Kandungan hidrokoloid tidak kurang dari 0,1%.                                                                         |
| Aktif  | 140104020008 | Minuman Teh               | Definisi : Minuman teh adalah minuman hasil seduhan daun teh dan/atau ekstrak teh dalam air dengan atau tanpa           |
|        |              |                           | penambahan gula dan/atau bahan pangan lain, dan dikemas secara kedap (hermetis).                                        |
| Aktif  | 140104020009 | Minuman Kopi              | Definisi : Minuman kopi adalah minuman yang dibuat dari kopi bubuk, kopi instan, dan/atau ekstrak kopi, air minum,      |
|        |              |                           | dengan atau tanpa penambahan gula dan bahan pangan lain.                                                                |
|        |              |                           |                                                                                                                         |
|        |              |                           | Karakteristik dasar : Kadar kopi tidak kurang dari 4% (dihitung dari basis berat kering).                               |
| Aktif  | 140104020010 | Kapucino                  | Definisi : Kapucino adalah minuman yang dibuat dari espresso dan susu, yang merupakan minuman khas Italia.              |
| Aktif  | 140104020011 | Minuman Rasa Susu         | Definisi : Minuman rasa susu adalah produk minuman yang diperoleh dari pencampuran air minum dengan susu untuk          |
|        |              |                           | memberikan rasa, dengan atau tanpa penambahan bahan pangan lain.                                                        |
|        |              |                           |                                                                                                                         |
|        |              |                           | Karakteristik dasar:                                                                                                    |
|        |              |                           |                                                                                                                         |
|        |              |                           | \xE2\x80\xA2 Kadar lemak susu kurang dari 0.3%;                                                                                    |
|        |              |                           |                                                                                                                         |
|        |              |                           | \xE2\x80\xA2 Kadar CO2 tidak lebih dari 5.890 mg/L.                                                                                |
| Aktif  | 140104020012 | Minuman Citrus Comminutes | Definisi : Minuman citrus comminutes adalah minuman ringan yang diperoleh dari proses yang melibatkan kelompok buah     |
|        |              |                           | citrus utuh.                                                                                                            |
|        |              |                           |                                                                                                                         |
|        |              |                           | Karakteristik dasar :                                                                                                   |
|        |              |                           |                                                                                                                         |
|        |              |                           | \xE2\x80\xA2 Kandungan buah dalam minuman 7% hingga 10% tergantung jenisnya sebelum diencerkan, dan 1,5% hingga 2% untuk minuman   |
|        |              |                           | yang dikonsumsi tanpa pengenceran;                                                                                      |
|        |              |                           |                                                                                                                         |
|        |              |                           | \xE2\x80\xA2 Dapat ditambahkan gula tidak lebih dari 100 g/kg.                                                                     |
| Aktif  | 140104020013 | Minuman Teh Fermentasi    |                                                                                                                         |
`--------+--------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------'

How many categories are active vs inactive?

% echo -n 'Aktif: '; bpomfc --status-is Aktif | wc -l; echo -n 'Tidak Aktif: '; bpomfc --status-isnt Aktif | wc -l
Aktif: 1185
Tidak Aktif: 235

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-BPOMUtils-Table-FoodCategory.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-BPOMUtils-Table-FoodCategory.

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 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-BPOMUtils-Table-FoodCategory

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::BPOMUtils::Table::FoodCategory

perl -MCPAN -e shell
install App::BPOMUtils::Table::FoodCategory