/ 
App-SQLiteUtils-0.006
River stage one • 1 direct dependent • 1 total dependent
/ import-csv-to-sqlite

NAME

import-csv-to-sqlite - Import a CSV file into SQLite database

VERSION

This document describes version 0.006 of import-csv-to-sqlite (from Perl distribution App-SQLiteUtils), released on 2023-02-24.

SYNOPSIS

import-csv-to-sqlite --help (or -h, -?)

import-csv-to-sqlite --version (or -v)

import-csv-to-sqlite [--debug|--log-level=level|--quiet|--trace|--verbose] [--format=name|--json] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] [--table=str] -- [csv_file] <db_file>

DESCRIPTION

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 CSVNAME TABLENAME

where CSVNAME is the CSV filename and TABLENAME is the table name.

If CSV filename is not specified, will be assumed to be - (stdin).

If table name is not specified, it will be derived from the CSV filename (basename) with extension removed. - will become stdin. All non-alphanumeric characters will be replaced with _ (underscore). If filename starts with number, t prefix will be added. If table already exists, a suffix of _2, _3, and so on will be added. Some examples:

CSV filename          Table name         Note
------------          ----------         ----
-                     stdin
-                     stdin_2            If 'stdin' already exists
/path/to/t1.csv       t1
/path/to/t1.csv       t1_2               If 't1' already exists
/path/to/t1.csv       t1_3               If 't1' and 't1_2' already exist
./2.csv               t2
report 2021.csv       report_2021
report 2021.rev1.csv  report_2021

Note that the sqlite3 CLI client can be used non-interactively as well. You can pipe the commands to its stdin, e.g.:

% echo -e ".mode csv\n.import /PATH/TO/FILE.CSV TABLENAME" | sqlite3 DB_FILE

But this utility gives you convenience of picking a table name automatically.

OPTIONS

* marks required options.

Main options

--csv-file=s

Default value:

"-"

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

--db-file=s*

(No description)

Can also be specified as the 2nd command-line argument.

--table=s

(No description)

Logging options

--debug

Shortcut for --log-level=debug.

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

--quiet

Shortcut for --log-level=error.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

Output options

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

--json

Set output format to json.

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

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

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

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

bash

To activate bash completion for this script, put:

complete -C import-csv-to-sqlite import-csv-to-sqlite

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 import-csv-to-sqlite 'p/*/`import-csv-to-sqlite`/'

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

SOURCE

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

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 software is copyright (c) 2023, 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.