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
|
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.10 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<refentry id="function.PDO-lastInsertId">
<refnamediv>
<refname>PDO::lastInsertId</refname>
<refpurpose>
Returns the ID of the last inserted row or sequence value
</refpurpose>
</refnamediv>
<refsect1 role="description">
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>PDO::lastInsertId</methodname>
<methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
Returns the ID of the last inserted row, or the last value from a
sequence object, depending on the underlying driver. For example,
<function>PDO_PGSQL</function> requires you to specify the name of
a sequence object for the <parameter>name</parameter> parameter.
</para>
<note>
<para>
This method may not return a meaningful or consistent result across
different PDO drivers, because the underlying database may not even
support the notion of auto-increment fields or sequences.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Name of the sequence object from which the ID should be returned.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If a sequence name was not specified for the <parameter>name</parameter>
parameter, <function>PDOStatement::lastInsertId</function> returns a
string representing the row ID of the last row that was inserted into
the database.
</para>
<para>
If a sequence name was specified for the <parameter>name</parameter>
parameter, <function>PDOStatement::lastInsertId</function> returns a
string representing the last value retrieved from the specified sequence
object.
</para>
<para>
If the PDO driver does not support this capability,
<function>PDO::lastInsertID</function> triggers an
<literal>IM001</literal> SQLSTATE.
</para>
</refsect1>
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Retrieving the last insert ID</title>
<para>
The following example demonstrates how to use the
<function>PDO::lastInsertID</function> method to retrieve the row
identifier for the last row that has been inserted into the database.
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</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
-->
|
