archived-doc-ja/reference/pgsql/functions/pg-insert.xml

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

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>pg_insert</methodname>
   <methodparam><type>resource</type><parameter>connection</parameter></methodparam>
   <methodparam><type>string</type><parameter>table_name</parameter></methodparam>
   <methodparam><type>array</type><parameter>assoc_array</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>PGSQL_DML_EXEC</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_insert</function> は、
   <literal>table_name</literal> で指定したテーブルに
   <literal>assoc_array</literal> の値をを挿入します。
   <parameter>options</parameter> が指定されている場合、そのオプションと
   ともに <function>pg_convert</function> が
   <literal>assoc_array</literal> に適用されます。
  </para>
 </refsect1>

<refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      <para>
       PostgreSQL データベースの接続リソース。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table_name</parameter></term>
     <listitem>
      <para>
       行を挿入するテーブルの名前。テーブル <parameter>table_name</parameter>
       は、少なくとも <parameter>assoc_array</parameter> の要素数ぶんのカラムを
       保持している必要があります。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>assoc_array</parameter></term>
     <listitem>
      <para>
       テーブル <parameter>table_name</parameter> のフィールド名をキーに、
       挿入する内容を値にもつ配列。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       <constant>PGSQL_CONV_OPTS</constant>、
       <constant>PGSQL_DML_NO_CONV</constant>、
       <constant>PGSQL_DML_ESCAPE</constant>、
       <constant>PGSQL_DML_EXEC</constant>、
       <constant>PGSQL_DML_ASYNC</constant> あるいは
       <constant>PGSQL_DML_STRING</constant> を組み合わせた数。
       <constant>PGSQL_DML_STRING</constant> が
       <parameter>options</parameter> に含まれていた場合、
       クエリ文字列が返されます。
       <constant>PGSQL_DML_NO_CONV</constant> あるいは <constant>PGSQL_DML_ESCAPE</constant>
       が設定されている場合は、内部的に <function>pg_convert</function> を呼びません。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功時に接続リソースを返し、&return.falseforfailure;。
   <parameter>options</parameter> で
   <constant>PGSQL_DML_STRING</constant> が渡された場合は文字列を返します。
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_insert</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php 
  $dbconn = pg_connect('dbname=foo');
  // これは安全です。なぜなら $_POST は自動的に変換されるからです。
  $res = pg_insert($dbconn, 'post_log', $_POST);
  if ($res) {
      echo "POST data is successfully logged\n";
  } else {
      echo "User must have sent wrong inputs\n";
  }
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.6.0</entry>
       <entry>
        <constant>PGSQL_DML_STRING</constant> が渡されない限り、
        この関数は、成功時に &true; の代わりに接続リソースを返します。
       </entry>
      </row>
      <row>
       <entry>5.6.0</entry>
       <entry>
        実験的な関数ではなくなりました。定数 <constant>PGSQL_DML_ESCAPE</constant> が追加されました。
        &true;/&false; や &null; をサポートするようになりました。
       </entry>
      </row>
      <row>
       <entry>5.5.3/5.4.19</entry>
       <entry>
        <parameter>table_name</parameter> に対する SQL インジェクション、そして識別子に対する間接的な SQL インジェクションの問題を修正しました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_convert</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
-->