php-doc-en/reference/dbplus/functions/dbplus-add.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.dbplus-add" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>dbplus_add</refname>
  <refpurpose>Add a tuple to a relation</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <!-- TODO: Check if tuple should be passed by reference -->
  <methodsynopsis>
   <type>int</type><methodname>dbplus_add</methodname>
   <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
   <methodparam><type>array</type><parameter>tuple</parameter></methodparam>
  </methodsynopsis>
  <para>
   Adds a tuple to a <parameter>relation</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>relation</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>tuple</parameter></term>
     <listitem>
      <para>
       An array of attribute/value pairs to be inserted into the given
       <parameter>relation</parameter>.
      </para>
      <para>
       After successful execution this array will contain the complete data
       of the newly created tuple, including all implicitly set domain fields
       like sequences.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The function will return <constant>DBPLUS_ERR_NOERR</constant> on success
   or a db++ error code on failure.
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &warn.experimental.func;
 </refsect1>

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