MongoDB\Driver\Server::executeCommand
(mongodb >=1.0.0)
MongoDB\Driver\Server::executeCommand — Execute a database command on this server
Descrição
$db, MongoDB\Driver\Command $command, array|MongoDB\Driver\ReadPreference|null $options = null): MongoDB\Driver\CursorExecutes 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.
Nota: A opção
"readPreference"não controla o servidor ao qual o driver emite a operação; ela sempre será executada neste objeto servidor. Em vez disso, ela pode ser usada ao emitir a operação para um servidor secundário (de uma conexão de conjunto de réplicas, não autônomas) ou nós mongo para garantir que o driver defina o protocolo de conexão de acordo ou adicione a preferência de leitura à operação, respectivamente.
Parâmetros
-
db(string) -
O nome do banco de dados no qual executar o comando.
-
command(MongoDB\Driver\Command) -
O comando a ser executado.
-
options -
options Option Type Description 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.
AvisoSe 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().
Valor Retornado
Retorna MongoDB\Driver\Cursor em caso de sucesso.
Erros/Exceções
- Lança uma exceção MongoDB\Driver\Exception\InvalidArgumentException se a opção
"session"for usada com uma transação associada em combinação com uma opção"readConcern"ou"writeConcern". - Lança uma exceção MongoDB\Driver\Exception\InvalidArgumentException se a opção
"session"for usada em combinação com um write concern não confirmado. - Lança uma exceção MongoDB\Driver\Exception\InvalidArgumentException em caso de erro ao analisar argumentos.
- Lança uma exceção MongoDB\Driver\Exception\ConnectionException se a conexão com o servidor falhar (por outros motivos além da autenticação).
- Lança uma exceção MongoDB\Driver\Exception\AuthenticationException se a autenticação for necessária e falhar.
- Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command, issuing a write command to a secondary).
Registro de Alterações
| Versão | Descrição |
|---|---|
| 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.
|
Notas
Nota: É responsabilidade do invocador garantir que o servidor seja capaz de executar a operação de escrita. Por exemplo, executar uma operação de escrita em um servidor secundário (excluindo seu banco de dados "local") falhará.
Veja Também
- 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
add a note
