<!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 number of affected records (tuples)</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ref.pgsql.html">PostgreSQL Functions</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.pg-cancel-query.html">pg_cancel_query</a></div> <div class="up"><a href="ref.pgsql.html">PostgreSQL Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.pg-affected-rows" class="refentry"> <div class="refnamediv"> <h1 class="refname">pg_affected_rows</h1> <p class="verinfo">(PHP 4 >= 4.2.0, PHP 5)</p><p class="refpurpose"><span class="refname">pg_affected_rows</span> — <span class="dc-title">Returns number of affected records (tuples)</span></p> </div> <div class="refsect1 description" id="refsect1-function.pg-affected-rows-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">int</span> <span class="methodname"><strong>pg_affected_rows</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$result</code></span> )</div> <p class="para rdfs-comment"> <span class="function"><strong>pg_affected_rows()</strong></span> returns the number of tuples (instances/records/rows) affected by <em>INSERT</em>, <em>UPDATE</em>, and <em>DELETE</em> queries. </p> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> This function used to be called <span class="function"><strong>pg_cmdtuples()</strong></span>. </p> </p></blockquote> </div> <div class="refsect1 parameters" id="refsect1-function.pg-affected-rows-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">result</code></em></span> <dd> <p class="para"> PostgreSQL query result resource, returned by <span class="function"><a href="function.pg-query.html" class="function">pg_query()</a></span>, <span class="function"><a href="function.pg-query-params.html" class="function">pg_query_params()</a></span> or <span class="function"><a href="function.pg-execute.html" class="function">pg_execute()</a></span> (among others). </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.pg-affected-rows-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> The number of rows affected by the query. If no tuple is affected, it will return 0. </p> </div> <div class="refsect1 examples" id="refsect1-function.pg-affected-rows-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-2045"> <p><strong>Example #1 <span class="function"><strong>pg_affected_rows()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$result </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">"INSERT INTO authors VALUES ('Orwell', 2002, 'Animal Farm')"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$cmdtuples </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_affected_rows</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">$cmdtuples </span><span style="color: #007700">. </span><span style="color: #DD0000">" tuples are affected.\n"</span><span style="color: #007700">;<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> 1 tuples are affected. </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.pg-affected-rows-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.pg-query.html" class="function" rel="rdfs-seeAlso">pg_query()</a> - Execute a query</span></li> <li class="member"> <span class="function"><a href="function.pg-query-params.html" class="function" rel="rdfs-seeAlso">pg_query_params()</a> - Submits a command to the server and waits for the result, with the ability to pass parameters separately from the SQL command text.</span></li> <li class="member"> <span class="function"><a href="function.pg-execute.html" class="function" rel="rdfs-seeAlso">pg_execute()</a> - Sends a request to execute a prepared statement with given parameters, and waits for the result.</span></li> <li class="member"> <span class="function"><a href="function.pg-num-rows.html" class="function" rel="rdfs-seeAlso">pg_num_rows()</a> - Returns the number of rows in a result</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="ref.pgsql.html">PostgreSQL Functions</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.pg-cancel-query.html">pg_cancel_query</a></div> <div class="up"><a href="ref.pgsql.html">PostgreSQL Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>