Skip to content

Instantly share code, notes, and snippets.

@mkstayalive
Forked from fabiolimace/ksuid.sql
Last active October 26, 2022 10:01
Show Gist options
  • Save mkstayalive/0c2d7464bfef449190ab0693f615843d to your computer and use it in GitHub Desktop.
Save mkstayalive/0c2d7464bfef449190ab0693f615843d to your computer and use it in GitHub Desktop.
Function for generating Segment's KSUIDs on PostgreSQL
/**
* Returns a Segment's KSUID.
*
* Reference implementation: https://github.com/segmentio/ksuid
* Also read: https://segment.com/blog/a-brief-history-of-the-uuid/
* Taken suggestions from: https://stackoverflow.com/a/71137273/518493
*/
CREATE EXTENSION pgcrypto;
CREATE OR REPLACE FUNCTION fn_ksuid(prefix text DEFAULT '') RETURNS text AS $$
DECLARE
v_time timestamp with time zone := null;
v_seconds numeric := null;
v_payload bytea := null;
v_numeric numeric := null;
v_base62 text := '';
v_epoch numeric = 1400000000; -- 2014-05-13T16:53:20Z
v_alphabet char array[62] := array[
'0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J',
'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T',
'U', 'V', 'W', 'X', 'Y', 'Z',
'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j',
'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't',
'u', 'v', 'w', 'x', 'y', 'z'];
i integer := 0;
BEGIN
-- Get the current time
v_time := clock_timestamp();
-- Extract seconds from the current time and apply epoch
v_seconds := EXTRACT(EPOCH FROM v_time) - v_epoch;
-- Generate a numeric value from the seconds
v_numeric := v_seconds * pow(2::numeric, 128);
-- Generate a pseudo-random payload
-- v_payload := gen_random_bytes(16); -- to be used with `pgcrypto`
v_payload := gen_random_bytes(16);
-------------------------------------------------------------------
-- FOR TEST: the expected result is '0ujtsYcgvSTl8PAuAdqWYSMnLOv'
-------------------------------------------------------------------
-- v_numeric := 107608047 * pow(2::numeric, 128);
-- v_payload := decode('B5A1CD34B5F99D1154FB6853345C9735', 'hex');
-- Add the payload to the numeric value
while i < 16 loop
i := i + 1;
v_numeric := v_numeric + (get_byte(v_payload, i - 1) * pow(2::numeric, (16 - i) * 8));
end loop;
-- Encode the numeric value to base62
while v_numeric <> 0 loop
v_base62 := v_base62 || v_alphabet[floor(mod(v_numeric, 62)) + 1];
v_numeric := div(v_numeric, 62);
end loop;
v_base62 := reverse(v_base62);
v_base62 := lpad(v_base62, 27, '0');
return prefix || v_base62;
END $$ language plpgsql;
-- EXAMPLE:
-- select fn_ksuid() ksuid, clock_timestamp()-statement_timestamp() time_taken;
-- EXAMPLE OUTPUT:
-- |ksuid |time_taken |
-- |-----------------------------|------------------|
-- |23SxnNLOWpyXUHauWNwS2O8pxgG |00:00:00.001373 |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment