lakeview_subscriptions

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

Overview

Name	lakeview_subscriptions
Type	Resource
Id	databricks_workspace.dashboards.lakeview_subscriptions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
created_by_user_id	integer	UserId of the user who adds subscribers (users or notification destinations) to the dashboard's schedule.
dashboard_id	string	UUID identifying the dashboard to which the subscription belongs.
schedule_id	string	UUID identifying the schedule to which the subscription belongs.
subscription_id	string	UUID identifying the subscription.
create_time	string	A timestamp indicating when the subscription was created.
etag	string	The etag for the subscription. Must be left empty on create, can be optionally provided on delete to ensure that the subscription has not been deleted since the last read.
▶subscriber	object
update_time	string	A timestamp indicating when the subscription was last updated.

list

Name	Datatype	Description
created_by_user_id	integer	UserId of the user who adds subscribers (users or notification destinations) to the dashboard's schedule.
dashboard_id	string	UUID identifying the dashboard to which the subscription belongs.
schedule_id	string	UUID identifying the schedule to which the subscription belongs.
subscription_id	string	UUID identifying the subscription.
create_time	string	A timestamp indicating when the subscription was created.
etag	string	The etag for the subscription. Must be left empty on create, can be optionally provided on delete to ensure that the subscription has not been deleted since the last read.
▶subscriber	object
update_time	string	A timestamp indicating when the subscription was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	dashboard_id, schedule_id, subscription_id, deployment_name		Get schedule subscription.
list	select	dashboard_id, schedule_id, deployment_name	page_size, page_token	List schedule subscriptions.
create	insert	dashboard_id, schedule_id, deployment_name, subscription		Create schedule subscription.
delete	delete	dashboard_id, schedule_id, subscription_id, deployment_name	etag	Delete schedule subscription.

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
dashboard_id	string	UUID identifying the dashboard which the subscription belongs.
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
schedule_id	string	UUID identifying the schedule which the subscription belongs.
subscription_id	string	UUID identifying the subscription.
etag	string	The etag for the subscription. Can be optionally provided to ensure that the subscription has not been modified since the last read.
page_size	integer	The number of subscriptions to return per page.
page_token	string	A page token, received from a previous ListSubscriptions call. Use this to retrieve the subsequent page.

SELECT examples

get

Get schedule subscription.

SELECT
created_by_user_id,
dashboard_id,
schedule_id,
subscription_id,
create_time,
etag,
subscriber,
update_time
FROM databricks_workspace.dashboards.lakeview_subscriptions
WHERE dashboard_id = '{{ dashboard_id }}' -- required
AND schedule_id = '{{ schedule_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

list

List schedule subscriptions.

SELECT
created_by_user_id,
dashboard_id,
schedule_id,
subscription_id,
create_time,
etag,
subscriber,
update_time
FROM databricks_workspace.dashboards.lakeview_subscriptions
WHERE dashboard_id = '{{ dashboard_id }}' -- required
AND schedule_id = '{{ schedule_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Create schedule subscription.

INSERT INTO databricks_workspace.dashboards.lakeview_subscriptions (
subscription,
dashboard_id,
schedule_id,
deployment_name
)
SELECT 
'{{ subscription }}' /* required */,
'{{ dashboard_id }}',
'{{ schedule_id }}',
'{{ deployment_name }}'
RETURNING
created_by_user_id,
dashboard_id,
schedule_id,
subscription_id,
create_time,
etag,
subscriber,
update_time
;

Manifest

# Description fields are for documentation purposes
- name: lakeview_subscriptions
props:
  - name: dashboard_id
    value: "{{ dashboard_id }}"
    description: Required parameter for the lakeview_subscriptions resource.
  - name: schedule_id
    value: "{{ schedule_id }}"
    description: Required parameter for the lakeview_subscriptions resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the lakeview_subscriptions resource.
  - name: subscription
    description: |
      The subscription to create. A schedule is limited to 100 subscriptions.
    value:
      subscriber:
        destination_subscriber:
          destination_id: "{{ destination_id }}"
        user_subscriber:
          user_id: {{ user_id }}
      create_time: "{{ create_time }}"
      created_by_user_id: {{ created_by_user_id }}
      dashboard_id: "{{ dashboard_id }}"
      etag: "{{ etag }}"
      schedule_id: "{{ schedule_id }}"
      subscription_id: "{{ subscription_id }}"
      update_time: "{{ update_time }}"

DELETE examples

delete

Delete schedule subscription.

DELETE FROM databricks_workspace.dashboards.lakeview_subscriptions
WHERE dashboard_id = '{{ dashboard_id }}' --required
AND schedule_id = '{{ schedule_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND etag = '{{ etag }}'
;