File: db2-last-insert-id.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (146 lines) | stat: -rw-r--r-- 3,787 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.db2-last-insert-id" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_last_insert_id</refname>
  <refpurpose>Returns the auto generated ID of the last insert query that successfully 
  executed on this connection</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>null</type></type><methodname>db2_last_insert_id</methodname>
   <methodparam><type>resource</type><parameter>resource</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns the auto generated ID of the last insert query that successfully 
  executed on this connection.
  </para>
  <para>
   The result of this function is not affected by any of the following:
   <itemizedlist>
    <listitem>
     <para>
      A single row INSERT statement with a VALUES clause for a table without an identity column.
     </para>
    </listitem>
    <listitem>
     <para>
      A multiple row INSERT statement with a VALUES clause.
     </para>
    </listitem>
    <listitem>
     <para>
      An INSERT statement with a fullselect.
     </para>
    </listitem>
    <listitem>
     <para>
      A ROLLBACK TO SAVEPOINT statement.
     </para>
    </listitem>
   </itemizedlist>
  </para>   
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>resource</parameter></term>
     <listitem>
      <para>
       A valid connection resource as returned from <function>db2_connect</function> 
       or <function>db2_pconnect</function>. The value of this parameter cannot be a 
       statement resource or result set resource.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the auto generated ID of last insert query that successfully 
  executed on this connection.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example xml:id="db2-last-insert-id.example.basic"><!-- {{{ -->
    <title>A <function>db2_last_insert_id</function> example</title>
    <para>
      The following example shows how to return the  
      auto generated ID of last insert query that successfully 
      executed on this connection.
    </para>
    <programlisting role="php">
<![CDATA[
<?php

$database = "SAMPLE";
$user = "db2inst1";
$password = "ibmdb2";

$conn = db2_connect($database, $user, $password);
if($conn) {
    $createTable = "CREATE TABLE lastInsertID 
      (id integer GENERATED BY DEFAULT AS IDENTITY, name varchar(20))";
    $insertTable = "INSERT INTO lastInsertID (name) VALUES ('Temp Name')";

    $stmt = @db2_exec($conn, $createTable);

    /* Checking for single row inserted. */
    $stmt = db2_exec($conn, $insertTable);
    $ret =  db2_last_insert_id($conn);
    if($ret) {
        echo "Last Insert ID is : " . $ret . "\n";
    } else {
        echo "No Last insert ID.\n";
    }
    
    db2_close($conn);
}
else {
    echo "Connection failed.";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Last Insert ID is : 1
]]>
    </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:"~/.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
-->