PHP: MongoDB\Driver\Manager::executeCommand

Descrierea

final public MongoDB\Driver\Manager::executeCommand ( string $db , MongoDB\Driver\Command $command , array $options = array() ) : MongoDB\Driver\Cursor

Selects a server according to the "readPreference" option and executes the command on that server. By default, the read preference from the MongoDB Connection URI will be used.

This method applies no special logic to the command. Although this method accepts "readConcern" and "writeConcern" options, which will be incorporated into the command document, those options will not default to corresponding values from the MongoDB Connection URI nor will the MongoDB server version be taken into account. Users are therefore encouraged to use specific read and/or write command methods if possible.

Parametri

db (string)

Denumirea bazei de date asupra căreia va fi executată comanda.

command (MongoDB\Driver\Command)

Comanda spre a fi executată.

options

**options**
Option	Type	Description
readConcern	MongoDB\Driver\ReadConcern	O preocupare de citire pentru a fi aplicată operațiunii. Această opțiune este disponibilă în MongoDB 3.2+ și va rezulta într-o excepție în timpul execuției dacă e specificată pentru o versiune mai veche a serverului.
readPreference	MongoDB\Driver\ReadPreference	Preferința de citire pentru a fi folosită la selectarea serverului pentru operațiune.
session	MongoDB\Driver\Session	O sesiune pentru a fi asociată cu operațiunea.
writeConcern	MongoDB\Driver\WriteConcern	O preocupare de înscriere pentru a fi aplicată operațiunii.

Avertizare

Dacă utilizați un "session" care are o tranzacție în desfășurare, nu puteți specifica opțiunile "readConcern" sau "writeConcern". Aceasta va rezulta în emiterea unei excepții MongoDB\Driver\Exception\InvalidArgumentException. În loc, trebuie să stabiliți aceste două opțiuni când creați tranzacția cu MongoDB\Driver\Session::startTransaction().

Valorile întoarse

Întoarce MongoDB\Driver\Cursor în caz de succes.

Erori/Excepții

Emite MongoDB\Driver\Exception\InvalidArgumentException dacă opțiunea "session" este utilizată cu o tranzacție asociată, în combinație cu o opțiune "readConcern" sau "writeConcern".
Emite MongoDB\Driver\Exception\InvalidArgumentException dacă opțiunea "session" este utilizată în combinație cu o preocupare de înscriere neconfirmată.
Emite MongoDB\Driver\Exception\InvalidArgumentException în cazul erorilor la interpretarea argumentelor.
Emite MongoDB\Driver\Exception\ConnectionException dacă conexiunea către server eșuează (din alte motive decât autentificarea).
Emite MongoDB\Driver\Exception\AuthenticationException dacă este necesară autentificare și aceasta eșuează.
Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command, issuing a write command to a secondary).

Istoricul schimbărilor

Versiune	Descriere
PECL mongodb 1.4.4	MongoDB\Driver\Exception\InvalidArgumentException will be thrown if the `"session"` option is used in combination with an unacknowledged write concern.
PECL mongodb 1.4.0	The third parameter is now an `options` array. For backwards compatibility, this paramater will still accept a MongoDB\Driver\ReadPreference object.

Exemple

Example #1 MongoDB\Driver\Manager::executeCommand() with a command returning a single result document


<?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;
}

/* The ping command returns a single result document, so we need to access the
 * first result in the cursor. */
$response = $cursor->toArray()[0];

var_dump($response);

?>

Exemplul de mai sus va afișa:

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

Example #2 MongoDB\Driver\Manager::executeCommand() with a command returning a 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);

/* The aggregate command can optionally return its results in a cursor instead
 * of a single result document. In this case, we can iterate on the cursor
 * directly to access those results. */
foreach ($cursor as $document) {
    var_dump($document);
}

?>

Exemplul de mai sus va afișa:

object(stdClass)#6 (2) {
  ["_id"]=>
  string(3) "bar"
  ["sum"]=>
  int(10)
}
object(stdClass)#7 (2) {
  ["_id"]=>
  string(3) "foo"
  ["sum"]=>
  int(2)
}

Example #3 Limiting execution time for a command

The execution time of a command may be limited by specifying a value for "maxTimeMS" in the MongoDB\Driver\Command document. Note that this time limit is enforced on the server side and does not take network latency into account. See » Terminate Running Operations in the MongoDB manual for more information.


<?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]);

?>

If the command fails to complete after one second of execution time on the server, a MongoDB\Driver\Exception\ExecutionTimeoutException will be thrown.

Note

Notă: 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.

A se vedea și

MongoDB\Driver\Command
MongoDB\Driver\Cursor
MongoDB\Driver\Manager::executeReadCommand() - Execute a database command that reads
MongoDB\Driver\Manager::executeReadWriteCommand() - Execute a database command that reads and writes
MongoDB\Driver\Manager::executeWriteCommand() - Execute a database command that writes
MongoDB\Driver\Server::executeCommand() - Execute a database command on this server

MongoDB\Driver\Manager::executeCommand