The MongoId class

(PECL mongo >=0.8.0)

Introduction

A unique identifier created for database objects. If an object is inserted into the database without an _id field, an _id field will be added to it with a MongoId instance as its value. If the data has a naturally occuring unique field (e.g. username or timestamp) it is fine to use this as the _id field instead, and it will not be replaced with a MongoId.

Instances of the MongoId class fulfill the role that autoincrementing does in a relational database: to provide a unique key if the data does not natually have one. Autoincrementing does not work well with a sharded database, as it is difficult to determine the next number in the sequence. This class fulfills the constraints of quickly generating a value that is unique across shards.

Each MongoId is 12 bytes (making its string form 24 hexadecimal characters). The first four bytes are a timestamp, the next three are a hash of the client machine's hostname, the next two are the two least significant bytes of the process id running the script, and the last three bytes are an incrementing value.

MongoIds are serializable/unserializable. Their serialized form is similar to their string form:

C:7:"MongoId":24:{4af9f23d8ead0e1d32000000}

Class synopsis

MongoId {

public string $$id = NULL ;

/* Methods */

public __construct ([ string $id = NULL ] )

public static string getHostname ( void )

public int getInc ( void )

public int getPID ( void )

public int getTimestamp ( void )

public static bool isValid ( mixed $value )

public static MongoId __set_state ( array $props )

public string __toString ( void )

}

Fields

$id

This field contains the string representation of this object.

Note: The property name begins with a $ character. It may be accessed using complex variable parsed syntax (e.g. $mongoId->{'$id'}).

See Also

MongoDB core docs on » ObjectIds.