NAME

rimetadb - Manage a Rinci metadata database

VERSION

This document describes version 0.226 of rimetadb (from Perl distribution App-rimetadb), released on 2023-07-09.

SYNOPSIS

Scan all local Perl modules in the MyCompany:: namespace, get all Rinci metadata and store them in the database (defaults to dbi:SQLite:dbname=$HOME/rimeta.db where $HOME is the user's home directory.

% rimetadb update-from-modules MyCompany::

Ditto, except we specify custom database location (note that this is not recommended, you should put username/password in config file instead of command-line options):

% rimetadb update-from-modules MyCompany:: \
    --dsn 'mysql:database=mycompany_rimeta' --user ... --password ...

Update a single package metadata:

% rimetadb update --package MyCompany::Job \
    --metadata-json '{"v":1.1,"summary":"Manage jobs"}'

Update a single function metadata:

% rimetadb update --package MyCompany::Job --function restart_job \
    --metadata-json '{"v":1.1,"summary":"Restart a job","args":{"id":{"summary":"Job ID","schema":"int*","req":1},"force":{"schema":"bool"}}}'

Delete a single package metadata:

% rimetadb delete --package MyCompany::Job

Delete a single function metadata:

% rimetadb delete --package MyCompany::Job --function restart_job

Show some statistics (will be expanded further later):

% rimetadb stats

List packages in the database:

% rimetadb packages
% rimetadb packages -l
% rimetadb packages MyCompany

List functions in the database:

% rimetadb functions
% rimetadb functions -l
% rimetadb functions MyCompany

List function arguments in the database:

% rimetadb arguments
% rimetadb arguments -l

Get metadata of function/package:

% rimetadb meta Foo::Bar::func

DESCRIPTION

This script (and backend Perl module, App::rimetadb) maintains a database that catalogs Rinci metadata. The metadata can be used for various purposes:

Statistics

Average number of functions in a package. Average number of arguments in a function. Most often used schema data types for arguments. And so on.
Allow access to Perl functions via HTTP

See Perinci::Access::HTTP::Server and Riap.
Documentation

You can add Rinci metadata from installed Perl modules, or manually by specifying JSON or data structure via CLI or Perl API.

SUBCOMMANDS

argument-stats

Show statistics on function arguments from the database.

arguments

List function arguments in the database.

delete

Delete a package or function metadata from the database.

function-stats

Show some statistics on functions from the database.

functions

List functions in the database.

packages

List packages in the database.

stats

Show some statistics from the database.

update

Add/update a package or function metadata in the database.

This routine lets you add/update a package or function metadata in the database with the specified metadata.

update-from-modules

Update Rinci metadata database from local Perl modules.

This routine scans Perl modules, load them, and update the database using Rinci metadata from each modules into the database.

For each package, function, or function argument metadata, you can put this attribute:

'x.app.rimetadb.exclude' => 1,

to exclude the entity from being imported into the database. When you exclude a package, all its contents (currently functions) are also excluded.

OPTIONS

* marks required options.

Common options

--config-path=s, -c

Set path to configuration file.

Can actually be specified multiple times to instruct application to read from multiple configuration files (and merge them).

--config-profile=s, -P

Set configuration profile to use.

A single configuration file can contain profiles, i.e. alternative sets of values that can be selected. For example:

[profile=dev]
username=foo
pass=beaver

[profile=production]
username=bar
pass=honey

When you specify --config-profile=dev, username will be set to foo and password to beaver. When you specify --config-profile=production, username will be set to bar and password to honey.

--debug

Shortcut for --log-level=debug.

--dsn=s

DBI connection DSN.

If not specified, will default to dbd:SQLite:$HOME/rimeta.db where $HOME is user's home directory.

Note: has been tested with MySQL and SQLite only.

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

--help, -h, -?

Display help message and exit.

--json

Set output format to json.

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

--naked-res

When outputing as JSON, strip result envelope.

Default value:

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]

--no-config, -C

Do not use any configuration file.

If you specify --no-config, the application will not read any configuration file.

--no-env

Do not read environment for default options.

If you specify --no-env, the application wil not read any environment variable.

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

--password=s

DBI connection password.

--quiet

Shortcut for --log-level=error.

--subcommands

List available subcommands.

--trace

Shortcut for --log-level=trace.

--user=s

DBI connection user.

--verbose

Shortcut for --log-level=info.

--version, -v

Display program's version and exit.

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

Options for subcommand arguments

--detail, -l

(No description)

--function=s

Select specific function only.

--package=s

Select specific package only.

--query=s

(No description)

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

--type=s

Select arguments with specific type only.

Options for subcommand delete

--function=s: (No description)
--package=s*: (No description)

Options for subcommand functions

--detail, -l

(No description)

--package=s

Select specific package only.

--query=s

(No description)

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

Options for subcommand meta

--name=s*

(Fully-qualified) function name or package name.

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

Options for subcommand packages

--detail, -l

(No description)

--query=s

(No description)

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

Options for subcommand update

