workspace_warehouse_config
Creates, updates, deletes, gets or lists a workspace_warehouse_config resource.
Overview
| Name | workspace_warehouse_config |
| Type | Resource |
| Id | databricks_workspace.sql.workspace_warehouse_config |
Fields
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
channel | object | Configures the channel name and DBSQL version of the warehouse. CHANNEL_NAME_CUSTOM should be<br /> chosen only when `dbsql_version` is specified. |
config_param | object | Deprecated: Use sql_configuration_parameters |
data_access_config | array | Spark confs for external hive metastore configuration JSON serialized size must be less than <= 512K |
enable_serverless_compute | boolean | Enable Serverless compute for SQL warehouses |
enabled_warehouse_types | array | List of Warehouse Types allowed in this workspace (limits allowed value of the type field in CreateWarehouse and EditWarehouse). Note: Some types cannot be disabled, they don't need to be specified in SetWorkspaceWarehouseConfig. Note: Disabling a type may cause existing warehouses to be converted to another type. Used by frontend to save specific type availability in the warehouse create and edit form UI. |
global_param | object | Deprecated: Use sql_configuration_parameters |
google_service_account | string | GCP only: Google Service Account used to pass to cluster to access Google Cloud Storage |
instance_profile_arn | string | AWS Only: The instance profile used to pass an IAM role to the SQL warehouses. This configuration is also applied to the workspace's serverless compute for notebooks and jobs. |
security_policy | string | Security policy for warehouses (DATA_ACCESS_CONTROL, NONE, PASSTHROUGH) |
sql_configuration_parameters | object | SQL configuration parameters |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | deployment_name | Gets the workspace level configuration that is shared by all SQL warehouses in a workspace. | |
set | replace | deployment_name | Sets the workspace level configuration that is shared by all SQL warehouses in a workspace. |
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 workspace level configuration that is shared by all SQL warehouses in a workspace.
SELECT
channel,
config_param,
data_access_config,
enable_serverless_compute,
enabled_warehouse_types,
global_param,
google_service_account,
instance_profile_arn,
security_policy,
sql_configuration_parameters
FROM databricks_workspace.sql.workspace_warehouse_config
WHERE deployment_name = '{{ deployment_name }}' -- required
;
REPLACE examples
- set
Sets the workspace level configuration that is shared by all SQL warehouses in a workspace.
REPLACE databricks_workspace.sql.workspace_warehouse_config
SET
channel = '{{ channel }}',
config_param = '{{ config_param }}',
data_access_config = '{{ data_access_config }}',
enable_serverless_compute = {{ enable_serverless_compute }},
enabled_warehouse_types = '{{ enabled_warehouse_types }}',
global_param = '{{ global_param }}',
google_service_account = '{{ google_service_account }}',
instance_profile_arn = '{{ instance_profile_arn }}',
security_policy = '{{ security_policy }}',
sql_configuration_parameters = '{{ sql_configuration_parameters }}'
WHERE
deployment_name = '{{ deployment_name }}' --required;