queries

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

Overview

Name	queries
Type	Resource
Id	databricks_workspace.dbsql.queries

Fields

The following fields are returned by SELECT queries:

get

Request completed successfully.

Name	Datatype	Description
id	string
warehouse_id	string
display_name	string
last_modifier_user_name	string
owner_user_name	string
create_time	string
description	string
lifecycle_state	string
parameters	array
parent_path	string
query_text	string
run_as_mode	string
tags	array
update_time	string

list

Request completed successfully.

Name	Datatype	Description
id	string
warehouse_id	string
display_name	string
last_modifier_user_name	string
owner_user_name	string
create_time	string
description	string
lifecycle_state	string
parameters	array
query_text	string
run_as_mode	string
tags	array
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 a query.
list	select	deployment_name		Gets a list of queries accessible to the user, ordered by creation time.
create	insert	deployment_name		Creates a query.
update	update	deployment_name		Updates a query.
delete	delete	deployment_name		Moves a query to the trash. Trashed queries immediately disappear from searches and list views, and cannot be used for alerts. You can restore a trashed query through the UI. A trashed query 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 a query.

SELECT
id,
warehouse_id,
display_name,
last_modifier_user_name,
owner_user_name,
create_time,
description,
lifecycle_state,
parameters,
parent_path,
query_text,
run_as_mode,
tags,
update_time
FROM databricks_workspace.dbsql.queries
WHERE deployment_name = '{{ deployment_name }}' -- required;

list

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

SELECT
id,
warehouse_id,
display_name,
last_modifier_user_name,
owner_user_name,
create_time,
description,
lifecycle_state,
parameters,
query_text,
run_as_mode,
tags,
update_time
FROM databricks_workspace.dbsql.queries
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

create

Creates a query.

INSERT INTO databricks_workspace.dbsql.queries (
data__query,
deployment_name
)
SELECT 
'{{ query }}',
'{{ deployment_name }}'
RETURNING
id,
warehouse_id,
display_name,
last_modifier_user_name,
owner_user_name,
create_time,
description,
lifecycle_state,
parameters,
parent_path,
query_text,
run_as_mode,
tags
;

Manifest

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

UPDATE examples

update

Updates a query.

UPDATE databricks_workspace.dbsql.queries
SET 
data__update_mask = '{{ update_mask }}',
data__query = '{{ query }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required
RETURNING
id,
warehouse_id,
display_name,
last_modifier_user_name,
owner_user_name,
create_time,
description,
lifecycle_state,
parameters,
parent_path,
query_text,
run_as_mode,
tags,
update_time;

DELETE examples

delete

Moves a query to the trash. Trashed queries immediately disappear from searches and list views, and cannot be used for alerts. You can restore a trashed query through the UI. A trashed query is permanently deleted after 30 days.

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