anonymize block and all YAML fields, see
YAML Reference. For organization-wide
enforcement, see Snapshot rules.
Quick start
auto turns on built-in PII detection and still lets you add explicit rules
for overrides.
Modes
Which mode should I use?
- Use
autoif you want the safest default for most development, CI, and staging workflows. It catches common PII automatically and still lets you add overrides. - Use
manualif you need full control over exactly which fields are masked and how. This is common when your schema has unusual field names or domain specific rules. - Use
offonly when you are certain the source data contains no sensitive information or you are working with already-anonymized input.
Rules
Use table-grouped keys forpublic tables (unqualified names resolve to
public.<table>) or wildcard keys for patterns such as *.email.
strategy + optional params (for example partial_mask
with visible, numeric_noise with percent).
Internal and test emails
Top-levelexcluded_domains skips anonymization for matching email domains
(case-insensitive). Per-rule params.excluded_domains overrides that list for a
single field. Details and examples are in
YAML Reference — anonymize.
Organization policies
On Team and Enterprise plans, Snapshot rules in the app can require specific strategies (for example*.email: fake_email) and excluded tables across every
snapshot. See Snapshot rules.
Strategies
See also
- How it works — extraction and traversal
snapshot create— CLI usage