`w.warehouses`: SQL Warehouses¶

class databricks.sdk.service.sql.WarehousesAPI¶

A SQL warehouse is a compute resource that lets you run SQL commands on data objects within Databricks SQL. Compute resources are infrastructure resources that provide processing capabilities in the cloud.

create([, auto_stop_mins: Optional[int], channel: Optional[Channel], cluster_size: Optional[str], creator_name: Optional[str], enable_photon: Optional[bool], enable_serverless_compute: Optional[bool], instance_profile_arn: Optional[str], max_num_clusters: Optional[int], min_num_clusters: Optional[int], name: Optional[str], spot_instance_policy: Optional[SpotInstancePolicy], tags: Optional[EndpointTags], warehouse_type: Optional[CreateWarehouseRequestWarehouseType]]) → Wait[GetWarehouseResponse]¶

Usage:

import time

from databricks.sdk import WorkspaceClient

w = WorkspaceClient()

created = w.warehouses.create(name=f'sdk-{time.time_ns()}',
                              cluster_size="2X-Small",
                              max_num_clusters=1,
                              auto_stop_mins=10).result()

# cleanup
w.warehouses.delete(id=created.id)

Create a warehouse.

Creates a new SQL warehouse.

Parameters:

auto_stop_mins –
int (optional) The amount of time in minutes that a SQL warehouse must be idle (i.e., no RUNNING queries) before it is automatically stopped.

Supported values: - Must be == 0 or >= 10 mins - 0 indicates no autostop.

Defaults to 120 mins
channel – Channel (optional) Channel Details
cluster_size –
str (optional) Size of the clusters allocated for this warehouse. Increasing the size of a spark cluster allows you to run larger queries on it. If you want to increase the number of concurrent queries, please tune max_num_clusters.

Supported values: - 2X-Small - X-Small - Small - Medium - Large - X-Large - 2X-Large - 3X-Large - 4X-Large
creator_name – str (optional) warehouse creator name
enable_photon –
bool (optional) Configures whether the warehouse should use Photon optimized clusters.

Defaults to false.
enable_serverless_compute – bool (optional) Configures whether the warehouse should use serverless compute
instance_profile_arn – str (optional) Deprecated. Instance profile used to pass IAM role to the cluster
max_num_clusters –
int (optional) Maximum number of clusters that the autoscaler will create to handle concurrent queries.

Supported values: - Must be >= min_num_clusters - Must be <= 30.

Defaults to min_clusters if unset.
min_num_clusters –
int (optional) Minimum number of available clusters that will be maintained for this SQL warehouse. Increasing this will ensure that a larger number of clusters are always running and therefore may reduce the cold start time for new queries. This is similar to reserved vs. revocable cores in a resource manager.

Supported values: - Must be > 0 - Must be <= min(max_num_clusters, 30)

Defaults to 1
name –
str (optional) Logical name for the cluster.

Supported values: - Must be unique within an org. - Must be less than 100 characters.
spot_instance_policy – SpotInstancePolicy (optional) Configurations whether the warehouse should use spot instances.
tags –
EndpointTags (optional) A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated with this SQL warehouse.

Supported values: - Number of tags < 45.
warehouse_type – CreateWarehouseRequestWarehouseType (optional) Warehouse type: PRO or CLASSIC. If you want to use serverless compute, you must set to PRO and also set the field enable_serverless_compute to true.

Returns:

Long-running operation waiter for GetWarehouseResponse. See :method:wait_get_warehouse_running for more details.

create_and_wait([, auto_stop_mins: Optional[int], channel: Optional[Channel], cluster_size: Optional[str], creator_name: Optional[str], enable_photon: Optional[bool], enable_serverless_compute: Optional[bool], instance_profile_arn: Optional[str], max_num_clusters: Optional[int], min_num_clusters: Optional[int], name: Optional[str], spot_instance_policy: Optional[SpotInstancePolicy], tags: Optional[EndpointTags], warehouse_type: Optional[CreateWarehouseRequestWarehouseType], timeout: datetime.timedelta = 0:20:00]) → GetWarehouseResponse¶

delete(id: str)¶

Delete a warehouse.

Deletes a SQL warehouse.

Parameters:: id – str Required. Id of the SQL warehouse.

edit(id: str [, auto_stop_mins: Optional[int], channel: Optional[Channel], cluster_size: Optional[str], creator_name: Optional[str], enable_photon: Optional[bool], enable_serverless_compute: Optional[bool], instance_profile_arn: Optional[str], max_num_clusters: Optional[int], min_num_clusters: Optional[int], name: Optional[str], spot_instance_policy: Optional[SpotInstancePolicy], tags: Optional[EndpointTags], warehouse_type: Optional[EditWarehouseRequestWarehouseType]]) → Wait[GetWarehouseResponse]¶

