<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
<refentry xml:id="function.pg-last-oid" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_last_oid</refname> 
  <refpurpose>Returns the last row's OID</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>int</type><type>false</type></type><methodname>pg_last_oid</methodname>
   <methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_last_oid</function> is used to retrieve the
   <varname>OID</varname> assigned to an inserted row.
  </para>
  <para>
   OID field became an optional field from PostgreSQL 7.2 and will
   not be present by default in PostgreSQL 8.1. When the
   OID field is not present in a table, the programmer must use 
   <function>pg_result_status</function> to check for successful
   insertion.
  </para>
  <para>
   To get the value of a <literal>SERIAL</literal> field in an inserted
   row, it is necessary to use the PostgreSQL <literal>CURRVAL</literal>
   function, naming the sequence whose last value is required.  If the
   name of the sequence is unknown, the <literal>pg_get_serial_sequence</literal>
   PostgreSQL 8.0 function is necessary.
  </para>
  <para>
   PostgreSQL 8.1 has a function <literal>LASTVAL</literal> that returns
   the value of the most recently used sequence in the session.  This avoids
   the need for naming the sequence, table or column altogether.
  </para>
  <note>
   <para>
    This function used to be called <function>pg_getlastoid</function>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>result</parameter></term>
     <listitem>
      &pgsql.parameter.result;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   An <type>int</type> or <type>string</type> containing the OID assigned to the most recently inserted
   row in the specified <parameter>connection</parameter>, or &false; on error or
   no available OID.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &pgsql.changelog.result-object;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_last_oid</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
  // Connect to the database
  pg_connect("dbname=mark host=localhost");

  // Create a sample table
  pg_query("CREATE TABLE test (a INTEGER) WITH OIDS");

  // Insert some data into it
  $res = pg_query("INSERT INTO test VALUES (1)");

  $oid = pg_last_oid($res);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_query</function></member>
    <member><function>pg_result_status</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
-->
