Share via


temporary-table-credentials command group

Note

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 temporary-table-credentials command group within the Databricks CLI contains commands to generate temporary table credentials. These are short-lived, downscoped credentials used to access cloud storage locations where table data is stored in Databricks.

databricks temporary-table-credentials generate-temporary-table-credentials

Generate a short-lived credential for directly accessing the table data on cloud storage. The metastore must have external_access_enabled flag set to true (default false). The caller must have EXTERNAL_USE_SCHEMA privilege on the parent schema and this privilege can only be granted by catalog owners.

databricks temporary-table-credentials generate-temporary-table-credentials [flags]

Arguments

None

Options

--json JSON

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

--operation TableOperation

    The operation performed against the table data. Supported values: READ, READ_WRITE

--table-id string

    UUID of the table to read or write.

Global flags

Examples

The following example generates a temporary table credential for reading:

databricks temporary-table-credentials generate-temporary-table-credentials --table-id <table-uuid> --operation READ

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