lakeview_schedules

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

Overview

Name	lakeview_schedules
Type	Resource
Id	databricks_workspace.dashboards.lakeview_schedules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
dashboard_id	string	UUID identifying the dashboard to which the schedule belongs.
schedule_id	string	UUID identifying the schedule.
warehouse_id	string	The warehouse id to run the dashboard with for the schedule.
display_name	string	The display name for schedule.
create_time	string	A timestamp indicating when the schedule was created.
▶cron_schedule	object
etag	string	The etag for the schedule. Must be left empty on create, must be provided on updates to ensure that the schedule has not been modified since the last read, and can be optionally provided on delete.
pause_status	string	The status indicates whether this schedule is paused or not. (PAUSED, UNPAUSED)
update_time	string	A timestamp indicating when the schedule was last updated.

list

Name	Datatype	Description
dashboard_id	string	UUID identifying the dashboard to which the schedule belongs.
schedule_id	string	UUID identifying the schedule.
warehouse_id	string	The warehouse id to run the dashboard with for the schedule.
display_name	string	The display name for schedule.
create_time	string	A timestamp indicating when the schedule was created.
▶cron_schedule	object
etag	string	The etag for the schedule. Must be left empty on create, must be provided on updates to ensure that the schedule has not been modified since the last read, and can be optionally provided on delete.
pause_status	string	The status indicates whether this schedule is paused or not. (PAUSED, UNPAUSED)
update_time	string	A timestamp indicating when the schedule 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, deployment_name		Get dashboard schedule.
list	select	dashboard_id, deployment_name	page_size, page_token	List dashboard schedules.
create	insert	dashboard_id, deployment_name, schedule		Create dashboard schedule.
delete	delete	dashboard_id, schedule_id, deployment_name	etag	Delete dashboard schedule.

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 to which the schedule belongs.
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
schedule_id	string	UUID identifying the schedule.
etag	string	The etag for the schedule. Optionally, it can be provided to verify that the schedule has not been modified from its last retrieval.
page_size	integer	The number of schedules to return per page.
page_token	string	A page token, received from a previous ListSchedules call. Use this to retrieve the subsequent page.

SELECT examples

get

Get dashboard schedule.

SELECT
dashboard_id,
schedule_id,
warehouse_id,
display_name,
create_time,
cron_schedule,
etag,
pause_status,
update_time
FROM databricks_workspace.dashboards.lakeview_schedules
WHERE dashboard_id = '{{ dashboard_id }}' -- required
AND schedule_id = '{{ schedule_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

list

List dashboard schedules.

SELECT
dashboard_id,
schedule_id,
warehouse_id,
display_name,
create_time,
cron_schedule,
etag,
pause_status,
update_time
FROM databricks_workspace.dashboards.lakeview_schedules
WHERE dashboard_id = '{{ dashboard_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Create dashboard schedule.

INSERT INTO databricks_workspace.dashboards.lakeview_schedules (
schedule,
dashboard_id,
deployment_name
)
SELECT 
'{{ schedule }}' /* required */,
'{{ dashboard_id }}',
'{{ deployment_name }}'
RETURNING
dashboard_id,
schedule_id,
warehouse_id,
display_name,
create_time,
cron_schedule,
etag,
pause_status,
update_time
;

Manifest

# Description fields are for documentation purposes
- name: lakeview_schedules
props:
  - name: dashboard_id
    value: "{{ dashboard_id }}"
    description: Required parameter for the lakeview_schedules resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the lakeview_schedules resource.
  - name: schedule
    description: |
      The schedule to create. A dashboard is limited to 10 schedules.
    value:
      cron_schedule:
        quartz_cron_expression: "{{ quartz_cron_expression }}"
        timezone_id: "{{ timezone_id }}"
      create_time: "{{ create_time }}"
      dashboard_id: "{{ dashboard_id }}"
      display_name: "{{ display_name }}"
      etag: "{{ etag }}"
      pause_status: "{{ pause_status }}"
      schedule_id: "{{ schedule_id }}"
      update_time: "{{ update_time }}"
      warehouse_id: "{{ warehouse_id }}"

DELETE examples

delete

Delete dashboard schedule.

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