Giter Club home page Giter Club logo

iid's Introduction

iid

Small, globally unique IDs implemented in Go.

GoDoc

Features

  • Can be sorted by creation time
  • Globally unique
  • Small size (can be stored in a 64 bit integer or an 11 byte string)
  • base64url encoded string format: the ids can be used in URLs

ID Format

1 Bit 32 Bit 31 Bit
Not used Timestamp in seconds Cryptographically secure random bytes

The first bit is not used so the ID fits into 64 bit signed integers.

Usage Example

package main

import (
	"github.com/robojones/iid"
	"log"
	"reflect"
)

func main() {
	// Generate new iid
	id := iid.New()
	log.Printf("buffer format: %#v", id)
	
	// Export as base64url string
	str := id.String()
	log.Printf("base64 string: %s", str)
	
	// Import the id from the string
	parsed, err := iid.FromString(str)
	if err != nil {
		panic(err)
	}
	log.Printf("parsed iid from string is identical to the original: %t", reflect.DeepEqual(id, parsed))
	
	// Export as uint64
	i := id.Uint64()
	log.Printf("integer: %d", i)
	
	// Import the id from the integer
	parsed = iid.FromUint64(i)
	log.Printf("parsed iid from uint64 is identical to original: %t", reflect.DeepEqual(id, parsed))
}

iid's People

Contributors

robojones avatar

Watchers

 avatar

iid's Issues

Wrong code comment

iid/iid.go

Line 40 in ef30a91

// Write current UNIX time in ms to the first four bytes.

The time is acutally in seconds, not milliseconds.
The 32 bits of the timestamp are written into the second to 33rd most significant bits, affecting the first five bytes in the byte array.

IDs should fit into a 64 bit signed integer

Many databases only support signed integers. When using iid at its current state the IDs will overflow in a few years when stored in a signed integer.
This could be fixed by shifting the timestamp to the right by one bit reducing the random bits from 32 to 31.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.