snowflake

README

Quick Start

Generate an ID

import (
  "fmt"
  "github.com/abulo/ratel/v3/snowflake"
)

func ExampleGenInt64ID() {
  id := snowflake.CommonConfig.GenInt64ID()
  fmt.Printf("id generated: %v", id)
}

Documentation

Index

• Constants
• Variables
• type Config
  • func ConstructConfig(timeBits, seqBits, machineBits uint) *Config
  • func ConstructConfigWithMachineID(timeBits, seqBits, machineBits uint, machineID int64) *Config
  • func (c *Config) GenInt64ID() int64
  • func (c *Config) GetSeqFromID(id int64) int64
  • func (c *Config) GetTimeFromID(id int64) int64

Constants

const (
	//StartTimeEnvName is the env key for ID generating start time
	StartTimeEnvName = "SNOWFLAKEID_START_TIME"
	//MachineIDEnvName is the env key for machine id
	MachineIDEnvName = "SNOWFLAKEID_MACHINE_ID"
)

StartTimeEnvName ...

Variables

var BenchmarkConfig = ConstructConfig(40, 15, 8)

BenchmarkConfig is a high performance setting for benchmark

40 bits timestamp
15 bits seq
8  bits machine id

var CommonConfig = ConstructConfig(40, 7, 16)

CommonConfig is the recommended setting for most applications

40 bits timestamp
7  bits seq
16 bits machine id

Types

type Config

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

Config maintains the settings for id generating

func ConstructConfig

func ConstructConfig(timeBits, seqBits, machineBits uint) *Config

ConstructConfig creates an instance of FastIDConfig with the given settings

func ConstructConfigWithMachineID

func ConstructConfigWithMachineID(timeBits, seqBits, machineBits uint, machineID int64) *Config

ConstructConfigWithMachineID creates an config with machine id, in case you don't want to use the lower 16 bits of the IP address.

func (*Config) GenInt64ID

func (c *Config) GenInt64ID() int64

GenInt64ID generates unique int64 IDs with the setting in the methond owner

func (*Config) GetSeqFromID

func (c *Config) GetSeqFromID(id int64) int64

GetSeqFromID extracts seq number from an existing ID

func (*Config) GetTimeFromID

func (c *Config) GetTimeFromID(id int64) int64

GetTimeFromID extracts timestamp from an existing ID