Skip to content

Document usage of ParametrizedType inside of a composite type #4559

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
josevalim merged 1 commit into from
Dec 22, 2024
Merged

Document usage of ParametrizedType inside of a composite type #4559

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions lib/ecto/parameterized_type.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,13 @@ defmodule Ecto.ParameterizedType do
field :bar, MyApp.MyType, opt1: :baz, opt2: :boo
end

To use this type in a schema field with a composite type, specify the type in a tuple
and opts afterwards.

schema "foo" do
field :bars, {:array, MyApp.MyType}, opt1: :baz, opt2: :boo
end

To use this type in places where you need it to be initialized (for example,
schemaless changesets), you can use `init/2`.

Expand Down
Loading