*: add column-level masking policy feature document by tiancaiamao · Pull Request #21454 · pingcap/docs-cn

tiancaiamao · 2026-03-23T09:20:14Z

First-time contributors' checklist

I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions (in Chinese).

What is the related PR or file link(s)?

This PR is translated from:
Other reference link(s): *: add document for column-level masking policy feature docs#22613

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

qiancai · 2026-03-24T10:44:13Z

@tiancaiamao Please involve a tech reviewer for this PR. Thanks.

bb7133 · 2026-05-09T02:57:34Z

Please address the comments~

ti-chi-bot · 2026-05-09T07:48:48Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from qiancai. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Co-authored-by: Grace Cai <qqzczy@126.com>

pingcap-cla-assistant · 2026-05-29T05:26:06Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
8 out of 9 committers have signed the CLA.

✅ xhebox
✅ tiancaiamao
✅ wlwilliamx
✅ yibin87
✅ qiancai
✅ solotzg
✅ Oreoxmt
✅ hfxsd
❌ Test User

Test User seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

# Conflicts: # sql-statements/sql-statement-overview.md

Add SQL statement docs for the column-level data masking feature: - New: sql-statement-create-masking-policy.md (CREATE MASKING POLICY) - New: sql-statement-show-masking-policies.md (SHOW MASKING POLICIES) - Updated: sql-statement-alter-table.md (ADD/DROP/ENABLE/DISABLE/MODIFY MASKING POLICY) - Updated: sql-statement-overview.md (add masking entries to DDL and SHOW tables) - Updated: TOC.md (add new statement entries) Refs: #21454

tiancaiamao · 2026-05-29T07:24:15Z

Add sql-statement related part, PTAL @qiancai

…cs-cn into column-masking-policy

qiancai

Rest LGTM

ti-chi-bot · 2026-06-08T08:06:35Z

[LGTM Timeline notifier]

Timeline:

2026-06-08 08:06:35.181916609 +0000 UTC m=+774496.252233989: ☑️ agreed by qiancai.

qiancai · 2026-06-10T03:56:24Z

+- **返回规则**
+    - **字符串** → 返回相同长度的字符串，所有字符替换为 `'X'`
+    - **日期/DATETIME/TIMESTAMP** → 返回 `1970-01-01`（保留原始类型和小数秒精度）
+    - **Duration** → 返回 `00:00:00`


qiancai · 2026-06-10T03:59:12Z

+- **字符串类型**：`VARCHAR`、`CHAR`、`TEXT` 及其变体
+- **二进制类型**：`BINARY`、`VARBINARY`、`BLOB`
+- **日期和时间类型**：`DATE`、`TIME`、`DATETIME`、`TIMESTAMP`、`YEAR`
+


这里要加一个 bullet，写数值类型吗？

不支持数值类型

支持这些:

VARCHAR, CHAR, TEXT(TINYTEXT, MEDIUMTEXT, LONGTEXT), BLOB(TINYBLOB, MEDIUMBLOB, LONGBLOB)

For the LONGTEXT and BLOB types, full masking (full redaction) or NULL masking needs to be supported.

DATE, TIME,DATETIME,TIMESTAMP,YEAR

Co-authored-by: Grace Cai <qqzczy@126.com>

tiancaiamao · 2026-06-11T06:13:23Z

PTAL @bb7133

expxiaoli

LGTM

ti-chi-bot · 2026-06-15T01:13:31Z

@expxiaoli: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

LGTM

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

tiancaiamao · 2026-06-15T06:02:34Z

/retest

ti-chi-bot · 2026-07-10T14:56:50Z

@tiancaiamao: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-verify	`638c43c`	link	true	`/test pull-verify`

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

*: add column-level masking policy feature document

f088931

ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 23, 2026

tiancaiamao mentioned this pull request Mar 23, 2026

*: add document for column-level masking policy feature pingcap/docs#22613

Open

14 tasks

add file

7d9f34b

ti-chi-bot Bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 23, 2026

hfxsd added translation/doing This PR’s assignee is translating this PR. and removed missing-translation-status This PR does not have translation status info. labels Mar 24, 2026

qiancai added the v9.0-beta.3 This PR/issue applies to TiDB v9.0-beta.3. label Mar 24, 2026

Frank945946 reviewed Apr 1, 2026

View reviewed changes

