php8.5
Home/ Manual/ monitoring / commandstartedevent/ MongoDB\Driver\Monitoring\CommandStartedEvent::getServiceId

MongoDB\Driver\Monitoring\CommandStartedEvent::getServiceId

PHP function Edit on GitHub ✎

(mongodb >=1.11.0)

Returns the load balancer service ID for the command

Description

MongoDB\Driver\Monitoring\CommandStartedEvent::getServiceId(): MongoDB\BSON\ObjectId|null

When the driver is connected to a MongoDB cluster through a load balancer, the service ID corresponds to the serviceId field in the hello command response.

Parameters Parameters

Return Values

Returns the load balancer service ID, or null if the driver is not connected to a load balancer.

Errors/Exceptions

Source: reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserviceid.xml · from the official PHP manual (php/doc-en)