Skip to main content

RECIPIENTS

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

INFORMATION_SCHEMA.RECIPIENTS describes recipients.

Information is displayed only for recipients the user has permission to interact with.

This is an extension to the SQL Standard Information Schema.

Definition​

The RECIPIENTS relation contains the following columns:

Name

Data type

Nullable

Description

RECIPIENT_NAME

STRING

No

Name of the recipient.

RECIPIENT_ID

STRING

No

A GUID of the recipient.

RECIPIENT_OWNER

STRING

No

Owner of the recipient.

AUTHENTICATION_TYPE

STRING

No

Authentication type used with the recipient.

COMMENT

STRING

Yes

An optional comment that describes the recipient.

CLOUD

STRING

Yes

Cloud vendor of the recipient (Databricks-to-Databricks only).

REGION

STRING

Yes

Region of the recipient (Databricks-to-Databricks only).

DATA_RECIPIENT_GLOBAL_METASTORE_ID

STRING

Yes

Globally unique metastore ID of the recipient (Databricks-to-Databricks only).

CREATED

TIMESTAMP

No

Timestamp when the recipient was created.

CREATED_BY

STRING

No

Principal who created the recipient.

LAST_ALTERED

TIMESTAMP

No

Timestamp when the recipient was last altered in any way.

LAST_ALTERED_BY

STRING

No

Principal who last altered the recipient.

Name

Data type

Nullable

Description

RECIPIENT_NAME

STRING

No

Name of the recipient.

RECIPIENT_ID

STRING

No

A GUID of the recipient.

RECIPIENT_OWNER

STRING

No

Owner of the recipient.

AUTHENTICATION_TYPE

STRING

No

Authentication type used with the recipient.

COMMENT

STRING

Yes

An optional comment that describes the recipient.

CLOUD

STRING

Yes

Cloud vendor of the recipient (Databricks-to-Databricks only).

REGION

STRING

Yes

Region of the recipient (Databricks-to-Databricks only).

DATA_RECIPIENT_GLOBAL_METASTORE_ID

STRING

Yes

Globally unique metastore ID of the recipient (Databricks-to-Databricks only).

CREATED

TIMESTAMP

No

Timestamp when the recipient was created.

CREATED_BY

STRING

No

Principal who created the recipient.

LAST_ALTERED

TIMESTAMP

No

Timestamp when the recipient was last altered in any way.

LAST_ALTERED_BY

STRING

No

Principal who last altered the recipient.

Constraints​

The following constraints apply to the RECIPIENTS relation:

Class

Name

Column List

Description

Primary key

RECIPIENTS_PK

RECIPIENT_NAME

Unique identifier for the recipient.

Unique key

RECIPIENTS_ID

RECIPIENT_ID

GUID for the recipient.

Class

Name

Column List

Description

Primary key

RECIPIENTS_PK

RECIPIENT_NAME

Unique identifier for the recipient.

Unique key

RECIPIENTS_ID

RECIPIENT_ID

GUID for the recipient.

Examples​

SQL
> SELECT recipient_owner
FROM information_schema.recipients