Configuration reference (auto-generated)

Generated from the pydantic Config model. For narrative examples see configuration.md. Raw schema: mask-rules.schema.json.

Regenerate with make docs-generate.

Root document (mask-rules.yaml)

Field	Type	Required	Description
audit_log	boolean	no	Default: True.
auto_detect	boolean	no	Default: True.
batch_size	integer	no	Default: 10000.
elevated_objects	object	no
global_salt	string | null	no
implied_fk_ignore	array[string]	no
on_existing_data	enum: fail, truncate, drop_create, append	no	Default: fail.
passthrough_copy	enum: auto, require_binary, batch	no	Default: auto.
pseudonym_key	string | null	no
refresh_materialized_views	boolean	no	Default: False.
replicate_all_indexes	boolean	no	Default: False.
replicate_functions	boolean	no	Default: True.
replicate_materialized_views	boolean	no	Default: False.
replicate_triggers	boolean	no	Default: True.
replicate_views	boolean	no	Default: True.
schema_mode	enum: replicate, assume_existing	no	Default: replicate.
strict_autodetect	boolean	no	Default: False.
tables	object	no
version	string	yes

AiRefineAction

Field	Type	Required	Description
action	string	yes
model	string	yes
params	object	no
provider	string	yes
when	string | null	no

FakeAction

Field	Type	Required	Description
action	string	yes
params	object	no
provider	string	yes
seed_alias	string | null	no
when	string | null	no

HashAction

Field	Type	Required	Description
action	string	yes
when	string | null	no

HmacHashAction

Field	Type	Required	Description
action	string	yes
encoding	enum: hex, base64url	no	Default: hex.
when	string | null	no

NerMaskAction

Field	Type	Required	Description
action	string	yes
entities	array[string]	no
when	string | null	no

NullAction

Field	Type	Required	Description
action	string	yes
when	string | null	no

PassthroughAction

Field	Type	Required	Description
action	string	yes
when	string | null	no

PseudonymAction

Field	Type	Required	Description
action	string	yes
params	object	no
provider	string	yes
seed_alias	string | null	no
when	string | null	no

RegexMaskAction

Field	Type	Required	Description
action	string	yes
flags	array[string]	no
pattern	string	yes
replace	string	yes
when	string | null	no

StaticAction

Field	Type	Required	Description
action	string	yes
value	string	yes
when	string | null	no

TableConfig

Field	Type	Required	Description
batch_size	integer | null	no
columns	object	no
null_orphan_fks	boolean	no	Default: False.
strategy	enum: transform, exclude, empty, truncate	no	Default: transform.