NAME

App::BPOMUtils::Table::FoodAdditive - List registered food additives in BPOM

VERSION

This document describes version 0.020 of App::BPOMUtils::Table::FoodAdditive (from Perl distribution App-BPOMUtils-Table-FoodAdditive), released on 2024-04-19.

DESCRIPTION

This distribution contains the following CLIs:

FUNCTIONS

bpom_list_food_additives

Usage:

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

List registered food additives in BPOM.

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

additive_group => str

Only return records where the 'additive_group' field equals specified value.
additive_group.contains => str

Only return records where the 'additive_group' field contains specified text.
additive_group.in => array[str]

Only return records where the 'additive_group' field is in the specified values.
additive_group.is => str

Only return records where the 'additive_group' field equals specified value.
additive_group.isnt => str

Only return records where the 'additive_group' field does not equal specified value.
additive_group.max => str

Only return records where the 'additive_group' field is less than or equal to specified value.
additive_group.min => str

Only return records where the 'additive_group' field is greater than or equal to specified value.
additive_group.not_contains => str

Only return records where the 'additive_group' field does not contain specified text.
additive_group.not_in => array[str]

Only return records where the 'additive_group' field is not in the specified values.
additive_group.xmax => str

Only return records where the 'additive_group' field is less than specified value.
additive_group.xmin => str

Only return records where the 'additive_group' field is greater than specified value.
additive_name => str

Only return records where the 'additive_name' field equals specified value.
additive_name.contains => str

Only return records where the 'additive_name' field contains specified text.
additive_name.in => array[str]

Only return records where the 'additive_name' field is in the specified values.
additive_name.is => str

Only return records where the 'additive_name' field equals specified value.
additive_name.isnt => str

Only return records where the 'additive_name' field does not equal specified value.
additive_name.max => str

Only return records where the 'additive_name' field is less than or equal to specified value.
additive_name.min => str

Only return records where the 'additive_name' field is greater than or equal to specified value.
additive_name.not_contains => str

Only return records where the 'additive_name' field does not contain specified text.
additive_name.not_in => array[str]

Only return records where the 'additive_name' field is not in the specified values.
additive_name.xmax => str

Only return records where the 'additive_name' field is less than specified value.
additive_name.xmin => str

Only return records where the 'additive_name' field is greater than specified value.
detail => bool (default: 0)

Return array of full records instead of just ID fields.

By default, only the key (ID) field is returned per result entry.
exclude_fields => array[str]

Select fields to return.
fields => array[str]

Select fields to return.
food_category_name => str

Only return records where the 'food_category_name' field equals specified value.
food_category_name.contains => str

Only return records where the 'food_category_name' field contains specified text.
food_category_name.in => array[str]

Only return records where the 'food_category_name' field is in the specified values.
food_category_name.is => str

Only return records where the 'food_category_name' field equals specified value.
food_category_name.isnt => str

Only return records where the 'food_category_name' field does not equal specified value.
food_category_name.max => str

Only return records where the 'food_category_name' field is less than or equal to specified value.
food_category_name.min => str

Only return records where the 'food_category_name' field is greater than or equal to specified value.
food_category_name.not_contains => str

Only return records where the 'food_category_name' field does not contain specified text.
food_category_name.not_in => array[str]

Only return records where the 'food_category_name' field is not in the specified values.
food_category_name.xmax => str

Only return records where the 'food_category_name' field is less than specified value.
food_category_name.xmin => str

Only return records where the 'food_category_name' field is greater than specified value.
food_category_number => str

Only return records where the 'food_category_number' field equals specified value.
food_category_number.contains => str

Only return records where the 'food_category_number' field contains specified text.
food_category_number.in => array[str]

Only return records where the 'food_category_number' field is in the specified values.
food_category_number.is => str

Only return records where the 'food_category_number' field equals specified value.
food_category_number.isnt => str

Only return records where the 'food_category_number' field does not equal specified value.
food_category_number.max => str

Only return records where the 'food_category_number' field is less than or equal to specified value.
food_category_number.min => str

Only return records where the 'food_category_number' field is greater than or equal to specified value.
food_category_number.not_contains => str

Only return records where the 'food_category_number' field does not contain specified text.
food_category_number.not_in => array[str]

Only return records where the 'food_category_number' field is not in the specified values.
food_category_number.xmax => str

Only return records where the 'food_category_number' field is less than specified value.
food_category_number.xmin => str

Only return records where the 'food_category_number' field is greater than specified value.
id => str

Only return records where the 'id' field equals specified value.
id.contains => str

Only return records where the 'id' field contains specified text.
id.in => array[str]

Only return records where the 'id' field is in the specified values.
id.is => str

Only return records where the 'id' field equals specified value.
id.isnt => str

Only return records where the 'id' field does not equal specified value.
id.max => str

Only return records where the 'id' field is less than or equal to specified value.
id.min => str

Only return records where the 'id' field is greater than or equal to specified value.
id.not_contains => str

Only return records where the 'id' field does not contain specified text.
id.not_in => array[str]

Only return records where the 'id' field is not in the specified values.
id.xmax => str

Only return records where the 'id' field is less than specified value.
id.xmin => str

Only return records where the 'id' field is greater than specified value.
information => str

Only return records where the 'information' field equals specified value.
information.contains => str

