MongoDB\Driver\Session::getClusterTime

Returns the cluster time for this session

Description

final public objectnull MongoDB\Driver\Session::getClusterTime()

Returns the cluster time for this session. If the session has not been used for any operation and MongoDB\Driver\Session::advanceClusterTime has not been called, the cluster time will be null.

Parameters

This function has no parameters.

Return Values

Returns the cluster time for this session, or null if the session has no cluster time.

Errors/Exceptions

  • Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.

See Also

  • MongoDB\Driver\Session::advanceClusterTime