PHP: MongoDB\Driver\Server::executeCommand

Beschreibung

final public MongoDB\Driver\Server::executeCommand(string $db, MongoDB\Driver\Command $command, array|MongoDB\Driver\ReadPreference|null $options = null): MongoDB\Driver\Cursor

Executes the command on this server.

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.

Hinweis: Die Option "readPreference" steuert nicht den Server, an den der Treiber die Operation ausgibt; sie wird immer auf diesem Serverobjekt ausgeführt. Stattdessen kann sie verwendet werden, wenn die Operation an einen sekundären Knoten (von einer Replikatsatzverbindung, keinen eigenständigen) oder einen Mongos-Knoten ausgegeben wird, um sicherzustellen, dass der Treiber das Übertragungsprotokoll entsprechend einstellt bzw. die Lesepräferenz zur Operation hinzufügt.

Parameter-Liste

db (string)

The name of the database on which to execute the command.

command (MongoDB\Driver\Command)

The command to execute.

options

**options**
Option	Type	Description
readConcern	MongoDB\Driver\ReadConcern	A read concern to apply to the operation. This option is available in MongoDB 3.2+ and will result in an exception at execution time if specified for an older server version.
readPreference	MongoDB\Driver\ReadPreference	A read preference to use for selecting a server for the operation.
session	MongoDB\Driver\Session	A session to associate with the operation.
writeConcern	MongoDB\Driver\WriteConcern	A write concern to apply to the operation.

Warnung

If you are using a "session" which has a transaction in progress, you cannot specify a "readConcern" or "writeConcern" option. This will result in an MongoDB\Driver\Exception\InvalidArgumentException being thrown. Instead, you should set these two options when you create the transaction with MongoDB\Driver\Session::startTransaction().

Rückgabewerte

Gibt bei Erfolg einen MongoDB\Driver\Cursor zurück.

Fehler/Exceptions

Wirft eine MongoDB\Driver\Exception\InvalidArgumentException, wenn die Option "session" mit einer zugehörigen Transaktion in Kombination mit einer der Optionen "readConcern" oder "writeConcern" verwendet wird.
Wirft eine MongoDB\Driver\Exception\InvalidArgumentException, wenn die Option "session" in Kombination mit einer unbestätigten Schreibanweisung verwendet wird.
Wirft eine MongoDB\Driver\Exception\InvalidArgumentException, wenn beim Analysieren von Argumenten ein Fehler auftritt.
Wirft eine MongoDB\Driver\Exception\ConnectionException, wenn der Aufbau einer Verbindung zum Server fehlschlägt (aus einem anderen Grund als der Authentifizierung).
Wirft eine MongoDB\Driver\Exception\AuthenticationException, wenn eine Authentifizierung erforderlich ist und fehlschlägt.
Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command, issuing a write command to a secondary).

Changelog

Version	Beschreibung
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.

Anmerkungen

Hinweis: Es liegt in der Verantwortung des aufrufenden Codes, sicherzustellen, dass der Server in der Lage ist, den Schreibvorgang auszuführen. So schlägt beispielsweise die Ausführung eines Schreibvorgangs auf einem sekundären Server (mit Ausnahme seiner "lokalen" Datenbank) fehl.

Siehe auch

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

MongoDB\Driver\Server::executeCommand