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.
global_salt	string | null	no
implied_fk_ignore	array[string]	no
on_existing_data	enum: fail, truncate, drop_create, append	no	Default: fail.
replicate_all_indexes	boolean	no	Default: False.
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

FakeAction

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

HashAction

Field	Type	Required	Description
action	string	yes

NerMaskAction

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

NullAction

Field	Type	Required	Description
action	string	yes

PassthroughAction

Field	Type	Required	Description
action	string	yes

RegexMaskAction

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

StaticAction

Field	Type	Required	Description
action	string	yes
value	string	yes

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.