archived-doc-es/reference/mongo/mongocollection.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5206bce97288eee5ca74476fa33d5d41140473da Maintainer: seros Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->

<phpdoc:classref xml:id="class.mongocollection" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 
 <title>La clase MongoCollection</title>
 <titleabbrev>MongoCollection</titleabbrev>
 
 <partintro>
  
  <!-- {{{ Mongocollection intro -->
  <section xml:id="mongocollection.intro">
   &reftitle.intro;
   <para>
    Representa una colección de MongoDB.
   </para>
   <para>
    Los nombres de colecciones pueden usar cualquier carácter del código ASCII. Algunos ejemplos
    de nombres válidos de colecciones son &quot;&quot;, &quot;...&quot;, 
    &quot;mi coleccion&quot;, y &quot;&#42;&amp;&#35;&#64;&quot;.
   </para>
   <para>
    Los nombres de colecciones definidos por el usuario no pueden contener el símbolo $. Existen
    colecciones del sistema que utilizan $ en sus nombres (p.ej.,
    local.oplog.$main), pero es un carácter reservado. Si se intentara
    crear y usar una colección que incluya $ en su nombre, MongoDB lo notificará.
   </para>
  </section>
  <!-- }}} -->
  
  <section xml:id="mongocollection.synopsis">
   &reftitle.classsynopsis;
   
   <!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>MongoCollection</classname></ooclass>
    
    <!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>MongoCollection</classname>
     </ooclass>
    </classsynopsisinfo>
    <!-- }}} -->
    
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="mongocollection.constants.ascending">MongoCollection::ASCENDING</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="mongocollection.constants.descending">MongoCollection::DESCENDING</varname>
     <initializer>-1</initializer>
    </fieldsynopsis>
    
    <classsynopsisinfo role="comment">Campos</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>MongoDB</type>
     <varname linkend="mongocollection.props.db">db</varname>
     <initializer>&null;</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>integer</type>
     <varname linkend="mongocollection.props.w">w</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>integer</type>
     <varname linkend="mongocollection.props.wtimeout">wtimeout</varname>
    </fieldsynopsis>
    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongocollection')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
   </classsynopsis>
   <!-- }}} -->
   
  </section>
  
  <section>
   &reftitle.constants;
   <variablelist>
    <varlistentry xml:id="mongocollection.constants.ascending">
     <term><constant>MongoCollection::ASCENDING</constant></term>
     <term><constant>1</constant></term>
     <listitem>
      <simpara>
       Sentido ascendente para ordenaciones y creaciones de índices.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="mongocollection.constants.descending">
     <term><constant>MongoCollection::DESCENDING</constant></term>
     <term><constant>-1</constant></term>
     <listitem>
      <simpara>
       Sentido descendente para ordenaciones y creaciones de índices.
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
  
  <section>
   <title>Campos</title>
   <variablelist>
    <varlistentry xml:id="mongocollection.props.db">
     <term><varname>db</varname></term>
     <listitem>
      <para>
       La base de datos "madre" de esta colección.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="mongocollection.props.w">
     <term><varname>w</varname></term>
     <listitem>
      <para>
       Número de servidores a los que replicar un cambio antes de confirmar el éxito.
       Este valor se hereda de la base de datos madre. La clase
       <classname>MongoDB</classname> indica de forma más detallada cómo funciona
       <literal>w</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="mongocollection.props.wtimeout">
     <term><varname>wtimeout</varname></term>
     <listitem>
      <para>
       El número de milisegundos a esperar a que las operaciones se realicen en las
       réplicas de <literal>$this->w</literal>. Este valor se hereda de la base de datos madre.
       La clase <classname>MongoDB</classname> indica de forma más detallada cómo
       funciona <literal>wtimeout</literal>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
  
  <section>
   &reftitle.seealso;
   <para>
    Documentación de MongoDB sobre <link xlink:href="&url.mongodb.dochub.collections;">collections</link>.
   </para>
  </section>
  
 </partintro>
 
 &reference.mongo.entities.mongocollection;
 
</phpdoc:classref>

<!-- 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
-->