SYSTEM$GET_CLASSIFICATION_RESULT¶

Syntax¶

SELECT SYSTEM$GET_CLASSIFICATION_RESULT( '<object_name>' )

Arguments¶

object_name

The name of the table, external table, view, or materialized view containing the columns to be classified. If a database and schema are not in use in the current session, the name must be fully-qualified.

The name must be specified exactly as it is stored in the database. If the name contains special characters, capitalization, or blank spaces, the name must be enclosed first in double-quotes and then in single quotes.

Returns¶

Returns a JSON object in the following format. For example:

{
  "classification_result": {
    "col1_name": {
      "alternates": [],
      "recommendation": {
        "confidence": "HIGH",
        "coverage": 1,
        "details": [
          {
            "coverage": 1,
            "semantic_category": "US_PASSPORT"
          }
        ],
        "privacy_category": "IDENTIFIER",
        "semantic_category": "PASSPORT"
      },
      "valid_value_ratio": 1
    },  
    "col2_name": { ... },
    ...
  }
}

Where:

alternates

Specifies information about each tag and value to consider other than the recommended tag.

recommendation

Specifies information about each tag and value as the primary choice based on the classification process.

These values can appear in both the alternates and recommendation:

classifier_name

The fully-qualified name of the custom classification instance that was used to tag the classified column.

This field only appears when using a custom classification instance as the source of the tag to set on a column.

confidence

Specifies one of the following values: HIGH, MEDIUM, or LOW. This value indicates the relative confidence that Snowflake has based upon the column sampling process and how the column data aligns with how Snowflake classifies data.

coverage

Specifies the percent of sampled cell values that match the rules for a particular category.

details

Specifies fields and values that refer to a geographical tag value for the SEMANTIC_CATEGORY tag.

privacy_category

Specifies the privacy category tag value.

The possible values are IDENTIFIER, QUASI-IDENTIFIER and SENSITIVE.

semantic_category

Specifies the semantic category tag value.

For possible tag values, see System tags and categories and System tags and categories.

valid_value_ratio

Specifies the ratio of valid values in the sample size. Invalid values include NULL, an empty string, and a string with more than 256 characters.

Usage notes¶

• Use an ALTER TABLE … MODIFY COLUMN … SET TAG statement to update the tag value.

• To unset a Classification system tag from a column, use an ALTER TABLE … MODIFY COLUMN … UNSET TAG statement.

Examples¶

Return the Data Classification result for a table:

SELECT SYSTEM$GET_CLASSIFICATION_RESULT('hr.tables.empl_info');

Copy