pg-last-notice.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./ja/functions/pgsql.xml, last change in rev 1.29 -->
<!-- EN-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<refentry xml:id="function.pg-last-notice" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_last_notice</refname> 
  <refpurpose>
   PostgreSQL サーバーからの直近の通知メッセージを返す
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>string</type><type>bool</type></type><methodname>pg_last_notice</methodname>
   <methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>PGSQL_NOTICE_LAST</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_last_notice</function> は、<parameter>connection</parameter>
   で指定した PostgreSQL サーバーからの直近の通知メッセージを返します。
   たとえば、テーブルに <literal>SERIAL</literal> カラムを作成する場合などに
   PostgreSQL サーバーは通知メッセージを送信します。
  </para>
  <para>
   <function>pg_last_notice</function> でトランザクションに関連する通知
   メッセージがあるかないかをチェックすることで、無意味なクエリの発行を
   避けることが可能です。
  </para>
  <para>
   &php.ini; で <literal>pgsql.ignore_notice</literal>
   に 1 を指定することで、通知メッセージの追跡をしないようにすることが可能です。
  </para>
  <para>
   &php.ini; で <literal>pgsql.log_notice</literal>
   に 0 を指定することで、通知メッセージをログに記録しないようにすることが可能です。
   <literal>pgsql.ignore_notice</literal> が 0 に設定されていない限り、
   通知メッセージをログに記録することはできません。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      &pgsql.parameter.connection;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       直近の通知を返す <constant>PGSQL_NOTICE_LAST</constant>、
       すべての通知を返す <constant>PGSQL_NOTICE_ALL</constant>、
       または通知をクリアする <constant>PGSQL_NOTICE_CLEAR</constant>
       のいずれか
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <constant>PGSQL_NOTICE_LAST</constant> 使用時は、
   指定された <parameter>connection</parameter> の直近の通知を含む <type>string</type>、
   <constant>PGSQL_NOTICE_ALL</constant> 使用時は <type>array</type>、
   <constant>PGSQL_NOTICE_CLEAR</constant> 使用時は <type>bool</type> を返します。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      &pgsql.changelog.connection-object;
      <row>
       <entry>7.1.0</entry>
       <entry>
        <parameter>mode</parameter> パラメータが追加されました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_last_notice</function> の例</title>
    <programlisting role="php">
     <![CDATA[
<?php
  $pgsql_conn = pg_connect("dbname=mark host=localhost");
  
  $res = pg_query("CREATE TABLE test (id SERIAL)");
  
  $notice = pg_last_notice($pgsql_conn);
  
  echo $notice;
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
     <![CDATA[
CREATE TABLE will create implicit sequence "test_id_seq" for "serial" column "test.id"
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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