Søren Rasmussen
07a23c1845
Some checks reported errors
continuous-integration/drone/push Build encountered an error
47 lines
1.8 KiB
Markdown
47 lines
1.8 KiB
Markdown
# NUID
|
|
|
|
[](https://www.apache.org/licenses/LICENSE-2.0)
|
|
[](http://goreportcard.com/report/nats-io/nuid)
|
|
[](http://travis-ci.org/nats-io/nuid)
|
|
[](https://github.com/nats-io/nuid/releases/tag/v1.0.1)
|
|
[](http://godoc.org/github.com/nats-io/nuid)
|
|
[](https://coveralls.io/github/nats-io/nuid?branch=master)
|
|
|
|
A highly performant unique identifier generator.
|
|
|
|
## Installation
|
|
|
|
Use the `go` command:
|
|
|
|
$ go get github.com/nats-io/nuid
|
|
|
|
## Basic Usage
|
|
```go
|
|
|
|
// Utilize the global locked instance
|
|
nuid := nuid.Next()
|
|
|
|
// Create an instance, these are not locked.
|
|
n := nuid.New()
|
|
nuid = n.Next()
|
|
|
|
// Generate a new crypto/rand seeded prefix.
|
|
// Generally not needed, happens automatically.
|
|
n.RandomizePrefix()
|
|
```
|
|
|
|
## Performance
|
|
NUID needs to be very fast to generate and be truly unique, all while being entropy pool friendly.
|
|
NUID uses 12 bytes of crypto generated data (entropy draining), and 10 bytes of pseudo-random
|
|
sequential data that increments with a pseudo-random increment.
|
|
|
|
Total length of a NUID string is 22 bytes of base 62 ascii text, so 62^22 or
|
|
2707803647802660400290261537185326956544 possibilities.
|
|
|
|
NUID can generate identifiers as fast as 60ns, or ~16 million per second. There is an associated
|
|
benchmark you can use to test performance on your own hardware.
|
|
|
|
## License
|
|
|
|
Unless otherwise noted, the NATS source files are distributed
|
|
under the Apache Version 2.0 license found in the LICENSE file.
|