snowflake is a Go package that provides

• A very simple Twitter snowflake generator.
• Methods to parse existing snowflake IDs.
• Methods to convert a snowflake ID into several other data types.
• JSON Marshal/Unmarshal functions to easily use snowflake IDs within a JSON API.

For help with this package or general Go discussion, please join the Discord Gophers chat server.

This package should be considered stable and completed. Any additions in the future will strongly avoid API changes to existing functions. Please see issues for any remaining TODO items that are planned.

This assumes you already have a working Go environment, if not please see this page first.

go get github.com/bwmarrin/snowflake

Import the package into your project then construct a new snowflake Node using a unique node number from 0 to 1023. With the node object call the Generate() method to generate and return a unique snowflake ID.

Keep in mind that each node you create must have a unique node number, even across multiple servers. If you do not keep node numbers unique the generator cannot guarantee unique IDs across all nodes.

Example Program:

package main

import (
	"fmt"

	"github.com/bwmarrin/snowflake"
)

func main() {

	// Create a new Node with a Node number of 1
	node, err := snowflake.NewNode(1)
	if err != nil {
		fmt.Println(err)
		return
	}

	// Generate a snowflake ID.
	id := node.Generate()

	// Print out the ID in a few different ways.
	fmt.Printf("Int64  ID: %d\n", id)
	fmt.Printf("String ID: %s\n", id)
	fmt.Printf("Base2  ID: %s\n", id.Base2())
	fmt.Printf("Base64 ID: %s\n", id.Base64())

	// Print out the ID's timestamp
	fmt.Printf("ID Time  : %d\n", id.Time())

	// Print out the ID's node number
	fmt.Printf("ID Node  : %d\n", id.Node())

	// Print out the ID's sequence number
	fmt.Printf("ID Step  : %d\n", id.Step())

  // Generate and print, all in one.
  fmt.Printf("ID       : %d\n", node.Generate().Int64())
}

This snowflake generator should be sufficiently fast enough on most systems to generate 4096 unique ID's per millisecond. This is the maximum that the snowflake ID format supports. That is, around 243-244 nanoseconds per operation.

Since the snowflake generator is single threaded the primary limitation will be the maximum speed of a single processor on your system.

To benchmark the generator on your system run the following command inside the snowflake package directory.

go test -bench=.

If your curious, check out this commit that shows benchmarks that compare a few different ways of implementing a snowflake generator in Go.

• https://github.com/bwmarrin/snowflake/tree/9befef8908df13f4102ed21f42b083dd862b5036