(mongodb >=1.0.0)
MongoDB\Driver\Manager::executeCommand — Executa um comando de banco de dados
$db, MongoDB\Driver\Command $command, array|MongoDB\Driver\ReadPreference|null $options = null): MongoDB\Driver\Cursor
Seleciona um servidor de acordo com a opção "readPreference"
e executa o comando nesse servidor.
Este método não aplica nenhuma lógica especial ao comando. Os
valores padrão para as opções "readPreference",
"readConcern" e "writeConcern"
serão inferidos de uma transação ativa (indicada pelo opção
"session"). Se não houver nenhuma transação ativa, uma
preferência de leitura primária será usada para seleção do servidor.
Os valores padrão não serão inferidos do URI de conexão. Os usuários são, portanto, incentivados a usar métodos de comando específicos de leitura e/ou gravação, se possível.
db (string)O nome do banco de dados no qual executar o comando.
command (MongoDB\Driver\Command)O comando a ser executado.
options
| Opção | Tipo | Descrição |
|---|---|---|
| readConcern | MongoDB\Driver\ReadConcern |
Um read concern a ser aplicado à operação. 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. |
| readPreference | MongoDB\Driver\ReadPreference |
Uma preferência de leitura a ser usada para selecionar um servidor para a operação. |
| session | MongoDB\Driver\Session |
Uma sessão para associar à operação. |
| writeConcern | MongoDB\Driver\WriteConcern |
Um write concern a ser aplicado à operação. |
Se uma "session" que tem uma transação em andamento
estiver sendo usada, uma opção "readConcern" ou
"writeConcern" não pode ser especificada. Isso resultará em uma
exceção MongoDB\Driver\Exception\InvalidArgumentException
sendo lançada. Em vez disso, essas duas opções devem ser definidas ao criar
a transação com
MongoDB\Driver\Session::startTransaction().
Retorna MongoDB\Driver\Cursor em caso de sucesso.
"session" for usada com uma transação associada em combinação com uma opção "readConcern" ou "writeConcern"."session" for usada em combinação com um write concern não confirmado.
| Versão | Descrição |
|---|---|
| PECL mongodb 1.4.4 |
MongoDB\Driver\Exception\InvalidArgumentException
será lançado se a opção "session" for usada em
combinação com uma preocupação de gravação não reconhecida.
|
| PECL mongodb 1.4.0 |
O terceiro parâmetro agora é um array options.
Para compatibilidade com versões anteriores, este parâmetro ainda aceitará
um objeto MongoDB\Driver\ReadPreference.
|
Exemplo #1 MongoDB\Driver\Manager::executeCommand() com um comando retornando um único documento de resultado
<?php
$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017');
$command = new MongoDB\Driver\Command(['ping' => 1]);
try {
$cursor = $manager->executeCommand('admin', $command);
} catch(MongoDB\Driver\Exception $e) {
echo $e->getMessage(), "\n";
exit;
}
/* O comando ping retorna um único documento de resultado, portanto precisamos acessar
* o primeiro resultado no cursor. */
$response = $cursor->toArray()[0];
var_dump($response);
?>O exemplo acima produzirá:
array(1) {
["ok"]=>
float(1)
}
Exemplo #2 MongoDB\Driver\Manager::executeCommand() com um comando retornando um cursor
<?php
$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017");
$bulk = new MongoDB\Driver\BulkWrite;
$bulk->insert(['x' => 1, 'y' => 'foo']);
$bulk->insert(['x' => 2, 'y' => 'bar']);
$bulk->insert(['x' => 3, 'y' => 'bar']);
$manager->executeBulkWrite('db.collection', $bulk);
$command = new MongoDB\Driver\Command([
'aggregate' => 'collection',
'pipeline' => [
['$group' => ['_id' => '$y', 'sum' => ['$sum' => '$x']]],
],
'cursor' => new stdClass,
]);
$cursor = $manager->executeCommand('db', $command);
/* O comando agregado pode opcionalmente retornar seus resultados em um cursor em vez de
* em um único documento de resultados. Nesse caso, podemos iterar diretamente no cursor
* para acessar esses resultados. */
foreach ($cursor as $document) {
var_dump($document);
}
?>O exemplo acima produzirá:
object(stdClass)#6 (2) {
["_id"]=>
string(3) "bar"
["sum"]=>
int(10)
}
object(stdClass)#7 (2) {
["_id"]=>
string(3) "foo"
["sum"]=>
int(2)
}
Exemplo #3 Limitando o tempo de execução de um comando
O tempo de execução de um comando pode ser limitado especificando um valor para
"maxTimeMS" no
documento MongoDB\Driver\Command. Observe que esse limite
de tempo é aplicado no lado do servidor e não leva em consideração a latência da
rede. Consulte
» Encerrar Operações em Execução
no manual do MongoDB para obter mais informações.
<?php
$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017');
$command = new MongoDB\Driver\Command([
'count' => 'collection',
'query' => ['x' => ['$gt' => 1]],
'maxTimeMS' => 1000,
]);
$cursor = $manager->executeCommand('db', $command);
var_dump($cursor->toArray()[0]);
?>Se o comando não for concluído após um segundo de tempo de execução no servidor, um MongoDB\Driver\Exception\ExecutionTimeoutException será lançado.
Nota: Se um
readPreferencesecundário for usado, é responsabilidade do chamador garantir que ocommandpossa ser executado em um secundário. Nenhuma validação é feita pelo driver.
Nota: Este método não usa como padrão a preferência de leitura do URI de conexão do MongoDB. As aplicações que precisam desse comportamento devem considerar o uso de MongoDB\Driver\Manager::executeReadCommand().