File: maxdb-info.xml

package info (click to toggle)
php-doc 20081024-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 57,752 kB
  • ctags: 3,858
  • sloc: xml: 686,554; php: 19,446; perl: 610; cpp: 500; makefile: 336; sh: 114; awk: 28
file content (169 lines) | stat: -rw-r--r-- 4,375 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
165
166
167
168
169
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.maxdb-info">
 <refnamediv>
  <refname>maxdb_info</refname>
  <refname>maxdb->info</refname>
  <refpurpose>Retrieves information about the most recently executed query</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>Procedural style:</para>
  <methodsynopsis>
   <type>string</type><methodname>maxdb_info</methodname>
   <methodparam><type>resource</type><parameter>link</parameter></methodparam>
  </methodsynopsis>
  <para>Object oriented style (property)</para>
  <classsynopsis>
   <ooclass><classname>maxdb</classname></ooclass>
    <fieldsynopsis><type>string</type><varname>info</varname></fieldsynopsis>
  </classsynopsis>
  <para>
   The <function>maxdb_info</function> function returns a string providing
   information about the last query executed. The nature of this string is
   provided below:
  </para>
  <para>
   <table>
    <title>Possible maxdb_info return values</title>
    <tgroup cols='2'>
     <thead>
      <row>
       <entry>Query type</entry>
       <entry>Example result string</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>INSERT INTO...SELECT...</entry>
       <entry>Records: 100 Duplicates: 0 Warnings: 0</entry>
      </row>
      <row>
       <entry>INSERT INTO...VALUES (...),(...),(...)</entry>
       <entry>Records: 3 Duplicates: 0 Warnings: 0</entry>
      </row>
      <row>
       <entry>LOAD DATA INFILE ...</entry>
       <entry>Records: 1 Deleted: 0 Skipped: 0 Warnings: 0</entry>
      </row>
      <row>
       <entry>ALTER TABLE ...</entry>
       <entry>Records: 3 Duplicates: 0 Warnings: 0</entry>
      </row>
      <row>
       <entry>UPDATE ...</entry>
       <entry>Rows matched: 40 Changed: 40 Warnings: 0</entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>
  <note>
   <para>
    Queries which do not fall into one of the above formats are not supported.
    In these situations, <function>maxdb_info</function> will return an empty string.
   </para>
  </note>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   A character string representing additional information about the most recently executed query.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Object oriented style</title>
   <programlisting role="php">
<![CDATA[
<?php
$maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB");

/* check connection */
if (maxdb_connect_errno()) {
   printf("Connect failed: %s\n", maxdb_connect_error());
   exit();
}

$maxdb->query("CREATE TABLE temp.t1 LIKE hotel.city");

/* INSERT INTO .. SELECT */
$maxdb->query("INSERT INTO temp.t1 SELECT * FROM hotel.city");
printf("%s\n", $maxdb->info);

/* close connection */
$maxdb->close();
?>
]]>
   </programlisting>
  </example>
  <example>
   <title>Procedural style</title>
   <programlisting role="php">
<![CDATA[
<?php
$link = maxdb_connect("localhost", "MONA", "RED", "DEMODB");

/* check connection */
if (maxdb_connect_errno()) {
   printf("Connect failed: %s\n", maxdb_connect_error());
   exit();
}

maxdb_query($link, "CREATE TABLE temp.t1 LIKE hotel.city");

/* INSERT INTO .. SELECT */
maxdb_query($link, "INSERT INTO temp.t1 SELECT * FROM hotel.city");
printf("%s\n", maxdb_info($link));

/* close connection */
maxdb_close($link);
?>
]]>
   </programlisting>
  </example>
  &example.outputs.similar;
  <screen>
<![CDATA[
Records: 25 Duplicates: 0 Warnings: 0
]]>
  </screen>
 </refsect1>

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