<!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>Copy a table to an array</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pg-copy-from.html">pg_copy_from</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pg-dbname.html">pg_dbname</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-copy-to" class="refentry">
<div class="refnamediv">
<h1 class="refname">pg_copy_to</h1>
<p class="verinfo">(PHP 4 >= 4.2.0, PHP 5)</p><p class="refpurpose"><span class="refname">pg_copy_to</span> — <span class="dc-title">
Copy a table to an array
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pg-copy-to-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>pg_copy_to</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$connection</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$table_name</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$delimiter</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$null_as</code></span>
]] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>pg_copy_to()</strong></span> copies a table to an array. It
issues <em>COPY TO</em> SQL command internally to
retrieve records.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.pg-copy-to-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">connection</code></em></span>
<dd>
<p class="para">
PostgreSQL database connection resource.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">table_name</code></em></span>
<dd>
<p class="para">
Name of the table from which to copy the data into <em><code class="parameter">rows</code></em>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">delimiter</code></em></span>
<dd>
<p class="para">
The token that separates values for each field in each element of
<em><code class="parameter">rows</code></em>. Default is <em>TAB</em>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">null_as</code></em></span>
<dd>
<p class="para">
How SQL <em>NULL</em> values are represented in the
<em><code class="parameter">rows</code></em>. Default is \N ("\\N").
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pg-copy-to-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
An <span class="type"><a href="language.types.array.html" class="type array">array</a></span> with one element for each line of <em>COPY</em> data.
It returns <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pg-copy-to-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2055">
<p><strong>Example #1 <span class="function"><strong>pg_copy_to()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> $db </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"dbname=publisher"</span><span style="color: #007700">) or die(</span><span style="color: #DD0000">"Could not connect"</span><span style="color: #007700">);<br /> <br /> </span><span style="color: #0000BB">$rows </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_copy_to</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">, </span><span style="color: #0000BB">$table_name</span><span style="color: #007700">);<br /> <br /> </span><span style="color: #0000BB">pg_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">, </span><span style="color: #DD0000">"DELETE FROM </span><span style="color: #0000BB">$table_name</span><span style="color: #DD0000">"</span><span style="color: #007700">);<br /> <br /> </span><span style="color: #0000BB">pg_copy_from</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">, </span><span style="color: #0000BB">$table_name</span><span style="color: #007700">, </span><span style="color: #0000BB">$rows</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.pg-copy-to-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.pg-copy-from.html" class="function" rel="rdfs-seeAlso">pg_copy_from()</a> - Insert records into a table from an array</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.pg-copy-from.html">pg_copy_from</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pg-dbname.html">pg_dbname</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>
