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: 39bb8a868935a56cfce438b0169e13c02c93211c Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<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 class="union"><type>PgSql\Result</type><type>string</type><type>bool</type></type><methodname>pg_insert</methodname>
   <methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
   <methodparam><type>string</type><parameter>table_name</parameter></methodparam>
   <methodparam><type>array</type><parameter>values</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>PGSQL_DML_EXEC</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_insert</function> は、
   <parameter>table_name</parameter> で指定したテーブルに
   <parameter>values</parameter> の値を挿入します。
  </para>
  <para>
   <parameter>flags</parameter> が指定されている場合、そのオプションと
   ともに <function>pg_convert</function> が
   <parameter>values</parameter> に適用されます。
  </para>
  <para>
   デフォルトでは、
   <function>pg_insert</function> は生の値を渡します。
   値はエスケープするか、
   <parameter>flags</parameter> に <constant>PGSQL_DML_ESCAPE</constant>
   オプションを指定しなければいけません。
   <constant>PGSQL_DML_ESCAPE</constant> はパラメータや識別子をクォートし、
   エスケープします。
   よって、テーブル/カラム名は大文字小文字を区別します。
  </para>
  <para>
   エスケープやプリペアドクエリであっても、
   LIKE, JSON, Array, Regex などのクエリを守れない可能性があることに注意してください。
   これらのパラメータはコンテクストに応じて処理されるべきです。
   たとえば、値をエスケープ/検証する処理を行うことなどです。
  </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>table_name</parameter>
       は、少なくとも <parameter>values</parameter> の要素数ぶんのカラムを
       保持している必要があります。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>values</parameter></term>
     <listitem>
      <para>
       テーブル <parameter>table_name</parameter> のフィールド名をキーに、
       挿入する内容を値にもつ配列。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</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>flags</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.success;
   <parameter>flags</parameter> で
   <constant>PGSQL_DML_STRING</constant> が渡された場合は、成功時に文字列を返します。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   指定したテーブルが無効な場合、<classname>ValueError</classname> がスローされます。
  </para>
  <para>
   値やフィールドの型が PostgreSQL の型と一致しない場合、
   <classname>ValueError</classname> または <classname>TypeError</classname> がスローされます。
  </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.3.0</entry>
      <entry>
       指定されたテーブルが無効な場合、
       <classname>ValueError</classname> がスローされるようになりました。
       これより前のバージョンでは、<constant>E_WARNING</constant> が発生していました。
      </entry>
     </row>
     <row>
      <entry>8.3.0</entry>
      <entry>
       値やフィールドの型が PostgreSQL の型と一致しない場合、
       <classname>ValueError</classname> または <classname>TypeError</classname> がスローされるようになりました。
       これより前のバージョンでは、<constant>E_WARNING</constant> が発生していました。
      </entry>
     </row>
     &pgsql.changelog.return-result-object;
     &pgsql.changelog.connection-object;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_insert</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php 
  $dbconn = pg_connect('dbname=foo');
  // これは少しだけ安全です。なぜなら、全ての値がエスケープされるからです。
  // しかし、PostgreSQL は JSON/Array をサポートしています。これらの型に
  // ついてはエスケープされたクエリや、プリペアドクエリでも安全ではありません。
  $res = pg_insert($dbconn, 'post_log', $_POST, PGSQL_DML_ESCAPE);
  if ($res) {
      echo "POST data is successfully logged\n";
  } else {
      echo "User must have sent wrong inputs\n";
  }
?>
]]>
    </programlisting>
   </example>
  </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
-->