Share via

recipients 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 recipients command group within the Databricks CLI contains commands to manage share recipients in Unity Catalog. See What is Delta Sharing?.

databricks recipients create

Create a new recipient with the delta sharing authentication type in the metastore. The caller must be a metastore admin or have the CREATE_RECIPIENT privilege on the metastore.

databricks recipients create NAME AUTHENTICATION_TYPE [flags]

Arguments

NAME

    Name of Recipient.

AUTHENTICATION_TYPE

    The delta sharing authentication type. Supported values: DATABRICKS, OAUTH_CLIENT_CREDENTIALS, OIDC_FEDERATION, TOKEN

Options

--comment string

    Description about the recipient.

--data-recipient-global-metastore-id string

    The global Unity Catalog metastore id provided by the data recipient.

--expiration-time int

    Expiration timestamp of the token, in epoch milliseconds.

--json JSON

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

--owner string

    Username of the recipient owner.

--sharing-code string

    The one-time sharing code provided by the data recipient.

Global flags

databricks recipients delete

Delete the specified recipient from the metastore. The caller must be the owner of the recipient.

databricks recipients delete NAME [flags]

Arguments

NAME

    Name of the recipient.

Options

Global flags

databricks recipients get

Get a share recipient from the metastore if:

  • the caller is the owner of the share recipient,
  • or is a metastore admin.
databricks recipients get NAME [flags]

Arguments

NAME

    Name of the recipient.

Options

Global flags

databricks recipients list

List all share recipients within the current metastore where:

  • the caller is a metastore admin,
  • or the caller is the owner.

There is no guarantee of a specific ordering of the elements in the array.

databricks recipients list [flags]

Arguments

None

Options

--data-recipient-global-metastore-id string

    If not provided, all recipients will be returned.

--max-results int

    Maximum number of recipients to return.

--page-token string

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

Global flags

databricks recipients rotate-token

Rotate the specified recipient's delta sharing authentication token with the provided token info. The caller must be the owner of the recipient.

databricks recipients rotate-token NAME EXISTING_TOKEN_EXPIRE_IN_SECONDS [flags]

Arguments

NAME

    The name of the Recipient.

EXISTING_TOKEN_EXPIRE_IN_SECONDS

    The expiration time of the bearer token in ISO 8601 format. This will set the expiration_time of existing token only to a smaller timestamp, it cannot extend the expiration_time. Use 0 to expire the existing token immediately, negative number will return an error.

Options

--json JSON

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

Global flags

databricks recipients update

Update an existing recipient in the metastore. The caller must be a metastore admin or the owner of the recipient. If the recipient name will be updated, the user must be both a metastore admin and the owner of the recipient.

databricks recipients update NAME [flags]

Arguments

NAME

    Name of the recipient.

Options

--comment string

    Description about the recipient.

--expiration-time int

    Expiration timestamp of the token, in epoch milliseconds.

--json JSON

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

--new-name string

    New name for the recipient.

--owner string

    Username of the recipient owner.

Global flags

databricks recipients share-permissions

Get the share permissions for the specified recipient. The caller must be a metastore admin or the owner of the recipient.

databricks recipients share-permissions NAME [flags]

Arguments

NAME

    The name of the recipient.

Options

--max-results int

    Maximum number of permissions to return.

--page-token string

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

Global flags

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