custom_classifier!ADD_REGEX

See also:

Using custom classifiers to implement custom semantic categories

Adds categories and a regular expression to the custom classifier, while optionally specifying a regular expression for the column name and a comment.

Syntax

<custom_classifier>!ADD_REGEX(
  SEMANTIC_CATEGORY => '<custom_category>' ,
  PRIVACY_CATEGORY => { 'IDENTIFIER' | 'QUASI-IDENTIFIER' | 'SENSITIVE' } ,
  VALUE_REGEX => '<regular_expression>' ,
  [ COL_NAME_REGEX => <regular_expression> ] ,
  [ DESCRIPTION => <string> ] ,
  [ THRESHOLD => <number> ]
)
Copy

Arguments

Required:

SEMANTIC_CATEGORY => custom_category

Specifies the name of the custom category (that is, type of information).

PRIVACY_CATEGORY => { 'IDENTIFIER' | 'QUASI-IDENTIFIER' | 'SENSITIVE' }

Specifies the sensitivity of the data, and can be one of the following values: 'IDENTIFIER', 'QUASI_IDENTIFIER', or 'SENSITIVE'.

VALUE_REGEX => regular_expression

Specifies the regular expression to match the values in a column.

You can test the syntax of the regular expression by calling the REGEXP_LIKE function.

Optional:

COL_NAME_REGEX => regular_expression

Specifies the regular expression to match the name of the column that you want to classify.

DESCRIPTION => string

Specifies a comment describing the custom category or the custom classifier that implements it.

THRESHOLD => number

Specifies the threshold value for the scoring rule. For more information, see Threshold for custom categories.

The acceptable range is greater than 0.0 and less than or equal to 1.0.

Default: 0.8.

Output

Returns a status message indicating the association of the category with the custom classifier in this format: classifier_name:category_name.

Access control requirements

A role used to execute this operation must have the following privileges at a minimum:

Instance role

Object

Notes

custom_classifier!PRIVACY_USER

The custom classification instance.

The account role that calls this method must be granted this instance role on the custom classifier.

By default, the account role used to create the instance can call this method.

Operating on an object in a schema requires at least one privilege on the parent database and at least one privilege on the parent schema.

For instructions on creating a custom role with a specified set of privileges, see Creating custom roles.

For general information about roles and privilege grants for performing SQL actions on securable objects, see Overview of Access Control.

Usage notes

  • Calling this method multiple times gives an additive result for the number of regular expressions associated with the instance.

  • Call each method in a separate SQL statement (no method chaining).

  • All regular expression searches for classification purposes are case-insensitive.

  • Test the regular expression before adding a regular expression to the custom classification instance. For example, use the [ NOT ] REGEXP function to make sure that only values that match the regex are returned in the result:

    SELECT <col_to_classify>
FROM <table_with_col_to_classify>
WHERE <col_to_classify> REGEXP('<regex>');
    Copy

    For details, see String functions (regular expressions).

Examples

Add categories and a regular expression to the medical_codes instance:

CALL medical_codes!ADD_REGEX(
  SEMANTIC_CATEGORY => 'ICD_10_CODES',
  PRIVACY_CATEGORY => 'IDENTIFIER',
  VALUE_REGEX => '[A-TV-Z][0-9][0-9AB]\.?[0-9A-TV-Z]{0,4}',
  COL_NAME_REGEX => 'ICD.*',
  DESCRIPTION => 'Add a regex to identify ICD-10 medical codes in a column',
  THRESHOLD => 0.8
);
Copy

Returns:

+---------------+
|   ADD_REGEX   |
+---------------+
| ICD_10_CODES  |
+---------------+

Create a custom classifier that uses the default threshold and doesn’t use a regular expression to match column names:

CALL medical_codes!ADD_REGEX(
  SEMANTIC_CATEGORY => 'ICD_10_CODES',
  PRIVACY_CATEGORY => 'IDENTIFIER',
  VALUE_REGEX => '[A-TV-Z][0-9][0-9AB]\.?[0-9A-TV-Z]{0,4}'
);
Copy
Language: English