File Coverage

blib/lib/Eidolon/Driver/DB.pm

Criterion	Covered	Total	%
statement	15	68	22.0
branch	0	24	0.0
condition	0	6	0.0
subroutine	5	15	33.3
pod	7	7	100.0
total	27	120	22.5

package Eidolon::Driver::DB;
# ==============================================================================
#
#   Eidolon
#   Copyright (c) 2009, Atma 7
#   ---
#   Eidolon/Driver/DB.pm - generic database driver
#
# ==============================================================================

use base qw/Eidolon::Driver/;
use Eidolon::Driver::DB::Exceptions;
use DBI;
use warnings;
use strict;

our $VERSION = "0.02"; # 2009-05-14 05:18:37

# ------------------------------------------------------------------------------
# \% new($dbd, $db, $user, $password, $host, $port, $cfg)
# constructor
# ------------------------------------------------------------------------------
sub new
{
    my ($class, $dbd, $db, $user, $password, $host, $port, $cfg, $self);

    ($class, $dbd, $db, $user, $password, $host, $port, $cfg) = @_;

    # class attributes
    $self =
    {
        # connection settings
        "dbd"         => $dbd,
        "database"    => $db,
        "user"        => $user,
        "password"    => $password,
        "host"        => $host,
        "port"        => $port,

        # other settings
        "auto_fetch"  => $cfg && exists $cfg->{"auto_fetch"}  ? $cfg->{"auto_fetch"}  : 0,
        "auto_commit" => $cfg && exists $cfg->{"auto_commit"} ? $cfg->{"auto_commit"} : 1,

        # handles
        "dbh"         => undef,
        "sth"         => undef,

        # data
        "query"       => undef,
        "query_count" => 0,
        "rows"        => 0,
        "dataset"     => []
    };

    bless $self, $class;
    $self->_init();

    return $self;
}

# ------------------------------------------------------------------------------
# _init()
# class initialization
# ------------------------------------------------------------------------------
sub _init
{
    my $self = shift;

    eval
    {
        $self->{"dbh"} = DBI->connect
        (
            "DBI:$self->{'dbd'}:database=$self->{'database'};host=$self->{'host'};port=$self->{'port'}",

            $self->{"user"},
            $self->{"password"},

            {
                "RaiseError"      => 1,
                "PrintError"      => 0,
                "PrintWarn"       => 0,
                "InactiveDestroy" => 1,
                "AutoCommit"      => $self->{"auto_commit"}
            }
        );
    };

    throw DriverError::DB::Connect($@) if ($@);
}

# ------------------------------------------------------------------------------
# \@ execute($query, @params)
# query execution
# ------------------------------------------------------------------------------
sub execute
{
    my ($self, $query, @params, $row);

    ($self, $query, @params) = @_;

    eval
    {
        $self->free;

        $self->{"query"} = $query;
        $self->{"query_count"}++;

        $self->{"sth"}  = $self->{"dbh"}->prepare($query);
        $self->{"rows"} = $self->{"sth"}->execute(@params);
    };

    throw DriverError::DB::SQL($query) if ($@);

    if ($self->{"auto_fetch"})
    {
        $self->_fetch_all;
        return $self->{"dataset"};
    }
}

# ------------------------------------------------------------------------------
# \@ execute_prepared(@params)
# execute prepared query
# ------------------------------------------------------------------------------
sub execute_prepared
{
    my ($self, @params, $row);

    ($self, @params) = @_;

    eval
    {
        $self->free;

        $self->{"query_count"}++;
        $self->{"rows"} = $self->{"sth"}->execute(@params);
    };

    throw DriverError::DB::SQL($self->{"query"}) if ($@);

    if ($self->{"auto_fetch"})
    {
        $self->_fetch_all;
        return $self->{"dataset"};
    }
}

# ------------------------------------------------------------------------------
# fetch()
# fetch result
# ------------------------------------------------------------------------------
sub fetch
{
    my ($self, $row);

    $self = shift;

    throw DriverError::DB::AlreadyFetched if ($self->{"auto_fetch"});
    $row  = $self->{"sth"}->fetchrow_hashref;

    return $row;
}

# ------------------------------------------------------------------------------
# _fetch_all()
# private version of fetch all results
# ------------------------------------------------------------------------------
sub _fetch_all
{
    my ($self, $row);

    $self = shift;

    while ($row = $self->{"sth"}->fetchrow_hashref)
    {
        push @{ $self->{"dataset"} }, $row;
    }
}

# ------------------------------------------------------------------------------
# fetch_all()
# fetch all results
# ------------------------------------------------------------------------------
sub fetch_all
{
    my $self = shift;

    throw DriverError::DB::AlreadyFetched if ($self->{"auto_fetch"});
    $self->_fetch_all;

    return $self->{"dataset"};
}

# ------------------------------------------------------------------------------
# free()
# free memory
# ------------------------------------------------------------------------------
sub free
{
    my $self = shift;

    $self->{"sth"}->finish  if ($self->{"sth"});

    if ($self->{"dataset"})
    {
        undef $self->{"dataset"};
        $self->{"dataset"} = [];
    }
}

# ------------------------------------------------------------------------------
# \@ call($function, @params)
# stored function/procedure call
# ------------------------------------------------------------------------------
sub call
{
    throw CoreError::AbstractMethod;
}

# ------------------------------------------------------------------------------
# DESTROY()
# destructor
# ------------------------------------------------------------------------------
sub DESTROY
{
    $_[0]->{"dbh"}->disconnect if ($_[0]->{"dbh"});
}

1;

__END__