Releases: databricks/databricks-sdk-py
Releases · databricks/databricks-sdk-py
v0.53.0
v0.52.0
Release v0.52.0
API Changes
- Added
future_feature_data_pathfield fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - Added
exclude_columnsandinclude_columnsfields fordatabricks.sdk.service.pipelines.TableSpecificConfig. - Added
network_check_control_plane_failure,network_check_dns_server_failure,network_check_metadata_endpoint_failure,network_check_multiple_components_failure,network_check_nic_failure,network_check_storage_failureandsecret_permission_deniedenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - [Breaking] Changed
pipeline_idfield fordatabricks.sdk.service.pipelines.EditPipelineto be required. - Changed
connection_name,gateway_storage_catalogandgateway_storage_schemafields fordatabricks.sdk.service.pipelines.IngestionGatewayPipelineDefinitionto be required. - [Breaking] Changed
connection_name,gateway_storage_catalogandgateway_storage_schemafields fordatabricks.sdk.service.pipelines.IngestionGatewayPipelineDefinitionto be required. - Changed
kindfield fordatabricks.sdk.service.pipelines.PipelineDeploymentto be required. - [Breaking] Changed
kindfield fordatabricks.sdk.service.pipelines.PipelineDeploymentto be required. - Changed
destination_catalog,destination_schemaandsource_urlfields fordatabricks.sdk.service.pipelines.ReportSpecto be required. - [Breaking] Changed
destination_catalog,destination_schemaandsource_urlfields fordatabricks.sdk.service.pipelines.ReportSpecto be required. - Changed
destination_catalog,destination_schemaandsource_schemafields fordatabricks.sdk.service.pipelines.SchemaSpecto be required. - [Breaking] Changed
destination_catalog,destination_schemaandsource_schemafields fordatabricks.sdk.service.pipelines.SchemaSpecto be required. - [Breaking] Changed
destination_catalog,destination_schemaandsource_tablefields fordatabricks.sdk.service.pipelines.TableSpecto be required. - Changed
destination_catalog,destination_schemaandsource_tablefields fordatabricks.sdk.service.pipelines.TableSpecto be required. - [Breaking] Changed
resultsfield fordatabricks.sdk.service.sql.ListAlertsV2Responseto typedatabricks.sdk.service.sql.AlertV2Listdataclass. - [Breaking] Changed pagination for AlertsV2API.list_alerts method.
- Fixed waiter for GenieAPI.create_message method.
v0.51.0
Release v0.51.0
New Features and Improvements
- Enabled asynchronous token refreshes by default. A new
disable_async_token_refreshconfiguration option has been added to allow disabling this feature if necessary (#952).
To disable asynchronous token refresh, set the environment variableDATABRICKS_DISABLE_ASYNC_TOKEN_REFRESH=trueor configure it within your configuration object.
The previousenable_experimental_async_token_refreshoption has been removed as asynchronous refresh is now the default behavior. - Introduce support for Databricks Workload Identity Federation in GitHub workflows (933).
See README.md for instructions. - [Breaking] Users running their workflows in GitHub Actions, which use Cloud native authentication and also have a
DATABRICKS_CLIENT_IDandDATABRICKS_HOST
environment variables set may see their authentication start failing due to the order in which the SDK tries different authentication methods.
API Changes
- Added w.alerts_v2 workspace-level service.
- Added
update_ncc_azure_private_endpoint_rule_public()method for a.network_connectivity account-level service. - Added
update_endpoint_budget_policy()andupdate_endpoint_custom_tags()methods for w.vector_search_endpoints workspace-level service. - Added
created_at,created_byandmetastore_idfields fordatabricks.sdk.service.catalog.SetArtifactAllowlist. - Added
node_type_flexibilityfield fordatabricks.sdk.service.compute.EditInstancePool. - Added
page_sizeandpage_tokenfields fordatabricks.sdk.service.compute.GetEvents. - Added
next_page_tokenandprev_page_tokenfields fordatabricks.sdk.service.compute.GetEventsResponse. - Added
node_type_flexibilityfield fordatabricks.sdk.service.compute.GetInstancePool. - Added
node_type_flexibilityfield fordatabricks.sdk.service.compute.InstancePoolAndStats. - Added
effective_performance_targetfield fordatabricks.sdk.service.jobs.RepairHistoryItem. - Added
performance_targetfield fordatabricks.sdk.service.jobs.RepairRun. - [Breaking] Added
network_connectivity_configfield fordatabricks.sdk.service.settings.CreateNetworkConnectivityConfigRequest. - [Breaking] Added
private_endpoint_rulefield fordatabricks.sdk.service.settings.CreatePrivateEndpointRuleRequest. - Added
domain_namesfield fordatabricks.sdk.service.settings.NccAzurePrivateEndpointRule. - Added
auto_resolve_display_namefield fordatabricks.sdk.service.sql.CreateAlertRequest. - Added
auto_resolve_display_namefield fordatabricks.sdk.service.sql.CreateQueryRequest. - Added
budget_policy_idfield fordatabricks.sdk.service.vectorsearch.CreateEndpoint. - Added
custom_tagsandeffective_budget_policy_idfields fordatabricks.sdk.service.vectorsearch.EndpointInfo. - Added
create_clean_room,execute_clean_room_taskandmodify_clean_roomenum values fordatabricks.sdk.service.catalog.Privilege. - Added
dns_resolution_errorandgcp_denied_by_org_policyenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - Added
disabledenum value fordatabricks.sdk.service.jobs.TerminationCodeCode. - Added
expiredenum value fordatabricks.sdk.service.settings.NccAzurePrivateEndpointRuleConnectionState. - [Breaking] Changed
create_network_connectivity_configuration()andcreate_private_endpoint_rule()methods for a.network_connectivity account-level service with new required argument order. - [Breaking] Changed
create_index()method for w.vector_search_indexes workspace-level service to returndatabricks.sdk.service.vectorsearch.VectorIndexdataclass. - [Breaking] Changed
delete_data_vector_index()method for w.vector_search_indexes workspace-level service . HTTP method/verb has changed. - [Breaking] Changed
delete_data_vector_index()method for w.vector_search_indexes workspace-level service with new required argument order. - [Breaking] Changed
databricks.sdk.service.vectorsearch.Listdataclass to. - [Breaking] Changed
workload_sizefield fordatabricks.sdk.service.serving.ServedModelInputto typestrdataclass. - [Breaking] Changed
group_idfield fordatabricks.sdk.service.settings.NccAzurePrivateEndpointRuleto typestrdataclass. - [Breaking] Changed
target_servicesfield fordatabricks.sdk.service.settings.NccAzureServiceEndpointRuleto typedatabricks.sdk.service.settings.EgressResourceTypeListdataclass. - [Breaking] Changed
data_arrayfield fordatabricks.sdk.service.vectorsearch.ResultDatato typedatabricks.sdk.service.vectorsearch.ListValueListdataclass. - [Breaking] Changed waiter for VectorSearchEndpointsAPI.create_endpoint method.
- [Breaking] Removed
nameandregionfields fordatabricks.sdk.service.settings.CreateNetworkConnectivityConfigRequest. - [Breaking] Removed
group_idandresource_idfields fordatabricks.sdk.service.settings.CreatePrivateEndpointRuleRequest. - [Breaking] Removed
null_valuefield fordatabricks.sdk.service.vectorsearch.Value. - [Breaking] Removed
large,mediumandsmallenum values fordatabricks.sdk.service.serving.ServedModelInputWorkloadSize. - [Breaking] Removed
blob,dfs,mysql_serverandsql_serverenum values fordatabricks.sdk.service.settings.NccAzurePrivateEndpointRuleGroupId.
v0.50.0
Release v0.50.0
API Changes
- Added w.enable_export_notebook workspace-level service, w.enable_notebook_table_clipboard workspace-level service and w.enable_results_downloading workspace-level service.
- Added
get_credentials_for_trace_data_download()andget_credentials_for_trace_data_upload()methods for w.experiments workspace-level service. - Added
get_download_full_query_result()method for w.genie workspace-level service. - Added
get_published_dashboard_token_info()method for w.lakeview_embedded workspace-level service. - Added
binding_workspace_idsfield fordatabricks.sdk.service.billing.BudgetPolicy. - Added
download_idfield fordatabricks.sdk.service.dashboards.GenieGenerateDownloadFullQueryResultResponse. - Added
dashboard_outputfield fordatabricks.sdk.service.jobs.RunOutput. - Added
dashboard_taskandpower_bi_taskfields fordatabricks.sdk.service.jobs.RunTask. - Added
dashboard_taskandpower_bi_taskfields fordatabricks.sdk.service.jobs.SubmitTask. - Added
dashboard_taskandpower_bi_taskfields fordatabricks.sdk.service.jobs.Task. - Added
include_featuresfield fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - Added
modelsfield fordatabricks.sdk.service.ml.LogInputs. - Added
dataset_digest,dataset_nameandmodel_idfields fordatabricks.sdk.service.ml.LogMetric. - Added
dataset_digest,dataset_name,model_idandrun_idfields fordatabricks.sdk.service.ml.Metric. - Added
model_inputsfield fordatabricks.sdk.service.ml.RunInputs. - Added
client_applicationfield fordatabricks.sdk.service.sql.QueryInfo. - Added
geographyandgeometryenum values fordatabricks.sdk.service.catalog.ColumnTypeName. - Added
allocation_timeout_no_healthy_and_warmed_up_clusters,docker_container_creation_exception,docker_image_too_large_for_instance_exceptionanddocker_invalid_os_exceptionenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - Added
standardenum value fordatabricks.sdk.service.jobs.PerformanceTarget. - Added
can_viewenum value fordatabricks.sdk.service.sql.WarehousePermissionLevel. - [Breaking] Changed
generate_download_full_query_result()method for w.genie workspace-level service . Method path has changed. - [Breaking] Changed waiter for CommandExecutionAPI.create method.
- [Breaking] Changed waiter for CommandExecutionAPI.execute method.
- [Breaking] Removed
error,statusandtransient_statement_idfields fordatabricks.sdk.service.dashboards.GenieGenerateDownloadFullQueryResultResponse. - [Breaking] Removed
balancedandcost_optimizedenum values fordatabricks.sdk.service.jobs.PerformanceTarget. - [Breaking] Removed PipelinesAPI.wait_get_pipeline_running method.
v0.49.0
API Changes
- Added
generate_download_full_query_result()method for w.genie workspace-level service. - Added
effective_user_api_scopes,oauth2_app_client_id,oauth2_app_integration_idanduser_api_scopesfields fordatabricks.sdk.service.apps.App. - Added
abfss,dbfs,error_message,execution_duration_seconds,file,gcs,s3,status,volumesandworkspacefields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails. - [Breaking] Added
forecast_granularityfield fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - Added
jwks_urifield fordatabricks.sdk.service.oauth2.OidcFederationPolicy. - Added
event_logfield fordatabricks.sdk.service.pipelines.CreatePipeline. - Added
event_logfield fordatabricks.sdk.service.pipelines.EditPipeline. - Added
event_logfield fordatabricks.sdk.service.pipelines.PipelineSpec. - Added
fallback_configfield fordatabricks.sdk.service.serving.AiGatewayConfig. - Added
custom_provider_configfield fordatabricks.sdk.service.serving.ExternalModel. - Added
fallback_configfield fordatabricks.sdk.service.serving.PutAiGatewayRequest. - Added
fallback_configfield fordatabricks.sdk.service.serving.PutAiGatewayResponse. - Added
aliases,comment,data_type,dependency_list,full_data_type,id,input_params,name,properties,routine_definition,schema,securable_kind,share,share_id,storage_locationandtagsfields fordatabricks.sdk.service.sharing.DeltaSharingFunction. - Added
query_sourcefield fordatabricks.sdk.service.sql.QueryInfo. - Added
foreign_catalogenum value fordatabricks.sdk.service.catalog.CatalogType. - Added
browseenum value fordatabricks.sdk.service.catalog.Privilege. - Added
access_token_failure,allocation_timeout,allocation_timeout_node_daemon_not_ready,allocation_timeout_no_healthy_clusters,allocation_timeout_no_matched_clusters,allocation_timeout_no_ready_clusters,allocation_timeout_no_unallocated_clusters,allocation_timeout_no_warmed_up_clusters,aws_inaccessible_kms_key_failure,aws_instance_profile_update_failure,aws_invalid_key_pair,aws_invalid_kms_key_state,aws_resource_quota_exceeded,azure_packed_deployment_partial_failure,bootstrap_timeout_due_to_misconfig,budget_policy_limit_enforcement_activated,budget_policy_resolution_failure,cloud_account_setup_failure,cloud_operation_cancelled,cloud_provider_instance_not_launched,cloud_provider_launch_failure_due_to_misconfig,cloud_provider_resource_stockout_due_to_misconfig,cluster_operation_throttled,cluster_operation_timeout,control_plane_request_failure_due_to_misconfig,data_access_config_changed,disaster_recovery_replication,driver_eviction,driver_launch_timeout,driver_node_unreachable,driver_out_of_disk,driver_out_of_memory,driver_pod_creation_failure,driver_unexpected_failure,dynamic_spark_conf_size_exceeded,eos_spark_image,executor_pod_unscheduled,gcp_api_rate_quota_exceeded,gcp_forbidden,gcp_iam_timeout,gcp_inaccessible_kms_key_failure,gcp_insufficient_capacity,gcp_ip_space_exhausted,gcp_kms_key_permission_denied,gcp_not_found,gcp_resource_quota_exceeded,gcp_service_account_access_denied,gcp_service_account_not_found,gcp_subnet_not_ready,gcp_trusted_image_projects_violated,gke_based_cluster_termination,init_container_not_finished,instance_pool_max_capacity_reached,instance_pool_not_found,instance_unreachable_due_to_misconfig,internal_capacity_failure,invalid_aws_parameter,invalid_instance_placement_protocol,invalid_worker_image_failure,in_penalty_box,lazy_allocation_timeout,maintenance_mode,netvisor_setup_timeout,no_matched_k8s,no_matched_k8s_testing_tag,pod_assignment_failure,pod_scheduling_failure,resource_usage_blocked,secret_creation_failure,serverless_long_running_terminated,spark_image_download_throttled,spark_image_not_found,ssh_bootstrap_failure,storage_download_failure_due_to_misconfig,storage_download_failure_slow,storage_download_failure_throttled,unexpected_pod_recreation,user_initiated_vm_terminationandworkspace_updateenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - Added
generated_sql_query_too_long_exceptionandmissing_sql_query_exceptionenum values fordatabricks.sdk.service.dashboards.MessageErrorType. - Added
balancedenum value fordatabricks.sdk.service.jobs.PerformanceTarget. - Added
listing_resourceenum value fordatabricks.sdk.service.marketplace.FileParentType. - Added
appenum value fordatabricks.sdk.service.marketplace.MarketplaceFileType. - Added
customenum value fordatabricks.sdk.service.serving.ExternalModelProvider. - Added
arclight_multi_tenant_azure_exchange_tokenandarclight_multi_tenant_azure_exchange_token_with_user_delegation_keyenum values fordatabricks.sdk.service.settings.TokenType. - [Breaking] Changed
create_experiment()method for w.forecasting workspace-level service with new required argument order. - Changed
instance_type_idfield fordatabricks.sdk.service.compute.NodeInstanceTypeto be required. - Changed
categoryfield fordatabricks.sdk.service.compute.NodeTypeto be required. - [Breaking] Changed
functionsfield fordatabricks.sdk.service.sharing.ListProviderShareAssetsResponseto typedatabricks.sdk.service.sharing.DeltaSharingFunctionListdataclass. - [Breaking] Removed
execution_detailsandscriptfields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails. - [Breaking] Removed
supports_elastic_diskfield fordatabricks.sdk.service.compute.NodeType. - [Breaking] Removed
data_granularity_quantityanddata_granularity_unitfields fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - [Breaking] Removed
aliases,comment,data_type,dependency_list,full_data_type,id,input_params,name,properties,routine_definition,schema,securable_kind,share,share_id,storage_locationandtagsfields fordatabricks.sdk.service.sharing.Function.
v0.48.0
API Changes
- Added
execution_detailsandscriptfields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails. - Added
supports_elastic_diskfield fordatabricks.sdk.service.compute.NodeType. - Added
data_granularity_quantityfield fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - [Breaking] Added
data_granularity_unitfield fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - Added
aliases,comment,data_type,dependency_list,full_data_type,id,input_params,name,properties,routine_definition,schema,securable_kind,share,share_id,storage_locationandtagsfields fordatabricks.sdk.service.sharing.Function. - [Breaking] Changed
create_experiment()method for w.forecasting workspace-level service with new required argument order. - [Breaking] Changed
instance_type_idfield fordatabricks.sdk.service.compute.NodeInstanceTypeto no longer be required. - [Breaking] Changed
categoryfield fordatabricks.sdk.service.compute.NodeTypeto no longer be required. - [Breaking] Changed
functionsfield fordatabricks.sdk.service.sharing.ListProviderShareAssetsResponseto typedatabricks.sdk.service.sharing.FunctionListdataclass. - [Breaking] Removed
abfss,dbfs,error_message,execution_duration_seconds,file,gcs,s3,status,volumesandworkspacefields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails. - [Breaking] Removed
forecast_granularityfield fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - [Breaking] Removed
jwks_urifield fordatabricks.sdk.service.oauth2.OidcFederationPolicy. - [Breaking] Removed
fallback_configfield fordatabricks.sdk.service.serving.AiGatewayConfig. - [Breaking] Removed
custom_provider_configfield fordatabricks.sdk.service.serving.ExternalModel. - [Breaking] Removed
fallback_configfield fordatabricks.sdk.service.serving.PutAiGatewayRequest. - [Breaking] Removed
fallback_configfield fordatabricks.sdk.service.serving.PutAiGatewayResponse. - [Breaking] Removed
aliases,comment,data_type,dependency_list,full_data_type,id,input_params,name,properties,routine_definition,schema,securable_kind,share,share_id,storage_locationandtagsfields fordatabricks.sdk.service.sharing.DeltaSharingFunction. - [Breaking] Removed
access_token_failure,allocation_timeout,allocation_timeout_node_daemon_not_ready,allocation_timeout_no_healthy_clusters,allocation_timeout_no_matched_clusters,allocation_timeout_no_ready_clusters,allocation_timeout_no_unallocated_clusters,allocation_timeout_no_warmed_up_clusters,aws_inaccessible_kms_key_failure,aws_instance_profile_update_failure,aws_invalid_key_pair,aws_invalid_kms_key_state,aws_resource_quota_exceeded,azure_packed_deployment_partial_failure,bootstrap_timeout_due_to_misconfig,budget_policy_limit_enforcement_activated,budget_policy_resolution_failure,cloud_account_setup_failure,cloud_operation_cancelled,cloud_provider_instance_not_launched,cloud_provider_launch_failure_due_to_misconfig,cloud_provider_resource_stockout_due_to_misconfig,cluster_operation_throttled,cluster_operation_timeout,control_plane_request_failure_due_to_misconfig,data_access_config_changed,disaster_recovery_replication,driver_eviction,driver_launch_timeout,driver_node_unreachable,driver_out_of_disk,driver_out_of_memory,driver_pod_creation_failure,driver_unexpected_failure,dynamic_spark_conf_size_exceeded,eos_spark_image,executor_pod_unscheduled,gcp_api_rate_quota_exceeded,gcp_forbidden,gcp_iam_timeout,gcp_inaccessible_kms_key_failure,gcp_insufficient_capacity,gcp_ip_space_exhausted,gcp_kms_key_permission_denied,gcp_not_found,gcp_resource_quota_exceeded,gcp_service_account_access_denied,gcp_service_account_not_found,gcp_subnet_not_ready,gcp_trusted_image_projects_violated,gke_based_cluster_termination,init_container_not_finished,instance_pool_max_capacity_reached,instance_pool_not_found,instance_unreachable_due_to_misconfig,internal_capacity_failure,invalid_aws_parameter,invalid_instance_placement_protocol,invalid_worker_image_failure,in_penalty_box,lazy_allocation_timeout,maintenance_mode,netvisor_setup_timeout,no_matched_k8s,no_matched_k8s_testing_tag,pod_assignment_failure,pod_scheduling_failure,resource_usage_blocked,secret_creation_failure,serverless_long_running_terminated,spark_image_download_throttled,spark_image_not_found,ssh_bootstrap_failure,storage_download_failure_due_to_misconfig,storage_download_failure_slow,storage_download_failure_throttled,unexpected_pod_recreation,user_initiated_vm_terminationandworkspace_updateenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - [Breaking] Removed
generated_sql_query_too_long_exceptionandmissing_sql_query_exceptionenum values fordatabricks.sdk.service.dashboards.MessageErrorType. - [Breaking] Removed
balancedenum value fordatabricks.sdk.service.jobs.PerformanceTarget. - [Breaking] Removed
listing_resourceenum value fordatabricks.sdk.service.marketplace.FileParentType. - [Breaking] Removed
appenum value fordatabricks.sdk.service.marketplace.MarketplaceFileType. - [Breaking] Removed
customenum value fordatabricks.sdk.service.serving.ExternalModelProvider.
v0.47.0
Release v0.47.0
Bug Fixes
- Ensure that refresh tokens are returned when using the
external-browsercredentials strategy.
API Changes
- Added
abfss,dbfs,error_message,execution_duration_seconds,file,gcs,s3,status,volumesandworkspacefields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails. - [Breaking] Added
forecast_granularityfield fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - Added
jwks_urifield fordatabricks.sdk.service.oauth2.OidcFederationPolicy. - Added
fallback_configfield fordatabricks.sdk.service.serving.AiGatewayConfig. - Added
custom_provider_configfield fordatabricks.sdk.service.serving.ExternalModel. - Added
fallback_configfield fordatabricks.sdk.service.serving.PutAiGatewayRequest. - Added
fallback_configfield fordatabricks.sdk.service.serving.PutAiGatewayResponse. - Added
aliases,comment,data_type,dependency_list,full_data_type,id,input_params,name,properties,routine_definition,schema,securable_kind,share,share_id,storage_locationandtagsfields fordatabricks.sdk.service.sharing.DeltaSharingFunction. - Added
access_token_failure,allocation_timeout,allocation_timeout_node_daemon_not_ready,allocation_timeout_no_healthy_clusters,allocation_timeout_no_matched_clusters,allocation_timeout_no_ready_clusters,allocation_timeout_no_unallocated_clusters,allocation_timeout_no_warmed_up_clusters,aws_inaccessible_kms_key_failure,aws_instance_profile_update_failure,aws_invalid_key_pair,aws_invalid_kms_key_state,aws_resource_quota_exceeded,azure_packed_deployment_partial_failure,bootstrap_timeout_due_to_misconfig,budget_policy_limit_enforcement_activated,budget_policy_resolution_failure,cloud_account_setup_failure,cloud_operation_cancelled,cloud_provider_instance_not_launched,cloud_provider_launch_failure_due_to_misconfig,cloud_provider_resource_stockout_due_to_misconfig,cluster_operation_throttled,cluster_operation_timeout,control_plane_request_failure_due_to_misconfig,data_access_config_changed,disaster_recovery_replication,driver_eviction,driver_launch_timeout,driver_node_unreachable,driver_out_of_disk,driver_out_of_memory,driver_pod_creation_failure,driver_unexpected_failure,dynamic_spark_conf_size_exceeded,eos_spark_image,executor_pod_unscheduled,gcp_api_rate_quota_exceeded,gcp_forbidden,gcp_iam_timeout,gcp_inaccessible_kms_key_failure,gcp_insufficient_capacity,gcp_ip_space_exhausted,gcp_kms_key_permission_denied,gcp_not_found,gcp_resource_quota_exceeded,gcp_service_account_access_denied,gcp_service_account_not_found,gcp_subnet_not_ready,gcp_trusted_image_projects_violated,gke_based_cluster_termination,init_container_not_finished,instance_pool_max_capacity_reached,instance_pool_not_found,instance_unreachable_due_to_misconfig,internal_capacity_failure,invalid_aws_parameter,invalid_instance_placement_protocol,invalid_worker_image_failure,in_penalty_box,lazy_allocation_timeout,maintenance_mode,netvisor_setup_timeout,no_matched_k8s,no_matched_k8s_testing_tag,pod_assignment_failure,pod_scheduling_failure,resource_usage_blocked,secret_creation_failure,serverless_long_running_terminated,spark_image_download_throttled,spark_image_not_found,ssh_bootstrap_failure,storage_download_failure_due_to_misconfig,storage_download_failure_slow,storage_download_failure_throttled,unexpected_pod_recreation,user_initiated_vm_terminationandworkspace_updateenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - Added
generated_sql_query_too_long_exceptionandmissing_sql_query_exceptionenum values fordatabricks.sdk.service.dashboards.MessageErrorType. - Added
balancedenum value fordatabricks.sdk.service.jobs.PerformanceTarget. - Added
listing_resourceenum value fordatabricks.sdk.service.marketplace.FileParentType. - Added
appenum value fordatabricks.sdk.service.marketplace.MarketplaceFileType. - Added
customenum value fordatabricks.sdk.service.serving.ExternalModelProvider. - [Breaking] Changed
create_experiment()method for w.forecasting workspace-level service with new required argument order. - Changed
instance_type_idfield fordatabricks.sdk.service.compute.NodeInstanceTypeto be required. - Changed
categoryfield fordatabricks.sdk.service.compute.NodeTypeto be required. - [Breaking] Changed
functionsfield fordatabricks.sdk.service.sharing.ListProviderShareAssetsResponseto typedatabricks.sdk.service.sharing.DeltaSharingFunctionListdataclass. - [Breaking] Changed waiter for ClustersAPI.create method.
- [Breaking] Changed waiter for ClustersAPI.delete method.
- [Breaking] Changed waiter for ClustersAPI.edit method.
- [Breaking] Changed waiter for ClustersAPI.get method.
- [Breaking] Changed waiter for ClustersAPI.resize method.
- [Breaking] Changed waiter for ClustersAPI.restart method.
- [Breaking] Changed waiter for ClustersAPI.start method.
- [Breaking] Changed waiter for ClustersAPI.update method.
- [Breaking] Removed
execution_detailsandscriptfields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails. - [Breaking] Removed
supports_elastic_diskfield fordatabricks.sdk.service.compute.NodeType. - [Breaking] Removed
data_granularity_quantityanddata_granularity_unitfields fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - [Breaking] Removed
aliases,comment,data_type,dependency_list,full_data_type,id,input_params,name,properties,routine_definition,schema,securable_kind,share,share_id,storage_locationandtagsfields fordatabricks.sdk.service.sharing.Function.
v0.46.0
Release v0.46.0
New Features and Improvements
- [Experimental] Add support for async token refresh (#916).
This can be enabled with by setting the following setting:This feature and its setting are experimental and may be removed in future releases.export DATABRICKS_ENABLE_EXPERIMENTAL_ASYNC_TOKEN_REFRESH=1
API Changes
- Added w.forecasting workspace-level service.
- Added
statement_idfield fordatabricks.sdk.service.dashboards.GenieQueryAttachment. - Added
could_not_get_model_deployments_exceptionenum value fordatabricks.sdk.service.dashboards.MessageErrorType. - [Breaking] Removed
jwks_urifield fordatabricks.sdk.service.oauth2.OidcFederationPolicy.
v0.45.0
New Features and Improvements
- Update Jobs service to use API 2.2 (#913).
Internal Changes
- Refactor
DatabricksErrorto expose different types of error details (#912). - Update Jobs ListJobs API to support paginated responses (#896)
- Update Jobs ListRuns API to support paginated responses (#890)
- Introduce automated tagging (#888)
- Update Jobs GetJob API to support paginated responses (#869).
- Update On Behalf Of User Authentication in Multithreaded applications (#907)
API Changes
- Added
execute_message_attachment_query(),get_message_attachment_query_result()andget_space()methods for w.genie workspace-level service. - Added
list_provider_share_assets()method for w.providers workspace-level service. - Added
budget_policy_idandeffective_budget_policy_idfields fordatabricks.sdk.service.apps.App. - Added
policyfield fordatabricks.sdk.service.billing.CreateBudgetPolicyRequest. - Added
databricks_gcp_service_accountfield fordatabricks.sdk.service.catalog.ValidateCredentialRequest. - Added
attachment_idfield fordatabricks.sdk.service.dashboards.GenieAttachment. - Added
conversation_idfield fordatabricks.sdk.service.dashboards.GenieConversation. - Added
message_idfield fordatabricks.sdk.service.dashboards.GenieMessage. - Added
description,id,last_updated_timestamp,query,query_result_metadataandtitlefields fordatabricks.sdk.service.dashboards.GenieQueryAttachment. - Added
gen_ai_compute_taskfield fordatabricks.sdk.service.jobs.RunTask. - Added
gen_ai_compute_taskfield fordatabricks.sdk.service.jobs.SubmitTask. - Added
gen_ai_compute_taskfield fordatabricks.sdk.service.jobs.Task. - Added
run_namefield fordatabricks.sdk.service.ml.CreateRun. - Added
run_namefield fordatabricks.sdk.service.ml.RunInfo. - Added
run_namefield fordatabricks.sdk.service.ml.UpdateRun. - Added
lifetimefield fordatabricks.sdk.service.oauth2.CreateServicePrincipalSecretRequest. - Added
expire_timefield fordatabricks.sdk.service.oauth2.CreateServicePrincipalSecretResponse. - Added
jwks_urifield fordatabricks.sdk.service.oauth2.OidcFederationPolicy. - Added
expire_timefield fordatabricks.sdk.service.oauth2.SecretInfo. - Added
instance_profile_arnfield fordatabricks.sdk.service.serving.AmazonBedrockConfig. - Added
budget_policy_idfield fordatabricks.sdk.service.serving.CreateServingEndpoint. - Added
budget_policy_idfield fordatabricks.sdk.service.serving.ServingEndpoint. - Added
budget_policy_idfield fordatabricks.sdk.service.serving.ServingEndpointDetailed. - Added
add,principalandremovefields fordatabricks.sdk.service.sharing.PermissionsChange. - Added
columns_to_rerankfield fordatabricks.sdk.service.vectorsearch.QueryVectorIndexRequest. - Added
oracleandteradataenum values fordatabricks.sdk.service.catalog.ConnectionType. - Added
function_arguments_invalid_type_exceptionandmessage_cancelled_while_executing_exceptionenum values fordatabricks.sdk.service.dashboards.MessageErrorType. - Added
waitingenum value fordatabricks.sdk.service.jobs.RunLifecycleStateV2State. - Added
active_only,allanddeleted_onlyenum values fordatabricks.sdk.service.ml.ViewType. - Added
oauth_client_credentialsenum value fordatabricks.sdk.service.sharing.AuthenticationType. - Added
rawenum value fordatabricks.sdk.service.workspace.ExportFormat. - [Breaking] Changed
get_by_name()method for w.experiments workspace-level service to returndatabricks.sdk.service.ml.GetExperimentByNameResponsedataclass. - [Breaking] Changed
log_inputs()method for w.experiments workspace-level service with new required argument order. - [Breaking] Changed
share_permissions()method for w.shares workspace-level service to returndatabricks.sdk.service.sharing.GetSharePermissionsResponsedataclass. - [Breaking] Changed
share_permissions()andupdate_permissions()methods for w.shares workspace-level service return type to become non-empty. - [Breaking] Changed
update_permissions()method for w.shares workspace-level service to returndatabricks.sdk.service.sharing.UpdateSharePermissionsResponsedataclass. - [Breaking] Changed
policy_idfield fordatabricks.sdk.service.billing.BudgetPolicyto no longer be required. - Changed
policy_idfield fordatabricks.sdk.service.billing.BudgetPolicyto no longer be required. - [Breaking] Changed
partitionsfield fordatabricks.sdk.service.cleanrooms.CleanRoomAssetTableLocalDetailsto typedatabricks.sdk.service.cleanrooms.PartitionListdataclass. - [Breaking] Changed
queryfield fordatabricks.sdk.service.dashboards.GenieAttachmentto typedatabricks.sdk.service.dashboards.GenieQueryAttachmentdataclass. - [Breaking] Changed
digest,name,sourceandsource_typefields fordatabricks.sdk.service.ml.Datasetto be required. - Changed
digest,name,sourceandsource_typefields fordatabricks.sdk.service.ml.Datasetto be required. - [Breaking] Changed
datasetfield fordatabricks.sdk.service.ml.DatasetInputto be required. - Changed
datasetfield fordatabricks.sdk.service.ml.DatasetInputto be required. - Changed
keyandvaluefields fordatabricks.sdk.service.ml.InputTagto be required. - [Breaking] Changed
keyandvaluefields fordatabricks.sdk.service.ml.InputTagto be required. - [Breaking] Changed
view_typefield fordatabricks.sdk.service.ml.ListExperimentsRequestto typedatabricks.sdk.service.ml.ViewTypedataclass. - [Breaking] Changed
run_idfield fordatabricks.sdk.service.ml.LogInputsto be required. - [Breaking] Changed
view_typefield fordatabricks.sdk.service.ml.SearchExperimentsto typedatabricks.sdk.service.ml.ViewTypedataclass. - [Breaking] Changed
run_view_typefield fordatabricks.sdk.service.ml.SearchRunsto typedatabricks.sdk.service.ml.ViewTypedataclass. - [Breaking] Removed
custom_tagsandpolicy_namefields fordatabricks.sdk.service.billing.CreateBudgetPolicyRequest. - [Breaking] Removed
cached_query_schema,description,id,instruction_id,instruction_title,last_updated_timestamp,query,statement_idandtitlefields fordatabricks.sdk.service.dashboards.QueryAttachment. - [Breaking] Removed
max_resultsandpage_tokenfields fordatabricks.sdk.service.sharing.UpdateSharePermissions. - [Breaking] Removed
active_only,allanddeleted_onlyenum values fordatabricks.sdk.service.ml.SearchExperimentsViewType. - [Breaking] Removed
active_only,allanddeleted_onlyenum values fordatabricks.sdk.service.ml.SearchRunsRunViewType.