alerts

Creates, updates, deletes, gets or lists an alerts resource.

Overview

Name	alerts
Type	Resource
Id	databricks_workspace.dbsql.alerts

Fields

The following fields are returned by SELECT queries:

get

Request completed successfully.

Name	Datatype	Description
id	string
query_id	string
display_name	string
owner_user_name	string
condition	object
create_time	string
lifecycle_state	string
parent_path	string
seconds_to_retrigger	integer
state	string
update_time	string

list

Request completed successfully.

Name	Datatype	Description
id	string
query_id	string
display_name	string
owner_user_name	string
condition	object
create_time	string
lifecycle_state	string
seconds_to_retrigger	integer
state	string
update_time	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deployment_name		Gets an alert.
list	select	deployment_name		Gets a list of alerts accessible to the user, ordered by creation time.
create	insert	deployment_name		Creates an alert.
update	update	deployment_name		Updates an alert.
delete	delete	deployment_name		Moves an alert to the trash. Trashed alerts immediately disappear from searches and list views, and can no longer trigger. You can restore a trashed alert through the UI. A trashed alert is permanently deleted after 30 days.

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 an alert.

SELECT
id,
query_id,
display_name,
owner_user_name,
condition,
create_time,
lifecycle_state,
parent_path,
seconds_to_retrigger,
state,
update_time
FROM databricks_workspace.dbsql.alerts
WHERE deployment_name = '{{ deployment_name }}' -- required;

list

Gets a list of alerts accessible to the user, ordered by creation time.

SELECT
id,
query_id,
display_name,
owner_user_name,
condition,
create_time,
lifecycle_state,
seconds_to_retrigger,
state,
update_time
FROM databricks_workspace.dbsql.alerts
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

create

Creates an alert.

INSERT INTO databricks_workspace.dbsql.alerts (
data__alert,
deployment_name
)
SELECT 
'{{ alert }}',
'{{ deployment_name }}'
RETURNING
id,
query_id,
display_name,
owner_user_name,
condition,
create_time,
lifecycle_state,
parent_path,
seconds_to_retrigger,
state,
update_time
;

Manifest

# Description fields are for documentation purposes
- name: alerts
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the alerts resource.
    - name: alert
      value: object

UPDATE examples

update

Updates an alert.

UPDATE databricks_workspace.dbsql.alerts
SET 
data__update_mask = '{{ update_mask }}',
data__alert = '{{ alert }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required
RETURNING
id,
query_id,
display_name,
owner_user_name,
condition,
create_time,
lifecycle_state,
parent_path,
seconds_to_retrigger,
state,
update_time;

DELETE examples

delete

Moves an alert to the trash. Trashed alerts immediately disappear from searches and list views, and can no longer trigger. You can restore a trashed alert through the UI. A trashed alert is permanently deleted after 30 days.

DELETE FROM databricks_workspace.dbsql.alerts
WHERE deployment_name = '{{ deployment_name }}' --required;