betterguid

package module
v0.0.0-...-c442874 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 21, 2017 License: MIT Imports: 3 Imported by: 40

README

This is Go package to generate guid (globally unique id) with good properties.

Usage:

import "github.com/kjk/betterguid"

id := betterguid.New()
fmt.Printf("guid: '%s'\n", id)

Generated guids have good properties:

  • they're 20 character strings, safe for inclusion in urls (don't require escaping)
  • they're based on timestamp; they sort after any existing ids
  • they contain 72-bits of random data after the timestamp so that IDs won't collide with other IDs
  • they sort lexicographically (the timestamp is converted to a string that will sort correctly)
  • they're monotonically increasing. Even if you generate more than one in the same timestamp, the latter ones will sort after the former ones. We do this by using the previous random bits but "incrementing" them by 1 (only in the case of a timestamp collision).

Read https://www.firebase.com/blog/2015-02-11-firebase-unique-identifiers.html for more info.

Based on https://gist.github.com/mikelehen/3596a30bd69384624c11

You can read Generating good, random and unique ids in Go to see how it compares to other similar libraries.

Documentation

Overview

Package betterguid generates 20-character guid (globally unique id) strings with good properties:

They're 20 character strings, safe for inclusion in urls (don't require escaping)

They're based on timestamp so that they sort **after** any existing ids

They contain 72-bits of random data after the timestamp so that IDs won't collide with other clients' IDs

They sort **lexicographically** (so the timestamp is converted to characters that will sort properly)

They're monotonically increasing. Even if you generate more than one in the same timestamp, thelatter ones will sort after the former ones. We do this by using the previous random bits but "incrementing" them by 1 (only in the case of a timestamp collision).

Read https://www.firebase.com/blog/2015-02-11-firebase-unique-identifiers.html for more info.

Based on https://gist.github.com/mikelehen/3596a30bd69384624c11

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func New() string

New creates a new random, unique id

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL