Top Related Projects
The Official Golang driver for MongoDB
Universally Unique Lexicographically Sortable Identifier (ULID) in Go
K-Sortable Globally Unique IDs
UUID package for Go
Go package for UUIDs based on RFC 4122 and DCE 1.1: Authentication and Security Services.
Quick Overview
The rs/xid
project is a Rust library that generates unique IDs. It provides a simple and efficient way to generate unique identifiers for use in various applications, such as databases, distributed systems, and more.
Pros
- Uniqueness: The generated IDs are globally unique, ensuring that there are no collisions.
- Performance: The library is designed to be fast and efficient, with low overhead.
- Simplicity: The API is straightforward and easy to use, making it accessible to developers of all skill levels.
- Compatibility: The library is compatible with various Rust versions and can be used in a wide range of projects.
Cons
- Dependency: The project relies on the
rand
crate, which may not be suitable for all use cases. - Lack of Customization: The library provides a limited set of options for customizing the generated IDs, which may not meet the requirements of all projects.
- Limited Documentation: The project's documentation could be more comprehensive, making it harder for new users to get started.
- Potential Timestamp Leakage: The generated IDs include a timestamp, which could potentially leak information about the creation time of the ID.
Code Examples
Here are a few examples of how to use the rs/xid
library in Rust:
use xid::Xid;
// Generate a new unique ID
let id = Xid::new();
println!("New ID: {}", id); // Output: New ID: 9m4oc7tnvqr8j1rvsogo
// Convert an ID to a string
let id_str = id.to_string();
println!("ID as string: {}", id_str); // Output: ID as string: 9m4oc7tnvqr8j1rvsogo
// Parse a string into an ID
let parsed_id = Xid::from_string("9m4oc7tnvqr8j1rvsogo").unwrap();
println!("Parsed ID: {}", parsed_id); // Output: Parsed ID: 9m4oc7tnvqr8j1rvsogo
Getting Started
To use the rs/xid
library in your Rust project, add the following dependency to your Cargo.toml
file:
[dependencies]
xid = "1.2.0"
Then, you can import the xid
crate and start using the Xid
type to generate unique IDs:
use xid::Xid;
fn main() {
// Generate a new unique ID
let id = Xid::new();
println!("New ID: {}", id);
}
This will output a new unique ID, such as "9m4oc7tnvqr8j1rvsogo"
.
Competitor Comparisons
The Official Golang driver for MongoDB
Pros of mongo-go-driver
- Comprehensive MongoDB driver with full feature support
- Official MongoDB-supported library for Go
- Extensive documentation and community support
Cons of mongo-go-driver
- Larger codebase and more complex to use
- Heavier dependency for projects only needing ID generation
Code Comparison
xid:
id := xid.New()
fmt.Printf("Generated ID: %s\n", id.String())
mongo-go-driver:
client, _ := mongo.Connect(context.TODO(), options.Client().ApplyURI("mongodb://localhost:27017"))
collection := client.Database("test").Collection("users")
result, _ := collection.InsertOne(context.TODO(), bson.D{{"name", "John Doe"}})
fmt.Printf("Inserted ID: %s\n", result.InsertedID)
Summary
xid is a lightweight, focused library for generating unique IDs, while mongo-go-driver is a full-featured MongoDB driver. xid is simpler to use for basic ID generation, but mongo-go-driver offers comprehensive MongoDB integration. Choose xid for simple ID needs, and mongo-go-driver for complete MongoDB functionality in Go applications.
Universally Unique Lexicographically Sortable Identifier (ULID) in Go
Pros of ulid
- Lexicographically sortable, allowing for efficient database indexing
- Includes millisecond precision timestamp, enabling more accurate time-based sorting
- Provides a crockford32 encoding option for case-insensitive sorting
Cons of ulid
- Slightly longer identifier (26 characters) compared to xid (20 characters)
- May have higher memory usage due to larger size
- Potentially slower generation time due to more complex algorithm
Code Comparison
xid:
id := xid.New()
fmt.Printf("xid: %s\n", id.String())
ulid:
t := time.Now()
entropy := ulid.Monotonic(rand.New(rand.NewSource(t.UnixNano())), 0)
id := ulid.MustNew(ulid.Timestamp(t), entropy)
fmt.Printf("ulid: %s\n", id.String())
Both xid and ulid provide unique identifier generation for distributed systems. xid offers a more compact solution with faster generation, while ulid provides better sortability and timestamp precision. The choice between them depends on specific project requirements, such as database indexing needs, identifier length constraints, and generation speed priorities.
K-Sortable Globally Unique IDs
Pros of ksuid
- Longer IDs (27 characters) provide more uniqueness and sortability
- Includes a timestamp component for better time-based sorting
- Offers Base62 encoding for more compact representation
Cons of ksuid
- Slightly larger ID size may increase storage requirements
- More complex implementation compared to xid's simplicity
- Potentially slower generation due to additional components
Code Comparison
xid:
id := xid.New()
fmt.Printf("xid: %s\n", id.String())
ksuid:
id := ksuid.New()
fmt.Printf("ksuid: %s\n", id.String())
Both libraries offer simple APIs for generating unique identifiers, but ksuid includes additional methods for working with timestamps and sorting.
xid generates 20-byte IDs, while ksuid produces 20-byte IDs with an additional 32-bit timestamp prefix. xid uses a combination of machine ID, process ID, and counter, whereas ksuid incorporates a timestamp and random component.
xid is generally faster and more lightweight, making it suitable for high-performance scenarios. ksuid offers better sortability and time-based features, which can be beneficial for certain use cases where chronological ordering is important.
Choose xid for simplicity and performance, or ksuid for enhanced sortability and time-based functionality.
UUID package for Go
Pros of go.uuid
- Implements multiple UUID versions (v1, v2, v3, v4, v5)
- Provides parsing and validation functions for UUIDs
- Widely adopted and well-established in the Go ecosystem
Cons of go.uuid
- Larger codebase and more dependencies
- Slower generation speed compared to xid
- UUIDs are longer (36 characters) than xids (20 characters)
Code Comparison
xid:
id := xid.New()
fmt.Printf("xid: %s\n", id.String())
go.uuid:
id := uuid.NewV4()
fmt.Printf("UUID: %s\n", id)
Key Differences
- xid generates sortable, 20-character IDs, while go.uuid creates standard 36-character UUIDs
- xid is optimized for performance and minimal memory allocation
- go.uuid offers more flexibility with multiple UUID versions and parsing functions
- xid includes a timestamp and machine identifier in the generated ID
- go.uuid focuses on compliance with RFC 4122 UUID specifications
Both libraries provide unique identifier generation for Go applications, but they cater to different use cases. xid is better suited for high-performance scenarios requiring compact, sortable IDs, while go.uuid is ideal for applications that need standard UUID compliance and multiple version support.
Go package for UUIDs based on RFC 4122 and DCE 1.1: Authentication and Security Services.
Pros of uuid
- Implements RFC 4122 UUID standard, ensuring broad compatibility
- Supports multiple UUID versions (1, 3, 4, 5)
- Well-maintained by Google, with regular updates and community support
Cons of uuid
- Larger ID size (128 bits) compared to xid (96 bits)
- Potentially slower generation speed for some UUID versions
- More complex implementation due to supporting multiple UUID versions
Code Comparison
xid:
id := xid.New()
fmt.Printf("xid: %s\n", id.String())
uuid:
id := uuid.New()
fmt.Printf("uuid: %s\n", id.String())
Both libraries offer simple APIs for generating unique identifiers. xid focuses on providing a compact, sortable ID with good performance, while uuid offers more flexibility with different UUID versions and broader compatibility with existing systems.
xid is ideal for applications requiring smaller, sortable IDs with fast generation, whereas uuid is better suited for systems that need to comply with the UUID standard or require specific UUID versions for compatibility reasons.
Consider your specific use case, performance requirements, and compatibility needs when choosing between these two libraries.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
Globally Unique ID Generator
Package xid is a globally unique id generator library, ready to safely be used directly in your server code.
Xid uses the Mongo Object ID algorithm to generate globally unique ids with a different serialization (base32hex) to make it shorter when transported as a string: 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 base32hex (w/o padding) for better space efficiency when stored in that form (20 bytes). The hex variant of base32 is used to retain the sortable property of the id.
Xid doesn't use base64 because case sensitivity and the 2 non alphanum chars may be an
issue when transported as a string between various systems. Base36 wasn't retained either
because 1/ it's not standard 2/ the resulting size is not predictable (not bit aligned)
and 3/ it would not remain sortable. To validate a base32 xid
, expect a 20 chars long,
all lowercase sequence of a
to v
letters and 0
to 9
numbers ([0-9a-v]{20}
).
UUIDs are 16 bytes (128 bits) and 36 chars as string representation. Twitter Snowflake ids are 8 bytes (64 bits) but require machine/data-center configuration and/or central generator servers. xid stands in between with 12 bytes (96 bits) and a more compact URL-safe string representation (20 chars). No configuration or central generator server is required so it can be used directly in server's code.
Name | Binary Size | String Size | Features |
---|---|---|---|
UUID | 16 bytes | 36 chars | configuration free, not sortable |
shortuuid | 16 bytes | 22 chars | configuration free, not sortable |
Snowflake | 8 bytes | up to 20 chars | needs machine/DC configuration, needs central server, sortable |
MongoID | 12 bytes | 24 chars | configuration free, sortable |
xid | 12 bytes | 20 chars | configuration free, sortable |
Features:
- Size: 12 bytes (96 bits), smaller than UUID, larger than snowflake
- Base32 hex encoded by default (20 chars when transported as printable string, still sortable)
- Non configured, you don't need set a unique machine and/or data center id
- K-ordered
- Embedded time with 1 second precision
- Unicity guaranteed for 16,777,216 (24 bits) unique ids per second and per host/process
- Lock-free (i.e.: unlike UUIDv1 and v2)
Best used with zerolog's RequestIDHandler.
Notes:
- Xid is dependent on the system time, a monotonic counter and so is not cryptographically secure. If unpredictability of IDs is important, you should not use Xids. It is worth noting that most other UUID-like implementations are also not cryptographically secure. You should use libraries that rely on cryptographically secure sources (like /dev/urandom on unix, crypto/rand in golang), if you want a truly random ID generator.
References:
- http://www.slideshare.net/davegardnerisme/unique-id-generation-in-distributed-systems
- https://en.wikipedia.org/wiki/Universally_unique_identifier
- https://blog.twitter.com/2010/announcing-snowflake
- Python port by Graham Abbott: https://github.com/graham/python_xid
- Scala port by Egor Kolotaev: https://github.com/kolotaev/ride
- Rust port by Kaz Yoshihara: https://github.com/kazk/xid-rs
- Python wrapper around the Rust port Aleksandr Shpak: https://github.com/shpaker/epyxid
- Ruby port by Valar: https://github.com/valarpirai/ruby_xid
- Java port by 0xShamil: https://github.com/0xShamil/java-xid
- Dart port by Peter Bwire: https://pub.dev/packages/xid
- PostgreSQL port by Rasmus Holm: https://github.com/modfin/pg-xid
- Swift port by Uditha Atukorala: https://github.com/uatuko/swift-xid
- C++ port by Uditha Atukorala: https://github.com/uatuko/libxid
- Typescript & Javascript port by Yiwen AI: https://github.com/yiwen-ai/xid-ts
- Gleam port by Alexandre Del Vecchio: https://github.com/defgenx/gxid
Install
go get github.com/rs/xid
Usage
guid := xid.New()
println(guid.String())
// Output: 9m4e2mr0ui3e8a215n4g
Get xid
embedded info:
guid.Machine()
guid.Pid()
guid.Time()
guid.Counter()
Benchmark
Benchmark against Go Maxim Bublis's UUID.
BenchmarkXID 20000000 91.1 ns/op 32 B/op 1 allocs/op
BenchmarkXID-2 20000000 55.9 ns/op 32 B/op 1 allocs/op
BenchmarkXID-4 50000000 32.3 ns/op 32 B/op 1 allocs/op
BenchmarkUUIDv1 10000000 204 ns/op 48 B/op 1 allocs/op
BenchmarkUUIDv1-2 10000000 160 ns/op 48 B/op 1 allocs/op
BenchmarkUUIDv1-4 10000000 195 ns/op 48 B/op 1 allocs/op
BenchmarkUUIDv4 1000000 1503 ns/op 64 B/op 2 allocs/op
BenchmarkUUIDv4-2 1000000 1427 ns/op 64 B/op 2 allocs/op
BenchmarkUUIDv4-4 1000000 1452 ns/op 64 B/op 2 allocs/op
Note: UUIDv1 requires a global lock, hence the performance degradation as we add more CPUs.
Licenses
All source code is licensed under the MIT License.
Top Related Projects
The Official Golang driver for MongoDB
Universally Unique Lexicographically Sortable Identifier (ULID) in Go
K-Sortable Globally Unique IDs
UUID package for Go
Go package for UUIDs based on RFC 4122 and DCE 1.1: Authentication and Security Services.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot