SYSTEM$CLASSIFY_SCHEMA¶

Syntax¶

CALL SYSTEM$CLASSIFY_SCHEMA( '<object_name>' , <arg> )

Arguments¶

object_name

The name of the schema containing the tables 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.

arg

Specifies an argument to determine how the classification process works. One of the following:

NULL

Snowflake uses its default configuration based on the number of rows in in the specified object. System tags are not set on any columns in the specified object.

{}

An empty list, which is functionally equivalent to specifying NULL.

{'sample_count': integer}

Specifies the number of rows to sample in the specified object. Any number from 1 to 10000, inclusive.

{'auto_tag': true}

Sets the recommended classification system tags on the columns in the specified object when the classification process is complete.

When you use this argument, call the stored procedure with the role that has the OWNERSHIP privilege on the schema.

{'sample_count': integer, 'auto_tag': true}

Classify the specified object while specifying the number of rows to sample and set the recommended system tag on each column in the specified object when the classification process is complete.

When you use this argument, call the stored procedure with the role that has the OWNERSHIP privilege on the schema.

{'use_all_custom_classifiers': true}

Snowflake evaluates all custom classification instances and recommends the tag associated with a custom classification instance based on the classification result.

This option uses the custom classifiers that are accessible to the role in use that calls the stored procedure (current role, caller’s rights). For details, see Understanding Caller’s Rights and Owner’s Rights Stored Procedures.

{'custom_classifiers': ['instance_name1' [ , 'instance_name2' ... ] ]}

Specifies the custom classification instance to evaluate as a source for the recommended tag to be set on the column.

You can specify multiple instances in the list and separate each instance with a comma.

Returns¶

The stored procedure returns a JSON object in the following format. For example:

{
  "failed": [
    {
      "message": "Insufficient privileges.",
      "table_name": "t4"
    }
  ],
  "succeeded": [
    {
      "table_name": "t1"
    },
    {
      "table_name": "t2"
    },
    {
      "table_name": "t3"
    }
  ]
}

Where:

failed

Specifies a message that provides a reason why the table was not scheduled to be classified.

succeeded

Specifies each table that was staged for Data Classification.

Usage notes¶

• The specified schema name can contain up to 1000 table objects. If the schema contains more than 1000 table objects, Snowflake returns an error message.

• Globally-defined stored procedures utilize caller’s rights. For more details, see Understanding Caller’s Rights and Owner’s Rights Stored Procedures.

• If you want to apply alternate system tag values, 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¶

Stage the classification of tables in the schema:

CALL SYSTEM$CLASSIFY_SCHEMA('hr.tables', null);

Copy

Stage the classification of the tables in the schema and specify the number of rows to sample:

CALL SYSTEM$CLASSIFY_SCHEMA('hr.tables.empl_info', {'sample_count': 1000});

Copy

Stage the classification of the tables in the schema and set the system tags to the columns:

CALL SYSTEM$CLASSIFY_SCHEMA('hr.tables.empl_info', {'auto_tag': true});

Copy

Stage the classification of the tables in the schema, specify the number of rows to sample, and set the recommended system tag to each column in the table:

CALL SYSTEM$CLASSIFY_SCHEMA('hr.tables.empl_info', {'sample_count': 1000, 'auto_tag': true});

Copy