SHOW RECIPIENTS

  • Article

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

Lists the recipients that match an optionally supplied regular expression pattern. If no pattern is supplied then the command lists all the recipients in the metastore.

Syntax

SHOW RECIPIENTS [ [ LIKE ] regex_pattern ]

Parameters

  • regex_pattern

    A regular expression pattern that is used to filter the results of the statement.

    • Except for * and | character, the pattern works like a regular expression.
    • * alone matches 0 or more characters and | is used to separate multiple different regular expressions, any of which can match.
    • The leading and trailing blanks are trimmed in the input pattern before processing. The pattern match is case-insensitive.

Examples

> CREATE RECIPIENT other_org COMMENT 'other.org';
> CREATE RECIPIENT better_corp COMMENT 'better.com';
> SHOW RECIPIENTS;
  name        created_at                   created_by                 comment
  ----------- ---------------------------- -------------------------- ----------
  other_org   2022-01-01T00:00:00.000+0000 alwaysworks@databricks.com other.org
  better_corp 2022-01-01T00:00:01.000+0000 alwaysworks@databricks.com better.com

> SHOW RECIPIENTS LIKE 'other_org';
  name      number_of_activated_token created_at                   created_by
  --------- ------------------------- ---------------------------- --------------------------
  other_org 0                         2022-01-01T00:00:00.000+0000 alwaysworks@databricks.com other.org