.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "DBIx::ContextualFetch 3pm"
.TH DBIx::ContextualFetch 3pm "2005-09-27" "perl v5.10.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
DBIx::ContextualFetch \- Add contextual fetches to DBI
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        my $dbh = DBI\->connect(...., { RootClass => "DBIx::ContextualFetch" });
\&
\&        # Modified statement handle methods.
\&        my $rv = $sth\->execute;
\&        my $rv = $sth\->execute(@bind_values);
\&        my $rv = $sth\->execute(\e@bind_values, \e@bind_cols);
\&
\&        # In addition to the normal DBI sth methods...
\&        my $row_ref = $sth\->fetch;
\&        my @row     = $sth\->fetch;
\&
\&        my $row_ref = $sth\->fetch_hash;
\&        my %row     = $sth\->fetch_hash;
\&
\&        my $rows_ref = $sth\->fetchall;
\&        my @rows     = $sth\->fetchall;
\&
\&        my $rows_ref = $sth\->fetchall_hash;
\&        my @tbl      = $sth\->fetchall_hash;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
It always struck me odd that \s-1DBI\s0 didn't take much advantage of Perl's
context sensitivity. DBIx::ContextualFetch redefines some of the various
fetch methods to fix this oversight. It also adds a few new methods for
convenience (though not necessarily efficiency).
.SH "SET-UP"
.IX Header "SET-UP"
.Vb 2
\&        my $dbh = DBIx::ContextualFetch\->connect(@info);
\&        my $dbh = DBI\->connect(@info, { RootClass => "DBIx::ContextualFetch" });
.Ve
.PP
To use this method, you can either make sure that everywhere you normall
call \s-1DBI\-\s0>\fIconnect()\fR you either call it on DBIx::ContextualFetch, or that
you pass this as your RootClass. After this \s-1DBI\s0 will Do The Right Thing
and pass all its calls through us.
.SH "EXTENSIONS"
.IX Header "EXTENSIONS"
.SS "execute"
.IX Subsection "execute"
.Vb 3
\&        $rv = $sth\->execute;
\&        $rv = $sth\->execute(@bind_values);
\&        $rv = $sth\->execute(\e@bind_values, \e@bind_cols);
.Ve
.PP
\&\fIexecute()\fR is enhanced slightly:
.PP
If called with no arguments, or with a simple list, \fIexecute()\fR operates
normally.  When when called with two array references, it performs
the functions of bind_param, execute and bind_columns similar to the
following:
.PP
.Vb 2
\&        $sth\->execute(@bind_values);
\&        $sth\->bind_columns(undef, @bind_cols);
.Ve
.PP
In addition, execute will accept tainted \f(CW@bind_values\fR.  I can't think of
what a malicious user could do with a tainted bind value (in the general
case. Your application may vary.)
.PP
Thus a typical idiom would be:
.PP
.Vb 1
\&        $sth\->execute([$this, $that], [\e($foo, $bar)]);
.Ve
.PP
Of course, this method provides no way of passing bind attributes
through to bind_param or bind_columns. If that is necessary, then you
must perform the bind_param, execute, bind_col sequence yourself.
.SS "fetch"
.IX Subsection "fetch"
.Vb 2
\&        $row_ref = $sth\->fetch;
\&        @row     = $sth\->fetch;
.Ve
.PP
A context sensitive version of \fIfetch()\fR. When in scalar context, it will
act as fetchrow_arrayref. In list context it will use fetchrow_array.
.SS "fetch_hash"
.IX Subsection "fetch_hash"
.Vb 2
\&        $row_ref = $sth\->fetch_hash;
\&        %row     = $sth\->fetch_hash;
.Ve
.PP
A modification on fetchrow_hashref. When in scalar context, it acts just
as \fIfetchrow_hashref()\fR does. In list context it returns the complete hash.
.SS "fetchall"
.IX Subsection "fetchall"
.Vb 2
\&        $rows_ref = $sth\->fetchall;
\&        @rows     = $sth\->fetchall;
.Ve
.PP
A modification on fetchall_arrayref. In scalar context it acts as
fetchall_arrayref. In list it returns an array of references to rows
fetched.
.SS "fetchall_hash"
.IX Subsection "fetchall_hash"
.Vb 2
\&        $rows_ref = $sth\->fetchall_hash;
\&        @rows     = $sth\->fetchall_hash;
.Ve
.PP
A mating of \fIfetchall_arrayref()\fR with \fIfetchrow_hashref()\fR. It gets all rows
from the hash, each as hash references. In scalar context it returns
a reference to an array of hash references. In list context it returns
a list of hash references.
.SH "ORIGINAL AUTHOR"
.IX Header "ORIGINAL AUTHOR"
Michael G Schwern as part of Ima::DBI
.SH "CURRENT MAINTAINER"
.IX Header "CURRENT MAINTAINER"
Tony Bowden <tony@tmtm.com>
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1DBI\s0. Ima::DBI. Class::DBI.