MongoDB\Driver\Server::executeCommand

(mongodb >=1.0.0)

MongoDB\Driver\Server::executeCommandExecute a database command on this server

Опис

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. The Default values for the "readPreference", "readConcern", and "writeConcern" options will be inferred from an active transaction (indicated by the "session" option). If there is no active transaction, a primary read preference will be used for server selection.

Default values will not be inferred from the connection URI. Users are therefore encouraged to use specific read and/or write command methods if possible.

Зауваження: Параметр "readPreference" впливає не на сервер, котрому драйвер дає команду, а тільки на об'єкт сервера. Натомість, під час надсилання драйвером команди, цей параметр може забезпечувати відповідний мережевий протокол для другорядного вузла з набору реплік, а також встановлювати вимоги щодо читання для mongo-вузла.

Параметри

db (string)

Назва бази даних, в якій буде виконано команду.

command (MongoDB\Driver\Command)

Команда, яку потрібно виконати.

options

options
Option Type Description
readConcern MongoDB\Driver\ReadConcern

Вимога щодо зчитування.

Цей параметр доступний в MongoDB 3.2+, тож його застосування у старіших версіях викине виключення під час виконання.

readPreference MongoDB\Driver\ReadPreference

Параметр читання для вибору сервера для операції.

session MongoDB\Driver\Session

Сеанс, по'язаний з операцією.

writeConcern MongoDB\Driver\WriteConcern

Вимога щодо запису.

Увага

Для сеансу ("session") транзакції, яка триває, не можна задати параметр "readConcern" або "writeConcern". Це призведе до викидання виключення MongoDB\Driver\Exception\InvalidArgumentException. Ці два параметри потрібно задавати під час створення транзакції методом MongoDB\Driver\Session::startTransaction().

Значення, що повертаються

У разі успіху повертає примірника MongoDB\Driver\Cursor.

Помилки/виключення

Журнал змін

Версія Опис
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.

Примітки

Зауваження: На програміста покладено роль визначити спроможність сервера виконувати операції запису. До прикладу, операція запису на другорядному вузлі (за винятком "локальної" БД) буде невдалою.

Прогляньте також

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top