File Coverage

blib/lib/Module/Build/DBD/SQLite.pm

Criterion	Covered	Total	%
statement	24	24	100.0
branch			n/a
condition			n/a
subroutine	11	11	100.0
pod	9	9	100.0
total	44	44	100.0

package Module::Build::DBD::SQLite;

use strict;
use warnings;
our $VERSION = '0.10';

sub get_client { 'sqlite3' }

sub get_db_and_command {
    my ($class, $client, $params) = @_;

    my @cmd = (
        $client,
        '-noheader',
        '-bail',
        '-column',
    );
    return $params->{dbname}, \@cmd
}

sub get_db_option {
    my ($class, $db) = @_;
    return $db;
}

sub get_create_db_command {
    my ($class, $cmd, $db) = @_;
    return ($^X, '-e', 42); # Do nothing.
}

sub get_drop_db_command {
    my ($class, $cmd, $db) = @_;
    return ( $^X, '-e', 'unlink shift', $db);
}

sub get_check_db_command {
    my ($class, $cmd, $db) = @_;
    return ($^X, '-l', '-e', "print 1 if -e shift", $db);
}

sub get_execute_command {
    my ($class, $cmd, $db, $sql) = @_;
    return (
        @$cmd,
        $class->get_db_option($db),
        $sql,
    );
}

sub get_file_command {
    my ($class, $cmd, $db, $fn) = @_;
    return (
        @$cmd,
        $class->get_db_option($db),
        ".read $fn"
    );
}

sub get_meta_table_sql {
    my ($class, $table) = @_;
    return qq{
        CREATE TABLE $table (
            label TEXT PRIMARY KEY,
            value INT  NOT NULL DEFAULT 0,
            note  TEXT NOT NULL
        );
    };
}

1;

=head1 Name

Module::Build::DBD:SQLite - SQLite specifics for Module::Build::DB

=head1 Description

This module contains a number of class methods called by L
to handle SQLite specific tasks when detecting, building, and updating a
database.

=head2 Methods

All methods are class methods.

=head3 C

  my $client = Module::Build::DBD::SQLite->get_client;

Returns the name of the client to use to connect to SQLite. For now,
that's just C, which is fine if it's in your path. Some code to search
for a client might be added in the future. Either way, it's best to specify
use the C<--db_client> option to avoid all ambiguity.

=head3 C

  my ($db_name, $cmd) = Module::Build::DBD::SQLite->get_db_and_command($client, $params);

Returns a database name culled from C<$params> and an array reference with
C<$client> and all required options for all access to the database. C<$params>
contains both the contents of the context configuration file's DBI section and
the attributes defined in the driver DSN (e.g., C in
C).

=head3 C

  my @opts = Module::Build::DBD::SQLite->get_db_option($db_name);

Returns a list of options to be appended to the command returned by
C to connect to a specific database. For SQLite, that's
simply C<$dbname>.

=head3 C

  my @command = Module::Build::DBD::SQLite->get_create_db_command($cmd, $db);

Returns a command list suitable for passing to C that will create a
new database. C<$cmd> is the command returned by C and
C<$db> is the name of the database to be created.

=head3 C

  my @command = Module::Build::DBD::SQLite->get_drop_db_command($cmd, $db);

Returns a command list suitable for passing to C that will drop an
existing database. C<$cmd> is the command returned by C
and C<$db> is the name of the database to be dropped.

=head3 C

  my @command = Module::Build::DBD::SQLite->get_check_db_command($cmd, $db);

Returns a command list suitable for passing to C that will, when
executed, output a 1 when C<$db> exists and nothing when C<$db> does not
exist. C<$cmd> is the command returned by C and C<$db>
is the name of the database to be checked.

=head3 C

  my @command = Module::Build::DBD::SQLite->get_execute_command($cmd, $db, $sql);

Returns a command list suitable for passing to C that will execute
the SQL in C<$sql> and return its output, if any. C<$cmd> is the command
returned by C, C<$db> is the name of the database to be
connect to for the query, and C<$sql> is the SQL command or commands to be
executed.

=head3 C

  my @command = Module::Build::DBD::SQLite->get_file_command($cmd, $db, $sql);

Returns a command list suitable for passing to C that will execute
the SQL in C<$file> and return its output, if any. C<$cmd> is the command
returned by C, C<$db> is the name of the database to be
connect to for the query, and C<$file> is a file with SQL commands.

=head3 C

  my $sql = Module::Build::DBD::SQLite->get_meta_table_sql($table_name);

Returns an SQL string that creates a metadata table named C<$table_name>.

=head1 Author

David E. Wheeler

=head1 Copyright

Copyright (c) 2008-2010 David E. Wheeler. Some Rights Reserved.

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


=cut