README.md

Sqids Go

Sqids (pronounced "squids") is a small library that lets you generate unique IDs from numbers. It's good for link shortening, fast & URL-safe ID generation and decoding back into numbers for quicker database lookups.

Features:

• Encode multiple numbers - generate short IDs from one or several non-negative numbers
• Quick decoding - easily decode IDs back into numbers
• Unique IDs - generate unique IDs by shuffling the alphabet once
• ID padding - provide minimum length to make IDs more uniform
• URL safe - auto-generated IDs do not contain common profanity
• Randomized output - Sequential input provides nonconsecutive IDs
• Many implementations - Support for 40+ programming languages

🧰 Use-cases

Good for:

• Generating IDs for public URLs (eg: link shortening)
• Generating IDs for internal systems (eg: event tracking)
• Decoding for quicker database lookups (eg: by primary keys)

Not good for:

• Sensitive data (this is not an encryption library)
• User IDs (can be decoded revealing user count)

🚀 Getting started

Use go get.

go get github.com/sqids/sqids-go

Then import the package into your own code.

import "github.com/sqids/sqids-go"

👩‍💻 Examples

Note Please note that the following examples omit proper error handling.

Simple encode & decode:

	s, _ := sqids.New()
	id, _ := s.Encode([]uint64{1, 2, 3}) // "86Rf07"
	numbers := s.Decode(id)              // [1, 2, 3]

Note 🚧 Because of the algorithm's design, multiple IDs can decode back into the same sequence of numbers. If it's important to your design that IDs are canonical, you have to manually re-encode decoded numbers and check that the generated ID matches.

Enforce a minimum length for IDs:

	s, _ := sqids.New(sqids.Options{
		MinLength: 10,
	})
	id, _ := s.Encode([]uint64{1, 2, 3}) // "86Rf07xd4z"
	numbers := s.Decode(id)              // [1, 2, 3]

Randomize IDs by providing a custom alphabet:

	s, _ := sqids.New(sqids.Options{
		Alphabet: "FxnXM1kBN6cuhsAvjW3Co7l2RePyY8DwaU04Tzt9fHQrqSVKdpimLGIJOgb5ZE",
	})
	id, _ := s.Encode([]uint64{1, 2, 3}) // "B4aajs"
	numbers := s.Decode(id)              // [1, 2, 3]

Prevent specific words from appearing anywhere in the auto-generated IDs:

	s, _ := sqids.New(sqids.Options{
		Blocklist: []string{"86Rf07"},
	})
	id, _ := s.Encode([]uint64{1, 2, 3}) // "se8ojk"
	numbers := s.Decode(id)              // [1, 2, 3]

📝 License

MIT