<classification_profile_name>!DESCRIBE¶

Describes the properties of an instance of the CLASSIFICATION_PROFILE class.

Syntax¶

<classification_profile_name>!DESCRIBE()

Copy

Output¶

The output includes the criteria you specified when creating the instance and is formatted as follows:

{
   "auto_tag": true | false ,
   "maximum_classification_validity_days": <integer>,
   "minimum_object_age_for_classification_days": <integer>
   "column_tag_map": <object>
   "custom_classifiers": <object>,
}

Access control requirements¶

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

Instance role	Object	Notes
`classification_profile`!PRIVACY_USER	The classification profile instance.	The account role that calls this method must be granted this instance role on the classification profile. The role used to create the instance is automatically granted this instance role.

The USAGE privilege on the parent database and schema are required to perform operations on any object in a 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 does not return the object. Because of this, you can’t use method chaining to call another method on the return value of this method. Instead, call each method in a separate SQL statement.

Examples¶

Describe the classification profile:

SELECT my_classification_profile!DESCRIBE();

Copy

+--------------------------------------------------------+
|         MY_CLASSIFICATION_PROFILE!DESCRIBE()           |
+--------------------------------------------------------+
|   {                                                    |
|     "auto_tag": true,                                  |
|     "maximum_classification_validity_days": 30,        |
|     "column_tag_map": [                                |
|       {                                                |
|         "semantic_categories": [                       |
|           "NAME"                                       |
|         ],                                             |
|         "tag_name": "test_cc_db.test_cc_schema.pii_r3",|
|         "tag_value": "important"                       |
|       },                                               |
|      "custom_classifiers": {                           |
|        "PII": {                                        |
|          "SC1": {                                      |
|            "col_name_regex": "my_name",                |
|             "description": "a new semantic category",  |
|             "privacy_category": "IDENTIFIER",          |
|             "threshold": 0.8,                          |
|             "value_regex": "\\\\d{{2}}-\\\\d{{2}}"     |
|          },                                            |
|          "SC2": {                                      |
|            "privacy_category": "IDENTIFIER",           |
|            "threshold": 0.8,                           |
|            "value_regex": "\\\\d{{3}}-\\\\d{{3}}|\\\\d"|
|          }                                             |
|        }                                               |
|      },                                                |
       "minimum_object_age_for_classification_days": 1   |
|   }                                                    |
+--------------------------------------------------------+