Only return records where the 'information' field contains specified text.
information.in => array[str]

Only return records where the 'information' field is in the specified values.
information.is => str

Only return records where the 'information' field equals specified value.
information.isnt => str

Only return records where the 'information' field does not equal specified value.
information.max => str

Only return records where the 'information' field is less than or equal to specified value.
information.min => str

Only return records where the 'information' field is greater than or equal to specified value.
information.not_contains => str

Only return records where the 'information' field does not contain specified text.
information.not_in => array[str]

Only return records where the 'information' field is not in the specified values.
information.xmax => str

Only return records where the 'information' field is less than specified value.
information.xmin => str

Only return records where the 'information' field is greater than specified value.
ins_number => str

Only return records where the 'ins_number' field equals specified value.
ins_number.contains => str

Only return records where the 'ins_number' field contains specified text.
ins_number.in => array[str]

Only return records where the 'ins_number' field is in the specified values.
ins_number.is => str

Only return records where the 'ins_number' field equals specified value.
ins_number.isnt => str

Only return records where the 'ins_number' field does not equal specified value.
ins_number.max => str

Only return records where the 'ins_number' field is less than or equal to specified value.
ins_number.min => str

Only return records where the 'ins_number' field is greater than or equal to specified value.
ins_number.not_contains => str

Only return records where the 'ins_number' field does not contain specified text.
ins_number.not_in => array[str]

Only return records where the 'ins_number' field is not in the specified values.
ins_number.xmax => str

Only return records where the 'ins_number' field is less than specified value.
ins_number.xmin => str

Only return records where the 'ins_number' field is greater than specified value.
limit => str

Only return records where the 'limit' field equals specified value.
limit.contains => str

Only return records where the 'limit' field contains specified text.
limit.in => array[str]

Only return records where the 'limit' field is in the specified values.
limit.is => str

Only return records where the 'limit' field equals specified value.
limit.isnt => str

Only return records where the 'limit' field does not equal specified value.
limit.max => str

Only return records where the 'limit' field is less than or equal to specified value.
limit.min => str

Only return records where the 'limit' field is greater than or equal to specified value.
limit.not_contains => str

Only return records where the 'limit' field does not contain specified text.
limit.not_in => array[str]

Only return records where the 'limit' field is not in the specified values.
limit.xmax => str

Only return records where the 'limit' field is less than specified value.
limit.xmin => str

Only return records where the 'limit' field is greater than specified value.
limit_unit => str

Only return records where the 'limit_unit' field equals specified value.
limit_unit.contains => str

Only return records where the 'limit_unit' field contains specified text.
limit_unit.in => array[str]

Only return records where the 'limit_unit' field is in the specified values.
limit_unit.is => str

Only return records where the 'limit_unit' field equals specified value.
limit_unit.isnt => str

Only return records where the 'limit_unit' field does not equal specified value.
limit_unit.max => str

Only return records where the 'limit_unit' field is less than or equal to specified value.
limit_unit.min => str

Only return records where the 'limit_unit' field is greater than or equal to specified value.
limit_unit.not_contains => str

Only return records where the 'limit_unit' field does not contain specified text.
limit_unit.not_in => array[str]

Only return records where the 'limit_unit' field is not in the specified values.
limit_unit.xmax => str

Only return records where the 'limit_unit' field is less than specified value.
limit_unit.xmin => str

Only return records where the 'limit_unit' field is greater than specified value.
note => str

Only return records where the 'note' field equals specified value.
note.contains => str

Only return records where the 'note' field contains specified text.
note.in => array[str]

Only return records where the 'note' field is in the specified values.
note.is => str

Only return records where the 'note' field equals specified value.
note.isnt => str

Only return records where the 'note' field does not equal specified value.
note.max => str

Only return records where the 'note' field is less than or equal to specified value.
note.min => str

Only return records where the 'note' field is greater than or equal to specified value.
note.not_contains => str

Only return records where the 'note' field does not contain specified text.
note.not_in => array[str]

Only return records where the 'note' field is not in the specified values.
note.xmax => str

Only return records where the 'note' field is less than specified value.
note.xmin => str

Only return records where the 'note' field is greater than specified value.
queries => array[str]

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.
query_boolean => str (default: "and")

Whether records must match all search queries ('and') or just one ('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.
random => bool (default: 0)

Return records in random order.
result_limit => int

Only return a certain number of records.
result_start => int (default: 1)

Only return starting from the n'th record.
sort => array[str]

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.
status => str

Only return records where the 'status' field equals specified value.
status.contains => str

Only return records where the 'status' field contains specified text.
status.in => array[str]

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

Only return records where the 'status' field equals specified value.
status.isnt => str

Only return records where the 'status' field does not equal specified value.
status.max => str

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

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

Only return records where the 'status' field does not contain specified text.
status.not_in => array[str]

Only return records where the 'status' field is not in the specified values.
status.xmax => str

Only return records where the 'status' field is less than specified value.
status.xmin => str

Only return records where the 'status' field is greater than specified value.
with_field_names => bool

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

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-BPOMUtils-Table-FoodAdditive.

SOURCE

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

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

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::BPOMUtils::Table::FoodAdditive, copy and paste the appropriate command in to your terminal.

cpanm

cpanm App::BPOMUtils::Table::FoodAdditive

CPAN shell

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

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)