Skip to content

Commit 486be7d

Browse files
committed
Update docs for phone number transformer
1 parent 460f15f commit 486be7d

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

docs/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -983,6 +983,42 @@ transformations:
983983
literal: "{'error': null}"
984984
```
985985

986+
</details>
987+
<details>
988+
<summary>phone_number</summary>
989+
990+
**Description:** Generates anonymized phone numbers with customizable length.
991+
992+
| Supported PostgreSQL types |
993+
| ----------------------------------- |
994+
| `text`, `varchar`, `char`, `bpchar` |
995+
996+
| Parameter | Type | Default | Required | Values |
997+
| --------------- | ------ | ------- | -------- | --------------------- |
998+
| prefix | string | "" | No | N/A |
999+
| min_length | int | 6 | No | N/A |
1000+
| max_length | int | 10 | No | N/A |
1001+
| generator | string | random | No | random, deterministic |
1002+
1003+
If the prefix is set, this transformer will always generate phone numbers starting with the prefix.
1004+
1005+
**Example Configuration:**
1006+
1007+
```yaml
1008+
transformations:
1009+
table_transformers:
1010+
- schema: public
1011+
table: users
1012+
column_transformers:
1013+
phone:
1014+
name: phone_number
1015+
parameters:
1016+
prefix: "+90"
1017+
min_length: 9
1018+
max_length: 12
1019+
generator: deterministic
1020+
```
1021+
9861022
</details>
9871023

9881024
### Transformation rules

0 commit comments

Comments
 (0)