The MongoDB\Driver\Monitoring\CommandFailedEvent class

(mongodb >=1.3.0)

はじめに

The MongoDB\Driver\Monitoring\CommandFailedEvent class encapsulates information about a failed command.

クラス概要

final class MongoDB\Driver\Monitoring\CommandFailedEvent {

/* プロパティ */

public readonly string $host;

public readonly int $port;

public readonly string $commandName;

public readonly string $databaseName;

public readonly int $duration;

public readonly Exception $error;

public readonly object $reply;

public readonly string $operationId;

public readonly string $requestId;

public readonly ?MongoDB\BSON\ObjectId $serviceId;

public readonly ?int $serverConnectionId;

/* メソッド */

final public function getCommandName(): string

final public function getDatabaseName(): string

final public function getDurationMicros(): int

final public function getError(): Exception

final public function getHost(): string

final public function getOperationId(): string

final public function getPort(): int

final public function getReply(): object

final public function getRequestId(): string

final public function getServer(): MongoDB\Driver\Server

final public function getServerConnectionId(): ?int

final public function getServiceId(): ?MongoDB\BSON\ObjectId

}

プロパティ

host: The hostname of the server that executed the command.
port: The port of the server that executed the command.
commandName: The command name.
databaseName: The database name.
duration: The duration of the command in microseconds. The duration is a calculated value that includes the time to send the message and receive the response from the server.
error: The exception that was thrown when the command failed.
reply: The failure reply document returned by the server.
operationId: The operation ID. This may be used to link events together such as bulk writes, which may dispatch multiple commands.
requestId: The request ID. This may be used to associate this MongoDB\Driver\Monitoring\CommandFailedEvent with a corresponding MongoDB\Driver\Monitoring\CommandStartedEvent.
serviceId: The service ID, or null if the server does not support it (i.e. not using load-balanced mode).
serverConnectionId: The server connection ID, or null if not available.

変更履歴

バージョン	説明
PECL mongodb 2.3.0	Added public readonly properties. The `duration` property replaces the getDurationMicros() method.

MongoDB\Driver\Monitoring\CommandFailedEvent::getCommandName — Returns the command name
MongoDB\Driver\Monitoring\CommandFailedEvent::getDatabaseName — Returns the database on which the command was executed
MongoDB\Driver\Monitoring\CommandFailedEvent::getDurationMicros — Returns the command's duration in microseconds
MongoDB\Driver\Monitoring\CommandFailedEvent::getError — Returns the Exception associated with the failed command
MongoDB\Driver\Monitoring\CommandFailedEvent::getHost — Returns the server hostname for the command
MongoDB\Driver\Monitoring\CommandFailedEvent::getOperationId — Returns the command's operation ID
MongoDB\Driver\Monitoring\CommandFailedEvent::getPort — Returns the server port for the command
MongoDB\Driver\Monitoring\CommandFailedEvent::getReply — Returns the command reply document
MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId — Returns the command's request ID
MongoDB\Driver\Monitoring\CommandFailedEvent::getServer — Returns the Server on which the command was executed
MongoDB\Driver\Monitoring\CommandFailedEvent::getServerConnectionId — Returns the server connection ID for the command
MongoDB\Driver\Monitoring\CommandFailedEvent::getServiceId — Returns the load balancer service ID for the command

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes

There are no user contributed notes for this page.