Package xid is a globally unique id generator suited for web scale¶
Xid is using Mongo Object ID algorithm to generate globally unique ids: https://docs.mongodb.org/manual/reference/object-id/
- 4-byte value representing the seconds since the Unix epoch, - 3-byte machine identifier, - 2-byte process id, and - 3-byte counter, starting with a random value.
The binary representation of the id is compatible with Mongo 12 bytes Object IDs. The string representation is using URL safe base64 for better space efficiency when stored in that form (16 bytes).
UUID is 16 bytes (128 bits), snowflake is 8 bytes (64 bits), xid stands in between with 12 bytes with a more compact string representation ready for the web and no required configuration or central generation server.
- Size: 12 bytes (96 bits), smaller than UUID, larger than snowflake - Base64 URL safe encoded by default (16 bytes storage when transported as printable string) - Non configured, you don't need set a unique machine and/or data center id - K-ordered - Embedded time with 1 second precision - Unicity guaranted for 16,777,216 (24 bits) unique ids per second and per host/process
Best used with xlog's RequestIDHandler (https://godoc.org/github.com/rs/xlog#RequestIDHandler).
Package Files ¶
ErrInvalidID is returned when trying to unmarshal an invalid ID
type ID [rawLen]byte
ID represents a unique request id
Counter returns the incrementing value part of the id. It's a runtime error to call this method with an invalid id.
Machine returns the 3-byte machine id part of the id. It's a runtime error to call this method with an invalid id.
func (ID) MarshalText ¶
MarshalText implements encoding/text TextMarshaler interface
Pid returns the process id part of the id. It's a runtime error to call this method with an invalid id.
String returns a base64 URL safe representation of the id
Time returns the timestamp part of the id. It's a runtime error to call this method with an invalid id.