The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
CORION / DBIx-RunSQL-0.17 / README.mkdn

Build Status

NAME

DBIx::RunSQL - run SQL from a file

SYNOPSIS

#!/usr/bin/perl -w
use strict;
use DBIx::RunSQL;

my $test_dbh = DBIx::RunSQL->create(
    dsn     => 'dbi:SQLite:dbname=:memory:',
    sql     => 'sql/create.sql',
    force   => 1,
    verbose => 1,
);

... # run your tests with a DB setup fresh from setup.sql

METHODS

DBIx::RunSQL->create ARGS

DBIx::RunSQL->run ARGS

Runs the SQL commands and returns the database handle. In list context, it returns the database handle and the suggested exit code.

DBIx::RunSQL->run_sql_file ARGS

my $dbh = DBI->connect(...)

for my $file (sort glob '*.sql') {
    DBIx::RunSQL->run_sql_file(
        verbose => 1,
        dbh     => $dbh,
        sql     => $file,
    );
};

Runs an SQL file on a prepared database handle. Returns the number of errors encountered.

If the statement returns rows, these are printed separated with tabs.

DBIx::RunSQL->run_sql ARGS

my $dbh = DBI->connect(...)

DBIx::RunSQL->run_sql(
    verbose => 1,
    dbh     => $dbh,
    sql     => \@sql_statements,
);

Runs an SQL string on a prepared database handle. Returns the number of errors encountered.

If the statement returns rows, these are printed separated with tabs, but see the output_bool and output_string options.

DBIx::RunSQL->format_results %options

my $sth= $dbh->prepare( 'select * from foo' );
$sth->execute();
print DBIx::RunSQL->format_results( sth => $sth );

Executes $sth->fetchall_arrayref and returns the results either as tab separated string or formatted using Text::Table if the module is available.

If you find yourself using this often to create reports, you may really want to look at Querylet instead.

Note that the query results are returned as one large string, so you really do not want to run this for large(r) result sets.

DBIx::RunSQL->split_sql ARGS

my @statements= DBIx::RunSQL->split_sql( <<'SQL');
    create table foo (name varchar(64));
    create trigger foo_insert on foo before insert;
        new.name= 'foo-'||old.name;
    end;
    insert into foo name values ('bar');
SQL
# Returns three elements

This is a helper subroutine to split a sequence of (semicolon-newline-delimited) SQL statements into separate statements. It is documented because it is not a very smart subroutine and you might want to override or replace it. It might also be useful outside the context of DBIx::RunSQL if you need to split up a large blob of SQL statements into smaller pieces.

The subroutine needs the whole sequence of SQL statements in memory. If you are attempting to restore a large SQL dump backup into your database, this approach might not be suitable.

DBIx::RunSQL->parse_command_line

my $options = DBIx::RunSQL->parse_command_line( 'my_application', \@ARGV );

Helper function to turn a command line array into options for DBIx::RunSQL invocations. The array of command line items is modified in-place.

If the reference to the array of command line items is missing, @ARGV will be modified instead.

DBIx::RunSQL->handle_command_line

DBIx::RunSQL->handle_command_line( 'my_application', \@ARGV );

Helper function to run the module functionality from the command line. See below how to use this function in a good self-contained script. This function passes the following command line arguments and options to ->create:

--user
--password
--dsn
--sql
--quiet
--format
--force
--verbose
--bool
--string

In addition, it handles the following switches through Pod::Usage:

--help
--man

If no dsn is given, this function will use dbi:SQLite:dbname=db/$appname.sqlite as the default database.

See also the section PROGRAMMER USAGE for a sample program to set up a database from an SQL file.

PROGRAMMER USAGE

This module abstracts away the "run these SQL statements to set up your database" into a module. In some situations you want to give the setup SQL to a database admin, but in other situations, for example testing, you want to run the SQL statements against an in-memory database. This module abstracts away the reading of SQL from a file and allows for various command line parameters to be passed in. A skeleton create-db.sql looks like this:

#!/usr/bin/perl -w
use strict;
use DBIx::RunSQL;

my $exitcode = DBIx::RunSQL->handle_command_line('myapp', \@ARGV);
exit $exitcode;

=head1 NAME

create-db.pl - Create the database

=head1 SYNOPSIS

  create-db.pl "select * from mytable where 1=0"

=head1 ABSTRACT

This sets up the database. The following
options are recognized:

=head1 OPTIONS

=over 4

=item C<--user> USERNAME

=item C<--password> PASSWORD

=item C<--dsn> DSN

The DBI DSN to use for connecting to
the database

=item C<--sql> SQLFILE

The alternative SQL file to use
instead of C<sql/create.sql>.

=item C<--quiet>

Output no headers for empty SELECT resultsets

=item C<--bool>

Set the exit code to 1 if at least one result row was found

=item C<--string>

Output the (single) column that the query returns as a string without
any headers

=item C<--format> formatter

Use a different formatter for table output. Supported formatters are

  tab - output results as tab delimited columns

  Text::Table - output results as ASCII table

=item C<--force>

Don't stop on errors

=item C<--help>

Show this message.

=back

=cut

NOTES

COMMENT FILTERING

The module tries to keep the SQL as much verbatim as possible. It filters all lines that end in semicolons but contain only SQL comments. All other comments are passed through to the database with the next statement.

TRIGGER HANDLING

This module uses a very simplicistic approach to recognize triggers. Triggers are problematic because they consist of multiple SQL statements and this module does not implement a full SQL parser. An trigger is recognized by the following sequence of lines

CREATE TRIGGER
    ...
END;

If your SQL dialect uses a different syntax, it might still work to put the whole trigger on a single line in the input file.

OTHER APPROACHES

If you find yourself wanting to write SELECT statements, consider looking at Querylet instead, which is geared towards that and even has an interface for Excel or HTML output.

If you find yourself wanting to write parametrized queries as .sql files, consider looking at Data::Phrasebook::SQL or potentially DBIx::SQLHandler.

SEE ALSO

ORLite::Migrate

REPOSITORY

The public repository of this module is http://github.com/Corion/DBIx--RunSQL.

SUPPORT

The public support forum of this module is http://perlmonks.org/.

BUG TRACKER

Please report bugs in this module via the RT CPAN bug queue at https://rt.cpan.org/Public/Dist/Display.html?Name=DBIx-RunSQL or via mail to bug-dbix-runsql@rt.cpan.org.

AUTHOR

Max Maischein corion@cpan.org

COPYRIGHT (c)

Copyright 2009-2018 by Max Maischein corion@cpan.org.

LICENSE

This module is released under the same terms as Perl itself.