Usage:

import time

from databricks.sdk import WorkspaceClient

w = WorkspaceClient()

created = w.warehouses.create(name=f'sdk-{time.time_ns()}',
                              cluster_size="2X-Small",
                              max_num_clusters=1,
                              auto_stop_mins=10).result()

_ = w.warehouses.edit(id=created.id,
                      name=f'sdk-{time.time_ns()}',
                      cluster_size="2X-Small",
                      max_num_clusters=1,
                      auto_stop_mins=10)

# cleanup
w.warehouses.delete(id=created.id)

Update a warehouse.

Updates the configuration for a SQL warehouse.

Parameters:

id – str Required. Id of the warehouse to configure.
auto_stop_mins –
int (optional) The amount of time in minutes that a SQL warehouse must be idle (i.e., no RUNNING queries) before it is automatically stopped.

Supported values: - Must be == 0 or >= 10 mins - 0 indicates no autostop.

Defaults to 120 mins
channel – Channel (optional) Channel Details
cluster_size –
str (optional) Size of the clusters allocated for this warehouse. Increasing the size of a spark cluster allows you to run larger queries on it. If you want to increase the number of concurrent queries, please tune max_num_clusters.

Supported values: - 2X-Small - X-Small - Small - Medium - Large - X-Large - 2X-Large - 3X-Large - 4X-Large
creator_name – str (optional) warehouse creator name
enable_photon –
bool (optional) Configures whether the warehouse should use Photon optimized clusters.

Defaults to false.
enable_serverless_compute – bool (optional) Configures whether the warehouse should use serverless compute.
instance_profile_arn – str (optional) Deprecated. Instance profile used to pass IAM role to the cluster
max_num_clusters –
int (optional) Maximum number of clusters that the autoscaler will create to handle concurrent queries.

Supported values: - Must be >= min_num_clusters - Must be <= 30.

Defaults to min_clusters if unset.
min_num_clusters –
int (optional) Minimum number of available clusters that will be maintained for this SQL warehouse. Increasing this will ensure that a larger number of clusters are always running and therefore may reduce the cold start time for new queries. This is similar to reserved vs. revocable cores in a resource manager.

Supported values: - Must be > 0 - Must be <= min(max_num_clusters, 30)

Defaults to 1
name –
str (optional) Logical name for the cluster.

Supported values: - Must be unique within an org. - Must be less than 100 characters.
spot_instance_policy – SpotInstancePolicy (optional) Configurations whether the warehouse should use spot instances.
tags –
EndpointTags (optional) A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated with this SQL warehouse.

Supported values: - Number of tags < 45.
warehouse_type – EditWarehouseRequestWarehouseType (optional) Warehouse type: PRO or CLASSIC. If you want to use serverless compute, you must set to PRO and also set the field enable_serverless_compute to true.

Returns:

Long-running operation waiter for GetWarehouseResponse. See :method:wait_get_warehouse_running for more details.

edit_and_wait(id: str [, auto_stop_mins: Optional[int], channel: Optional[Channel], cluster_size: Optional[str], creator_name: Optional[str], enable_photon: Optional[bool], enable_serverless_compute: Optional[bool], instance_profile_arn: Optional[str], max_num_clusters: Optional[int], min_num_clusters: Optional[int], name: Optional[str], spot_instance_policy: Optional[SpotInstancePolicy], tags: Optional[EndpointTags], warehouse_type: Optional[EditWarehouseRequestWarehouseType], timeout: datetime.timedelta = 0:20:00]) → GetWarehouseResponse¶

get(id: str) → GetWarehouseResponse¶

Usage:

import time

from databricks.sdk import WorkspaceClient

w = WorkspaceClient()

created = w.warehouses.create(name=f'sdk-{time.time_ns()}',
                              cluster_size="2X-Small",
                              max_num_clusters=1,
                              auto_stop_mins=10).result()

wh = w.warehouses.get(id=created.id)

# cleanup
w.warehouses.delete(id=created.id)

Get warehouse info.

Gets the information for a single SQL warehouse.

Parameters:: id – str Required. Id of the SQL warehouse.
Returns:: GetWarehouseResponse

get_permission_levels(warehouse_id: str) → GetWarehousePermissionLevelsResponse¶

Get SQL warehouse permission levels.

Gets the permission levels that a user can have on an object.

Parameters:: warehouse_id – str The SQL warehouse for which to get or manage permissions.
Returns:: GetWarehousePermissionLevelsResponse

get_permissions(warehouse_id: str) → WarehousePermissions¶

Get SQL warehouse permissions.

Gets the permissions of a SQL warehouse. SQL warehouses can inherit permissions from their root object.