Comment thread column-level-masking-policy.md Outdated

Comment thread column-level-masking-policy.md Outdated

qiancai self-assigned this Apr 17, 2026

tiancaiamao requested a review from bb7133 May 9, 2026 02:56

tiancaiamao added 2 commits May 9, 2026 15:42

Merge branch 'master' into column-masking-policy

765ead0

address comment

c86aa36

address comment

004d0fa

qiancai reviewed May 11, 2026

View reviewed changes

Comment thread column-level-masking-policy.md Outdated

qiancai reviewed May 11, 2026

View reviewed changes

qiancai reviewed May 12, 2026

View reviewed changes

Comment thread column-level-masking-policy.md Outdated

qiancai reviewed May 12, 2026

View reviewed changes

Comment thread column-level-masking-policy.md Outdated

qiancai reviewed May 12, 2026

View reviewed changes

Comment thread column-level-masking-policy.md Outdated

Apply suggestions from code review

7d9bc9c

Co-authored-by: Grace Cai <qqzczy@126.com>

tiancaiamao commented May 14, 2026

View reviewed changes

qiancai reviewed May 19, 2026

View reviewed changes

Comment thread column-level-masking-policy.md Outdated

Comment thread column-level-masking-policy.md Outdated

Comment thread column-level-masking-policy.md Outdated

Comment thread column-level-masking-policy.md Outdated

Comment thread column-level-masking-policy.md Outdated

Apply suggestions from code review

d73e99f

Co-authored-by: Grace Cai <qqzczy@126.com>

tiancaiamao requested a review from qiancai May 20, 2026 08:39

Test User and others added 2 commits May 29, 2026 13:29

Merge remote-tracking branch 'origin/master' into column-masking-policy

ee1411a

# Conflicts: # sql-statements/sql-statement-overview.md

tiancaiamao force-pushed the column-masking-policy branch from ee1411a to 6f7e786 Compare May 29, 2026 07:12

qiancai added 2 commits June 4, 2026 11:13

Merge branch 'column-masking-policy' of https://github.com/pingcap/do…

7ccc91c

…cs-cn into column-masking-policy

removed copyable tags and fixed toc indention

c664ff5

qiancai reviewed Jun 4, 2026

View reviewed changes

qiancai and others added 2 commits June 4, 2026 14:44

editorial changes

21a94d9

address comment

53b0122

qiancai approved these changes Jun 8, 2026

View reviewed changes

Comment thread privilege-management.md Outdated

Comment thread sql-statements/sql-statement-create-masking-policy.md Outdated

ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jun 8, 2026

Apply suggestions from code review

fc90d60

qiancai reviewed Jun 10, 2026

View reviewed changes

Comment thread sql-statements/sql-statement-create-masking-policy.md Outdated

qiancai reviewed Jun 10, 2026

View reviewed changes

Comment thread sql-statements/sql-statement-create-masking-policy.md Outdated

qiancai reviewed Jun 10, 2026

View reviewed changes

Comment thread sql-statements/sql-statement-create-masking-policy.md Outdated

minor wording updates

6e3c9c1

qiancai reviewed Jun 10, 2026

View reviewed changes

Comment thread column-level-masking-policy.md Outdated

qiancai reviewed Jun 10, 2026

View reviewed changes

qiancai and others added 2 commits June 10, 2026 13:02

fix broken links

ebce75c

Apply suggestions from code review

80bc12c

Co-authored-by: Grace Cai <qqzczy@126.com>

expxiaoli approved these changes Jun 15, 2026

View reviewed changes

qiancai reviewed Jul 10, 2026

View reviewed changes

Comment thread column-level-masking-policy.md Outdated

remove a duplicated sentence

638c43c

Uh oh!

Conversation

tiancaiamao commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

First-time contributors' checklist

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

Uh oh!

qiancai commented Mar 24, 2026

Uh oh!

Uh oh!

Uh oh!

bb7133 commented May 9, 2026

Uh oh!

ti-chi-bot Bot commented May 9, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pingcap-cla-assistant Bot commented May 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tiancaiamao commented May 29, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

qiancai left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ti-chi-bot Bot commented Jun 8, 2026

[LGTM Timeline notifier]

Uh oh!

tiancaiamao commented Mar 23, 2026 •

edited

Loading

pingcap-cla-assistant Bot commented May 29, 2026 •

edited

Loading