CREATE MASK RULE

Description

The CREATE MASK RULE syntax is used to create a mask rule.

Syntax

Grammar Railroad diagram

  1. CreateEncryptRule ::=
  2.   'CREATE' 'MASK' 'RULE' ifNotExists? maskRuleDefinition (',' maskRuleDefinition)*
  4. ifNotExists ::=
  5.   'IF' 'NOT' 'EXISTS'
  7. maskRuleDefinition ::=
  8.   ruleName '(' 'COLUMNS' '(' columnDefinition (',' columnDefinition)* ')' ')'
  10. columnDefinition ::=
  11.   '(' 'NAME' '=' columnName ',' maskAlgorithmDefinition ')'
  13. maskAlgorithmDefinition ::=
  14.   'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
  16. propertiesDefinition ::=
  17.   'PROPERTIES' '(' key '=' value (',' key '=' value)* ')'
  19. ruleName ::=
  20.   identifier
  22. columnName ::=
  23.   identifier
  25. algorithmType ::=
  26.   literal
  28. key ::=
  29.   string
  31. value ::=
  32.   literal

Note

  • algorithmType specifies the data masking algorithm type. For more details, please refer to Data Masking Algorithm;
  • Duplicate ruleName will not be created;
  • ifNotExists clause is used for avoid Duplicate mask rule error.

Example

Create a mask rule

  1. CREATE MASK RULE t_mask (
  2. COLUMNS(
  3. (NAME=phone_number,TYPE(NAME='MASK_FROM_X_TO_Y', PROPERTIES("from-x"=1, "to-y"=2, "replace-char"="*"))),
  4. (NAME=address,TYPE(NAME='MD5'))
  5. ));

Create mask rule with ifNotExists clause

  1. CREATE MASK RULE IF NOT EXISTS t_mask (
  2. COLUMNS(
  3. (NAME=phone_number,TYPE(NAME='MASK_FROM_X_TO_Y', PROPERTIES("from-x"=1, "to-y"=2, "replace-char"="*"))),
  4. (NAME=address,TYPE(NAME='MD5'))
  5. ));

Reserved words

CREATE, MASK, RULE, COLUMNS, NAME, TYPE