DESCRIBE RECIPIENT

  • Article

Applies to: check marked yes Databricks SQL check marked yes Databricks Runtime 10.4 LTS and above check marked yes Unity Catalog only

Returns the metadata of an existing recipient. The metadata information includes recipient name, and activation link.

Syntax

[ DESC | DESCRIBE ] RECIPIENT recipient_name

Parameters

  • recipient_name

    The name of an existing recipient. If the name does not exist, an exception is thrown.

Examples

-- A recipient created for Databricks to Databricks sharing
> CREATE RECIPIENT other_databricks_org USING ID 'azure:chinaeast2:f64dcb39-5046-4d4c-9588-c6ac84f9b38a';
> DESCRIBE RECIPIENT other_databricks_org;
 info_name           info_value
 ------------- ----------
 recipient_name      other_databricks_org
 authentication_type DATABRICKS
 owner               alwaysworks@databricks.com
 created_by          alwaysworks@databricks.com
 create_at           2022-01-01T00:00:00.000+0000
 updated_by          alwayswork@databricks.com
 updated_at          2022-01-05T12:00:00.000+0000
 comment
 cloud                 azure
 region                chinaeast2
 metastore_id          f64dcb39-5046-4d4c-9588-c6ac84f9b38a

-- A recipient created for sharing outside of Databricks
> CREATE RECIPIENT other_org;
> DESCRIBE RECIPIENT other_org;
 info_name               info_value
 ----------------------- ----------
 recipient_name          other_org
 recipient_id            0123451f-5262-40bb-9b03-3ee12e612345
 authentication_type     TOKEN
 owner                   alwaysworks@databricks.com
 created_by              alwaysworks@databricks.com
 create_at               2022-01-01T00:00:00.000+0000
 updated_by              alwayswork@databricks.com
 updated_at              2022-01-05T12:00:00.000+0000
 comment
 active_token_id         0160c81f-5262-40bb-9b03-3ee12e6d98d7
 active_token_expiration 2023-01-05T12:00:00.000+0000
 activation_link         https://send/this