An Elixir implementation of TypeID.
TypeIDs are a modern, type-safe, globally unique identifier based on the upcoming UUIDv7 standard. They provide a ton of nice properties that make them a great choice as the primary identifiers for your data in a database, APIs, and distributed systems. Read more about TypeIDs in the specification.
def deps do
[
{:elixir_typeid, "~> 0.1"}
]
end- The test cases of the formal specification are 100% covered.
- Implements
Ecto.ParameterizedTypecan optionally integrate with Ecto schema. - Implements
Jason.Encodercan optionally inegerate withjasonencoding.
iex> {:ok, typeid} = Typeid.new("user")
{:ok, #Typeid<"user_01hz6wxrw2ecmtwaqhnnpr275f">}
iex> "#{typeid}"
"user_01hz6wxrw2ecmtwaqhnnpr275f"
iex> Typeid.uuid(typeid)
{:ok, #UUIDv7<018fcdce-e382-7329-ae2a-f1ad6d811caf>}
iex> Typeid.parse("user_01hz6wxrw2ecmtwaqhnnpr275f")
{:ok, #Typeid<"user_01hz6wxrw2ecmtwaqhnnpr275f">}
iex> Typeid.valid?(typeid)
trueIn usual we use TypeID to generate the primary key with Ecto schema, define Typeid type within @primary_key:
defmodule User do
use Ecto.Schema
@primary_key {:id, Typeid, autogenerate: true, type: "user"}
schema "user" do
field(:name, :string)
end
endor define Typeid type in a primary key field of a schema:
defmodule User do
use Ecto.Schema
@primary_key false
schema "user" do
field(:user_id, Typeid, autogenerate: true, primary_key: true, type: "user")
field(:name, :string)
end
endIf the type: "user" in the above mentioned examples is not set, there will process the prefix of the Typeid as nil.
We can simply encode Typeid struct within jason.
iex> typeid
#Typeid<"user_01hz6wxrw2ecmtwaqhnnpr275f">
iex> Jason.encode(%{id: typeid})
{:ok, "{\"id\":\"user_01hz6wxrw2ecmtwaqhnnpr275f\"}"}