File: pg-last-notice.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (164 lines) | stat: -rw-r--r-- 4,312 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.pg-last-notice">
 <refnamediv>
  <refname>pg_last_notice</refname> 
  <refpurpose>
   Returns the last notice message from PostgreSQL server
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>pg_last_notice</methodname>
   <methodparam><type>resource</type><parameter>connection</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_last_notice</function> returns the last notice
   message from the PostgreSQL server on the specified
   <parameter>connection</parameter>. The PostgreSQL server sends notice
   messages in several cases, for instance when creating a <literal>SERIAL</literal>
   column in a table.
  </para>
  <para>
   With <function>pg_last_notice</function>, you can avoid issuing useless
   queries by checking whether or not the notice is related to your transaction.
  </para>
  <para>
   Notice message tracking can be set to optional by setting 1 for
   <literal>pgsql.ignore_notice</literal> in &php.ini;.
  </para>
  <para>
   Notice message logging can be set to optional by setting 0 for
   <literal>pgsql.log_notice</literal> in &php.ini;.
   Unless <literal>pgsql.ignore_notice</literal> is set
   to 0, notice message cannot be logged.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      <para>
       PostgreSQL database connection resource.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   A <type>string</type> containing the last notice on the 
   given <parameter>connection</parameter>, or &false; on error.
  </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>4.3.0</entry>
       <entry>
        This function is now fully implemented. Earlier versions ignores
        database connection parameter.
       </entry>
      </row>
      <row>
       <entry>4.3.0</entry>
       <entry>
        The <literal>pgsql.ignore_notice</literal> and 
        <literal>pgsql.log_notice</literal> &php.ini; directives were added.
       </entry>
      </row>
      <row>
       <entry>4.0.6</entry>
       <entry>
        PHP 4.0.6 has problem with notice message handling. Use of the
        PostgreSQL module with PHP 4.0.6 is not recommended even if you are
        not using <function>pg_last_notice</function>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

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