#!perl

use 5.010001;
use strict;
use warnings;

use Perinci::CmdLine::Any;

Perinci::CmdLine::Any->new(
    url => '/App/dbinfo/',
    summary => 'Get/extract information from SQLite database',
    subcommands => {
        'list-tables'  => {url => '/App/dbinfo/list_sqlite_tables'},
        'list-columns' => {url => '/App/dbinfo/list_sqlite_columns'},
        'list-indexes' => {url => '/App/dbinfo/list_sqlite_indexes'},
        'dump-table'   => {url => '/App/dbinfo/dump_sqlite_table'},
    },
    log => 1,
    log_level => 'info',
)->run;

# ABSTRACT: Get/extract information from SQLite database
# PODNAME: dbinfo-sqlite

__END__

=pod

=encoding UTF-8

=head1 NAME

dbinfo-sqlite - Get/extract information from SQLite database

=head1 VERSION

This document describes version 0.008 of dbinfo-sqlite (from Perl distribution App-dbinfo), released on 2020-05-06.

=head1 SYNOPSIS

List SQLite tables:

 % dbinfo-sqlite list-tables mydata.db

List columns of a table:

 % dbinfo-sqlite list-columns mydata.db mytable
 % dbinfo-sqlite list-columns mydata.db mytable -l  ;# show detail

Dump a table into various format:

 % dbinfo-sqlite dump-table mydata.db mytable

=head1 DESCRIPTION

=head1 SUBCOMMANDS

=head2 B<dump-table>

Dump SQLite table into various formats.

=head2 B<list-columns>

List columns of a SQLite database table.

=head2 B<list-indexes>

List SQLite table indexes.

=head2 B<list-tables>

List tables in the SQLite database.

=head1 OPTIONS

C<*> marks required options.

=head2 Common options

=over

=item B<--config-path>=I<s>, B<-c>

Set path to configuration file.

=item B<--config-profile>=I<s>, B<-P>

Set configuration profile to use.

=item B<--dbpath>=I<s>

=item B<--debug>

Shortcut for --log-level=debug.

=item B<--format>=I<s>

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

Default value:

 undef

=item B<--help>, B<-h>, B<-?>

Display help message and exit.

=item B<--json>

Set output format to json.

=item B<--log-level>=I<s>

Set log level.

=item B<--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]


=item B<--no-config>, B<-C>

Do not use any configuration file.

=item B<--no-env>

Do not read environment for default options.

=item B<--page-result>

Filter output through a pager.

=item B<--quiet>

Shortcut for --log-level=error.

=item B<--subcommands>

List available subcommands.

=item B<--trace>

Shortcut for --log-level=trace.

=item B<--verbose>

Shortcut for --log-level=info.

=item B<--version>, B<-v>

Display program's version and exit.

=back

=head2 Options for subcommand dump-table

=over

=item B<--array>

Shortcut for --row-format=array.

See C<--row-format>.

=item B<--exclude-column>=I<s@>

Can be specified multiple times.

=item B<--exclude-columns-json>=I<s>

See C<--exclude-column>.

=item B<--include-column>=I<s@>

Can be specified multiple times.

=item B<--include-columns-json>=I<s>

See C<--include-column>.

=item B<--limit-number>=I<s>, B<-n>

=item B<--limit-offset>=I<s>, B<-o>

=item B<--row-format>=I<s>

Default value:

 "hash"

Valid values:

 ["array","hash"]

=item B<--table>=I<s>*

Table name.

=item B<--where>=I<s@>, B<-w>

Add WHERE clause.

Can be specified multiple times.

=item B<--wheres-json>=I<s>

Add WHERE clause (JSON-encoded).

See C<--where>.

=item B<-a>

Shortcut for --row-format=array.

See C<--row-format>.

=back

=head2 Options for subcommand list-columns

=over

=item B<--detail>, B<-l>

Show detailed information per record.

=item B<--table>=I<s>*

Table name.

=back

=head2 Options for subcommand list-indexes

=over

=item B<--table>=I<s>

Table name.

=back

=head1 COMPLETION

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

=head2 bash

To activate bash completion for this script, put:

 complete -C dbinfo-sqlite dbinfo-sqlite

in your bash startup (e.g. F<~/.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 L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete dbinfo-sqlite 'p/*/`dbinfo-sqlite`/'

in your tcsh startup (e.g. F<~/.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 L<shcompgen> (see above).

=head2 other shells

For fish and zsh, install L<shcompgen> as described above.

=head1 CONFIGURATION FILE

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

By default, these names are searched for configuration filenames (can be changed using C<--config-path>): F<~/.config/dbinfo-sqlite.conf>, F<~/dbinfo-sqlite.conf>, or F</etc/dbinfo-sqlite.conf>.

All found files will be read and merged.

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

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

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

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

Finally, you can filter a section by environment variable using the filter C<env=CONDITION> in section names. For example if you only want a section to be read if a certain environment variable is true: C<[env=SOMEVAR ...]> or C<[SOMESECTION env=SOMEVAR ...]>. If you only want a section to be read when the value of an environment variable has value equals something: C<[env=HOSTNAME=blink ...]> or C<[SOMESECTION env=HOSTNAME=blink ...]>. If you only want a section to be read when the value of an environment variable does not equal something: C<[env=HOSTNAME!=blink ...]> or C<[SOMESECTION env=HOSTNAME!=blink ...]>. If you only want a section to be read when an environment variable contains something: C<[env=HOSTNAME*=server ...]> or C<[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.

List of available configuration parameters:

=head2 Common for all subcommands

 dbpath (see --dbpath)
 format (see --format)
 log_level (see --log-level)
 naked_res (see --naked-res)

=head2 Configuration for subcommand dump-table

 exclude_columns (see --exclude-column)
 include_columns (see --include-column)
 limit_number (see --limit-number)
 limit_offset (see --limit-offset)
 row_format (see --row-format)
 table (see --table)
 wheres (see --where)

=head2 Configuration for subcommand list-columns

 detail (see --detail)
 table (see --table)

=head2 Configuration for subcommand list-indexes

 table (see --table)

=head2 Configuration for subcommand list-tables

=head1 ENVIRONMENT

=head2 DBINFO_SQLITE_OPT => str

Specify additional command-line options.

=head1 FILES

F<~/.config/dbinfo-sqlite.conf>

F<~/dbinfo-sqlite.conf>

F</etc/dbinfo-sqlite.conf>

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/App-dbinfo>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-App-dbinfo>.

=head1 BUGS

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

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.

=head1 SEE ALSO

L<dbinfo-sqlite>, ...

L<mysqlinfo> from L<App::mysqlinfo>

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2020, 2019, 2018, 2017 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.

=cut