pg_hashids
Short unique id generator for PostgreSQL, using hashids
Repository
iCyberon/pg_hashids
https://github.com/iCyberon/pg_hashids
Source
pg_hashids-1.3.tar.gz
pg_hashids-1.3.tar.gz
Overview
| Package | Version | Category | License | Language |
|---|---|---|---|---|
pg_hashids | 1.3 | FUNC | MIT | C |
| ID | Extension | Bin | Lib | Load | Create | Trust | Reloc | Schema |
|---|---|---|---|---|---|---|---|---|
| 4560 | pg_hashids | No | Yes | No | Yes | No | Yes | - |
| Related | pg_idkit pg_base58 pgx_ulid pg_uuidv7 sequential_uuids permuteseq |
|---|
Version
| Type | Repo | Version | PG Ver | Package | Deps |
|---|---|---|---|---|---|
| EXT | PIGSTY | 1.3 | 1817161514 | pg_hashids | - |
| RPM | PIGSTY | 1.3 | 1817161514 | pg_hashids_$v | - |
| DEB | PIGSTY | 1.3 | 1817161514 | postgresql-$v-pg-hashids | - |
Build
You can build the RPM / DEB packages for pg_hashids using pig build:
pig build pkg pg_hashids # build RPM / DEB packages
Install
You can install pg_hashids directly. First, make sure the PGDG and PIGSTY repositories are added and enabled:
pig repo add pgsql -u # Add repo and update cache
Install the extension using pig or apt/yum/dnf:
pig install pg_hashids; # Install for current active PG version
pig ext install -y pg_hashids -v 18 # PG 18
pig ext install -y pg_hashids -v 17 # PG 17
pig ext install -y pg_hashids -v 16 # PG 16
pig ext install -y pg_hashids -v 15 # PG 15
pig ext install -y pg_hashids -v 14 # PG 14
dnf install -y pg_hashids_18 # PG 18
dnf install -y pg_hashids_17 # PG 17
dnf install -y pg_hashids_16 # PG 16
dnf install -y pg_hashids_15 # PG 15
dnf install -y pg_hashids_14 # PG 14
apt install -y postgresql-18-pg-hashids # PG 18
apt install -y postgresql-17-pg-hashids # PG 17
apt install -y postgresql-16-pg-hashids # PG 16
apt install -y postgresql-15-pg-hashids # PG 15
apt install -y postgresql-14-pg-hashids # PG 14
Create Extension:
CREATE EXTENSION pg_hashids;
Usage
Converts numbers like 347 into strings like “yr8”. Useful for obfuscating database primary keys.
CREATE EXTENSION pg_hashids;
Functions
| Function | Description |
|---|---|
id_encode(number [, salt [, min_length [, alphabet]]]) | Encode an integer to a hashid string |
id_decode(hash, salt, min_length [, alphabet]) | Decode a hashid string back to integer array |
id_decode_once(hash [, salt [, min_length [, alphabet]]]) | Decode a hashid string back to a single integer |
Examples
-- Basic encoding
SELECT id_encode(1001); -- 'jNl'
SELECT id_encode(1234567, 'This is my salt'); -- 'Pdzxp'
SELECT id_encode(1234567, 'This is my salt', 10); -- 'PlRPdzxpR7'
-- Custom alphabet
SELECT id_encode(1234567, 'This is my salt', 10, 'abcdefghijABCDxFGHIJ1234567890');
-- '3GJ956J9B9'
-- Decoding (use the same salt!)
SELECT id_decode('PlRPdzxpR7', 'This is my salt', 10); -- 1234567
SELECT id_decode_once('jNl'); -- 1001
SELECT id_decode_once('Pdzxp', 'This is my salt'); -- 1234567
Feedback
Was this page helpful?
Thanks for the feedback! Please let us know how we can improve.
Sorry to hear that. Please let us know how we can improve.