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

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry xml:id="function.dbplus-rcreate" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>dbplus_rcreate</refname>
  <refpurpose>Creates a new DB++ relation</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>dbplus_rcreate</methodname>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>domlist</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>overwrite</parameter></methodparam>
  </methodsynopsis>
  <para>
   Creates a new relation. Any existing relation sharing the same
   <parameter>name</parameter> will be overwritten if the relation is
   currently not in use and <parameter>overwrite</parameter> is set to TRUE.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>domlist</parameter></term>
     <listitem>
      <para>
       A combination of domains. May be passed as a single domain name string
       or as an array of domain names.
      </para>
      <para>
       This parameter should contain the domain specification for the new
       relation within an array of domain description strings. A domain
       description string consists of a domain name unique to this
       relation, a slash and a type specification character. See the
       db++ documentation, especially the dbcreate(1) manpage, for a
       description of available type specifiers and their meanings.
      </para>
      <note>
       <para>
        This function will also accept a string with space delimited domain
        description strings, but it is recommended to use an array
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>overwrite</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &warn.experimental.func;
 </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
-->