--dist=s: (No description)
--extra=s: (No description)
--function=s: (No description)
--metadata-json=s: See --metadata.
--metadata=s*: (No description)
--package=s*: (No description)

Options for subcommand update-from-modules

--exclude-json=s

Perl package names or prefixes to exclude (JSON-encoded).

See --exclude.

--exclude=s@

Perl package names or prefixes to exclude.

You can also use this attribute in your package metadata:

'x.app.rimetadb.exclude' => 1,

to exclude the package (as well as its contents: all functions) from being imported into the database.

Can be specified multiple times.

--force-update, --force

Force update database even though module hasn't changed since last update.

--library=s, -I

Include library path, like Perl's -I.

Note that some modules are already loaded before this option takes effect. To make sure you use the right library, you can use PERL5OPT or explicitly use perl and use its -I option.

--module-or-package-json=s

Perl module or prefixes or package to add/update (JSON-encoded).

See --module-or-package.

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

--module-or-package=s@*

Perl module or prefixes or package to add/update.

For each entry, you can specify:

a Perl module name e.g. Foo::Bar. An attempt will be made to load that module.
a module prefix ending with :: e.g. Foo::Bar::. Module::List will be used to list all modules under Foo::Bar:: recursively and load all those modules.
a package name using +Foo::Bar syntax. An attempt to load module with that name will not be made. This can be used to add an already-loaded package e.g. by another module).
a package prefix using +Foo::Bar:: or +Foo::Bar:: syntax. Subpackages will be listed recursively (using Package::Util::Lite's list_subpackages).

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

Can be specified multiple times.

--no-delete

(No description)

--require-json=s, -m

Require a Perl module, a la Perl's -m (JSON-encoded).

See --require.

--require=s@

Require a Perl module, a la Perl's -m.

Can be specified multiple times.

--use-json=s, -M

Use a Perl module, a la Perl's -M (JSON-encoded).

See --use.

--use=s@

Use a Perl module, a la Perl's -M.

Can be specified multiple times.

COMPLETION

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

bash

To activate bash completion for this script, put:

complete -C rimetadb rimetadb

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

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.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): /home/u1/.config/rimetadb.conf, /home/u1/rimetadb.conf, or /etc/rimetadb.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

You can also filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable equals some string: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [env=HOSTNAME!*=server ...] or [SOMESECTION env=HOSTNAME!*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:

[plugin=DumpArgs]
-event=before_validate_args
-prio=99

[plugin=Foo]
-event=after_validate_args
arg1=val1
arg2=val2

which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.

List of available configuration parameters:

Common for all subcommands

dsn (see --dsn)
format (see --format)
log_level (see --log-level)
naked_res (see --naked-res)
password (see --password)
user (see --user)

Configuration for subcommand argument-stats

Configuration for subcommand arguments

detail (see --detail)
function (see --function)
package (see --package)
query (see --query)
type (see --type)

Configuration for subcommand delete

function (see --function)
package (see --package)

Configuration for subcommand function-stats

Configuration for subcommand functions

detail (see --detail)
package (see --package)
query (see --query)

Configuration for subcommand meta

name (see --name)

Configuration for subcommand packages

detail (see --detail)
query (see --query)

Configuration for subcommand stats

Configuration for subcommand update

dist (see --dist)
extra (see --extra)
function (see --function)
metadata (see --metadata)
package (see --package)

Configuration for subcommand update-from-modules

delete (see --no-delete)
exclude (see --exclude)
force_update (see --force-update)
library (see --library)
module_or_package (see --module-or-package)
require (see --require)
use (see --use)

ENVIRONMENT

RIMETADB_OPT

String. Specify additional command-line options.

FILES

/home/u1/.config/rimetadb.conf

/home/u1/rimetadb.conf

/etc/rimetadb.conf

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/perlancar/perl-App-rimetadb.

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

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

cpanm

cpanm App::rimetadb

CPAN shell

perl -MCPAN -e shell
install App::rimetadb

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)

NAME

VERSION

SYNOPSIS

DESCRIPTION

SUBCOMMANDS

argument-stats

arguments

delete

function-stats

functions

meta

packages

stats

update

update-from-modules

OPTIONS

Common options

Options for subcommand arguments

Options for subcommand delete

Options for subcommand functions

Options for subcommand meta

Options for subcommand packages

Options for subcommand update

Options for subcommand update-from-modules

COMPLETION

bash

tcsh

other shells

CONFIGURATION FILE

Common for all subcommands

Configuration for subcommand argument-stats

Configuration for subcommand arguments

Configuration for subcommand delete

Configuration for subcommand function-stats

Configuration for subcommand functions

Configuration for subcommand meta

Configuration for subcommand packages

Configuration for subcommand stats

Configuration for subcommand update

Configuration for subcommand update-from-modules

ENVIRONMENT

RIMETADB_OPT

FILES

/home/u1/.config/rimetadb.conf

/home/u1/rimetadb.conf

/etc/rimetadb.conf

HOMEPAGE

SOURCE

AUTHOR

CONTRIBUTING

COPYRIGHT AND LICENSE

BUGS

Module Install Instructions