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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.80 -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<refentry xml:id='function.pg-select' xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_select</refname>
  <refpurpose>
   レコードを選択する
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>pg_select</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_select</function> は、<literal>field=>value</literal>
   形式の <literal>assoc_array</literal> で指定したレコードを選択します。
   クエリに成功した場合、<literal>assoc_array</literal> で指定した条件に
   マッチする全てのレコードとフィールドを含む配列が返されます。
  </para>
  <para><literal>options</literal> が指定された場合、
   指定したフラグとともに <function>pg_convert</function> が
   <literal>assoc_array</literal> に適用されます。
  </para>
  &warn.experimental.func;
 </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>
       行を選択するテーブルの名前。
      </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_FORCE_NULL</constant>、
       <constant>PGSQL_DML_NO_CONV</constant>、
       <constant>PGSQL_DML_EXEC</constant>、
       <constant>PGSQL_DML_ASYNC</constant> あるいは
       <constant>PGSQL_DML_STRING</constant> の組み合わせ。
       <parameter>options</parameter> の一部に 
       <constant>PGSQL_DML_STRING</constant> が含まれていた場合、
       クエリ文字列が返されます。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success; <parameter>options</parameter> に
   <constant>PGSQL_DML_STRING</constant> が渡された場合は文字列を返します。
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_select</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php 
  $db = pg_connect('dbname=foo');
  // これは安全です。なぜなら $_POST は自動的に変換されるからです。
  $rec = pg_select($db, 'post_log', $_POST);
  if ($rec) {
      echo "選択されたレコード:\n";
      var_dump($rec);
  } else {
      echo "ユーザーが誤った入力を送信しました。\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
-->