warehouses

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

Overview

Name	warehouses
Type	Resource
Id	databricks_workspace.dbsql.warehouses

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string
name	string
creator_name	string
auto_stop_mins	string
channel	object
cluster_size	string
enable_photon	boolean
enable_serverless_compute	boolean
health	object
instance_profile_arn	string
jdbc_url	string
max_num_clusters	integer
min_num_clusters	string
num_active_sessions	integer
num_clusters	integer
odbc_params	object
spot_instance_policy	string
state	string
tags	object
warehouse_type	string

list

Name	Datatype	Description
id	string
name	string
creator_name	string
auto_stop_mins	string
channel	object
cluster_size	string
enable_photon	boolean
enable_serverless_compute	boolean
health	object
instance_profile_arn	string
jdbc_url	string
max_num_clusters	integer
min_num_clusters	string
num_active_sessions	integer
num_clusters	integer
odbc_params	object
spot_instance_policy	string
state	string
tags	object
warehouse_type	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deployment_name		Gets the information for a single SQL warehouse.
list	select	deployment_name		Lists all SQL warehouses that a user has manager permissions on.
create	insert	deployment_name		Creates a new SQL warehouse.
edit	replace	deployment_name		Updates the configuration for a SQL warehouse.
delete	delete	deployment_name		Deletes a SQL warehouse.
start	exec	deployment_name		Starts a SQL warehouse.
stop	exec	deployment_name		Stops a SQL warehouse.

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 the information for a single SQL warehouse.

SELECT
id,
name,
creator_name,
auto_stop_mins,
channel,
cluster_size,
enable_photon,
enable_serverless_compute,
health,
instance_profile_arn,
jdbc_url,
max_num_clusters,
min_num_clusters,
num_active_sessions,
num_clusters,
odbc_params,
spot_instance_policy,
state,
tags,
warehouse_type
FROM databricks_workspace.dbsql.warehouses
WHERE deployment_name = '{{ deployment_name }}' -- required;

list

Lists all SQL warehouses that a user has manager permissions on.

SELECT
id,
name,
creator_name,
auto_stop_mins,
channel,
cluster_size,
enable_photon,
enable_serverless_compute,
health,
instance_profile_arn,
jdbc_url,
max_num_clusters,
min_num_clusters,
num_active_sessions,
num_clusters,
odbc_params,
spot_instance_policy,
state,
tags,
warehouse_type
FROM databricks_workspace.dbsql.warehouses
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

create

Creates a new SQL warehouse.

INSERT INTO databricks_workspace.dbsql.warehouses (
data__name,
data__cluster_size,
data__min_num_clusters,
data__max_num_clusters,
data__auto_stop_mins,
data__creator_name,
data__instance_profile_arn,
data__spot_instance_policy,
data__enable_photon,
data__enable_serverless_compute,
data__warehouse_type,
data__tags,
data__channel,
deployment_name
)
SELECT 
'{{ name }}',
'{{ cluster_size }}',
'{{ min_num_clusters }}',
'{{ max_num_clusters }}',
'{{ auto_stop_mins }}',
'{{ creator_name }}',
'{{ instance_profile_arn }}',
'{{ spot_instance_policy }}',
{{ enable_photon }},
{{ enable_serverless_compute }},
'{{ warehouse_type }}',
'{{ tags }}',
'{{ channel }}',
'{{ deployment_name }}'
RETURNING
id
;

Manifest

# Description fields are for documentation purposes
- name: warehouses
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the warehouses resource.
    - name: name
      value: string
    - name: cluster_size
      value: string
    - name: min_num_clusters
      value: int32
    - name: max_num_clusters
      value: int32
    - name: auto_stop_mins
      value: int32
    - name: creator_name
      value: string
    - name: instance_profile_arn
      value: string
    - name: spot_instance_policy
      value: string
    - name: enable_photon
      value: boolean
    - name: enable_serverless_compute
      value: boolean
    - name: warehouse_type
      value: string
    - name: tags
      value: object
    - name: channel
      value: object

REPLACE examples

edit

Updates the configuration for a SQL warehouse.

REPLACE databricks_workspace.dbsql.warehouses
SET 
data__name = '{{ name }}',
data__cluster_size = '{{ cluster_size }}',
data__min_num_clusters = '{{ min_num_clusters }}',
data__max_num_clusters = '{{ max_num_clusters }}',
data__auto_stop_mins = '{{ auto_stop_mins }}',
data__creator_name = '{{ creator_name }}',
data__instance_profile_arn = '{{ instance_profile_arn }}',
data__spot_instance_policy = '{{ spot_instance_policy }}',
data__enable_photon = {{ enable_photon }},
data__enable_serverless_compute = {{ enable_serverless_compute }},
data__warehouse_type = '{{ warehouse_type }}',
data__tags = '{{ tags }}',
data__channel = '{{ channel }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required;

DELETE examples

delete

Deletes a SQL warehouse.

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

Lifecycle Methods

start

Starts a SQL warehouse.

EXEC databricks_workspace.dbsql.warehouses.start 
@deployment_name='{{ deployment_name }}' --required;

stop

Stops a SQL warehouse.

EXEC databricks_workspace.dbsql.warehouses.stop 
@deployment_name='{{ deployment_name }}' --required;