MongoDB\Driver\Manager::executeCommand

(mongodb >=0.2.0)

MongoDB\Driver\Manager::executeCommand — Execute a MongoDB database command

Descripción

final public MongoDB\Driver\Cursor MongoDB\Driver\Manager::executeCommand ( string $db , MongoDB\Driver\Command $command [, MongoDB\Driver\ReadPreference $readPreference ] )

Executes command on a MongoDB server matching readPreference.

Parámetros

db: The name of the database on which to execute the command.
command: The command document.
readPreference: Opcionalmente, un MongoDB\Driver\ReadPreference a donde redireccionar el comando. Si no se proporciona, se empleará el valor de la Preferencia de lectura establcecida por el URI de conexión de MongoDB.

Valores devueltos

Returns MongoDB\Driver\Cursor on success, lanza una excepción (instanceof MongoDB\Driver\Exception) en caso de fallo.

Errores/Excepciones

Lanza una MongoDB\Driver\AuthenticationException si se requiere autenticación y esta falla
Lanza una MongoDB\Driver\ConnectionException si la conexión al servidor falla por otras razones razones de autentiación
Lanza una MongoDB\Driver\DuplicateKeyException si una escritura causa un error de Clave duplicada
Lanza una MongoDB\Driver\WriteException on Write Error
Lanza una MongoDB\Driver\WriteConcernException en caso de fallo de un Asunto de escritura
Throws MongoDB\Driver\RuntimeException on other errors (invalid command, command arguments, ...)

Ejemplos

Ejemplo #1 MongoDB\Driver\Manager::executeCommand() example


<?php

$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017");
$command = new MongoDB\Driver\Command(array("ping" => 1));

try {
    $cursor = $manager->executeCommand("admin", $command);
    $response = $cursor->toArray()[0];
} catch(MongoDB\Driver\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}
var_dump($response);

?>

El resultado del ejemplo sería algo similar a:


array(1) {
  ["ok"]=>
  float(1)
}

Notas

Nota:
For write commands, MongoDB\Driver\WriteConcern is included in the command document itself.

Nota:
If a secondary readPreference is used, it is the caller's responsibility to ensure that the command can be executed on a secondary. No validation is done by the driver.