<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
<refentry xml:id='function.pg-copy-from' xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_copy_from</refname>
  <refpurpose>
   Insert records into a table from an array
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>pg_copy_from</methodname>
   <methodparam><type>resource</type><parameter>connection</parameter></methodparam>
   <methodparam><type>string</type><parameter>table_name</parameter></methodparam>
   <methodparam><type>array</type><parameter>rows</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>delimiter</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>null_as</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_copy_from</function> inserts records into a table from 
   <parameter>rows</parameter>. It issues a <literal>COPY FROM</literal> SQL command 
   internally to insert records.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      <para>
       PostgreSQL database connection resource.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table_name</parameter></term>
     <listitem>
      <para>
       Name of the table into which to copy the <parameter>rows</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>rows</parameter></term>
     <listitem>
      <para>
       An <type>array</type> of data to be copied into <parameter>table_name</parameter>.
       Each value in <parameter>rows</parameter> becomes a row in <parameter>table_name</parameter>.
       Each value in <parameter>rows</parameter> should be a delimited string of the values
       to insert into each field.  Values should be linefeed terminated.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>delimiter</parameter></term>
     <listitem>
      <para>
       The token that separates values for each field in each element of
       <parameter>rows</parameter>.  Default is <literal>TAB</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>null_as</parameter></term>
     <listitem>
      <para>
       How SQL <literal>NULL</literal> values are represented in the
       <parameter>rows</parameter>.  Default is \N ("\\N").
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
   <para>
    &return.success;
   </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_copy_from</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
   $db = pg_connect("dbname=publisher") or die("Could not connect");
   
   $rows = pg_copy_to($db, $table_name);
   
   pg_query($db, "DELETE FROM $table_name");
   
   pg_copy_from($db, $table_name, $rows);
?>
]]>
    </programlisting>
   </example> 
  </para>
 </refsect1>
  
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_copy_to</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->