README
¶
Sandflake 
Decentralized, sequential, lexicographically sortable unique id
This is a work in progress, things might change quickly without notice
Features
- 128 bit
- Lexicographically sortable
- Sequential (not guarranted for future ids)
- 1.21e+24 unique ids per millisecond
- 2.81e+14 unique ids per worker per millisecond
Table of contents
Install/Update
go get -u github.com/celrenheit/sandflake
Usage
var g sandflake.Generator
id := g.Next()
fmt.Println(id)
Composition
- 48 bit: timestamp in milliseconds
- 32 bit: worker id (random at initialization)
- 24 bit: sequence number
- 24 bit: randomness
Sandflake ids do not need to wait some milliseconds for the next id if time goes backwards, it can just generate new ones and random bytes at the end should avoid any possible conflict with previous ids. In this case, the order is not guaranteed anymore.
Likewise, for future manually generated ids, the order is not guaranteed.
Ports
Inspiration
License
Apache 2.0
Documentation
¶
Index ¶
- Constants
- Variables
- func Compare(id1, id2 ID) int
- type FixedTimeGenerator
- type Generator
- type ID
- func (d ID) After(other ID) bool
- func (d ID) Before(other ID) bool
- func (d ID) Bytes() []byte
- func (d ID) Equal(other ID) bool
- func (d ID) Marshal() ([]byte, error)
- func (d ID) MarshalJSON() ([]byte, error)
- func (d ID) MarshalText() ([]byte, error)
- func (d ID) MarshalTo(dst []byte) (int, error)
- func (d ID) RandomBytes() []byte
- func (d ID) Sequence() uint32
- func (d ID) Size() int
- func (id ID) String() string
- func (d ID) Time() time.Time
- func (d *ID) Unmarshal(b []byte) error
- func (d *ID) UnmarshalJSON(b []byte) error
- func (d *ID) UnmarshalText(b []byte) error
- func (d ID) WorkerID() (wid WorkerID)
- type WorkerID
Constants ¶
const (
Size = timestampLength + workerIDLength + sequenceLength + randomLength
)
Variables ¶
Functions ¶
Types ¶
type FixedTimeGenerator ¶
type FixedTimeGenerator struct {
// contains filtered or unexported fields
}
func NewFixedTimeGenerator ¶
func NewFixedTimeGenerator(t time.Time) *FixedTimeGenerator
func (*FixedTimeGenerator) Next ¶
func (g *FixedTimeGenerator) Next() ID
Next returns the next id. It returns an error if New() fails. It is safe for concurrent use.
type ID ¶
48bit: timestamp 32bit: worker id (defaults to MAC Address) 24bit: sequence number 24bit: random number
func MustParseBytes ¶
func Next ¶
func Next() ID
Next returns the next id from the global generator It is safe for concurrent use.
func ParseBytes ¶
func (ID) MarshalJSON ¶
func (ID) MarshalText ¶
func (ID) RandomBytes ¶
RandomBytes returns the random stored in the ID
Source Files