Warehouse
EndpointInfo object
- idstringImmutable
Unique identifier of the warehouse.
- namestring
Logical name for the warehouse.
Supported values:
- Must be unique within an org.
- Must be 1 to 100 characters.
- cluster_sizestring
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
- 5X-Large
- min_num_clustersint32
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
- max_num_clustersint32
Maximum number of clusters that the autoscaler will create to handle concurrent queries.
Supported values:
- Must be >= min_num_clusters
- Must be <= 40.
Defaults to min_clusters if unset.
- auto_stop_minsint32
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 >= 1 min for serverless warehouses.
- Must be == 0 or >= 10 mins for classic and pro warehouses.
- 0 indicates no autostop.
Defaults to 120 mins
- creator_namestring
Name of the user who created the warehouse. Set by the server and ignored in requests.
- instance_profile_arnstringDeprecated
Deprecated. Instance profile used to pass IAM role to the cluster
- tagsobject
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.
Show child attributesHide child attributes
- custom_tagsarray of object
User-defined tags, applied in addition to the tags Databricks sets automatically.
Show child attributesHide child attributes
- keystring
Tag key. Keys must be unique within the warehouse and cannot use the keys that Databricks reserves for the tags it sets automatically.
- valuestring
Tag value. Keys and values must follow the tagging rules of the cloud provider.
- spot_instance_policystring
Configures whether the warehouse should use spot instances. COST_OPTIMIZED uses spot instances where the cloud provider supports them, and RELIABILITY_OPTIMIZED uses on-demand instances only.
POLICY_UNSPECIFIEDCOST_OPTIMIZEDRELIABILITY_OPTIMIZED
- enable_photonboolean
Configures whether the warehouse should use Photon optimized clusters.
Defaults to true.
- channelobject
Channel that determines which Databricks SQL version the warehouse runs.
Show child attributesHide child attributes
- namestring
Channel to follow. CHANNEL_NAME_CURRENT is the default, and CHANNEL_NAME_PREVIEW carries the upcoming Databricks SQL release for testing.
CHANNEL_NAME_PREVIEWCHANNEL_NAME_CURRENTCHANNEL_NAME_PREVIOUSCHANNEL_NAME_CUSTOM
- dbsql_versionstring
Databricks SQL version to pin to. Set it if and only if name is CHANNEL_NAME_CUSTOM.
- enable_serverless_computeboolean
Configures whether the warehouse should use serverless compute
- warehouse_typestring
Warehouse type:
PROorCLASSIC. If you want to use serverless compute, you must set toPROand also set the fieldenable_serverless_computetotrue.TYPE_UNSPECIFIEDCLASSICPRO
- statement_timeoutint32Public Preview
Maximum time in seconds that a statement can run on this warehouse before it is cancelled. Set to 0 to remove the warehouse-level timeout. Changing the value of a running warehouse restarts it. See https://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout.
- num_clustersint32
Number of clusters currently allocated to the warehouse, including clusters that are still starting.
- num_active_sessionsint64Deprecated
Deprecated. current number of active sessions for the warehouse
- statestring
Current state of the warehouse.
STARTINGRUNNINGSTOPPINGSTOPPEDDELETINGDELETED
- jdbc_urlstring
JDBC connection string for the warehouse.
- odbc_paramsobject
ODBC parameters for the SQL warehouse
Show child attributesHide child attributes
- hostnamestring
Hostname of the workspace to connect to.
- pathstring
HTTP path of the warehouse.
- protocolstring
The transport protocol is always https.
- portint32
The connection port is always 443.
- healthobjectOutput only
Optional health status. Assume the warehouse is healthy if this field is not set.
Show child attributesHide child attributes
- statusstringOutput only
Health status of the endpoint.
HEALTHYDEGRADEDFAILED
- messagestringDeprecated
Deprecated. split into summary and details for security
- failure_reasonobject
The reason for failure to bring up clusters for this warehouse. This is available when status is 'FAILED' and sometimes when it is DEGRADED.
Show child attributesHide child attributes
- codestring
status code indicating why the cluster was terminated
Show 187 possible values
UNKNOWNUSER_REQUESTJOB_FINISHEDINACTIVITYCLOUD_PROVIDER_SHUTDOWNCOMMUNICATION_LOSTCLOUD_PROVIDER_LAUNCH_FAILUREINIT_SCRIPT_FAILURESPARK_STARTUP_FAILUREINVALID_ARGUMENTUNEXPECTED_LAUNCH_FAILUREINTERNAL_ERRORINSTANCE_UNREACHABLEREQUEST_REJECTEDTRIAL_EXPIREDDRIVER_UNREACHABLESPARK_ERRORDRIVER_UNRESPONSIVEMETASTORE_COMPONENT_UNHEALTHYDBFS_COMPONENT_UNHEALTHYEXECUTION_COMPONENT_UNHEALTHYAZURE_RESOURCE_MANAGER_THROTTLINGAZURE_RESOURCE_PROVIDER_THROTTLINGNETWORK_CONFIGURATION_FAILURECONTAINER_LAUNCH_FAILUREINSTANCE_POOL_CLUSTER_FAILURESKIPPED_SLOW_NODESATTACH_PROJECT_FAILUREUPDATE_INSTANCE_PROFILE_FAILUREDATABASE_CONNECTION_FAILUREREQUEST_THROTTLEDSELF_BOOTSTRAP_FAILUREGLOBAL_INIT_SCRIPT_FAILURESLOW_IMAGE_DOWNLOADINVALID_SPARK_IMAGENPIP_TUNNEL_TOKEN_FAILUREHIVE_METASTORE_PROVISIONING_FAILUREAZURE_INVALID_DEPLOYMENT_TEMPLATEAZURE_UNEXPECTED_DEPLOYMENT_TEMPLATE_FAILURESUBNET_EXHAUSTED_FAILUREBOOTSTRAP_TIMEOUTSTORAGE_DOWNLOAD_FAILURECONTROL_PLANE_REQUEST_FAILUREBOOTSTRAP_TIMEOUT_CLOUD_PROVIDER_EXCEPTIONAWS_INSUFFICIENT_INSTANCE_CAPACITY_FAILUREDOCKER_IMAGE_PULL_FAILUREAZURE_VNET_CONFIGURATION_FAILURENPIP_TUNNEL_SETUP_FAILUREAWS_AUTHORIZATION_FAILURENEPHOS_RESOURCE_MANAGEMENTSTS_CLIENT_SETUP_FAILURESECURITY_DAEMON_REGISTRATION_EXCEPTIONAWS_REQUEST_LIMIT_EXCEEDEDAWS_INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET_FAILUREAWS_UNSUPPORTED_FAILUREAZURE_QUOTA_EXCEEDED_EXCEPTIONAZURE_OPERATION_NOT_ALLOWED_EXCEPTIONNFS_MOUNT_FAILUREK8S_AUTOSCALING_FAILUREK8S_DBR_CLUSTER_LAUNCH_TIMEOUTSPARK_IMAGE_DOWNLOAD_FAILUREAZURE_VM_EXTENSION_FAILUREWORKSPACE_CANCELLED_ERRORAWS_MAX_SPOT_INSTANCE_COUNT_EXCEEDED_FAILURETEMPORARILY_UNAVAILABLEWORKER_SETUP_FAILUREIP_EXHAUSTION_FAILUREGCP_QUOTA_EXCEEDEDCLOUD_PROVIDER_RESOURCE_STOCKOUTGCP_SERVICE_ACCOUNT_DELETEDAZURE_BYOK_KEY_PERMISSION_FAILURESPOT_INSTANCE_TERMINATIONAZURE_EPHEMERAL_DISK_FAILUREABUSE_DETECTEDIMAGE_PULL_PERMISSION_DENIEDWORKSPACE_CONFIGURATION_ERRORSECRET_RESOLUTION_ERRORUNSUPPORTED_INSTANCE_TYPECLOUD_PROVIDER_DISK_SETUP_FAILURESSH_BOOTSTRAP_FAILUREAWS_INACCESSIBLE_KMS_KEY_FAILUREINIT_CONTAINER_NOT_FINISHEDSPARK_IMAGE_DOWNLOAD_THROTTLEDSPARK_IMAGE_NOT_FOUNDCLUSTER_OPERATION_THROTTLEDCLUSTER_OPERATION_TIMEOUTSERVERLESS_LONG_RUNNING_TERMINATEDAZURE_PACKED_DEPLOYMENT_PARTIAL_FAILUREINVALID_WORKER_IMAGE_FAILUREWORKSPACE_UPDATEINVALID_AWS_PARAMETERDRIVER_OUT_OF_DISKDRIVER_OUT_OF_MEMORYDRIVER_LAUNCH_TIMEOUTDRIVER_UNEXPECTED_FAILUREUNEXPECTED_POD_RECREATIONGCP_INACCESSIBLE_KMS_KEY_FAILUREGCP_KMS_KEY_PERMISSION_DENIEDDRIVER_EVICTIONUSER_INITIATED_VM_TERMINATIONGCP_IAM_TIMEOUTAWS_RESOURCE_QUOTA_EXCEEDEDCLOUD_ACCOUNT_SETUP_FAILUREAWS_INVALID_KEY_PAIRDRIVER_POD_CREATION_FAILUREMAINTENANCE_MODEINTERNAL_CAPACITY_FAILUREEXECUTOR_POD_UNSCHEDULEDSTORAGE_DOWNLOAD_FAILURE_SLOWSTORAGE_DOWNLOAD_FAILURE_THROTTLEDDYNAMIC_SPARK_CONF_SIZE_EXCEEDEDAWS_INSTANCE_PROFILE_UPDATE_FAILUREINSTANCE_POOL_NOT_FOUNDINSTANCE_POOL_MAX_CAPACITY_REACHEDAWS_INVALID_KMS_KEY_STATEGCP_INSUFFICIENT_CAPACITYGCP_API_RATE_QUOTA_EXCEEDEDGCP_RESOURCE_QUOTA_EXCEEDEDGCP_IP_SPACE_EXHAUSTEDGCP_SERVICE_ACCOUNT_ACCESS_DENIEDGCP_SERVICE_ACCOUNT_NOT_FOUNDGCP_FORBIDDENGCP_NOT_FOUNDRESOURCE_USAGE_BLOCKEDDATA_ACCESS_CONFIG_CHANGEDACCESS_TOKEN_FAILUREINVALID_INSTANCE_PLACEMENT_PROTOCOLBUDGET_POLICY_RESOLUTION_FAILUREIN_PENALTY_BOXDISASTER_RECOVERY_REPLICATIONBOOTSTRAP_TIMEOUT_DUE_TO_MISCONFIGINSTANCE_UNREACHABLE_DUE_TO_MISCONFIGSTORAGE_DOWNLOAD_FAILURE_DUE_TO_MISCONFIGCONTROL_PLANE_REQUEST_FAILURE_DUE_TO_MISCONFIGCLOUD_PROVIDER_LAUNCH_FAILURE_DUE_TO_MISCONFIGGCP_SUBNET_NOT_READYCLOUD_OPERATION_CANCELLEDCLOUD_PROVIDER_INSTANCE_NOT_LAUNCHEDGCP_TRUSTED_IMAGE_PROJECTS_VIOLATEDBUDGET_POLICY_LIMIT_ENFORCEMENT_ACTIVATEDEOS_SPARK_IMAGENO_MATCHED_K8SLAZY_ALLOCATION_TIMEOUTDRIVER_NODE_UNREACHABLESECRET_CREATION_FAILUREPOD_SCHEDULING_FAILUREPOD_ASSIGNMENT_FAILUREALLOCATION_TIMEOUTALLOCATION_TIMEOUT_NO_UNALLOCATED_CLUSTERSALLOCATION_TIMEOUT_NO_MATCHED_CLUSTERSALLOCATION_TIMEOUT_NO_READY_CLUSTERSALLOCATION_TIMEOUT_NO_WARMED_UP_CLUSTERSALLOCATION_TIMEOUT_NODE_DAEMON_NOT_READYALLOCATION_TIMEOUT_NO_HEALTHY_CLUSTERSNETVISOR_SETUP_TIMEOUTNO_MATCHED_K8S_TESTING_TAGCLOUD_PROVIDER_RESOURCE_STOCKOUT_DUE_TO_MISCONFIGGKE_BASED_CLUSTER_TERMINATIONALLOCATION_TIMEOUT_NO_HEALTHY_AND_WARMED_UP_CLUSTERSDOCKER_INVALID_OS_EXCEPTIONDOCKER_CONTAINER_CREATION_EXCEPTIONDOCKER_IMAGE_TOO_LARGE_FOR_INSTANCE_EXCEPTIONDNS_RESOLUTION_ERRORGCP_DENIED_BY_ORG_POLICYSECRET_PERMISSION_DENIEDNETWORK_CHECK_NIC_FAILURENETWORK_CHECK_DNS_SERVER_FAILURENETWORK_CHECK_STORAGE_FAILURENETWORK_CHECK_METADATA_ENDPOINT_FAILURENETWORK_CHECK_CONTROL_PLANE_FAILURENETWORK_CHECK_MULTIPLE_COMPONENTS_FAILUREDRIVER_UNHEALTHYUSAGE_POLICY_ENTITLEMENT_DENIEDK8S_ACTIVE_POD_QUOTA_EXCEEDEDCLOUD_ACCOUNT_POD_QUOTA_EXCEEDEDNETWORK_CHECK_NIC_FAILURE_DUE_TO_MISCONFIGNETWORK_CHECK_DNS_SERVER_FAILURE_DUE_TO_MISCONFIGNETWORK_CHECK_STORAGE_FAILURE_DUE_TO_MISCONFIGNETWORK_CHECK_METADATA_ENDPOINT_FAILURE_DUE_TO_MISCONFIGNETWORK_CHECK_CONTROL_PLANE_FAILURE_DUE_TO_MISCONFIGNETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE_DUE_TO_MISCONFIGDBR_IMAGE_RESOLUTION_FAILURECONTROL_PLANE_CONNECTION_FAILURECONTROL_PLANE_CONNECTION_FAILURE_DUE_TO_MISCONFIGRATE_LIMITEDMTLS_PORT_CONNECTIVITY_FAILUREHIVEMETASTORE_CONNECTIVITY_FAILURE
- typestring
type of the termination
SUCCESSCLIENT_ERRORSERVICE_FAULTCLOUD_FAILURE
- parametersobject
list of parameters that provide additional information about why the cluster was terminated
- summarystring
A short summary of the health status in case of degraded/failed warehouses.
- detailsstring
Details about errors that are causing current degraded/failed status.
Get warehouse info GA
GET
Gets the information for a single SQL warehouse.
API scopes: sql
Parameters
- idstringRequiredpath
Required. Id of the SQL warehouse.
Response
- idstringImmutable
Unique identifier of the warehouse.
- namestring
Logical name for the warehouse.
Supported values:
- Must be unique within an org.
- Must be 1 to 100 characters.
- cluster_sizestring
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
- 5X-Large
- min_num_clustersint32
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
- max_num_clustersint32
Maximum number of clusters that the autoscaler will create to handle concurrent queries.
Supported values:
- Must be >= min_num_clusters
- Must be <= 40.
Defaults to min_clusters if unset.
- auto_stop_minsint32
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 >= 1 min for serverless warehouses.
- Must be == 0 or >= 10 mins for classic and pro warehouses.
- 0 indicates no autostop.
Defaults to 120 mins
- creator_namestring
Name of the user who created the warehouse. Set by the server and ignored in requests.
- instance_profile_arnstringDeprecated
Deprecated. Instance profile used to pass IAM role to the cluster
- tagsobject
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.
Show child attributesHide child attributes
- custom_tagsarray of object
User-defined tags, applied in addition to the tags Databricks sets automatically.
Show child attributesHide child attributes
- keystring
Tag key. Keys must be unique within the warehouse and cannot use the keys that Databricks reserves for the tags it sets automatically.
- valuestring
Tag value. Keys and values must follow the tagging rules of the cloud provider.
- spot_instance_policystring
Configures whether the warehouse should use spot instances. COST_OPTIMIZED uses spot instances where the cloud provider supports them, and RELIABILITY_OPTIMIZED uses on-demand instances only.
POLICY_UNSPECIFIEDCOST_OPTIMIZEDRELIABILITY_OPTIMIZED
- enable_photonboolean
Configures whether the warehouse should use Photon optimized clusters.
Defaults to true.
- channelobject
Channel that determines which Databricks SQL version the warehouse runs.
Show child attributesHide child attributes
- namestring
Channel to follow. CHANNEL_NAME_CURRENT is the default, and CHANNEL_NAME_PREVIEW carries the upcoming Databricks SQL release for testing.
CHANNEL_NAME_PREVIEWCHANNEL_NAME_CURRENTCHANNEL_NAME_PREVIOUSCHANNEL_NAME_CUSTOM
- dbsql_versionstring
Databricks SQL version to pin to. Set it if and only if name is CHANNEL_NAME_CUSTOM.
- enable_serverless_computeboolean
Configures whether the warehouse should use serverless compute
- warehouse_typestring
Warehouse type:
PROorCLASSIC. If you want to use serverless compute, you must set toPROand also set the fieldenable_serverless_computetotrue.TYPE_UNSPECIFIEDCLASSICPRO
- statement_timeoutint32Public Preview
Maximum time in seconds that a statement can run on this warehouse before it is cancelled. Set to 0 to remove the warehouse-level timeout. Changing the value of a running warehouse restarts it. See https://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout.
- num_clustersint32
Number of clusters currently allocated to the warehouse, including clusters that are still starting.
- num_active_sessionsint64Deprecated
Deprecated. current number of active sessions for the warehouse
- statestring
Current state of the warehouse.
STARTINGRUNNINGSTOPPINGSTOPPEDDELETINGDELETED
- jdbc_urlstring
JDBC connection string for the warehouse.
- odbc_paramsobject
ODBC parameters for the SQL warehouse
Show child attributesHide child attributes
- hostnamestring
Hostname of the workspace to connect to.
- pathstring
HTTP path of the warehouse.
- protocolstring
The transport protocol is always https.
- portint32
The connection port is always 443.
- healthobjectOutput only
Optional health status. Assume the warehouse is healthy if this field is not set.
Show child attributesHide child attributes
- statusstringOutput only
Health status of the endpoint.
HEALTHYDEGRADEDFAILED
- messagestringDeprecated
Deprecated. split into summary and details for security
- failure_reasonobject
The reason for failure to bring up clusters for this warehouse. This is available when status is 'FAILED' and sometimes when it is DEGRADED.
Show child attributesHide child attributes
- codestring
status code indicating why the cluster was terminated
Show 187 possible values
UNKNOWNUSER_REQUESTJOB_FINISHEDINACTIVITYCLOUD_PROVIDER_SHUTDOWNCOMMUNICATION_LOSTCLOUD_PROVIDER_LAUNCH_FAILUREINIT_SCRIPT_FAILURESPARK_STARTUP_FAILUREINVALID_ARGUMENTUNEXPECTED_LAUNCH_FAILUREINTERNAL_ERRORINSTANCE_UNREACHABLEREQUEST_REJECTEDTRIAL_EXPIREDDRIVER_UNREACHABLESPARK_ERRORDRIVER_UNRESPONSIVEMETASTORE_COMPONENT_UNHEALTHYDBFS_COMPONENT_UNHEALTHYEXECUTION_COMPONENT_UNHEALTHYAZURE_RESOURCE_MANAGER_THROTTLINGAZURE_RESOURCE_PROVIDER_THROTTLINGNETWORK_CONFIGURATION_FAILURECONTAINER_LAUNCH_FAILUREINSTANCE_POOL_CLUSTER_FAILURESKIPPED_SLOW_NODESATTACH_PROJECT_FAILUREUPDATE_INSTANCE_PROFILE_FAILUREDATABASE_CONNECTION_FAILUREREQUEST_THROTTLEDSELF_BOOTSTRAP_FAILUREGLOBAL_INIT_SCRIPT_FAILURESLOW_IMAGE_DOWNLOADINVALID_SPARK_IMAGENPIP_TUNNEL_TOKEN_FAILUREHIVE_METASTORE_PROVISIONING_FAILUREAZURE_INVALID_DEPLOYMENT_TEMPLATEAZURE_UNEXPECTED_DEPLOYMENT_TEMPLATE_FAILURESUBNET_EXHAUSTED_FAILUREBOOTSTRAP_TIMEOUTSTORAGE_DOWNLOAD_FAILURECONTROL_PLANE_REQUEST_FAILUREBOOTSTRAP_TIMEOUT_CLOUD_PROVIDER_EXCEPTIONAWS_INSUFFICIENT_INSTANCE_CAPACITY_FAILUREDOCKER_IMAGE_PULL_FAILUREAZURE_VNET_CONFIGURATION_FAILURENPIP_TUNNEL_SETUP_FAILUREAWS_AUTHORIZATION_FAILURENEPHOS_RESOURCE_MANAGEMENTSTS_CLIENT_SETUP_FAILURESECURITY_DAEMON_REGISTRATION_EXCEPTIONAWS_REQUEST_LIMIT_EXCEEDEDAWS_INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET_FAILUREAWS_UNSUPPORTED_FAILUREAZURE_QUOTA_EXCEEDED_EXCEPTIONAZURE_OPERATION_NOT_ALLOWED_EXCEPTIONNFS_MOUNT_FAILUREK8S_AUTOSCALING_FAILUREK8S_DBR_CLUSTER_LAUNCH_TIMEOUTSPARK_IMAGE_DOWNLOAD_FAILUREAZURE_VM_EXTENSION_FAILUREWORKSPACE_CANCELLED_ERRORAWS_MAX_SPOT_INSTANCE_COUNT_EXCEEDED_FAILURETEMPORARILY_UNAVAILABLEWORKER_SETUP_FAILUREIP_EXHAUSTION_FAILUREGCP_QUOTA_EXCEEDEDCLOUD_PROVIDER_RESOURCE_STOCKOUTGCP_SERVICE_ACCOUNT_DELETEDAZURE_BYOK_KEY_PERMISSION_FAILURESPOT_INSTANCE_TERMINATIONAZURE_EPHEMERAL_DISK_FAILUREABUSE_DETECTEDIMAGE_PULL_PERMISSION_DENIEDWORKSPACE_CONFIGURATION_ERRORSECRET_RESOLUTION_ERRORUNSUPPORTED_INSTANCE_TYPECLOUD_PROVIDER_DISK_SETUP_FAILURESSH_BOOTSTRAP_FAILUREAWS_INACCESSIBLE_KMS_KEY_FAILUREINIT_CONTAINER_NOT_FINISHEDSPARK_IMAGE_DOWNLOAD_THROTTLEDSPARK_IMAGE_NOT_FOUNDCLUSTER_OPERATION_THROTTLEDCLUSTER_OPERATION_TIMEOUTSERVERLESS_LONG_RUNNING_TERMINATEDAZURE_PACKED_DEPLOYMENT_PARTIAL_FAILUREINVALID_WORKER_IMAGE_FAILUREWORKSPACE_UPDATEINVALID_AWS_PARAMETERDRIVER_OUT_OF_DISKDRIVER_OUT_OF_MEMORYDRIVER_LAUNCH_TIMEOUTDRIVER_UNEXPECTED_FAILUREUNEXPECTED_POD_RECREATIONGCP_INACCESSIBLE_KMS_KEY_FAILUREGCP_KMS_KEY_PERMISSION_DENIEDDRIVER_EVICTIONUSER_INITIATED_VM_TERMINATIONGCP_IAM_TIMEOUTAWS_RESOURCE_QUOTA_EXCEEDEDCLOUD_ACCOUNT_SETUP_FAILUREAWS_INVALID_KEY_PAIRDRIVER_POD_CREATION_FAILUREMAINTENANCE_MODEINTERNAL_CAPACITY_FAILUREEXECUTOR_POD_UNSCHEDULEDSTORAGE_DOWNLOAD_FAILURE_SLOWSTORAGE_DOWNLOAD_FAILURE_THROTTLEDDYNAMIC_SPARK_CONF_SIZE_EXCEEDEDAWS_INSTANCE_PROFILE_UPDATE_FAILUREINSTANCE_POOL_NOT_FOUNDINSTANCE_POOL_MAX_CAPACITY_REACHEDAWS_INVALID_KMS_KEY_STATEGCP_INSUFFICIENT_CAPACITYGCP_API_RATE_QUOTA_EXCEEDEDGCP_RESOURCE_QUOTA_EXCEEDEDGCP_IP_SPACE_EXHAUSTEDGCP_SERVICE_ACCOUNT_ACCESS_DENIEDGCP_SERVICE_ACCOUNT_NOT_FOUNDGCP_FORBIDDENGCP_NOT_FOUNDRESOURCE_USAGE_BLOCKEDDATA_ACCESS_CONFIG_CHANGEDACCESS_TOKEN_FAILUREINVALID_INSTANCE_PLACEMENT_PROTOCOLBUDGET_POLICY_RESOLUTION_FAILUREIN_PENALTY_BOXDISASTER_RECOVERY_REPLICATIONBOOTSTRAP_TIMEOUT_DUE_TO_MISCONFIGINSTANCE_UNREACHABLE_DUE_TO_MISCONFIGSTORAGE_DOWNLOAD_FAILURE_DUE_TO_MISCONFIGCONTROL_PLANE_REQUEST_FAILURE_DUE_TO_MISCONFIGCLOUD_PROVIDER_LAUNCH_FAILURE_DUE_TO_MISCONFIGGCP_SUBNET_NOT_READYCLOUD_OPERATION_CANCELLEDCLOUD_PROVIDER_INSTANCE_NOT_LAUNCHEDGCP_TRUSTED_IMAGE_PROJECTS_VIOLATEDBUDGET_POLICY_LIMIT_ENFORCEMENT_ACTIVATEDEOS_SPARK_IMAGENO_MATCHED_K8SLAZY_ALLOCATION_TIMEOUTDRIVER_NODE_UNREACHABLESECRET_CREATION_FAILUREPOD_SCHEDULING_FAILUREPOD_ASSIGNMENT_FAILUREALLOCATION_TIMEOUTALLOCATION_TIMEOUT_NO_UNALLOCATED_CLUSTERSALLOCATION_TIMEOUT_NO_MATCHED_CLUSTERSALLOCATION_TIMEOUT_NO_READY_CLUSTERSALLOCATION_TIMEOUT_NO_WARMED_UP_CLUSTERSALLOCATION_TIMEOUT_NODE_DAEMON_NOT_READYALLOCATION_TIMEOUT_NO_HEALTHY_CLUSTERSNETVISOR_SETUP_TIMEOUTNO_MATCHED_K8S_TESTING_TAGCLOUD_PROVIDER_RESOURCE_STOCKOUT_DUE_TO_MISCONFIGGKE_BASED_CLUSTER_TERMINATIONALLOCATION_TIMEOUT_NO_HEALTHY_AND_WARMED_UP_CLUSTERSDOCKER_INVALID_OS_EXCEPTIONDOCKER_CONTAINER_CREATION_EXCEPTIONDOCKER_IMAGE_TOO_LARGE_FOR_INSTANCE_EXCEPTIONDNS_RESOLUTION_ERRORGCP_DENIED_BY_ORG_POLICYSECRET_PERMISSION_DENIEDNETWORK_CHECK_NIC_FAILURENETWORK_CHECK_DNS_SERVER_FAILURENETWORK_CHECK_STORAGE_FAILURENETWORK_CHECK_METADATA_ENDPOINT_FAILURENETWORK_CHECK_CONTROL_PLANE_FAILURENETWORK_CHECK_MULTIPLE_COMPONENTS_FAILUREDRIVER_UNHEALTHYUSAGE_POLICY_ENTITLEMENT_DENIEDK8S_ACTIVE_POD_QUOTA_EXCEEDEDCLOUD_ACCOUNT_POD_QUOTA_EXCEEDEDNETWORK_CHECK_NIC_FAILURE_DUE_TO_MISCONFIGNETWORK_CHECK_DNS_SERVER_FAILURE_DUE_TO_MISCONFIGNETWORK_CHECK_STORAGE_FAILURE_DUE_TO_MISCONFIGNETWORK_CHECK_METADATA_ENDPOINT_FAILURE_DUE_TO_MISCONFIGNETWORK_CHECK_CONTROL_PLANE_FAILURE_DUE_TO_MISCONFIGNETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE_DUE_TO_MISCONFIGDBR_IMAGE_RESOLUTION_FAILURECONTROL_PLANE_CONNECTION_FAILURECONTROL_PLANE_CONNECTION_FAILURE_DUE_TO_MISCONFIGRATE_LIMITEDMTLS_PORT_CONNECTIVITY_FAILUREHIVEMETASTORE_CONNECTIVITY_FAILURE
- typestring
type of the termination
SUCCESSCLIENT_ERRORSERVICE_FAULTCLOUD_FAILURE
- parametersobject
list of parameters that provide additional information about why the cluster was terminated
- summarystring
A short summary of the health status in case of degraded/failed warehouses.
- detailsstring
Details about errors that are causing current degraded/failed status.
List warehouses GA
GET
Lists all SQL warehouses that a user has access to.
API scopes: sql
Parameters
- run_as_user_idint64int32Deprecatedquery
Deprecated: this field is ignored by the server. Service Principal which will be used to fetch the list of endpoints. If not specified, SQL Gateway will use the user from the session header.
- page_sizeint32query
The max number of warehouses to return.
- page_tokenstringquery
A page token, received from a previous
ListWarehousescall. Provide this to retrieve the subsequent page; otherwise the first will be retrieved.When paginating, all other parameters provided to
ListWarehousesmust match the call that provided the page token.
Response
Returns a list of EndpointInfo objects.
Create a warehouse GA
POST
Creates a new SQL warehouse.
API scopes: sql
Request body
- namestring
Logical name for the warehouse.
Supported values:
- Must be unique within an org.
- Must be 1 to 100 characters.
- cluster_sizestring
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
- 5X-Large
- min_num_clustersint32
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
- max_num_clustersint32
Maximum number of clusters that the autoscaler will create to handle concurrent queries.
Supported values:
- Must be >= min_num_clusters
- Must be <= 40.
Defaults to min_clusters if unset.
- auto_stop_minsint32
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 >= 1 min for serverless warehouses.
- Must be == 0 or >= 10 mins for classic and pro warehouses.
- 0 indicates no autostop.
Defaults to 120 mins
- creator_namestring
Name of the user who created the warehouse. Set by the server and ignored in requests.
- instance_profile_arnstringDeprecated
Deprecated. Instance profile used to pass IAM role to the cluster
- tagsobject
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.
Show child attributesHide child attributes
- custom_tagsarray of object
User-defined tags, applied in addition to the tags Databricks sets automatically.
Show child attributesHide child attributes
- keystring
Tag key. Keys must be unique within the warehouse and cannot use the keys that Databricks reserves for the tags it sets automatically.
- valuestring
Tag value. Keys and values must follow the tagging rules of the cloud provider.
- spot_instance_policystring
Configures whether the warehouse should use spot instances. COST_OPTIMIZED uses spot instances where the cloud provider supports them, and RELIABILITY_OPTIMIZED uses on-demand instances only.
POLICY_UNSPECIFIEDCOST_OPTIMIZEDRELIABILITY_OPTIMIZED
- enable_photonboolean
Configures whether the warehouse should use Photon optimized clusters.
Defaults to true.
- channelobject
Channel that determines which Databricks SQL version the warehouse runs.
Show child attributesHide child attributes
- namestring
Channel to follow. CHANNEL_NAME_CURRENT is the default, and CHANNEL_NAME_PREVIEW carries the upcoming Databricks SQL release for testing.
CHANNEL_NAME_PREVIEWCHANNEL_NAME_CURRENTCHANNEL_NAME_PREVIOUSCHANNEL_NAME_CUSTOM
- dbsql_versionstring
Databricks SQL version to pin to. Set it if and only if name is CHANNEL_NAME_CUSTOM.
- enable_serverless_computeboolean
Configures whether the warehouse should use serverless compute
- warehouse_typestring
Warehouse type:
PROorCLASSIC. If you want to use serverless compute, you must set toPROand also set the fieldenable_serverless_computetotrue.TYPE_UNSPECIFIEDCLASSICPRO
- statement_timeoutint32Public Preview
Maximum time in seconds that a statement can run on this warehouse before it is cancelled. Set to 0 to remove the warehouse-level timeout. Changing the value of a running warehouse restarts it. See https://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout.
Response
- idstring
Id for the SQL warehouse. This value is unique across all SQL warehouses.
Update a warehouse GA
POST
Updates the configuration for a SQL warehouse.
API scopes: sql
Parameters
- idstringRequiredpath
Required. Id of the warehouse to configure.
Request body
- namestring
Logical name for the warehouse.
Supported values:
- Must be unique within an org.
- Must be 1 to 100 characters.
- cluster_sizestring
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
- 5X-Large
- min_num_clustersint32
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
- max_num_clustersint32
Maximum number of clusters that the autoscaler will create to handle concurrent queries.
Supported values:
- Must be >= min_num_clusters
- Must be <= 40.
Defaults to min_clusters if unset.
- auto_stop_minsint32
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 >= 1 min for serverless warehouses.
- Must be == 0 or >= 10 mins for classic and pro warehouses.
- 0 indicates no autostop.
Defaults to 120 mins
- creator_namestring
Name of the user who created the warehouse. Set by the server and ignored in requests.
- instance_profile_arnstringDeprecated
Deprecated. Instance profile used to pass IAM role to the cluster
- tagsobject
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.
Show child attributesHide child attributes
- custom_tagsarray of object
User-defined tags, applied in addition to the tags Databricks sets automatically.
Show child attributesHide child attributes
- keystring
Tag key. Keys must be unique within the warehouse and cannot use the keys that Databricks reserves for the tags it sets automatically.
- valuestring
Tag value. Keys and values must follow the tagging rules of the cloud provider.
- spot_instance_policystring
Configures whether the warehouse should use spot instances. COST_OPTIMIZED uses spot instances where the cloud provider supports them, and RELIABILITY_OPTIMIZED uses on-demand instances only.
POLICY_UNSPECIFIEDCOST_OPTIMIZEDRELIABILITY_OPTIMIZED
- enable_photonboolean
Configures whether the warehouse should use Photon optimized clusters.
Defaults to true.
- channelobject
Channel that determines which Databricks SQL version the warehouse runs.
Show child attributesHide child attributes
- namestring
Channel to follow. CHANNEL_NAME_CURRENT is the default, and CHANNEL_NAME_PREVIEW carries the upcoming Databricks SQL release for testing.
CHANNEL_NAME_PREVIEWCHANNEL_NAME_CURRENTCHANNEL_NAME_PREVIOUSCHANNEL_NAME_CUSTOM
- dbsql_versionstring
Databricks SQL version to pin to. Set it if and only if name is CHANNEL_NAME_CUSTOM.
- enable_serverless_computeboolean
Configures whether the warehouse should use serverless compute
- warehouse_typestring
Warehouse type:
PROorCLASSIC. If you want to use serverless compute, you must set toPROand also set the fieldenable_serverless_computetotrue.TYPE_UNSPECIFIEDCLASSICPRO
- statement_timeoutint32Public Preview
Maximum time in seconds that a statement can run on this warehouse before it is cancelled. Set to 0 to remove the warehouse-level timeout. Changing the value of a running warehouse restarts it. See https://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout.
Delete a warehouse GA
Get the workspace configuration GA
GET
Gets the workspace level configuration that is shared by all SQL warehouses in a workspace.
API scopes: sql
Response
- security_policystring
Security policy for warehouses
NONEDATA_ACCESS_CONTROLPASSTHROUGH
- data_access_configarray of object
Spark configuration applied to every warehouse in the workspace, for example to connect to an external Hive metastore or to configure access to cloud storage. Only allowlisted keys are accepted, and the JSON-serialized size must be at most 512 KB. See https://docs.databricks.com/aws/en/admin/sql/data-access-configuration.
Show child attributesHide child attributes
- keystring
Name of the configuration parameter.
- valuestring
Value of the configuration parameter.
- instance_profile_arnstringDeprecated
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.
- channelobject
Optional: Channel selection details
Show child attributesHide child attributes
- namestring
Channel to follow. CHANNEL_NAME_CURRENT is the default, and CHANNEL_NAME_PREVIEW carries the upcoming Databricks SQL release for testing.
CHANNEL_NAME_PREVIEWCHANNEL_NAME_CURRENTCHANNEL_NAME_PREVIOUSCHANNEL_NAME_CUSTOM
- dbsql_versionstring
Databricks SQL version to pin to. Set it if and only if name is CHANNEL_NAME_CUSTOM.
- enable_serverless_computebooleanDeprecated
Deprecated: only setting this to true is allowed.
- global_paramobjectDeprecated
Deprecated: Use sql_configuration_parameters
Show child attributesHide child attributes
- config_pairarray of objectDeprecated
Deprecated: Use configuration_pairs
Show child attributesHide child attributes
- keystring
Name of the configuration parameter.
- valuestring
Value of the configuration parameter.
- configuration_pairsarray of object
Configuration parameters, each a key-value pair.
Show child attributesHide child attributes
- keystring
Name of the configuration parameter.
- valuestring
Value of the configuration parameter.
- config_paramobjectDeprecated
Deprecated: Use sql_configuration_parameters
Show child attributesHide child attributes
- config_pairarray of objectDeprecated
Deprecated: Use configuration_pairs
Show child attributesHide child attributes
- keystring
Name of the configuration parameter.
- valuestring
Value of the configuration parameter.
- configuration_pairsarray of object
Configuration parameters, each a key-value pair.
Show child attributesHide child attributes
- keystring
Name of the configuration parameter.
- valuestring
Value of the configuration parameter.
- sql_configuration_parametersobject
SQL configuration parameters applied to every warehouse in the workspace. Only parameters that can be set at the workspace scope are accepted. See https://docs.databricks.com/aws/en/sql/language-manual/sql-ref-parameters.
Show child attributesHide child attributes
- config_pairarray of objectDeprecated
Deprecated: Use configuration_pairs
Show child attributesHide child attributes
- keystring
Name of the configuration parameter.
- valuestring
Value of the configuration parameter.
- configuration_pairsarray of object
Configuration parameters, each a key-value pair.
Show child attributesHide child attributes
- keystring
Name of the configuration parameter.
- valuestring
Value of the configuration parameter.
- google_service_accountstring
GCP only: Google service account that the warehouse clusters use to access Google Cloud Storage.
- enabled_warehouse_typesarray of object
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.
Show child attributesHide child attributes
- warehouse_typestring
Warehouse type that this entry enables or disables.
TYPE_UNSPECIFIEDCLASSICPRO
- enabledboolean
If set to false the specific warehouse type will not be allowed as a value for warehouse_type in CreateWarehouse and EditWarehouse
Set the workspace configuration GA
PUT
Sets the workspace level configuration that is shared by all SQL warehouses in a workspace.
API scopes: sql
Request body
- security_policystring
Security policy for warehouses
NONEDATA_ACCESS_CONTROLPASSTHROUGH
- data_access_configarray of object
Spark configuration applied to every warehouse in the workspace, for example to connect to an external Hive metastore or to configure access to cloud storage. Only allowlisted keys are accepted, and the JSON-serialized size must be at most 512 KB. See https://docs.databricks.com/aws/en/admin/sql/data-access-configuration.
Show child attributesHide child attributes
- keystring
Name of the configuration parameter.
- valuestring
Value of the configuration parameter.
- instance_profile_arnstringDeprecated
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.
- channelobject
Optional: Channel selection details
Show child attributesHide child attributes
- namestring
Channel to follow. CHANNEL_NAME_CURRENT is the default, and CHANNEL_NAME_PREVIEW carries the upcoming Databricks SQL release for testing.
CHANNEL_NAME_PREVIEWCHANNEL_NAME_CURRENTCHANNEL_NAME_PREVIOUSCHANNEL_NAME_CUSTOM
- dbsql_versionstring
Databricks SQL version to pin to. Set it if and only if name is CHANNEL_NAME_CUSTOM.
- enable_serverless_computebooleanDeprecated
Deprecated: only setting this to true is allowed.
- global_paramobjectDeprecated
Deprecated: Use sql_configuration_parameters
Show child attributesHide child attributes
- config_pairarray of objectDeprecated
Deprecated: Use configuration_pairs
Show child attributesHide child attributes
- keystring
Name of the configuration parameter.
- valuestring
Value of the configuration parameter.
- configuration_pairsarray of object
Configuration parameters, each a key-value pair.
Show child attributesHide child attributes
- keystring
Name of the configuration parameter.
- valuestring
Value of the configuration parameter.
- config_paramobjectDeprecated
Deprecated: Use sql_configuration_parameters
Show child attributesHide child attributes
- config_pairarray of objectDeprecated
Deprecated: Use configuration_pairs
Show child attributesHide child attributes
- keystring
Name of the configuration parameter.
- valuestring
Value of the configuration parameter.
- configuration_pairsarray of object
Configuration parameters, each a key-value pair.
Show child attributesHide child attributes
- keystring
Name of the configuration parameter.
- valuestring
Value of the configuration parameter.
- sql_configuration_parametersobject
SQL configuration parameters applied to every warehouse in the workspace. Only parameters that can be set at the workspace scope are accepted. See https://docs.databricks.com/aws/en/sql/language-manual/sql-ref-parameters.
Show child attributesHide child attributes
- config_pairarray of objectDeprecated
Deprecated: Use configuration_pairs
Show child attributesHide child attributes
- keystring
Name of the configuration parameter.
- valuestring
Value of the configuration parameter.
- configuration_pairsarray of object
Configuration parameters, each a key-value pair.
Show child attributesHide child attributes
- keystring
Name of the configuration parameter.
- valuestring
Value of the configuration parameter.
- google_service_accountstring
GCP only: Google service account that the warehouse clusters use to access Google Cloud Storage.
- enabled_warehouse_typesarray of object
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.
Show child attributesHide child attributes
- warehouse_typestring
Warehouse type that this entry enables or disables.
TYPE_UNSPECIFIEDCLASSICPRO
- enabledboolean
If set to false the specific warehouse type will not be allowed as a value for warehouse_type in CreateWarehouse and EditWarehouse