Parameters:: warehouse_id – str The SQL warehouse for which to get or manage permissions.
Returns:: WarehousePermissions

get_workspace_warehouse_config() → GetWorkspaceWarehouseConfigResponse¶

Get the workspace configuration.

Gets the workspace level configuration that is shared by all SQL warehouses in a workspace.

Returns:: GetWorkspaceWarehouseConfigResponse

list([, run_as_user_id: Optional[int]]) → Iterator[EndpointInfo]¶

Usage:

from databricks.sdk import WorkspaceClient
from databricks.sdk.service import sql

w = WorkspaceClient()

all = w.warehouses.list(sql.ListWarehousesRequest())

List warehouses.

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

Parameters:: run_as_user_id – int (optional) Service Principal which will be used to fetch the list of warehouses. If not specified, the user from the session header is used.
Returns:: Iterator over EndpointInfo

set_permissions(warehouse_id: str [, access_control_list: Optional[List[WarehouseAccessControlRequest]]]) → WarehousePermissions¶

Set SQL warehouse permissions.

Sets permissions on a SQL warehouse. SQL warehouses can inherit permissions from their root object.

Parameters:

warehouse_id – str The SQL warehouse for which to get or manage permissions.
access_control_list – List[WarehouseAccessControlRequest] (optional)

Returns:

WarehousePermissions

set_workspace_warehouse_config([, channel: Optional[Channel], config_param: Optional[RepeatedEndpointConfPairs], data_access_config: Optional[List[EndpointConfPair]], enabled_warehouse_types: Optional[List[WarehouseTypePair]], global_param: Optional[RepeatedEndpointConfPairs], google_service_account: Optional[str], instance_profile_arn: Optional[str], security_policy: Optional[SetWorkspaceWarehouseConfigRequestSecurityPolicy], sql_configuration_parameters: Optional[RepeatedEndpointConfPairs]])¶

Set the workspace configuration.

Sets the workspace level configuration that is shared by all SQL warehouses in a workspace.

Parameters:

channel – Channel (optional) Optional: Channel selection details
config_param – RepeatedEndpointConfPairs (optional) Deprecated: Use sql_configuration_parameters
data_access_config – List[EndpointConfPair] (optional) Spark confs for external hive metastore configuration JSON serialized size must be less than <= 512K
enabled_warehouse_types – List[WarehouseTypePair] (optional) 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 – RepeatedEndpointConfPairs (optional) Deprecated: Use sql_configuration_parameters
google_service_account – str (optional) GCP only: Google Service Account used to pass to cluster to access Google Cloud Storage
instance_profile_arn – str (optional) AWS Only: Instance profile used to pass IAM role to the cluster
security_policy – SetWorkspaceWarehouseConfigRequestSecurityPolicy (optional) Security policy for warehouses
sql_configuration_parameters – RepeatedEndpointConfPairs (optional) SQL configuration parameters

start(id: str) → Wait[GetWarehouseResponse]¶

Start a warehouse.

Starts a SQL warehouse.

Parameters:: id – str Required. Id of the SQL warehouse.
Returns:: Long-running operation waiter for GetWarehouseResponse. See :method:wait_get_warehouse_running for more details.

start_and_wait(id: str, timeout: datetime.timedelta = 0:20:00) → GetWarehouseResponse¶

stop(id: str) → Wait[GetWarehouseResponse]¶

Stop a warehouse.

Stops a SQL warehouse.

Parameters:: id – str Required. Id of the SQL warehouse.
Returns:: Long-running operation waiter for GetWarehouseResponse. See :method:wait_get_warehouse_stopped for more details.

stop_and_wait(id: str, timeout: datetime.timedelta = 0:20:00) → GetWarehouseResponse¶

update_permissions(warehouse_id: str [, access_control_list: Optional[List[WarehouseAccessControlRequest]]]) → WarehousePermissions¶

Update SQL warehouse permissions.

Updates the permissions on a SQL warehouse. SQL warehouses can inherit permissions from their root object.

Parameters:

warehouse_id – str The SQL warehouse for which to get or manage permissions.
access_control_list – List[WarehouseAccessControlRequest] (optional)

Returns:

WarehousePermissions

wait_get_warehouse_running(id: str, timeout: datetime.timedelta = 0:20:00, callback: Optional[Callable[[GetWarehouseResponse], None]]) → GetWarehouseResponse¶

wait_get_warehouse_stopped(id: str, timeout: datetime.timedelta = 0:20:00, callback: Optional[Callable[[GetWarehouseResponse], None]]) → GetWarehouseResponse¶

Navigation

Related Topics

`w.warehouses`: SQL Warehouses¶

w.warehouses: SQL Warehouses¶

`w.warehouses`: SQL Warehouses¶