<!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>Gets a user defined size of LOB files with each invocation</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.db2-last-insert-id.html">db2_last_insert_id</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.db2-next-result.html">db2_next_result</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-lob-read" class="refentry">
<div class="refnamediv">
<h1 class="refname">db2_lob_read</h1>
<p class="verinfo">(PECL ibm_db2 >= 1.6.0)</p><p class="refpurpose"><span class="refname">db2_lob_read</span> — <span class="dc-title">
Gets a user defined size of LOB files with each invocation
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.db2-lob-read-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>db2_lob_read</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">$colnum</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$length</code></span>
)</div>
<p class="para rdfs-comment">
Use <span class="function"><strong>db2_lob_read()</strong></span> to iterate through a specified column of
a result set and retrieve a user defined size of LOB data.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.db2-lob-read-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 LOB data.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">colnum</code></em></span>
<dd>
<p class="para">
A valid column number in the result set of the <em>stmt</em> resource.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">length</code></em></span>
<dd>
<p class="para">
The size of the LOB data to be retrieved from the <em>stmt</em> resource.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.db2-lob-read-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the amount of data the user specifies. Returns
<strong><code>FALSE</code></strong> if the data cannot be retrieved.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.db2-lob-read-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-1174">
<p><strong>Example #1 Iterating through different types of data</strong></p>
<div class="example-contents"><p>
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">/* Database Connection Parameters */<br /></span><span style="color: #0000BB">$db </span><span style="color: #007700">= </span><span style="color: #DD0000">'SAMPLE'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$username </span><span style="color: #007700">= </span><span style="color: #DD0000">'db2inst1'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$password </span><span style="color: #007700">= </span><span style="color: #DD0000">'ibmdb2'</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">/* Obtain Connection Resource */<br /></span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">,</span><span style="color: #0000BB">$username</span><span style="color: #007700">,</span><span style="color: #0000BB">$password</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$conn</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$drop </span><span style="color: #007700">= </span><span style="color: #DD0000">'DROP TABLE clob_stream'</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">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">$drop </span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$create </span><span style="color: #007700">= </span><span style="color: #DD0000">'CREATE TABLE clob_stream (id INTEGER, my_clob CLOB)'</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">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">$create </span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$variable </span><span style="color: #007700">= </span><span style="color: #DD0000">""</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: #DD0000">"INSERT INTO clob_stream (id,my_clob) VALUES (1, ?)"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$variable </span><span style="color: #007700">= </span><span style="color: #DD0000">"THIS IS A CLOB TEST. THIS IS A CLOB TEST."</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">db2_bind_param</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #DD0000">"variable"</span><span style="color: #007700">, </span><span style="color: #0000BB">DB2_PARAM_IN</span><span style="color: #007700">);<br /> </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 /> </span><span style="color: #0000BB">$sql </span><span style="color: #007700">= </span><span style="color: #DD0000">"SELECT id,my_clob FROM clob_stream"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$result </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">db2_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">db2_fetch_row</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">;<br /> </span><span style="color: #FF8000">/* Read LOB data */<br /> </span><span style="color: #007700">while (</span><span style="color: #0000BB">$data </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_lob_read</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #0000BB">6</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Loop </span><span style="color: #0000BB">$i</span><span style="color: #DD0000">: </span><span style="color: #0000BB">$data</span><span style="color: #DD0000">\n"</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">1</span><span style="color: #007700">;<br /> }<br /><br /> </span><span style="color: #0000BB">$drop </span><span style="color: #007700">= </span><span style="color: #DD0000">'DROP TABLE blob_stream'</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">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">$drop </span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$create </span><span style="color: #007700">= </span><span style="color: #DD0000">'CREATE TABLE blob_stream (id INTEGER, my_blob CLOB)'</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">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">$create </span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$variable </span><span style="color: #007700">= </span><span style="color: #DD0000">""</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: #DD0000">"INSERT INTO blob_stream (id,my_blob) VALUES (1, ?)"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$variable </span><span style="color: #007700">= </span><span style="color: #DD0000">"THIS IS A BLOB TEST. THIS IS A BLOB TEST."</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">db2_bind_param</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #DD0000">"variable"</span><span style="color: #007700">, </span><span style="color: #0000BB">DB2_PARAM_IN</span><span style="color: #007700">);<br /> </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 /> </span><span style="color: #0000BB">$sql </span><span style="color: #007700">= </span><span style="color: #DD0000">"SELECT id,my_blob FROM blob_stream"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$result </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">db2_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">db2_fetch_row</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">;<br /> </span><span style="color: #FF8000">/* Read LOB data */<br /> </span><span style="color: #007700">while (</span><span style="color: #0000BB">$data </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_lob_read</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #0000BB">6</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Loop </span><span style="color: #0000BB">$i</span><span style="color: #DD0000">: </span><span style="color: #0000BB">$data</span><span style="color: #DD0000">\n"</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">1</span><span style="color: #007700">;<br /> }<br />} else {<br /> echo </span><span style="color: #DD0000">'no connection: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">db2_conn_errormsg</span><span style="color: #007700">();<br />}<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>
Loop 0: THIS I
Loop 1: S A CL
Loop 2: OB TES
Loop 3: T. THI
Loop 4: S IS A
Loop 5: CLOB
Loop 6: TEST.
Loop 0: THIS I
Loop 1: S A BL
Loop 2: OB TES
Loop 3: T. THI
Loop 4: S IS A
Loop 5: BLOB
Loop 6: TEST.
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.db2-lob-read-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.db2-bind-param.html" class="function" rel="rdfs-seeAlso">db2_bind_param()</a> - Binds a PHP variable to an SQL statement parameter</span></li>
<li class="member"> <span class="function"><a href="function.db2-exec.html" class="function" rel="rdfs-seeAlso">db2_exec()</a> - Executes an SQL statement directly</span></li>
<li class="member"> <span class="function"><a href="function.db2-execute.html" class="function" rel="rdfs-seeAlso">db2_execute()</a> - Executes a prepared SQL statement</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-prepare.html" class="function" rel="rdfs-seeAlso">db2_prepare()</a> - Prepares an SQL statement to be executed</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-last-insert-id.html">db2_last_insert_id</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.db2-next-result.html">db2_next_result</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>
