snowflake

Documentation

Index

• Constants
• Variables
• type Generator
  • func NewGenerator(clock clock.Clock, datacenterID, workerID uint32) (*Generator, error)
  • func (g *Generator) Generate() (ID, error)
• type ID
  • func (s ID) DatacenterID() uint32
  • func (s ID) Sequence() uint32
  • func (s ID) Timestamp() int64
  • func (s ID) WorkerID() uint32

Constants

const (
	MaxDatacenterID = -1 ^ (-1 << datacenterIDBits)
	MaxWorkerID     = -1 ^ (-1 << workerIDBits)
	MaxSequence     = -1 ^ (-1 << sequenceBits)
)

Variables

var (
	ErrClockMovingBackwards   = errors.New("the clock is moving backwards")
	ErrDatacenterIDOutOfRange = fmt.Errorf("datacenter id is out of range [0, %d]", MaxDatacenterID)
	ErrWorkerIDOutOfRange     = fmt.Errorf("worker id is out of range [0, %d]", MaxWorkerID)
)

Types

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

func NewGenerator

func NewGenerator(clock clock.Clock, datacenterID, workerID uint32) (*Generator, error)

func (*Generator) Generate

func (g *Generator) Generate() (ID, error)

type ID

type ID uint64

func (ID) DatacenterID

func (s ID) DatacenterID() uint32

func (ID) Sequence

func (s ID) Sequence() uint32

func (ID) Timestamp

func (s ID) Timestamp() int64

func (ID) WorkerID

func (s ID) WorkerID() uint32