object BSONObjectID extends Serializable
- Alphabetic
- By Inheritance
- BSONObjectID
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- def apply(array: Array[Byte]): BSONObjectID
- def fromTime(timeMillis: Long, fillOnlyTimestamp: Boolean = true): BSONObjectID
Generates a new BSON ObjectID from the given timestamp in milliseconds.
Generates a new BSON ObjectID from the given timestamp in milliseconds.
The included timestamp is the number of seconds since epoch, so a BSONObjectID time part has only a precision up to the second. To get a reasonably unique ID, you _must_ set
onlyTimestamp
to false.Crafting a BSONObjectID from a timestamp with
fillOnlyTimestamp
set to true is helpful for range queries, eg if you want of find documents an _id field which timestamp part is greater than or lesser than the one of another id.If you do not intend to use the produced BSONObjectID for range queries, then you'd rather use the
generate
method instead.- fillOnlyTimestamp
if true, the returned BSONObjectID will only have the timestamp bytes set; the other will be set to zero.
- def generate(): BSONObjectID
Generates a new BSON ObjectID using the current time.
Generates a new BSON ObjectID using the current time.
- See also
- def parse(id: String): Try[BSONObjectID]
Tries to make a BSON ObjectId from a hexadecimal string representation.
- def unapply(id: BSONObjectID): Option[Array[Byte]]