/ 
App-UpdateRinciMetadataDb-0.06
/ App::UpdateRinciMetadataDb

NAME

App::UpdateRinciMetadataDb - Create/update Rinci metadata database

VERSION

This document describes version 0.06 of App::UpdateRinciMetadataDb (from Perl distribution App-UpdateRinciMetadataDb), released on 2014-08-16.

FUNCTIONS

update_rinci_metadata_db(%args) -> [status, msg, result, meta]

Create/update Spanel API metadata database.

This function supports dry-run operation.

Arguments ('*' denotes required arguments):

  • delete => bool (default: 1)

    Whether to delete packages from DB if no longer mentioned as arguments or found in filesystem.

  • dsn* => str

    DBI connection DSN.

    Note: has been tested with MySQL and SQLite only.

  • exclude => array

    Perl package names or prefixes to exclude.

  • force_update => bool

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

  • library => any

    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* => array

    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 SHARYANTO::Package::Util's list_subpackages).

  • password => str

    DBI connection password.

  • require => array

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

  • use => array

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

  • user => str

    DBI connection user.

Special arguments:

  • -dry_run => bool

    Pass -dry_run=>1 to enable simulation mode.

Return value:

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

(any)

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

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Steven Haryanto.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.