archived-doc-ja/reference/pgsql/functions/pg-copy-from.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./ja/functions/pgsql.xml, last change in rev 1.31 -->
<!-- EN-Revision: aa120f36c5762e99f9ee121d8caf910e0a67121e Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<refentry xml:id="function.pg-copy-from" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_copy_from</refname>
  <refpurpose>
   配列からテーブルに挿入する
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>pg_copy_from</methodname>
   <methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
   <methodparam><type>string</type><parameter>table_name</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>Traversable</type></type><parameter>rows</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>"\t"</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>null_as</parameter><initializer>"\\\\N"</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_copy_from</function> は、<parameter>rows</parameter>
   の内容をテーブルに挿入します。レコードを挿入するために、内部では
   <literal>COPY FROM</literal> SQL コマンドを発行します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      &pgsql.parameter.connection;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table_name</parameter></term>
     <listitem>
      <para>
       <parameter>rows</parameter> をコピーするテーブルの名前。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>rows</parameter></term>
     <listitem>
      <para>
       <parameter>table_name</parameter> にコピーする <type>iterable</type> なデータ。
       <parameter>rows</parameter> の個々の値が <parameter>table_name</parameter>
       のひとつの行となります。<parameter>rows</parameter> の個々の値は、
       それぞれのフィールドに対応する値が区切り文字で区切られており、最後は
       改行で終了していなければなりません。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>separator</parameter></term>
     <listitem>
      <para>
       <parameter>rows</parameter> の要素内で、各フィールドに対応する値を
       区切る文字。デフォルトは <literal>\t</literal> です。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>null_as</parameter></term>
     <listitem>
      <para>
       <parameter>rows</parameter> の中で、SQL の <literal>NULL</literal> 
       をどのように表現するか。デフォルトは <literal>\\N</literal> (<literal>"\\\\N"</literal>) です。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.5.0</entry>
      <entry>
       <parameter>rows</parameter> の型が <type>iterable</type> になりました。
       以前は、<type>array</type> でした。
      </entry>
     </row>
     &pgsql.changelog.connection-object;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_copy_from</function> の例</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
-->