/oneid

Thread-safe concurrent, partially-sortable numeric IDs generator package for your app needs

Primary LanguageGoISC LicenseISC

ONEID - Distributable Unique numeric IDs

Features Summary

  • Thread-safe concurrent Numeric IDs.
  • Support upto 1024 servers with upto 32 processes each by default.
  • Partially-sortable time-based IDs.
  • Trivially customizable to support even more.
  • Uses only builtin Golang stdlib with no external dependencies.
  • Fully testable.
  • go.mod support.

You will love it if:

  • You believe numbers are IDs :)
  • You believe IDs creation should be wired to the app with no dependencies on any external ID servers.

Installation

  • The usal way, get it: go get github.com/coderme/oneid/v3

Usage

  • Generation of uint32 Id on a simple server with single process is as simple as:
id := oneid.Uint32(1,1 &oneid.DefaultUint32Config)
  • or better an uint64 if your database supports it
id := oneid.Uint64(1,1 &oneid.DefaultUint64Config)

Advanced Usage

  • You can Create a custom config in order to support upto 16,384 servers with 32 processes each.

conf := oneid.NewUint64Config(14, 5, 20)
id, err := EnvUint64()
if err != nil {
   // deal with the error
}

Benchmarks

go test -bench=. -benchmem

BenchmarkUint32-8        9375111               127.2 ns/op             0 B/op          0 allocs/op
BenchmarkUint64-8        9512419               128.2 ns/op             0 B/op          0 allocs/op
PASS
ok      github.com/coderme/oneid/v2     79.977s

Note: running test require at least 8GB and much cpu. be preapred with at least 16GB of free memory just in case :)