/ 
App-SQLiteUtils-0.003
River stage one • 1 direct dependent • 1 total dependent
/ App::SQLiteUtils

NAME

App::SQLiteUtils - Utilities related to SQLite

VERSION

This document describes version 0.003 of App::SQLiteUtils (from Perl distribution App-SQLiteUtils), released on 2021-09-12.

DESCRIPTION

This distribution includes several utilities:

FUNCTIONS

import_csv_to_sqlite

Usage:

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

Import a CSV file into SQLite database.

This tool utilizes the sqlite3 command-line client to import a CSV file into SQLite database. It pipes the following commands to the sqlite3 CLI:

.mode csv
.import FILENAME TABLENAME

where FILENAME is the CSV filename and TABLENAME is the table name. If the table option is not specified, the table name will be derived from the CSV filename (e.g. 'stdin' for '-', 't1' for '/path/to/t1.csv', 'table2' for './2.csv' and so on).

This function is not exported.

Arguments ('*' denotes required arguments):

  • csv_file => filename (default: "-")

  • db_file* => filename

  • table => str

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)

list_sqlite_columns

Usage:

list_sqlite_columns(%args) -> any

See also the .schema and .fullschema meta-command of the sqlite3 CLI.

This function is not exported.

Arguments ('*' denotes required arguments):

  • db_file* => filename

  • table* => str

Return value: (any)

list_sqlite_tables

Usage:

list_sqlite_tables(%args) -> any

See also the .tables meta-command of the sqlite3 CLI.

This function is not exported.

Arguments ('*' denotes required arguments):

  • db_file* => filename

Return value: (any)

HOMEPAGE

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

SOURCE

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

SEE ALSO

App::DBIUtils

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, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2021 by perlancar <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.

BUGS

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

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.