.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "DBIx::ContextualFetch 3pm"
.TH DBIx::ContextualFetch 3pm "2022-12-06" "perl v5.36.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>\fBconnect()\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
\&\fBexecute()\fR is enhanced slightly:
.PP
If called with no arguments, or with a simple list, \fBexecute()\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 \fBfetch()\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 \fBfetchrow_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 \fBfetchall_arrayref()\fR with \fBfetchrow_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.