The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
App-UpdateRinciMetadataDb-0.09
/ update-rinci-metadata-db

NAME

update-rinci-metadata-db - Create/update Rinci API metadata database

VERSION

This document describes version 0.09 of update-rinci-metadata-db (from Perl distribution App-UpdateRinciMetadataDb), released on 2014-12-27.

SYNOPSIS

Usage:

 % update-rinci-metadata-db [options] <dsn> <module_or_package> ...

OPTIONS

* marks required options.

--config-path=s

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--dsn=s*

DBI connection DSN.

Note: has been tested with MySQL and SQLite only.

--exclude-json=s

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

See --exclude.

--exclude=s@

Perl package names or prefixes to exclude.

Can be specified multiple times.

--force-update, --force

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

--format=s

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

--help, -h, -?

Display this help message.

--json

Set output format to json.

--library-json=s, -I

Include library path, like Perl's -I (JSON-encoded).

See --library.

--library=s

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.

--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 `::` or `::*` 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::MoreUtil`'s `list_subpackages`).

Can be specified multiple times.

--naked-res

When outputing as JSON, strip result envelope.

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

Do not use any configuration file.

--no-delete
--password=s

DBI connection password.

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

--user=s

DBI connection user.

--version, -v

FILES

/etc/update-rinci-metadata-db.conf

~/update-rinci-metadata-db.conf

COMPLETION

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

bash

To activate bash completion for this script, put:

 complete -C update-rinci-metadata-db update-rinci-metadata-db

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 shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immadiately have tab completion.

tcsh

To activate tcsh completion for this script, put:

 complete update-rinci-metadata-db 'p/*/`update-rinci-metadata-db`/'

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

SOURCE

Source repository is at https://github.com/sharyanto/perl-App-UpdateRinciMetadataDb.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-UpdateRinciMetadataDb

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