php8.5
Home/ Manual/ bson / timestamp/ MongoDB\BSON\Timestamp::getIncrement

MongoDB\BSON\Timestamp::getIncrement

PHP function Edit on GitHub ✎

(mongodb >=1.3.0)

Returns the increment component of this Timestamp

Description

MongoDB\BSON\Timestamp::getIncrement(): int

The increment component of a Timestamp is its least significant 32 bits, which denotes the incrementing ordinal for operations within a given second. This value is read as an unsigned 32-bit integer with big-endian byte order.

Uint32

Parameters Parameters

Return Values

Returns the increment component of this Timestamp.

Warning

On 32-bit systems this method may return a negative number. Although the increment and timestamp parts of the BSON timestamp type consists of two unsigned 32-bit values, PHP can not represent these on 32-bit platforms.

Errors/Exceptions

See Also

  • BSON Types: Timestamps

Source: reference/mongodb/bson/timestamp/getincrement.xml · from the official PHP manual (php/doc-en)