<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.mongodb-driver-bulkwrite.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'es',
  ),
  'this' => 
  array (
    0 => 'mongodb-driver-bulkwrite.update.php',
    1 => 'MongoDB\\Driver\\BulkWrite::update',
    2 => 'A&ntilde;ade una operaci&oacute;n de actualizaci&oacute;n al lote',
  ),
  'up' => 
  array (
    0 => 'class.mongodb-driver-bulkwrite.php',
    1 => 'MongoDB\\Driver\\BulkWrite',
  ),
  'prev' => 
  array (
    0 => 'mongodb-driver-bulkwrite.insert.php',
    1 => 'MongoDB\\Driver\\BulkWrite::insert',
  ),
  'next' => 
  array (
    0 => 'class.mongodb-driver-bulkwritecommand.php',
    1 => 'MongoDB\\Driver\\BulkWriteCommand',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'es',
    'path' => 'reference/mongodb/mongodb/driver/bulkwrite/update.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="mongodb-driver-bulkwrite.update" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">MongoDB\Driver\BulkWrite::update</h1>
  <p class="verinfo">(mongodb &gt;=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\BulkWrite::update</span> &mdash; <span class="dc-title">Añade una operación de actualización al lote</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mongodb-driver-bulkwrite.update-description">
  <h3 class="title">Descripción</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>MongoDB\Driver\BulkWrite::update</strong></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.object.php" class="type object">object</a></span></span> <code class="parameter">$filter</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.object.php" class="type object">object</a></span></span> <code class="parameter">$newObj</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.array.php" class="type array">array</a></span></span> <code class="parameter">$updateOptions</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>

  <p class="para rdfs-comment">
   Añade una operación de actualización al
   <span class="classname"><a href="class.mongodb-driver-bulkwrite.php" class="classname">MongoDB\Driver\BulkWrite</a></span>.
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-mongodb-driver-bulkwrite.update-parameters">
  <h3 class="title">Parámetros</h3>
  <dl>
   

<dt><code class="parameter">filter</code> (<span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.object.php" class="type object">object</a></span></span>)</dt>
<dd>
    <p class="para">
        El <a href="https://www.mongodb.com/docs/manual/tutorial/query-documents/" class="link external">&raquo;&nbsp;atributo de la consulta</a>.
        Un atributo vacío hará coincidir todos los documentos de la colección.
    </p>
    <blockquote class="note"><p><strong class="note">Nota</strong>: 
        <span class="simpara">
            Al evaluar los criterios de consulta, MongoDB compara los tipos y los valores según sus propias <a href="https://www.mongodb.com/docs/manual/reference/bson-type-comparison-order/" class="link external">&raquo;&nbsp;reglas de comparación para los tipos BSON</a>, que difieren de las reglas de <a href="types.comparisons.php" class="link">comparación</a> y de <a href="language.types.type-juggling.php" class="link">manipulación de tipos</a> de PHP. Al hacer coincidir un tipo BSON especial, los criterios de consulta deben utilizar la <a href="mongodb.bson.php" class="link">clase BSON</a> (ej.: utilizar <span class="classname"><a href="class.mongodb-bson-objectid.php" class="classname">MongoDB\BSON\ObjectId</a></span> para hacer coincidir un <a href="https://www.mongodb.com/docs/manual/reference/bson-types/#objectid" class="link external">&raquo;&nbsp;ObjectId</a>).
        </span>
    </p></blockquote>
</dd>


   
    <dt><code class="parameter">newObj</code> (<span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.object.php" class="type object">object</a></span></span>)</dt>
    <dd>
     <p class="para">
      Un documento que contiene operadores de actualización (por ejemplo
      <code class="literal">$set</code>), un documento de reemplazo (es decir,
      <em>solo</em> expresiones <code class="literal">field:value</code>), o
      una <a href="https://www.mongodb.com/docs/manual/reference/command/update/#update-with-an-aggregation-pipeline" class="link external">&raquo;&nbsp;pipeline de agregación</a>.
     </p>
    </dd>
   
   
    <dt><code class="parameter">updateOptions</code></dt>
    <dd>
     <p class="para">
      <table class="doctable table">
       <caption><strong>updateOptions</strong></caption>
       
        <thead>
         <tr>
          <th>Option</th>
          <th>Type</th>
          <th>Description</th>
          <th>Defaut</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td>arrayFilters</td>
          <td><span class="type"><a href="language.types.array.php" class="type array">array</a></span></td>
          <td>
           <p class="para">
            Un array de documentos de filtro que determina qué elementos de array
            modificar para una operación de actualización en un campo de array. Véase
            <a href="https://www.mongodb.com/docs/manual/reference/command/update/#update-command-arrayfilters" class="link external">&raquo;&nbsp;Especificar arrayFilters para las operaciones de actualización de array</a>
            en el manual de MongoDB para más información.
           </p>
           <p class="para">
            Esta opción está disponible en MongoDB 3.6+ y causará una
            excepción en el momento de la ejecución si se especifica para una versión de servidor
            más antigua.
           </p>
          </td>
         </tr>

         
<tr>
<td>collation</td>
<td><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.object.php" class="type object">object</a></span></span></td>
<td>
    <p class="para">
        <a href="https://www.mongodb.com/docs/upcoming/reference/collation/" class="link external">&raquo;&nbsp;Collation</a> permite a los usuarios especificar reglas específicas del lenguaje para la comparación de cadenas, por ejemplo, reglas para mayúsculas o acentos. Al especificar una collation, el campo <code class="literal">&quot;locale&quot;</code> es obligatorio; todos los demás campos de la collation son opcionales. Para la descripción de estos campos, consúltese el <a href="https://www.mongodb.com/docs/upcoming/reference/collation/#collation-document" class="link external">&raquo;&nbsp;documento Collation</a>.
    </p>
    <p class="para">
        Si la collation no es especificada pero la colección tiene una collation por omisión, la operación utilizará la collation especificada para la colección. Si ninguna collation es especificada para la colección o para la operación, MongoDB utilizará el binario simple de comparación utilizado en versiones anteriores para las comparaciones de cadenas.
    </p>
    <p class="para">
        Esta opción está disponible en MongoDB 3.4+ y una excepción será emitida en tiempo de ejecución si es especificada en una versión anterior.
    </p>
</td>
</tr>


         <tr>
          <td>hint</td>
          <td><span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.object.php" class="type object">object</a></span></span></td>
          <td>
           <p class="para">
            Especificación de índice. Especifique el nombre del índice como string
            o el patrón de clave de índice. Si se especifica, el sistema de consultas
            solo considerará los planes que usen el índice sugerido.
           </p>
           <p class="para">
            Esta opción está disponible en MongoDB 4.4+ y causará una
            excepción en el momento de la ejecución si se especifica para una versión de servidor
            más antigua.
           </p>
          </td>
         </tr>

         <tr>
          <td>multi</td>
          <td><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></td>
          <td>
           Actualiza solo el primer documento coincidente si <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, o todos
           los documentos coincidentes <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>. Esta opción no puede ser <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> si
           <code class="parameter">newObj</code> es un documento de reemplazo.
          </td>
          <td><strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></td>
         </tr>

         <tr>
          <td>sort</td>
          <td><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.object.php" class="type object">object</a></span></span></td>
          <td>
           <p class="para">
            Especifica qué documento la operación actualiza si la consulta coincide
            con varios documentos. El primer documento coincidente por el orden de clasificación
            será actualizado.
           </p>
           <p class="para">
            Esta opción no puede ser utilizada si <code class="literal">&quot;multi&quot;</code> es <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>.
           </p>
           <p class="para">
            Esta opción está disponible en MongoDB 4.4+ y causará una
            excepción en el momento de la ejecución si se especifica para una versión de servidor
            más antigua.
           </p>
          </td>
         </tr>

         <tr>
          <td>upsert</td>
          <td><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></td>
          <td>
           Si <code class="parameter">filter</code> no coincide con un documento existente,
           inserta un <em>único</em> documento. El documento será
           creado a partir de <code class="parameter">newObj</code> si es un documento de reemplazo
           (es decir, sin operadores de actualización); de lo contrario, los operadores en
           <code class="parameter">newObj</code> serán aplicados a
           <code class="parameter">filter</code> para crear el nuevo documento.
          </td>
          <td><strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></td>
         </tr>

        </tbody>
       
      </table>

     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-mongodb-driver-bulkwrite.update-returnvalues">
  <h3 class="title">Valores devueltos</h3>
  <p class="para">
   No se retorna ningún valor.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-mongodb-driver-bulkwrite.update-errors">
  <h3 class="title">Errores/Excepciones</h3>
  <ul class="simplelist">
   <li>Lanza una excepción <span class="classname"><strong class="classname">MongoDB\Driver\InvalidArgumentException</strong></span> en caso de error durante el análisis de un argumento.</li>
  </ul>
 </div>


 <div class="refsect1 changelog" id="refsect1-mongodb-driver-bulkwrite.update-changelog">
  <h3 class="title">Historial de cambios</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Versión</th>
       <th>Descripción</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>PECL mongodb 1.21.0</td>
       <td>
        Adición de la opción <code class="literal">&quot;sort&quot;</code>.
       </td>
      </tr>

      <tr>
       <td>PECL mongodb 1.7.0</td>
       <td>
        Adición de la opción <code class="literal">&quot;hint&quot;</code>.
       </td>
      </tr>

      <tr>
       <td>PECL mongodb 1.6.0</td>
       <td>
        El parámetro <code class="parameter">newObj</code> acepta ahora una pipeline
        de agregación. Esta funcionalidad requiere MongoDB 4.2+ y causará una
        excepción en el momento de la ejecución si se especifica para una versión de servidor
        más antigua.
       </td>
      </tr>

      <tr>
       <td>PECL mongodb 1.5.0</td>
       <td>
        Utilizar la opción <code class="literal">&quot;arrayFilters&quot;</code> causará una excepción
        en el momento de la ejecución si no es soportada por el servidor. Anteriormente, ninguna excepción era lanzada y la opción podía ser ignorada.
       </td>
      </tr>

      <tr>
       <td>PECL mongodb 1.4.0</td>
       <td>
        Adición de la opción <code class="literal">&quot;arrayFilters&quot;</code>.
       </td>
      </tr>

      <tr>
       <td>PECL mongodb 1.2.0</td>
       <td>
        Adición de la opción <code class="literal">&quot;collation&quot;</code>.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-mongodb-driver-bulkwrite.update-examples">
  <h3 class="title">Ejemplos</h3>
  <div class="example" id="example-1">
   <p><strong>Ejemplo #1 Ejemplo de <span class="function"><strong>MongoDB\Driver\BulkWrite::update()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$bulk </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB\Driver\BulkWrite</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$bulk</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">update</span><span style="color: #007700">(<br />    [</span><span style="color: #DD0000">'x' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">2</span><span style="color: #007700">],<br />    [</span><span style="color: #DD0000">'$set' </span><span style="color: #007700">=&gt; [</span><span style="color: #DD0000">'y' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">3</span><span style="color: #007700">]],<br />    [</span><span style="color: #DD0000">'multi' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #DD0000">'upsert' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">false</span><span style="color: #007700">]<br />);<br /><br /></span><span style="color: #0000BB">$manager </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB\Driver\Manager</span><span style="color: #007700">(</span><span style="color: #DD0000">'mongodb://localhost:27017'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$manager</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">executeBulkWrite</span><span style="color: #007700">(</span><span style="color: #DD0000">'db.collection'</span><span style="color: #007700">, </span><span style="color: #0000BB">$bulk</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-mongodb-driver-bulkwrite.update-seealso">
  <h3 class="title">Ver también</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="mongodb-driver-manager.executebulkwrite.php" class="methodname" rel="rdfs-seeAlso">MongoDB\Driver\Manager::executeBulkWrite()</a> - Ejecuta una o varias operaciones de escritura</span></li>
   <li><span class="classname"><a href="class.mongodb-driver-writeresult.php" class="classname">MongoDB\Driver\WriteResult</a></span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>