The MongoDB\Driver\Monitoring\CommandStartedEvent class

(mongodb >=1.3.0)

Introduction

The MongoDB\Driver\Monitoring\CommandStartedEvent class encapsulates information about a started command.

final class MongoDB\Driver\Monitoring\CommandStartedEvent {

/* Properties */

public readonly string $host;

public readonly int $port;

public readonly string $commandName;

public readonly string $databaseName;

public readonly object $command;

public readonly string $operationId;

public readonly string $requestId;

public readonly ?MongoDB\BSON\ObjectId $serviceId;

public readonly ?int $serverConnectionId;

/* Methods */

final public function getCommand(): object

final public function getCommandName(): string

final public function getDatabaseName(): string

final public function getHost(): string

final public function getOperationId(): string

final public function getPort(): int

final public function getRequestId(): string

final public function getServerConnectionId(): ?int

}

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.
command: The command document.
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\CommandStartedEvent with a corresponding MongoDB\Driver\Monitoring\CommandSucceededEvent or MongoDB\Driver\Monitoring\CommandFailedEvent.
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.

Version	Description
PECL mongodb 2.3.0	Added public readonly properties.

There are no user contributed notes for this page.