data-classification command group
This information applies to Databricks CLI versions 0.205 and above. The Databricks CLI is in Public Preview.
Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.
The data-classification command group within the Databricks CLI allows you to manage data classification for Unity Catalog catalogs. Data classification automatically identifies and tags sensitive data (PII) in Unity Catalog tables. Each catalog can have at most one configuration resource that controls scanning behavior and auto-tagging rules.
databricks data-classification create-catalog-config
Create a data classification configuration for a catalog. The configuration must not already exist for the catalog.
databricks data-classification create-catalog-config PARENT [flags]
Arguments
PARENT
Parent resource in the format: catalogs/{catalog_name}.
Options
--json JSON
The inline JSON string or the @path to the JSON file with the request body.
--name string
Resource name in the format: catalogs/{catalog_name}/config.
Examples
The following example creates a data classification configuration for a catalog:
databricks data-classification create-catalog-config catalogs/my-catalog
databricks data-classification delete-catalog-config
Delete the data classification configuration for a catalog.
databricks data-classification delete-catalog-config NAME [flags]
Arguments
NAME
Resource name in the format: catalogs/{catalog_name}/config.
Options
Examples
The following example deletes the data classification configuration for a catalog:
databricks data-classification delete-catalog-config catalogs/my-catalog/config
databricks data-classification get-catalog-config
Get the data classification configuration for a catalog.
databricks data-classification get-catalog-config NAME [flags]
Arguments
NAME
Resource name in the format: catalogs/{catalog_name}/config.
Options
Examples
The following example gets the data classification configuration for a catalog:
databricks data-classification get-catalog-config catalogs/my-catalog/config
databricks data-classification update-catalog-config
Update the data classification configuration for a catalog. The configuration must already exist for the catalog. Updates fields specified in the update mask.
databricks data-classification update-catalog-config NAME UPDATE_MASK [flags]
Arguments
NAME
Resource name in the format: catalogs/{catalog_name}/config.
UPDATE_MASK
Field mask specifying which fields to update.
Options
--json JSON
The inline JSON string or the @path to the JSON file with the request body.
--name string
Resource name in the format: catalogs/{catalog_name}/config.
Examples
The following example updates the data classification configuration using a JSON file:
databricks data-classification update-catalog-config catalogs/my-catalog/config "*" --json @config.json
Global flags
--debug
Whether to enable debug logging.
-h or --help
Display help for the Databricks CLI or the related command group or the related command.
--log-file string
A string representing the file to write output logs to. If this flag is not specified then the default is to write output logs to stderr.
--log-format format
The log format type, text or json. The default value is text.
--log-level string
A string representing the log format level. If not specified then the log format level is disabled.
-o, --output type
The command output type, text or json. The default value is text.
-p, --profile string
The name of the profile in the ~/.databrickscfg file to use to run the command. If this flag is not specified then if it exists, the profile named DEFAULT is used.
--progress-format format
The format to display progress logs: default, append, inplace, or json
-t, --target string
If applicable, the bundle target to use