<?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-manager.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'mongodb-driver-manager.startsession.php',
    1 => 'MongoDB\\Driver\\Manager::startSession',
    2 => 'Inicia uma nova sess&atilde;o de cliente para uso com este cliente',
  ),
  'up' => 
  array (
    0 => 'class.mongodb-driver-manager.php',
    1 => 'MongoDB\\Driver\\Manager',
  ),
  'prev' => 
  array (
    0 => 'mongodb-driver-manager.selectserver.php',
    1 => 'MongoDB\\Driver\\Manager::selectServer',
  ),
  'next' => 
  array (
    0 => 'class.mongodb-driver-command.php',
    1 => 'MongoDB\\Driver\\Command',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/mongodb/mongodb/driver/manager/startsession.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="mongodb-driver-manager.startsession" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">MongoDB\Driver\Manager::startSession</h1>
  <p class="verinfo">(mongodb &gt;=1.4.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\Manager::startSession</span> &mdash; <span class="dc-title">Inicia uma nova sessão de cliente para uso com este cliente</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mongodb-driver-manager.startsession-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><strong>MongoDB\Driver\Manager::startSession</strong></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">$options</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><a href="class.mongodb-driver-session.php" class="type MongoDB\Driver\Session">MongoDB\Driver\Session</a></span></div>

  <p class="para rdfs-comment">
   Cria um objeto <span class="classname"><a href="class.mongodb-driver-session.php" class="classname">MongoDB\Driver\Session</a></span> para as opções
   fornecidas. A sessão pode então ser especificada ao executar comandos, consultas
   e operações de gravação.
  </p>
  <blockquote class="note"><p><strong class="note">Nota</strong>: 
   <span class="simpara">
    Um <span class="classname"><a href="class.mongodb-driver-session.php" class="classname">MongoDB\Driver\Session</a></span> só pode ser usado com o
    <span class="classname"><a href="class.mongodb-driver-manager.php" class="classname">MongoDB\Driver\Manager</a></span> a partir do qual foi criado.
   </span>
  </p></blockquote>
 </div>


 <div class="refsect1 parameters" id="refsect1-mongodb-driver-manager.startsession-parameters">
  <h3 class="title">Parâmetros</h3>
  <dl>
   
    <dt><code class="parameter">options</code></dt>
    <dd>
     <p class="para">
      <table class="doctable table">
       <caption><strong>Opções</strong></caption>
       
        <thead>
         <tr>
          <th>Opção</th>
          <th>Tipo</th>
          <th>Descrição</th>
          <th>Default</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td>causalConsistency</td>
          <td><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></td>
          <td>
           <p class="para">
            Configura a consistência causal em uma sessão. Se <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>, cada operação
            na sessão será ordenada causalmente após a operação anterior de leitura ou
            gravação. Se definido como <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, desativa a consistência causal.
           </p>
           <p class="para">
            Consulte
            <a href="https://www.mongodb.com/docs/manual/core/read-isolation-consistency-recency/#causal-consistency" class="link external">&raquo;&nbsp;Consistência Causal</a>
            no manual do MongoDB para obter mais informações.
           </p>
          </td>
          <td><strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong></td>
         </tr>

         <tr>
          <td>defaultTransactionOptions</td>
          <td><span class="type"><a href="language.types.array.php" class="type array">array</a></span></td>
          <td>
           <p class="para">
            Opções padrão a serem aplicadas a transações recém-criadas. Estas
            opções são utilizadas a menos que sejam substituídas quando uma transação é
            iniciada com valores diferentes para cada opção.
           </p>
           <p class="para">
            <table class="doctable table">
             <caption><strong>Opções</strong></caption>
             
              <thead>
               <tr>
                <th>Opção</th>
                <th>Tipo</th>
                <th>Descrição</th>
               </tr>

              </thead>

              <tbody class="tbody">
               
         <tr>
          <td>maxCommitTimeMS</td>
          <td>integer</td>
          <td>
           <p class="para">
            A quantidade máxima de tempo em milissegundos para permitir que um único
            comando <code class="literal">commitTransaction</code> seja executado.
           </p>
           <p class="para">
            Se especificada, <code class="literal">maxCommitTimeMS</code> deve ser um inteiro
            de 32 bits com sinal com valor maior ou igual a zero.
           </p>
          </td>
         </tr>


               
         <tr>
          <td>readConcern</td>
          <td><span class="classname"><a href="class.mongodb-driver-readconcern.php" class="classname">MongoDB\Driver\ReadConcern</a></span></td>
          <td>
           <p class="para">
            Um read concern a ser aplicado à operação.
           </p>
           <p class="para">
            Esta opção está disponível no MongoDB 3.2+ e resultará em uma
            exceção em tempo de execução se for especificada para uma versão de servidor
            mais antiga.
           </p>
          </td>
         </tr>


               
         <tr>
          <td>readPreference</td>
          <td><span class="classname"><a href="class.mongodb-driver-readpreference.php" class="classname">MongoDB\Driver\ReadPreference</a></span></td>
          <td>
           <p class="para">
            Uma preferência de leitura a ser usada para selecionar um servidor para a operação.
           </p>
          </td>
         </tr>


               
         <tr>
          <td>writeConcern</td>
          <td><span class="classname"><a href="class.mongodb-driver-writeconcern.php" class="classname">MongoDB\Driver\WriteConcern</a></span></td>
          <td>
           <p class="para">
            Um write concern a ser aplicado à operação.
           </p>
          </td>
         </tr>


              </tbody>
             
            </table>

           </p>
           <p class="para">
            Esta opção está disponível no MongoDB 4.0+.
           </p>
          </td>
          <td><code class="literal">[]</code></td>
         </tr>

         <tr>
          <td>snapshot</td>
          <td><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></td>
          <td>
           <p class="para">
            Configure leituras de instantâneos em uma sessão. Se <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>, um timestamp
            será obtido da primeira operação de leitura suportada na sessão
            (ou seja, <code class="literal">find</code>, <code class="literal">aggregate</code> ou
            <code class="literal">distinct</code> não fragmentado). As operações de leitura
            subsequentes dentro da sessão utilizarão um nível de preocupação de leitura
            <code class="literal">&quot;snapshot&quot;</code> (instantâneo) para ler os dados confirmados pela maioria daquele
            timestamp. Se definido como <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, desativa leituras de instantâneos.
           </p>
           <p class="para">
            As leituras de instantâneo requerem MongoDB 5.0+ e não podem ser usadas
            com consistência causal, transações ou operações de gravação. Se
            <code class="literal">&quot;snapshot&quot;</code> for <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>,
            <code class="literal">&quot;causalConsistency&quot;</code> será padronizado como <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
           </p>
           <p class="para">
            Consulte
            <a href="https://www.mongodb.com/docs/manual/reference/read-concern-snapshot/#read-concern-and-atclustertime" class="link external">&raquo;&nbsp;Preocupação de Leitura &quot;snapshot&quot;</a>
            no manual do MongoDB para obter mais informações.
           </p>
          </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-manager.startsession-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Retorna um <span class="classname"><a href="class.mongodb-driver-session.php" class="classname">MongoDB\Driver\Session</a></span>.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-mongodb-driver-manager.startsession-errors">
  <h3 class="title">Erros/Exceções</h3>
  <ul class="simplelist">
   <li>Lança uma exceção <span class="classname"><a href="class.mongodb-driver-exception-invalidargumentexception.php" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a></span> em caso de erro ao analisar argumentos.</li>
   <li>Lança <span class="classname"><a href="class.mongodb-driver-exception-invalidargumentexception.php" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a></span> se as opções <code class="literal">&quot;causalConsistency&quot;</code> e <code class="literal">&quot;snapshot&quot;</code> forem ambas <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>.</li>
   <li>Lança <span class="classname"><a href="class.mongodb-driver-exception-runtimeexception.php" class="classname">MongoDB\Driver\Exception\RuntimeException</a></span> se a sessão não puder ser criada (ex.: libmongoc não suporta criptografia).</li>
  </ul>
 </div>


 <div class="refsect1 changelog" id="refsect1-mongodb-driver-manager.startsession-changelog">
  <h3 class="title">Registro de Alterações</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Versão</th>
       <th>Descrição</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>PECL mongodb 1.11.0</td>
       <td>
        <p class="para">
         A opção <code class="literal">&quot;snapshot&quot;</code> foi adicionada.
        </p>
       </td>
      </tr>

      <tr>
       <td>PECL mongodb 1.6.0</td>
       <td>
        <p class="para">
         A opção <code class="literal">&quot;maxCommitTimeMS&quot;</code> foi adicionada a
         <code class="literal">&quot;defaultTransactionOptions&quot;</code>.
        </p>
       </td>
      </tr>

      <tr>
       <td>PECL mongodb 1.5.0</td>
       <td>
        <p class="para">
         A opção <code class="literal">&quot;defaultTransactionOptions&quot;</code> foi adicionada.
        </p>
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-mongodb-driver-manager.startsession-seealso">
  <h3 class="title">Veja Também</h3>
  <ul class="simplelist">
   <li><span class="classname"><a href="class.mongodb-driver-session.php" class="classname">MongoDB\Driver\Session</a></span></li>
   <li><a href="https://www.mongodb.com/docs/manual/core/read-isolation-consistency-recency/#causal-consistency" class="link external">&raquo;&nbsp;Consistência Causal</a> no manual do MongoDB</li>
  </ul>
 </div>


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