allow binary type

This commit is contained in:
Dennis Beatty 2024-07-16 23:54:01 -06:00
parent ee51c5fdcb
commit 6af1efe6d3
No known key found for this signature in database
GPG key ID: CF0FEE7E6719D59C
2 changed files with 12 additions and 9 deletions
README.md
lib/type_id

View file

@ -31,7 +31,7 @@ TypeIDs as fields in your Ecto schemas.
defmodule MyApp.Accounts.User do
use Ecto.Schema
@primary_key {:id, TypeID, autogenerate: true, prefix: "acct", type: :binary_id}
@primary_key {:id, TypeID, autogenerate: true, prefix: "acct", type: :binary}
@foreign_key_type TypeID
# ...
@ -40,9 +40,11 @@ end
### Underlying types
`TypeID`s can be stored as either `:string` or `:binary_id`. `:string` will
store the entire TypeID including the prefix. `:binary_id` stores only the
UUID portion and requires a `:uuid` or `:binary` column.
`TypeID`s can be stored as `:string`, `:binary_id`, or `:binary`. `:string` will
store the entire TypeID including the prefix. `:binary` and `:binary_id` store
only the UUID portion and require a `:uuid` or `:binary` column. `:binary_id`
will use UUIDv4 (non K-sortable), whereas `:binary` will use UUIDv7, so
`:binary` is recommended over `:binary_id` for that reason.
#### Default type
@ -50,5 +52,5 @@ The type used can be set globally in the application config.
```elixir
config :typeid_elixir,
default_type: :binary_id
default_type: :binary
```

View file

@ -49,6 +49,7 @@ if Code.ensure_loaded?(Ecto.ParameterizedType) do
case {tid.prefix, type} do
{^prefix, :string} -> {:ok, TypeID.to_string(tid)}
{^prefix, :binary_id} -> {:ok, TypeID.uuid(tid)}
{^prefix, :binary} -> {:ok, TypeID.uuid_bytes(tid)}
_ -> :error
end
end
@ -66,12 +67,12 @@ if Code.ensure_loaded?(Ecto.ParameterizedType) do
end
end
def load(<<_::128>> = uuid, _, %{type: :binary_id} = params) do
def load(<<_::128>> = uuid, _, %{type: type} = params) when type in [:binary_id, :binary] do
prefix = find_prefix(params)
TypeID.from_uuid_bytes(prefix, uuid)
end
def load(<<_::288>> = uuid, _, %{type: :binary_id} = params) do
def load(<<_::288>> = uuid, _, %{type: type} = params) when type in [:binary_id, :binary] do
prefix = find_prefix(params)
TypeID.from_uuid(prefix, uuid)
rescue
@ -95,8 +96,8 @@ if Code.ensure_loaded?(Ecto.ParameterizedType) do
end
end
unless type in ~w[string binary_id]a do
raise ArgumentError, "`type` must be `:string` or `:binary_id`"
unless type in ~w[string binary_id binary]a do
raise ArgumentError, "`type` must be `:string`, `:binary_id`, or `:binary`"
end
if primary_key do