recipients

Creates, updates, deletes, gets or lists a recipients resource.

Overview

Name	recipients
Type	Resource
Id	databricks_workspace.deltasharing.recipients

Fields

The following fields are returned by SELECT queries:

get

The recipient was successfully retrieved.

Name	Datatype	Description
name	string
data_recipient_global_metastore_id	string
metastore_id	string
activated	boolean
activation_url	string
authentication_type	string
cloud	string
comment	string
created_at	integer
created_by	string
ip_access_list	object
owner	string
properties_kvpairs	object
region	string
sharing_code	string
tokens	array
updated_at	integer
updated_by	string

list

The list of recipients was successfully retrieved.

Name	Datatype	Description
name	string
data_recipient_global_metastore_id	string
metastore_id	string
activated	boolean
activation_url	string
authentication_type	string
cloud	string
comment	string
created_at	integer
created_by	string
ip_access_list	object
owner	string
properties_kvpairs	object
region	string
sharing_code	string
tokens	array
updated_at	integer
updated_by	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deployment_name		Gets a share recipient from the metastore if:
list	select	deployment_name		Gets an array of all share recipients within the current metastore where:
create	insert	deployment_name		Creates a new recipient with the delta sharing authentication type in the metastore. The caller must be a metastore admin or has the
update	update	deployment_name		Updates 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.
delete	delete	deployment_name		Deletes the specified recipient from the metastore. The caller must be the owner of the recipient.
rotatetoken	exec	deployment_name		Refreshes the specified recipient's delta sharing authentication token with the provided token info. The caller must be the owner of the recipient.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)

SELECT examples

get

Gets a share recipient from the metastore if:

SELECT
name,
data_recipient_global_metastore_id,
metastore_id,
activated,
activation_url,
authentication_type,
cloud,
comment,
created_at,
created_by,
ip_access_list,
owner,
properties_kvpairs,
region,
sharing_code,
tokens,
updated_at,
updated_by
FROM databricks_workspace.deltasharing.recipients
WHERE deployment_name = '{{ deployment_name }}' -- required;

list

Gets an array of all share recipients within the current metastore where:

SELECT
name,
data_recipient_global_metastore_id,
metastore_id,
activated,
activation_url,
authentication_type,
cloud,
comment,
created_at,
created_by,
ip_access_list,
owner,
properties_kvpairs,
region,
sharing_code,
tokens,
updated_at,
updated_by
FROM databricks_workspace.deltasharing.recipients
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

create

Creates a new recipient with the delta sharing authentication type in the metastore. The caller must be a metastore admin or has the

INSERT INTO databricks_workspace.deltasharing.recipients (
data__name,
data__authentication_type,
data__owner,
data__comment,
data__data_recipient_global_metastore_id,
data__sharing_code,
data__expiration_time,
data__ip_access_list,
data__properties_kvpairs,
deployment_name
)
SELECT 
'{{ name }}',
'{{ authentication_type }}',
'{{ owner }}',
'{{ comment }}',
'{{ data_recipient_global_metastore_id }}',
'{{ sharing_code }}',
'{{ expiration_time }}',
'{{ ip_access_list }}',
'{{ properties_kvpairs }}',
'{{ deployment_name }}'
RETURNING
name,
data_recipient_global_metastore_id,
metastore_id,
activated,
activation_url,
authentication_type,
cloud,
comment,
created_at,
created_by,
ip_access_list,
owner,
properties_kvpairs,
region,
sharing_code,
tokens,
updated_at,
updated_by
;

Manifest

# Description fields are for documentation purposes
- name: recipients
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the recipients resource.
    - name: name
      value: required
    - name: authentication_type
      value: string
    - name: owner
      value: required
    - name: comment
      value: string
    - name: data_recipient_global_metastore_id
      value: string
    - name: sharing_code
      value: string
    - name: expiration_time
      value: string
    - name: ip_access_list
      value: object
    - name: properties_kvpairs
      value: object

UPDATE examples

update

Updates 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.

UPDATE databricks_workspace.deltasharing.recipients
SET 
data__owner = '{{ owner }}',
data__comment = '{{ comment }}',
data__new_name = '{{ new_name }}',
data__expiration_time = {{ expiration_time }},
data__ip_access_list = '{{ ip_access_list }}',
data__properties_kvpairs = '{{ properties_kvpairs }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required;

DELETE examples

delete

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

DELETE FROM databricks_workspace.deltasharing.recipients
WHERE deployment_name = '{{ deployment_name }}' --required;

Lifecycle Methods

rotatetoken

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

EXEC databricks_workspace.deltasharing.recipients.rotatetoken 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"existing_token_expire_in_seconds": "{{ existing_token_expire_in_seconds }}"
}';