The MongoDB\Driver\Monitoring\CommandStartedEvent class

Introduction

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

MongoDB\Driver\Monitoring\CommandStartedEvent

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\ObjectIdnull $serviceId;

public readonly intnull $serverConnectionId;

/* Methods */

final public object getCommand()

final public string getCommandName()

final public string getDatabaseName()

final public string getHost()

final public string getOperationId()

final public int getPort()

final public string getRequestId()

final public MongoDB\Driver\Server getServer()

final public intnull getServerConnectionId()

final public MongoDB\BSON\ObjectIdnull getServiceId()

}

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.

Table of Contents