Source of: /manual/en/function.pg-copy-from.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.pgsql.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.pg-copy-from.php',
1 => 'pg_copy_from',
),
'up' =>
array (
0 => 'ref.pgsql.php',
1 => 'PostgreSQL Functions',
),
'prev' =>
array (
0 => 'function.pg-convert.php',
1 => 'pg_convert',
),
'next' =>
array (
0 => 'function.pg-copy-to.php',
1 => 'pg_copy_to',
),
'alternatives' =>
array (
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.pg-copy-from" class="refentry">
<div class="refnamediv">
<h1 class="refname">pg_copy_from</h1>
<p class="verinfo">(PHP 4 >= 4.2.0, PHP 5)</p><p class="refpurpose"><span class="refname">pg_copy_from</span> — <span class="dc-title">
Insert records into a table from an array
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pg-copy-from-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>pg_copy_from</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">array</span> <code class="parameter">$rows</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_from()</strong></span> inserts records into a table from
<em><code class="parameter">rows</code></em>. It issues a <em>COPY FROM</em> SQL command
internally to insert records.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.pg-copy-from-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 into which to copy the <em><code class="parameter">rows</code></em>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">rows</code></em></span>
<dd>
<p class="para">
An <span class="type"><a href="language.types.array.php" class="type array">array</a></span> of data to be copied into <em><code class="parameter">table_name</code></em>.
Each value in <em><code class="parameter">rows</code></em> becomes a row in <em><code class="parameter">table_name</code></em>.
Each value in <em><code class="parameter">rows</code></em> should be a delimited string of the values
to insert into each field. Values should be linefeed terminated.
</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-from-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pg-copy-from-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2094">
<p><strong>Example #1 <span class="function"><strong>pg_copy_from()</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-from-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.pg-copy-to.php" class="function" rel="rdfs-seeAlso">pg_copy_to()</a> - Copy a table to an array</span></li>
</ul>
</p>
</div>
</div><?php manual_footer(); ?>
