Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sqids/sqids-go
Official Go port of Sqids. Generate short unique IDs from numbers.
https://github.com/sqids/sqids-go
go golang hashids id id-generator short-id short-url sqids uid unique-id unique-id-generator
Last synced: 3 months ago
JSON representation
Official Go port of Sqids. Generate short unique IDs from numbers.
- Host: GitHub
- URL: https://github.com/sqids/sqids-go
- Owner: sqids
- License: mit
- Created: 2023-06-24T15:27:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-11T10:00:20.000Z (over 1 year ago)
- Last Synced: 2024-08-01T17:26:07.244Z (6 months ago)
- Topics: go, golang, hashids, id, id-generator, short-id, short-url, sqids, uid, unique-id, unique-id-generator
- Language: Go
- Homepage: https://sqids.org/go
- Size: 41 KB
- Stars: 497
- Watchers: 5
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - sqids/sqids-go - Official Go port of Sqids. Generate short unique IDs from numbers. (Go)
- my-awesome - sqids/sqids-go - generator,short-id,short-url,sqids,uid,unique-id,unique-id-generator pushed_at:2023-09 star:0.6k fork:0.0k Official Go port of Sqids. Generate short unique IDs from numbers. (Go)
README
# [Sqids Go](https://sqids.org/go)
[](https://godoc.org/github.com/sqids/sqids-go)
[](https://github.com/sqids/sqids-go/actions)
[Sqids](https://sqids.org/go) (*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](https://sqids.org/)
## 🧰 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.
```bash
go get github.com/sqids/sqids-go
```
Then import the package into your own code.
```golang
import "github.com/sqids/sqids-go"
```
## 👩💻 Examples
> **Note**
> Please note that the following examples omit proper error handling.
Simple encode & decode:
[embedmd]:# (examples/sqids-encode-decode/sqids-encode-decode.go /.+sqids.New/ /\[1, 2, 3\]/)
```go
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:
[embedmd]:# (examples/sqids-minimum-length/sqids-minimum-length.go /.+sqids.New/ /\[1, 2, 3\]/)
```go
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:
[embedmd]:# (examples/sqids-custom-alphabet/sqids-custom-alphabet.go /.+sqids.New/ /\[1, 2, 3\]/)
```go
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:
[embedmd]:# (examples/sqids-blocklist/sqids-blocklist.go /.+sqids.New/ /\[1, 2, 3\]/)
```go
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](LICENSE)