posts-go/docs/2022-07-12-uuid-or-else.html

228 lines
7.1 KiB
HTML
Raw Normal View History

2023-07-18 18:38:30 +00:00
<!doctype html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link
rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/5.6.1/github-markdown.min.css"
/>
<title>haunt98 posts</title>
</head>
<style>
.markdown-body {
box-sizing: border-box;
min-width: 200px;
max-width: 980px;
margin: 0 auto;
padding: 45px;
2024-03-01 10:11:20 +00:00
font-family:
Shantell Sans Normal,
Rec Mono Casual,
SF Pro,
Inter,
sans-serif;
font-weight: 500;
}
.markdown-body pre {
font-family:
Berkeley Mono,
IBM Plex Mono,
SF Mono,
Jetbrains Mono,
monospace;
}
@media (max-width: 767px) {
.markdown-body {
padding: 15px;
}
}
</style>
<body class="markdown-body">
2023-08-09 07:22:58 +00:00
<h2>
<a href="index.html"><code>~</code></a>
</h2>
2024-02-29 12:29:26 +00:00
<div class="markdown-heading">
<h1 class="heading-element">UUID or else</h1>
2023-11-19 15:59:21 +00:00
<a
id="user-content-uuid-or-else"
2024-03-08 08:12:41 +00:00
class="anchor"
2024-02-29 12:29:26 +00:00
aria-label="Permalink: UUID or else"
2023-11-19 15:59:21 +00:00
href="#uuid-or-else"
2024-02-29 12:29:26 +00:00
><span aria-hidden="true" class="octicon octicon-link"></span
></a>
</div>
2022-12-30 09:26:06 +00:00
<p>
There are many use cases where we need to use a unique ID. In my
2024-07-22 11:32:39 +00:00
experience, I only encounter 2 cases:
2022-12-30 09:26:06 +00:00
</p>
<ul>
<li>
ID to trace request from client to server, from service to service
(microservice architecture or nanoservice I don't know).
</li>
<li>Primary key for database.</li>
</ul>
<p>In my Go universe, there are some libs to help us with this:</p>
<ul>
<li><a href="https://github.com/google/uuid">google/uuid</a></li>
<li><a href="https://github.com/rs/xid">rs/xid</a></li>
<li><a href="https://github.com/segmentio/ksuid">segmentio/ksuid</a></li>
<li><a href="https://github.com/oklog/ulid">oklog/ulid</a></li>
</ul>
2024-02-29 12:29:26 +00:00
<div class="markdown-heading">
<h2 class="heading-element">
First use case is trace ID, or context aware ID
</h2>
2022-12-30 09:26:06 +00:00
<a
2023-11-19 15:59:21 +00:00
id="user-content-first-use-case-is-trace-id-or-context-aware-id"
2024-03-08 08:12:41 +00:00
class="anchor"
2024-02-29 12:29:26 +00:00
aria-label="Permalink: First use case is trace ID, or context aware ID"
2022-12-30 09:26:06 +00:00
href="#first-use-case-is-trace-id-or-context-aware-id"
2024-02-29 12:29:26 +00:00
><span aria-hidden="true" class="octicon octicon-link"></span
></a>
</div>
2022-12-30 09:26:06 +00:00
<p>
The ID is used only for trace and log. If same ID is generated twice
2024-07-22 11:32:39 +00:00
(because maybe the possibility is too small but not 0), honestly I don't
2022-12-30 09:26:06 +00:00
care. When I use that ID to search log , if it pops more than things I
care for, it is still no harm to me.
</p>
<p>
My choice for this use case is <strong>rs/xid</strong>. Because it is
small (not span too much on log line) and copy friendly.
</p>
2024-02-29 12:29:26 +00:00
<div class="markdown-heading">
<h2 class="heading-element">
Second use case is primary key, also hard choice
</h2>
2022-12-30 09:26:06 +00:00
<a
2023-11-19 15:59:21 +00:00
id="user-content-second-use-case-is-primary-key-also-hard-choice"
2024-03-08 08:12:41 +00:00
class="anchor"
2024-02-29 12:29:26 +00:00
aria-label="Permalink: Second use case is primary key, also hard choice"
2022-12-30 09:26:06 +00:00
href="#second-use-case-is-primary-key-also-hard-choice"
2024-02-29 12:29:26 +00:00
><span aria-hidden="true" class="octicon octicon-link"></span
></a>
</div>
2022-12-30 09:26:06 +00:00
<p>
Why I don't use auto increment key for primary key? The answer is simple,
I don't want to write database specific SQL. SQLite has some different
syntax from MySQL, and PostgreSQL and so on. Every logic I can move to
application layer from database layer, I will.
</p>
2024-06-25 10:33:22 +00:00
<p>The ID must be sortable (because index) and unique.</p>
<p>I have 3 choices:</p>
<ul>
<li><strong>google/uuid</strong>: use UUID v7 not v4.</li>
<li>
<strong>segmentio/ksuid</strong>: handle error if you don't want panic.
</li>
<li><strong>oklog/ulid</strong>: don't use yet.</li>
</ul>
2024-02-29 12:29:26 +00:00
<div class="markdown-heading">
<h2 class="heading-element">What else?</h2>
2023-11-19 15:59:21 +00:00
<a
id="user-content-what-else"
2024-03-08 08:12:41 +00:00
class="anchor"
2024-02-29 12:29:26 +00:00
aria-label="Permalink: What else?"
2023-11-19 15:59:21 +00:00
href="#what-else"
2024-02-29 12:29:26 +00:00
><span aria-hidden="true" class="octicon octicon-link"></span
></a>
</div>
2022-12-30 09:26:06 +00:00
<p>
I think about adding prefix to ID to identify which resource that ID
represents.
</p>
2024-06-25 10:33:22 +00:00
<p>For example: <code>user:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</code>.</p>
2024-02-29 12:29:26 +00:00
<div class="markdown-heading">
<h2 class="heading-element">Thanks</h2>
2023-11-19 15:59:21 +00:00
<a
id="user-content-thanks"
2024-03-08 08:12:41 +00:00
class="anchor"
2024-02-29 12:29:26 +00:00
aria-label="Permalink: Thanks"
2023-11-19 15:59:21 +00:00
href="#thanks"
2024-02-29 12:29:26 +00:00
><span aria-hidden="true" class="octicon octicon-link"></span
></a>
</div>
2022-12-30 09:26:06 +00:00
<ul>
<li>
2024-06-25 10:33:22 +00:00
<p>
<a href="https://datatracker.ietf.org/doc/html/rfc9562" rel="nofollow"
>Universally Unique IDentifiers (UUIDs)</a
>
</p>
</li>
<li>
<p>
<a href="https://0pointer.net/blog/projects/ids.html" rel="nofollow"
>On IDs</a
>
</p>
</li>
<li>
<p>
<a
href="https://www.cybertec-postgresql.com/en/uuid-serial-or-identity-columns-for-postgresql-auto-generated-primary-keys/"
rel="nofollow"
>UUID, SERIAL OR IDENTITY COLUMNS FOR POSTGRESQL AUTO-GENERATED
PRIMARY KEYS?</a
>
</p>
2022-12-30 09:26:06 +00:00
</li>
<li>
2024-06-25 10:33:22 +00:00
<p>
<a href="https://brandur.org/nanoglyphs/026-ids" rel="nofollow"
>Identity Crisis: Sequence v. UUID as Primary Key</a
>
</p>
2022-12-30 09:26:06 +00:00
</li>
<li>
2024-06-25 10:33:22 +00:00
<p>
<a
href="https://blog.kowalczyk.info/article/JyRZ/generating-good-unique-ids-in-go.html"
rel="nofollow"
>Generating good unique ids in Go</a
>
</p>
2022-12-30 09:26:06 +00:00
</li>
<li>
2024-06-25 10:33:22 +00:00
<p>
<a
href="https://encore.dev/blog/go-1.18-generic-identifiers"
rel="nofollow"
>How we used Go 1.18 when designing our Identifiers</a
>
</p>
2022-12-30 09:26:06 +00:00
</li>
<li>
2024-06-25 10:33:22 +00:00
<p>
<a href="https://blog.daveallie.com/ulid-primary-keys" rel="nofollow"
>ULIDs and Primary Keys</a
>
</p>
2022-12-30 09:26:06 +00:00
</li>
<li>
2024-06-25 10:33:22 +00:00
<p>
<a href="https://antonz.org/uuidv7/" rel="nofollow"
>UUIDv7 in 32 languages</a
>
</p>
2022-12-30 09:26:06 +00:00
</li>
</ul>
2022-12-25 19:22:39 +00:00
<div>
Feel free to ask me via
<a href="mailto:hauvipapro+posts@gmail.com">email</a> or
2023-08-20 17:29:13 +00:00
<a rel="me" href="https://hachyderm.io/@haunguyen">Mastodon</a>.
<br />Source code is available on
2022-12-30 09:55:38 +00:00
<a href="https://github.com/haunt98/posts-go">GitHub</a>
2023-08-20 17:29:13 +00:00
<a href="https://codeberg.org/yoshie/posts-go">Codeberg</a>
<a href="https://git.sr.ht/~youngyoshie/posts-go">sourcehut</a>
<a href="https://gitea.treehouse.systems/yoshie/posts-go">Treehouse</a>
<a href="https://gitlab.com/youngyoshie/posts-go">GitLab</a>
2022-12-25 19:22:39 +00:00
</div>
</body>
</html>