<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Returns an array, indexed by column name, representing a row in a result set</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.db2-fetch-array.html">db2_fetch_array</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.db2-fetch-both.html">db2_fetch_both</a></div>
<div class="up"><a href="ref.ibm-db2.html">IBM DB2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.db2-fetch-assoc" class="refentry">
<div class="refnamediv">
<h1 class="refname">db2_fetch_assoc</h1>
<p class="verinfo">(PECL ibm_db2 >= 1.0.0)</p><p class="refpurpose"><span class="refname">db2_fetch_assoc</span> — <span class="dc-title">
Returns an array, indexed by column name, representing a row in a result set
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.db2-fetch-assoc-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>db2_fetch_assoc</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$stmt</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$row_number</code><span class="initializer"> = -1</span></span>
] )</div>
<p class="para rdfs-comment">
Returns an array, indexed by column name, representing a row in a result
set.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.db2-fetch-assoc-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">stmt</code></em></span>
<dd>
<p class="para">
A valid <em>stmt</em> resource containing a result set.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">row_number</code></em></span>
<dd>
<p class="para">
Requests a specific 1-indexed row from the result set. Passing this
parameter results in a PHP warning if the result set uses a
forward-only cursor.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.db2-fetch-assoc-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an associative array with column values indexed by the column name
representing the next or requested row in the result set. Returns <strong><code>FALSE</code></strong> if
there are no rows left in the result set, or if the row requested by
<em><code class="parameter">row_number</code></em> does not exist in the result set.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.db2-fetch-assoc-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-1165">
<p><strong>Example #1 Iterating through a forward-only cursor</strong></p>
<div class="example-contents"><p>
If you call <span class="function"><strong>db2_fetch_assoc()</strong></span> without a specific row
number, it automatically retrieves the next row in the result set.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$sql </span><span style="color: #007700">= </span><span style="color: #DD0000">"SELECT id, name, breed, weight FROM animals ORDER BY breed"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$stmt </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_prepare</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">$sql</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">);<br /><br />while (</span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_fetch_assoc</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">printf </span><span style="color: #007700">(</span><span style="color: #DD0000">"%-5d %-16s %-32s %10s\n"</span><span style="color: #007700">, <br /> </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'ID'</span><span style="color: #007700">], </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'NAME'</span><span style="color: #007700">], </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'BREED'</span><span style="color: #007700">], </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'WEIGHT'</span><span style="color: #007700">]);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
0 Pook cat 3.20
5 Rickety Ride goat 9.70
2 Smarty horse 350.00
</pre></div>
</div>
</div>
<div class="example" id="example-1166">
<p><strong>Example #2 Retrieving specific rows with <span class="function"><strong>db2_fetch_assoc()</strong></span>
from a scrollable cursor</strong></p>
<div class="example-contents"><p>
If your result set uses a scrollable cursor, you can call
<span class="function"><strong>db2_fetch_assoc()</strong></span> with a specific row number. The
following example retrieves every other row in the result set, starting
with the second row.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$sql </span><span style="color: #007700">= </span><span style="color: #DD0000">"SELECT id, name, breed, weight FROM animals ORDER BY breed"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_exec</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">, </span><span style="color: #0000BB">$sql</span><span style="color: #007700">, array(</span><span style="color: #DD0000">'cursor' </span><span style="color: #007700">=> </span><span style="color: #0000BB">DB2_SCROLLABLE</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">$i</span><span style="color: #007700">=</span><span style="color: #0000BB">2</span><span style="color: #007700">;<br />while (</span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_fetch_assoc</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">, </span><span style="color: #0000BB">$i</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">printf </span><span style="color: #007700">(</span><span style="color: #DD0000">"%-5d %-16s %-32s %10s\n"</span><span style="color: #007700">, <br /> </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'ID'</span><span style="color: #007700">], </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'NAME'</span><span style="color: #007700">], </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'BREED'</span><span style="color: #007700">], </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'WEIGHT'</span><span style="color: #007700">]);<br /> </span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">$i </span><span style="color: #007700">+ </span><span style="color: #0000BB">2</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
0 Pook cat 3.20
5 Rickety Ride goat 9.70
2 Smarty horse 350.00
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.db2-fetch-assoc-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.db2-fetch-array.html" class="function" rel="rdfs-seeAlso">db2_fetch_array()</a> - Returns an array, indexed by column position, representing a row in a result set</span></li>
<li class="member"> <span class="function"><a href="function.db2-fetch-both.html" class="function" rel="rdfs-seeAlso">db2_fetch_both()</a> - Returns an array, indexed by both column name and position, representing a row in a result set</span></li>
<li class="member"> <span class="function"><a href="function.db2-fetch-object.html" class="function" rel="rdfs-seeAlso">db2_fetch_object()</a> - Returns an object with properties representing columns in the fetched row</span></li>
<li class="member"> <span class="function"><a href="function.db2-fetch-row.html" class="function" rel="rdfs-seeAlso">db2_fetch_row()</a> - Sets the result set pointer to the next row or requested row</span></li>
<li class="member"> <span class="function"><a href="function.db2-result.html" class="function" rel="rdfs-seeAlso">db2_result()</a> - Returns a single column from a row in the result set</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.db2-fetch-array.html">db2_fetch_array</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.db2-fetch-both.html">db2_fetch_both</a></div>
<div class="up"><a href="ref.ibm-db2.html">IBM DB2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
