<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
  <refentry id="function.maxdb-insert-id">
   <refnamediv>
    <refname>maxdb_insert_id</refname>
    <refname>maxdb->insert_id</refname>
    <refpurpose>Returns the auto generated id used in the last query</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <para>Procedural style:</para>
     <methodsynopsis>
      <type>mixed</type><methodname>maxdb_insert_id</methodname>
      <methodparam><type>resource</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
     <para>Object oriented style (property):</para>
     <classsynopsis>
      <ooclass><classname>maxdb</classname></ooclass>
       <fieldsynopsis><type>mixed</type><varname>insert_id</varname></fieldsynopsis>
     </classsynopsis>
    <para>
     The <function>maxdb_insert_id</function> function returns the ID generated 
     by a query on a table with a column having the DEFAULT SERIAL attribute. If
     the last query wasn't an INSERT or UPDATE statement or if the modified table
     does not have a column with the DEFAULT SERIAL attribute, this function will
     return zero.
    </para>
   </refsect1>
   <refsect1>
    &reftitle.returnvalues;
    <para>
      The value of the <literal>DEFAULT SERIAL</literal> field that was updated 
      by the previous query. Returns zero if there was no previous query on the 
      connection or if the query did not update an <literal>DEFAULT_SERIAL</literal>
      value. 
  </para>
  <note> 
   <para>
    If the number is greater than maximal int value, <function>maxdb_insert_id</function> 
    will return a string.
   </para>
  </note>
 </refsect1>
 <refsect1>
  <title>Example</title>
  <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_report (MAXDB_REPORT_OFF);
$maxdb->query("DROP TABLE mycity");
maxdb_report (MAXDB_REPORT_ERROR);

$maxdb->query("CREATE TABLE mycity LIKE hotel.city");
$maxdb->query("ALTER TABLE mycity ADD id FIXED(11) DEFAULT SERIAL");

$query = "INSERT INTO mycity (zip,name,state) VALUES ('12203','Albany' ,'NY')";
$maxdb->query($query);

printf ("New Record has id %d.\n", $maxdb->insert_id);

/* drop table */
$maxdb->query("DROP TABLE mycity");

/* 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_report (MAXDB_REPORT_OFF);
maxdb_query($link,"DROP TABLE mycity");
maxdb_report (MAXDB_REPORT_ERROR);

maxdb_query($link, "CREATE TABLE mycity LIKE hotel.city");
maxdb_query($link, "ALTER TABLE mycity ADD id FIXED(11) DEFAULT SERIAL");

$query = "INSERT INTO mycity (zip,name,state) VALUES ('12203','Albany' ,'NY')";
maxdb_query($link, $query);

printf ("New Record has id %d.\n", maxdb_insert_id($link));

/* drop table */
maxdb_query($link, "DROP TABLE mycity");

/* close connection */
maxdb_close($link);
?>
]]>
   </programlisting>
  </example>
  <para>
   The above examples would produce the following output:
  </para>
  <screen>
<![CDATA[
New Record has id 1.
]]>
  </screen>
 </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
-->