<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.mysql-xdevapi-collection.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'fr',
  ),
  'this' => 
  array (
    0 => 'mysql-xdevapi-collection.add.php',
    1 => 'Collection::add',
    2 => 'Ajoute un document &agrave; la collection',
  ),
  'up' => 
  array (
    0 => 'class.mysql-xdevapi-collection.php',
    1 => 'mysql_xdevapi\\Collection',
  ),
  'prev' => 
  array (
    0 => 'class.mysql-xdevapi-collection.php',
    1 => 'mysql_xdevapi\\Collection',
  ),
  'next' => 
  array (
    0 => 'mysql-xdevapi-collection.addorreplaceone.php',
    1 => 'Collection::addOrReplaceOne',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'fr',
    'path' => 'reference/mysql_xdevapi/mysql_xdevapi/collection/add.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="mysql-xdevapi-collection.add" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Collection::add</h1>
  <p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">Collection::add</span> &mdash; <span class="dc-title">Ajoute un document à la collection</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mysql-xdevapi-collection.add-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>mysql_xdevapi\Collection::add</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$document</code></span>): <span class="type"><a href="class.mysql-xdevapi-collectionadd.php" class="type mysql_xdevapi\CollectionAdd">mysql_xdevapi\CollectionAdd</a></span></div>

  <p class="para rdfs-comment">
   Déclenche l&#039;insertion du ou des documents donnés dans la collection, et
   plusieurs variantes de cette méthode sont prises en charge. Les options incluent :
  </p>
  <ol type="1">
   <li class="listitem">
     <p class="para">
      Ajouter un seul document sous forme de chaîne JSON.
     </p>
   </li>
   <li class="listitem">
     <p class="para">
      Ajouter un seul document sous forme de tableau comme :
      <code class="literal">[ &#039;field&#039; =&gt; &#039;value&#039;, &#039;field2&#039; =&gt; &#039;value2&#039; ... ]</code>
    </p>
   </li>
   <li class="listitem">
    <p class="para">
      Un mélange des deux, et plusieurs documents peuvent être ajoutés dans la même opération.
    </p>
   </li>
  </ol>
 </div>


 <div class="refsect1 parameters" id="refsect1-mysql-xdevapi-collection.add-parameters">
  <h3 class="title">Liste de paramètres</h3>
  <dl>
   
    <dt><code class="parameter">document</code></dt>
    <dd>
     <p class="para">
      Un ou plusieurs documents, et cela peut être soit du JSON ou un tableau de champs avec
      leurs valeurs associées. Cela ne peut pas être un tableau vide.
     </p>
     <p class="para">
      Le serveur MySQL génère automatiquement des valeurs <code class="literal">_id</code> uniques pour
      chaque document (recommandé), bien que cela puisse également être ajouté manuellement. Cette
      valeur doit être unique, sinon l&#039;opération d&#039;ajout échouera.
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-mysql-xdevapi-collection.add-returnvalues">
  <h3 class="title">Valeurs de retour</h3>
  <p class="para">
   Une collection d&#039;objets, Utiliser execute() pour retourner un résultat qui peut être utilisé pour
   interroger le nombre d&#039;éléments affectés, le nombre d&#039;avertissements générés par l&#039;opération, ou pour
   récupérer une liste d&#039;identifiants générés pour les documents insérés.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-mysql-xdevapi-collection.add-examples">
  <h3 class="title">Exemples</h3>
  <div class="example" id="example-1">
   <p><strong>Exemple #1 Exemple de <span class="function"><strong>mysql_xdevapi\Collection::add()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$session </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_xdevapi\getSession</span><span style="color: #007700">(</span><span style="color: #DD0000">"mysqlx://user:password@localhost"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"DROP DATABASE IF EXISTS addressbook"</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"CREATE DATABASE addressbook"</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$schema </span><span style="color: #007700">= </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getSchema</span><span style="color: #007700">(</span><span style="color: #DD0000">"addressbook"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$create </span><span style="color: #007700">= </span><span style="color: #0000BB">$schema</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">createCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"people"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$collection </span><span style="color: #007700">= </span><span style="color: #0000BB">$schema</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"people"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Ajoute deux documents<br /></span><span style="color: #0000BB">$collection</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">'{"name": "Fred",  "age": 21, "job": "Construction"}'</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$collection</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">'{"name": "Wilma", "age": 23, "job": "Teacher"}'</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// Ajoute deux documents en utilisant un seul objet JSON<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$collection</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">add</span><span style="color: #007700">(<br />  </span><span style="color: #DD0000">'{"name": "Bernie",<br />    "jobs": [{"title":"Cat Herder","Salary":42000}, {"title":"Father","Salary":0}],<br />    "hobbies": ["Sports","Making cupcakes"]}'</span><span style="color: #007700">,<br />  </span><span style="color: #DD0000">'{"name": "Jane",<br />    "jobs": [{"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0}],<br />    "hobbies": ["Walking","Making pies"]}'</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// Récupère une liste d'identifiants générés à partir du dernier add()<br /></span><span style="color: #0000BB">$ids </span><span style="color: #007700">= </span><span style="color: #0000BB">$result</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getGeneratedIds</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$ids</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>Résultat de l&#039;exemple ci-dessus est similaire à :</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Array
(
    [0] =&gt; 00005b6b53610000000000000056
    [1] =&gt; 00005b6b53610000000000000057
)</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 notes" id="refsect1-mysql-xdevapi-collection.add-notes">
  <h3 class="title">Notes</h3>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    Un identifiant unique _id est généré par MySQL Server 8.0 ou supérieur, comme démontré
    dans l&#039;exemple. Le champ _id doit être défini manuellement si on utilise
    MySQL Server 5.7.
   </p>
  </p></blockquote>
 </div>


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