Add @schema_redact: :all_except_primary_keys module attribute to Ecto Schema

[Nezteb]

Initial proposal: https://groups.google.com/g/elixir-ecto/c/kQJN-7HPn6E

@josevalim initially approved of the second of my two proposed options:

@schema_redact :all_except_primary_keys
schema "users" do
  # ...
end

While implementing, I realized that it's probably not best to redact all fields. I opted to keep the primary keys of a schema even if @schema_redact is set to something like :all, hence the rename to :all_except_primary_keys.

TODO:

• Document new property once implementation/naming is settled

Future ideas:

• Actually add @schema_redact: :all, but would that be useful?
• Add separate attributes only deriving inspect for a list of specific fields?

[solnic]

Fantastic! PKs by default sounds very reasonable. Thank you for working on this 💜

[josevalim]

Hi @Nezteb, in this case, I would call it :all_except_primary_keys.

Btw, implementation wise, I'd implement it here:

https://github.com/elixir-ecto/ecto/blob/master/lib/ecto/schema.ex#L1995-L1997

So it does something like this:

Keyword.get(opts, :redact, fn -> compute_default_redact_from_module_attribute(...) end)

This way, you don't need to change changesets nor nothing else, we reuse the existing redact infrastructure. WDYT?

[josevalim]

💚 💙 💜 💛 ❤️