default_warehouse_overrides

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

Overview

Name	default_warehouse_overrides
Type	Resource
Id	databricks_workspace.sql.default_warehouse_overrides

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	The resource name of the default warehouse override. Format: default-warehouse-overrides/{default_warehouse_override_id}
default_warehouse_override_id	string	The ID component of the resource name (user ID).
warehouse_id	string	The specific warehouse ID when type is CUSTOM. Not set for LAST_SELECTED type.
type	string	The type of override behavior. (CUSTOM, LAST_SELECTED)

list

Name	Datatype	Description
name	string	The resource name of the default warehouse override. Format: default-warehouse-overrides/{default_warehouse_override_id}
default_warehouse_override_id	string	The ID component of the resource name (user ID).
warehouse_id	string	The specific warehouse ID when type is CUSTOM. Not set for LAST_SELECTED type.
type	string	The type of override behavior. (CUSTOM, LAST_SELECTED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, deployment_name		Returns the default warehouse override for a user. Users can fetch their own override. Admins can
list	select	deployment_name	page_size, page_token	Lists all default warehouse overrides in the workspace. Only workspace administrators can list all
create	insert	default_warehouse_override_id, deployment_name, default_warehouse_override		Creates a new default warehouse override for a user. Users can create their own override. Admins can
update	update	name, update_mask, deployment_name, default_warehouse_override	allow_missing	Updates an existing default warehouse override for a user. Users can update their own override. Admins
delete	delete	name, deployment_name		Deletes the default warehouse override for a user. Users can delete their own override. Admins can

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
default_warehouse_override_id	string	Required. The ID to use for the override, which will become the final component of the override's resource name. Can be a numeric user ID or the literal string "me" for the current user.
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
name	string	Required. The resource name of the default warehouse override to delete. Format: default-warehouse-overrides/{default_warehouse_override_id} The default_warehouse_override_id can be a numeric user ID or the literal string "me" for the current user.
update_mask	object	Required. Field mask specifying which fields to update. Only the fields specified in the mask will be updated. Use "*" to update all fields. When allow_missing is true, this field is ignored and all fields are applied.
allow_missing	boolean	If set to true, and the override is not found, a new override will be created. In this situation, update_mask is ignored and all fields are applied. Defaults to false.
page_size	integer	The maximum number of overrides to return. The service may return fewer than this value. If unspecified, at most 100 overrides will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token	string	A page token, received from a previous ListDefaultWarehouseOverrides call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDefaultWarehouseOverrides must match the call that provided the page token.

SELECT examples

get

Returns the default warehouse override for a user. Users can fetch their own override. Admins can

SELECT
name,
default_warehouse_override_id,
warehouse_id,
type
FROM databricks_workspace.sql.default_warehouse_overrides
WHERE name = '{{ name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

list

Lists all default warehouse overrides in the workspace. Only workspace administrators can list all

SELECT
name,
default_warehouse_override_id,
warehouse_id,
type
FROM databricks_workspace.sql.default_warehouse_overrides
WHERE deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Creates a new default warehouse override for a user. Users can create their own override. Admins can

INSERT INTO databricks_workspace.sql.default_warehouse_overrides (
default_warehouse_override,
default_warehouse_override_id,
deployment_name
)
SELECT 
'{{ default_warehouse_override }}' /* required */,
'{{ default_warehouse_override_id }}',
'{{ deployment_name }}'
RETURNING
name,
default_warehouse_override_id,
warehouse_id,
type
;

Manifest

# Description fields are for documentation purposes
- name: default_warehouse_overrides
props:
  - name: default_warehouse_override_id
    value: "{{ default_warehouse_override_id }}"
    description: Required parameter for the default_warehouse_overrides resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the default_warehouse_overrides resource.
  - name: default_warehouse_override
    description: |
      Required. The default warehouse override to create.
    value:
      type: "{{ type }}"
      default_warehouse_override_id: "{{ default_warehouse_override_id }}"
      name: "{{ name }}"
      warehouse_id: "{{ warehouse_id }}"

UPDATE examples

update

Updates an existing default warehouse override for a user. Users can update their own override. Admins

UPDATE databricks_workspace.sql.default_warehouse_overrides
SET 
default_warehouse_override = '{{ default_warehouse_override }}'
WHERE 
name = '{{ name }}' --required
AND update_mask = '{{ update_mask }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND default_warehouse_override = '{{ default_warehouse_override }}' --required
AND allow_missing = {{ allow_missing}}
RETURNING
name,
default_warehouse_override_id,
warehouse_id,
type;

DELETE examples

delete

Deletes the default warehouse override for a user. Users can delete their own override. Admins can

DELETE FROM databricks_workspace.sql.default_warehouse_overrides
WHERE name = '{{ name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
;