DBIx::QueryByName::FromXML - Import named queries from an xml text


DBIx-QueryByName documentation Contained in the DBIx-QueryByName distribution.

Index


Code Index:

NAME

Top

DBIx::QueryByName::FromXML - Import named queries from an xml text

DESCRIPTION

Top

DBIx::QueryByName::FromXML is a backend for the load() method from DBIx::QueryByName and is in charge of loading named queries from an xml file/string that describes each query.

DO NOT USE DIRECTLY!

XML SYNTAX

Top

See DBIx::QueryByName.

INTERFACE

Top

load($querypool,$sessionname,$xmlstring);

Fill this $querypool with all the queries described in $xmlstring. Those queries will only run over database connections opened with the credential associated with $sessionname.


DBIx-QueryByName documentation Contained in the DBIx-QueryByName distribution.

package DBIx::QueryByName::FromXML;
use utf8;
use strict;
use warnings;
use XML::Parser;
use XML::SimpleObject;
use Data::Dumper;
use DBIx::QueryByName::Logger qw(get_logger);

my $PARSER = XML::Parser->new( ErrorContext => 2, Style => 'Tree' );

sub load {
    my $qpool   = shift;
    my $session = shift;
    my $xml     = shift;
    my $log     = get_logger();

    $log->logcroak("undefined query pool")  if (!defined $qpool);
    $log->logcroak("undefined session")     if (!defined $session);
    $log->logcroak("undefined xml string")    if (!defined $xml);

    my @queries;
    eval {
        @queries = XML::SimpleObject->new( $PARSER->parse($xml) )->child('queries')->children('query');
    };

    $log->logcroak("failed to parse xml: $@")
        if (defined $@ && $@ ne '');

    $log->logcroak("invalid xml: no <query> nodes (session_name => $session)")
        if (scalar @queries == 1 and ref $queries[0] ne 'XML::SimpleObject');

    foreach my $query ( @queries ) {

        my $name = $query->attribute('name');
        $log->logcroak("invalid xml: no name attribute in query node (session_name => $session)")
            if (!defined $name);

        my $params = $query->attribute('params');
        $log->logcroak("invalid xml: no params attribute in query node (query_name => $name, session_name => $session)")
            if (!defined $params);

        my @params = map { $_ =~ s/^\s*//; $_ =~ s/\s*$//; $_ } split(q{,}, $params);
#        my @params = split(q{,}, $params);

        my $result = $query->attribute('result') || 'sth';

        # The retry attribute controls how to handle network problems.
        # We will always attempt to reconnect to the database if we lose connection.
        # The "retry" attribute controls if we should attempt to execute the query again,
        # if we have reasons to believe it was not executed when we last tried,
        # such as a interrupted network call.
        #
        # safe   : execute again if there is no risk it has already been executed.
        # never  : do not execute again
        # always : execute again, even if it might already have been executed
        my $retry = $query->attribute('retry') || 'safe';
        if ($retry !~ m/^(safe|never|always)$/) {
            $log->logcroak("invalid value of retry attribute: $retry");
        }

        if ( $qpool->knows_query($name) ) {
            # query is already imported, possibly from other XML file
            $log->logcroak("query already imported (query_name => $name, session_name => $session)");
        }

        # TODO: we might want to perform minimum sanity check on query string
        $qpool->add_query(
            name    => $name,
            sql     => $query->value,
            session => $session,
            result  => $result,
            params  => \@params,
            retry   => $retry
        );
    }
}

1;

__END__