<?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-server.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'mongodb-driver-server.executecommand.php',
    1 => 'MongoDB\\Driver\\Server::executeCommand',
    2 => 'Executa um comando de banco de dados neste servidor',
  ),
  'up' => 
  array (
    0 => 'class.mongodb-driver-server.php',
    1 => 'MongoDB\\Driver\\Server',
  ),
  'prev' => 
  array (
    0 => 'mongodb-driver-server.executebulkwritecommand.php',
    1 => 'MongoDB\\Driver\\Server::executeBulkWriteCommand',
  ),
  'next' => 
  array (
    0 => 'mongodb-driver-server.executequery.php',
    1 => 'MongoDB\\Driver\\Server::executeQuery',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/mongodb/mongodb/driver/server/executecommand.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="mongodb-driver-server.executecommand" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">MongoDB\Driver\Server::executeCommand</h1>
  <p class="verinfo">(mongodb &gt;=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\Server::executeCommand</span> &mdash; <span class="dc-title">Executa um comando de banco de dados neste servidor</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mongodb-driver-server.executecommand-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\Server::executeCommand</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$db</code></span>, <span class="methodparam"><span class="type"><a href="class.mongodb-driver-command.php" class="type MongoDB\Driver\Command">MongoDB\Driver\Command</a></span> <code class="parameter">$command</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">$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-cursor.php" class="type MongoDB\Driver\Cursor">MongoDB\Driver\Cursor</a></span></div>

  <p class="para rdfs-comment">
   Executa o comando neste servidor.
  </p>
  <p class="para">
   Este método não aplica nenhuma lógica especial ao comando. Os
   valores padrão para as opções <code class="literal">&quot;readPreference&quot;</code>,
   <code class="literal">&quot;readConcern&quot;</code> e <code class="literal">&quot;writeConcern&quot;</code>
   serão inferidos de uma transação ativa (indicada pela
   opção <code class="literal">&quot;session&quot;</code>). Se não houver nenhuma transação ativa, uma
   preferência de leitura primária será usada para seleção do servidor.
  </p>
  <p class="para">
   Os valores padrão <em>não</em> serão inferidos do
   <a href="mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-uri" class="link">URI de conexão</a>.
   Os usuários são, portanto, incentivados a usar métodos de comando específicos
   de leitura e/ou gravação, se possível.
  </p>
  
  <blockquote class="note"><p><strong class="note">Nota</strong>: 
   <span class="simpara">
    A opção <code class="literal">&quot;readPreference&quot;</code> não controla o servidor
    ao qual o driver emite a operação; ela sempre será executada
    neste objeto servidor. Em vez disso, ela pode ser usada ao emitir a operação para um
    servidor secundário (de uma conexão de conjunto de réplicas, não autônomas) ou nós mongo para
    garantir que o driver defina o protocolo de conexão de acordo ou adicione a
    preferência de leitura à operação, respectivamente.
   </span>
  </p></blockquote>

 </div>


 <div class="refsect1 parameters" id="refsect1-mongodb-driver-server.executecommand-parameters">
  <h3 class="title">Parâmetros</h3>
  <dl>
   
   
    <dt><code class="parameter">db</code> (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)</dt>
    <dd>
     <p class="para">
      O nome do banco de dados no qual executar o comando.
     </p>
    </dd>
   

   
   
    <dt><code class="parameter">command</code> (<span class="classname"><a href="class.mongodb-driver-command.php" class="classname">MongoDB\Driver\Command</a></span>)</dt>
    <dd>
     <p class="para">
      O comando a ser executado.
     </p>
    </dd>
   

   
    <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>
         </tr>

        </thead>

        <tbody class="tbody">
         
         <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>session</td>
          <td><span class="classname"><a href="class.mongodb-driver-session.php" class="classname">MongoDB\Driver\Session</a></span></td>
          <td>
           <p class="para">
            Uma sessão para associar à 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>
     
     <div class="warning"><strong class="warning">Aviso</strong>
      <p class="para">
       Se uma <code class="literal">&quot;session&quot;</code> que tem uma transação em andamento
       estiver sendo usada, uma opção <code class="literal">&quot;readConcern&quot;</code> ou
       <code class="literal">&quot;writeConcern&quot;</code> não pode ser especificada. Isso resultará em uma
       exceção <span class="classname"><a href="class.mongodb-driver-exception-invalidargumentexception.php" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a></span>
       sendo lançada. Em vez disso, essas duas opções devem ser definidas ao criar
       a transação com
       <span class="methodname"><a href="mongodb-driver-session.starttransaction.php" class="methodname">MongoDB\Driver\Session::startTransaction()</a></span>.
      </p>
     </div>

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


 <div class="refsect1 returnvalues" id="refsect1-mongodb-driver-server.executecommand-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">Retorna <span class="classname"><a href="class.mongodb-driver-cursor.php" class="classname">MongoDB\Driver\Cursor</a></span> em caso de sucesso.</p>
 </div>


 <div class="refsect1 errors" id="refsect1-mongodb-driver-server.executecommand-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> se a opção <code class="literal">&quot;session&quot;</code> for usada com uma transação associada em combinação com uma opção <code class="literal">&quot;readConcern&quot;</code> ou <code class="literal">&quot;writeConcern&quot;</code>.</li>
   <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> se a opção <code class="literal">&quot;session&quot;</code> for usada em combinação com uma preocupação de escrita não confirmada.</li>
   <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 uma exceção <span class="classname"><a href="class.mongodb-driver-exception-connectionexception.php" class="classname">MongoDB\Driver\Exception\ConnectionException</a></span> se a conexão com o servidor falhar (por outros motivos além da autenticação).</li><li>Lança uma exceção <span class="classname"><a href="class.mongodb-driver-exception-authenticationexception.php" class="classname">MongoDB\Driver\Exception\AuthenticationException</a></span> se a autenticação for necessária e falhar.</li>
   <li>Lança uma <span class="classname"><a href="class.mongodb-driver-exception-runtimeexception.php" class="classname">MongoDB\Driver\Exception\RuntimeException</a></span> em outros erros (por exemplo, comando inválido, emissão de um comando de gravação para um secundário).</li>
  </ul>
 </div>


 <div class="refsect1 changelog" id="refsect1-mongodb-driver-server.executecommand-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 2.0.0</td>
       <td>
        O parâmetro <code class="parameter">options</code> não aceita mais uma instância de
        <span class="classname"><a href="class.mongodb-driver-readpreference.php" class="classname">MongoDB\Driver\ReadPreference</a></span>.
       </td>
      </tr>

      <tr>
       <td>PECL mongodb 1.21.0</td>
       <td>
        Passar um objeto <span class="classname"><a href="class.mongodb-driver-readpreference.php" class="classname">MongoDB\Driver\ReadPreference</a></span> como
        <code class="parameter">options</code> foi descontinuado e será removido na versão 2.0.
       </td>
      </tr>

      <tr>
       <td>PECL mongodb 1.4.4</td>
       <td>
        <span class="classname"><a href="class.mongodb-driver-exception-invalidargumentexception.php" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a></span>
        será lançada se a opção <code class="literal">&quot;session&quot;</code> for usada em
        combinação com uma preocupação de gravação não reconhecida.
       </td>
      </tr>

      <tr>
       <td>PECL mongodb 1.4.0</td>
       <td>
        O terceiro parâmetro agora é um array <code class="parameter">options</code>.
        Para compatibilidade com versões anteriores, esse parâmetro ainda aceitará
        um objeto <span class="classname"><a href="class.mongodb-driver-readpreference.php" class="classname">MongoDB\Driver\ReadPreference</a></span>.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-mongodb-driver-server.executecommand-notes">
  <h3 class="title">Notas</h3>
  
  <blockquote class="note"><p><strong class="note">Nota</strong>: 
   <span class="simpara">
    É responsabilidade do invocador garantir que o servidor seja capaz
    de executar a operação de escrita. Por exemplo, executar uma operação de escrita
    em um servidor secundário (excluindo seu banco de dados &quot;local&quot;) falhará.
   </span>
  </p></blockquote>

 </div>


 <div class="refsect1 seealso" id="refsect1-mongodb-driver-server.executecommand-seealso">
  <h3 class="title">Veja Também</h3>
  <ul class="simplelist">
   <li><span class="classname"><a href="class.mongodb-driver-command.php" class="classname">MongoDB\Driver\Command</a></span></li>
   <li><span class="classname"><a href="class.mongodb-driver-cursor.php" class="classname">MongoDB\Driver\Cursor</a></span></li>
   <li><span class="function"><a href="mongodb-driver-server.executereadcommand.php" class="function" rel="rdfs-seeAlso">MongoDB\Driver\Server::executeReadCommand()</a> - Executa um comando de banco de dados que l&ecirc; neste servidor</span></li>
   <li><span class="function"><a href="mongodb-driver-server.executereadwritecommand.php" class="function" rel="rdfs-seeAlso">MongoDB\Driver\Server::executeReadWriteCommand()</a> - Executa um comando de banco de dados que l&ecirc; e grava neste servidor</span></li>
   <li><span class="function"><a href="mongodb-driver-server.executewritecommand.php" class="function" rel="rdfs-seeAlso">MongoDB\Driver\Server::executeWriteCommand()</a> - Executa um comando de banco de dados que grava neste servidor</span></li>
   <li><span class="function"><a href="mongodb-driver-manager.executecommand.php" class="function" rel="rdfs-seeAlso">MongoDB\Driver\Manager::executeCommand()</a> - Executa um comando de banco de dados</span></li>
  </ul>
 </div>


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