Php/docs/mongodb-driver-session.getclustertime

• PHP Manual
• MongoDB\Driver\Session
• Returns the cluster time for this session

MongoDB\Driver\Session::getClusterTime

(mongodb >=1.4.0)

MongoDB\Driver\Session::getClusterTime — Returns the cluster time for this session

Description

final public MongoDB\Driver\Session::getClusterTime ( ) : object|null

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() - Advances the cluster time for this session