Skip to content

Document that a custom Inspect implementation shows redacted fields #4805

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
ericmj merged 1 commit into from
Oct 19, 2026
+4 −2
Merged

Document that a custom Inspect implementation shows redacted fields #4805

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
6 changes: 4 additions & 2 deletions lib/ecto/schema.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,10 @@ defmodule Ecto.Schema do

A field marked with `redact: true` will display a value of `**redacted**`
when inspected in changes inside a `Ecto.Changeset` and be excluded from
inspect on the schema unless the schema module is tagged with
the option `@derive_inspect_for_redacted_fields false`.
inspect on the schema, unless the schema derives or implements `Inspect`
itself or the schema module is tagged with `@derive_inspect_for_redacted_fields false`.
A schema that derives `Inspect` itself must exclude redacted fields
explicitly, for example with `@derive {Inspect, except: [:password]}`.

A schema module tagged with `@schema_redact :all_except_primary_keys` will
redact all fields except primary keys.
Expand Down
Loading