ch12_03.htm

by Randal L. Schwartz and Tom Phoenix ISBN 0-596-00132-0 Third Edition, published July 2001. (See

<a name="INDEX-1775" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>err</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">handle</em>-&gt;err
</pre><p><a name="INDEX-1775" />Returns the error code from the last
driver function called.
</p></div>

<a name="INDEX-1776" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>errstr</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">handle</em>-&gt;errstr
</pre><p><a name="INDEX-1776" />Returns the error message from the last
driver function called.
</p></div>

<a name="INDEX-1777" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>execute</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">result</em> = $<em class="replaceable">st_handle</em>-&gt;execute([@<em class="replaceable">bind_values</em>])
</pre><p><a name="INDEX-1777" />Executes a prepared statement.
</p><dl>
<dt><b><tt class="literal">@</tt><em class="replaceable">bind_values</em></b></dt>
<dd>
Binds values for placeholder substitution</p>
</dd>

</dl></div>

<a name="INDEX-1778" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>fetch</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">arrayref</em> = $<em class="replaceable">st_handle</em>-&gt;fetch
</pre><p><a name="INDEX-1778" />Fetches the next row of data, returning an
array reference with the field values.
</p></div>

<a name="INDEX-1779" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>fetchall_arrayref</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">arrayref</em> = $<em class="replaceable">st_handle</em>-&gt;fetchall_arrayref
</pre><p><a name="INDEX-1779" />Fetches all data from a prepared statement
and returns a reference to an array of references.
</p></div>

<a name="INDEX-1780" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>fetchrow_array</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">array</em> = $<em class="replaceable">st_handle</em>-&gt;fetchrow_array
</pre><p><a name="INDEX-1780" />Fetches the next row of data, returning an
array with the field values.
</p></div>

<a name="INDEX-1781" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>fetchrow_arrayref</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
<em class="replaceable">$arrayref</em> = <em class="replaceable">$st_handle</em>-&gt;fetchrow_arrayref
</pre><p><a name="INDEX-1781" />Fetches the next row of data, returning an
array reference with the field values. Synonym for
<tt class="literal">fetch</tt>.
</p></div>

<a name="INDEX-1782" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>fetchrow_hashref</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">hashref</em> = $<em class="replaceable">st_handle</em>-&gt;fetchrow_hashref
</pre><p><a name="INDEX-1782" />Fetches the next row of data, returning a
hash reference containing the field values. The keys of the hash are
the same as <tt class="literal">$st_handle-&gt;{NAME}</tt>.
</p></div>

<a name="INDEX-1783" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>finish</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">result</em> = $<em class="replaceable">st_handle</em>-&gt;finish
</pre><p><a name="INDEX-1783" />Disables further fetching from a
statement.
</p></div>

<a name="INDEX-1784" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>func</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">handle</em>-&gt;func(@<em class="replaceable">arguments</em>, <em class="replaceable">function</em>)
</pre><p><a name="INDEX-1784" />Calls a private nonportable method on the
specific handle.
</p><dl>
<dt><b><tt class="literal">@</tt><em class="replaceable">arguments</em></b></dt>
<dd>
The arguments to the function.</p>
</dd>


<dt><i><em class="replaceable"><tt>function</tt></em></i></dt>
<dd>
The function name. Note that the function name is specified last.</p>
</dd>

</dl></div>

<a name="INDEX-1785" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>neat</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">newstring</em> = DBI::neat(<em class="replaceable">string</em>, <em class="replaceable">maxlength</em>)
</pre><p><a name="INDEX-1785" />Converts a string to one with quoted
strings, null values shown as <tt class="literal">undef</tt>, and
unprintable characters shown as
".".
</p><dl>
<dt><i><em class="replaceable"><tt>string</tt></em></i></dt>
<dd>
The string to convert</p>
</dd>


<dt><i><em class="replaceable"><tt>maxlength</tt></em></i></dt>
<dd>
The length at which to truncate the string with
"..."
</p>
</dd>

</dl></div>

<a name="INDEX-1786" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>neat_list</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">newstring</em> = DBI::neat_list(\@<em class="replaceable">list</em>, <em class="replaceable">maxlength</em>, <em class="replaceable">delim</em>)
</pre><p><a name="INDEX-1786" />Converts each element of a list with
<tt class="literal">DBI::neat</tt> and returns it as a string.
</p><dl>
<dt><b><tt class="literal">\@</tt><em class="replaceable">list</em></b></dt>
<dd>
A reference to the list to convert.</p>
</dd>


<dt><i><em class="replaceable"><tt>maxlength</tt></em></i></dt>
<dd>
The length at which to truncate the string with
"...".
</p>
</dd>


<dt><i><em class="replaceable"><tt>delim</tt></em></i></dt>
<dd>
The delimiter to use between list elements in the new string. Default
is <tt class="literal">,</tt> .
</p>
</dd>

</dl></div>

<a name="INDEX-1787" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>ping</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">result</em> = $<em class="replaceable">db_handle</em>-&gt;ping
</pre><p><a name="INDEX-1787" />Determines if the database is still
connected.
</p></div>

<a name="INDEX-1788" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>prepare</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">st_handle</em> = $<em class="replaceable">db_handle</em>-&gt;prepare(<em class="replaceable">statement</em> [, \%<em class="replaceable">attr</em> ])
</pre><p><a name="INDEX-1788" />Prepares a statement for execution and
returns a reference to a statement handle object.
</p><dl>
<dt><i><em class="replaceable"><tt>statement</tt></em></i></dt>
<dd>
The statement to prepare</p>
</dd>


<dt><b><tt class="literal">\%</tt><em class="replaceable">attr</em></b></dt>
<dd>
Attributes to set for the assigned statement handle</p>
</dd>

</dl></div>

<a name="INDEX-1789" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>quote</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">sql</em> = $<em class="replaceable">db_handle</em>-&gt;quote(<em class="replaceable">string</em>)
</pre><p><a name="INDEX-1789" />Escapes special characters in a string for
use in a SQL statement.
</p><dl>
<dt><i><em class="replaceable"><tt>string</tt></em></i></dt>
<dd>
The string to convert</p>
</dd>

</dl></div>

<a name="INDEX-1790" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>rollback</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">result</em> = $<em class="replaceable">db_handle</em>-&gt;rollback
</pre><p><a name="INDEX-1790" />Undoes the most recent database changes if
not yet committed.
</p></div>

<a name="INDEX-1791" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>rows</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">rows</em> = $<em class="replaceable">st_handle</em>-&gt;rows
</pre><p><a name="INDEX-1791" />Returns the number of rows affected by the
last change to the database.
</p></div>

<a name="INDEX-1792" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>state</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">handle</em>-&gt;state
</pre><p><a name="INDEX-1792" />Returns an error code in a
five-character format.
</p></div>

<a name="INDEX-1793" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>trace</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
DBI-&gt;trace(<em class="replaceable">n</em>, <em class="replaceable">filename</em>)
</pre><p><a name="INDEX-1793" />Traces the execution of DBI.
</p><dl>
<dt><i><em class="replaceable"><tt>n</tt></em></i></dt>
<dd>
An integer indicating the level of trace/debugging information, as
follows:
</p>

<dl>
<dt><b><tt class="literal">0</tt></b></dt>
<dd>
Disable the trace.</p>
</dd>


<dt><b><tt class="literal">1</tt></b></dt>
<dd>
Trace the execution of the DBI.</p>
</dd>


<dt><b><tt class="literal">2</tt></b></dt>
<dd>
Output detailed call trace information including parameters and
return values.
</p>
</dd>

</dl>
</dd>


<dt><i><em class="replaceable"><tt>filename</tt></em></i></dt>
<dd>
The file to append trace information to</p>
</dd>

</dl></div>

<a name="INDEX-1794" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>trace</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">handle</em>-&gt;trace(<em class="replaceable">n</em>, <em class="replaceable">filename</em>)
</pre><p>Same as the class method <tt class="literal">DBI-&gt;trace</tt>, but for a
specific database, statement, or driver handle.<a name="INDEX-1794" />
</p></div>


<hr width="684" align="left" />
<div class="navbar"><table width="684" border="0"><tr><td align="left" valign="top" width="228"><a href="ch12_02.htm"><img src="../gifs/txtpreva.gif" alt="Previous" border="0" /></a></td><td align="center" valign="top" width="228"><a href="index.htm"><img src="../gifs/txthome.gif" alt="Home" border="0" /></a></td><td align="right" valign="top" width="228"><a href="ch12_04.htm"><img src="../gifs/txtnexta.gif" alt="Next" border="0" /></a></td></tr><tr><td align="left" valign="top" width="228">12.2. Design of DBI</td><td align="center" valign="top" width="228"><a href="index/index.htm"><img src="../gifs/index.gif" alt="Book Index" border="0" /></a></td><td align="right" valign="top" width="228">12.4. DBI Environment Variables</td></tr></table></div>
<hr width="684" align="left" />

<img src="../gifs/navbar.gif" usemap="#library-map" border="0" alt="Library Navigation Links" />
<p><p><font size="-1"><a href="copyrght.htm">Copyright &copy; 2002</a> O'Reilly &amp; Associates. All rights reserved.</font></p>

<map name="library-map">
<area shape="rect" coords="1,0,85,94" href="../index.htm"><area shape="rect" coords="86,1,178,103" href="../lwp/index.htm"><area shape="rect" coords="180,0,265,103" href="../lperl/index.htm"><area shape="rect" coords="267,0,353,105" href="../perlnut/index.htm"><area shape="rect" coords="354,1,446,115" href="../prog/index.htm"><area shape="rect" coords="448,0,526,132" href="../tk/index.htm"><area shape="rect" coords="528,1,615,119" href="../cookbook/index.htm"><area shape="rect" coords="617,0,690,135" href="../pxml/index.htm">
</map>

</body></html>