system-schemas command group

Note

Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.

The system-schemas command group within the Databricks CLI contains commands to manage schemas in the system catalog. A system schema may contain information about customer usage of Unity Catalog such as audit-logs, billing-logs, and lineage information. See System tables reference.

databricks system-schemas disable

Disable the system schema and removes it from the system catalog. The caller must be an account admin or a metastore admin.

databricks system-schemas disable METASTORE_ID SCHEMA_NAME [flags]

Arguments

METASTORE_ID

    The metastore ID under which the system schema lives.

SCHEMA_NAME

    Full name of the system schema.

Options

Global flags

Examples

The following example disables a system schema:

databricks system-schemas disable my-metastore-id system.audit

databricks system-schemas enable

Enable the system schema and adds it to the system catalog. The caller must be an account admin or a metastore admin.

databricks system-schemas enable METASTORE_ID SCHEMA_NAME [flags]

Arguments

METASTORE_ID

    The metastore ID under which the system schema lives.

SCHEMA_NAME

    Full name of the system schema.

Options

--catalog-name string

    The catalog for which the system schema is to enabled in.

--json JSON

    The inline JSON string or the @path to the JSON file with the request body.

Global flags

Examples

The following example enables a system schema:

databricks system-schemas enable my-metastore-id system.audit

The following example enables a system schema with a specific catalog:

databricks system-schemas enable my-metastore-id system.audit --catalog-name my-catalog

databricks system-schemas list

List system schemas for a metastore. The caller must be an account admin or a metastore admin.

databricks system-schemas list METASTORE_ID [flags]

Arguments

METASTORE_ID

    The ID for the metastore in which the system schema resides.

Options

--max-results int

    Maximum number of schemas to return.

--page-token string

    Opaque pagination token to go to next page based on previous query.

Global flags

Examples

The following example lists all system schemas for a metastore:

databricks system-schemas list my-metastore-id

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