dashboard_schedules

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

Overview

Name	dashboard_schedules
Type	Resource
Id	databricks_workspace.lakeview.dashboard_schedules

Fields

The following fields are returned by SELECT queries:

getschedule

Request completed successfully.

Name	Datatype	Description
dashboard_id	string
schedule_id	string
warehouse_id	string
display_name	string
create_time	string
cron_schedule	object
etag	string
pause_status	string
update_time	string

listschedules

Request completed successfully.

Name	Datatype	Description
dashboard_id	string
schedule_id	string
warehouse_id	string
display_name	string
create_time	string
cron_schedule	object
etag	string
pause_status	string
update_time	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
getschedule	select	deployment_name
listschedules	select	deployment_name
createschedule	insert	deployment_name
updateschedule	update	deployment_name
deleteschedule	delete	deployment_name

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

getschedule

Request completed successfully.

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

listschedules

Request completed successfully.

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

INSERT examples

createschedule

No description available.

INSERT INTO databricks_workspace.lakeview.dashboard_schedules (
data__pause_status,
data__display_name,
data__etag,
data__warehouse_id,
data__cron_schedule,
deployment_name
)
SELECT 
'{{ pause_status }}',
'{{ display_name }}',
'{{ etag }}',
'{{ warehouse_id }}',
'{{ cron_schedule }}',
'{{ 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: dashboard_schedules
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the dashboard_schedules resource.
    - name: pause_status
      value: string
    - name: display_name
      value: string
    - name: etag
      value: string
    - name: warehouse_id
      value: string
    - name: cron_schedule
      value: object

UPDATE examples

updateschedule

No description available.

UPDATE databricks_workspace.lakeview.dashboard_schedules
SET 
data__pause_status = '{{ pause_status }}',
data__display_name = '{{ display_name }}',
data__etag = '{{ etag }}',
data__warehouse_id = '{{ warehouse_id }}',
data__cron_schedule = '{{ cron_schedule }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required
RETURNING
dashboard_id,
schedule_id,
warehouse_id,
display_name,
create_time,
cron_schedule,
etag,
pause_status,
update_time;

DELETE examples

deleteschedule

No description available.

DELETE FROM databricks_workspace.lakeview.dashboard_schedules
WHERE deployment_name = '{{ deployment_name }}' --required;