Skip to content

Add Exqlite.TypeExtensions to allow more types to be stored in the database #333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 20, 2025
Merged

Add Exqlite.TypeExtensions to allow more types to be stored in the database #333

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb9593b
Exqlite.TypeExtensions
aseigo Jun 20, 2025
7b5d2ee
Use a tagged :ok/:error tuple
aseigo Jun 20, 2025
704c9bd
default to nil
aseigo Jun 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions lib/exqlite/sqlite3.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -489,12 +489,19 @@ defmodule Exqlite.Sqlite3 do

defp convert_with_type_extensions([extension | other_extensions], val) do
case extension.convert(val) do
nil -> convert_with_type_extensions(other_extensions, val)
convert -> convert
nil ->
convert_with_type_extensions(other_extensions, val)

{:ok, converted} ->
converted

{:error, reason} ->
raise ArgumentError,
"Failed conversion by TypeExtension #{extension}: #{inspect(val)}. Reason: #{inspect(reason)}."
end
end

defp type_extensions() do
defp type_extensions do
Application.get_env(:exqlite, :type_extensions, [])
end
end
5 changes: 4 additions & 1 deletion lib/exqlite/extension.ex → lib/exqlite/type_extension.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ defmodule Exqlite.TypeExtension do

@doc """
Takes a value and convers it to data suitable for storage in the database.

Returns a tagged :ok/:error tuple. If the value is not convertable by this
extension, returns nil.
"""
@callback convert(value :: term) :: term
@callback convert(value :: term) :: {:ok, term} | {:error, reason :: term} | nil
Copy link
Member

@warmwaffles warmwaffles Jun 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know it's just an atom, but perhaps :unsupported is more clear than nil?

Copy link
Contributor Author

@aseigo aseigo Jun 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason I didn't use a more "expressive" atom is one ends up having to remember all the various names for "this is not something that is happening" return values. nil is convenient in that it is the least surprising (at least for me) and widely used to mean "nothing here".

If you prefer, I can change it to :unsupported, but as a library user I lean towards "common and therefore predictable" in these cases.

Copy link
Member

@warmwaffles warmwaffles Jun 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No that's a fine justification.

end