Releases: databricks/databricks-sdk-py
Releases · databricks/databricks-sdk-py
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_ids
field fordatabricks.sdk.service.billing.BudgetPolicy
. - Added
download_id
field fordatabricks.sdk.service.dashboards.GenieGenerateDownloadFullQueryResultResponse
. - Added
dashboard_output
field fordatabricks.sdk.service.jobs.RunOutput
. - Added
dashboard_task
andpower_bi_task
fields fordatabricks.sdk.service.jobs.RunTask
. - Added
dashboard_task
andpower_bi_task
fields fordatabricks.sdk.service.jobs.SubmitTask
. - Added
dashboard_task
andpower_bi_task
fields fordatabricks.sdk.service.jobs.Task
. - Added
include_features
field fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest
. - Added
models
field fordatabricks.sdk.service.ml.LogInputs
. - Added
dataset_digest
,dataset_name
andmodel_id
fields fordatabricks.sdk.service.ml.LogMetric
. - Added
dataset_digest
,dataset_name
,model_id
andrun_id
fields fordatabricks.sdk.service.ml.Metric
. - Added
model_inputs
field fordatabricks.sdk.service.ml.RunInputs
. - Added
client_application
field fordatabricks.sdk.service.sql.QueryInfo
. - Added
geography
andgeometry
enum 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_exception
anddocker_invalid_os_exception
enum values fordatabricks.sdk.service.compute.TerminationReasonCode
. - Added
standard
enum value fordatabricks.sdk.service.jobs.PerformanceTarget
. - Added
can_view
enum 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
,status
andtransient_statement_id
fields fordatabricks.sdk.service.dashboards.GenieGenerateDownloadFullQueryResultResponse
. - [Breaking] Removed
balanced
andcost_optimized
enum 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_id
anduser_api_scopes
fields fordatabricks.sdk.service.apps.App
. - Added
abfss
,dbfs
,error_message
,execution_duration_seconds
,file
,gcs
,s3
,status
,volumes
andworkspace
fields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails
. - [Breaking] Added
forecast_granularity
field fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest
. - Added
jwks_uri
field fordatabricks.sdk.service.oauth2.OidcFederationPolicy
. - Added
event_log
field fordatabricks.sdk.service.pipelines.CreatePipeline
. - Added
event_log
field fordatabricks.sdk.service.pipelines.EditPipeline
. - Added
event_log
field fordatabricks.sdk.service.pipelines.PipelineSpec
. - Added
fallback_config
field fordatabricks.sdk.service.serving.AiGatewayConfig
. - Added
custom_provider_config
field fordatabricks.sdk.service.serving.ExternalModel
. - Added
fallback_config
field fordatabricks.sdk.service.serving.PutAiGatewayRequest
. - Added
fallback_config
field 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_location
andtags
fields fordatabricks.sdk.service.sharing.DeltaSharingFunction
. - Added
query_source
field fordatabricks.sdk.service.sql.QueryInfo
. - Added
foreign_catalog
enum value fordatabricks.sdk.service.catalog.CatalogType
. - Added
browse
enum 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_termination
andworkspace_update
enum values fordatabricks.sdk.service.compute.TerminationReasonCode
. - Added
generated_sql_query_too_long_exception
andmissing_sql_query_exception
enum values fordatabricks.sdk.service.dashboards.MessageErrorType
. - Added
balanced
enum value fordatabricks.sdk.service.jobs.PerformanceTarget
. - Added
listing_resource
enum value fordatabricks.sdk.service.marketplace.FileParentType
. - Added
app
enum value fordatabricks.sdk.service.marketplace.MarketplaceFileType
. - Added
custom
enum value fordatabricks.sdk.service.serving.ExternalModelProvider
. - Added
arclight_multi_tenant_azure_exchange_token
andarclight_multi_tenant_azure_exchange_token_with_user_delegation_key
enum 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_id
field fordatabricks.sdk.service.compute.NodeInstanceType
to be required. - Changed
category
field fordatabricks.sdk.service.compute.NodeType
to be required. - [Breaking] Changed
functions
field fordatabricks.sdk.service.sharing.ListProviderShareAssetsResponse
to typedatabricks.sdk.service.sharing.DeltaSharingFunctionList
dataclass. - [Breaking] Removed
execution_details
andscript
fields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails
. - [Breaking] Removed
supports_elastic_disk
field fordatabricks.sdk.service.compute.NodeType
. - [Breaking] Removed
data_granularity_quantity
anddata_granularity_unit
fields 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_location
andtags
fields fordatabricks.sdk.service.sharing.Function
.
v0.48.0
API Changes
- Added
execution_details
andscript
fields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails
. - Added
supports_elastic_disk
field fordatabricks.sdk.service.compute.NodeType
. - Added
data_granularity_quantity
field fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest
. - [Breaking] Added
data_granularity_unit
field 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_location
andtags
fields 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_id
field fordatabricks.sdk.service.compute.NodeInstanceType
to no longer be required. - [Breaking] Changed
category
field fordatabricks.sdk.service.compute.NodeType
to no longer be required. - [Breaking] Changed
functions
field fordatabricks.sdk.service.sharing.ListProviderShareAssetsResponse
to typedatabricks.sdk.service.sharing.FunctionList
dataclass. - [Breaking] Removed
abfss
,dbfs
,error_message
,execution_duration_seconds
,file
,gcs
,s3
,status
,volumes
andworkspace
fields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails
. - [Breaking] Removed
forecast_granularity
field fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest
. - [Breaking] Removed
jwks_uri
field fordatabricks.sdk.service.oauth2.OidcFederationPolicy
. - [Breaking] Removed
fallback_config
field fordatabricks.sdk.service.serving.AiGatewayConfig
. - [Breaking] Removed
custom_provider_config
field fordatabricks.sdk.service.serving.ExternalModel
. - [Breaking] Removed
fallback_config
field fordatabricks.sdk.service.serving.PutAiGatewayRequest
. - [Breaking] Removed
fallback_config
field 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_location
andtags
fields 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_termination
andworkspace_update
enum values fordatabricks.sdk.service.compute.TerminationReasonCode
. - [Breaking] Removed
generated_sql_query_too_long_exception
andmissing_sql_query_exception
enum values fordatabricks.sdk.service.dashboards.MessageErrorType
. - [Breaking] Removed
balanced
enum value fordatabricks.sdk.service.jobs.PerformanceTarget
. - [Breaking] Removed
listing_resource
enum value fordatabricks.sdk.service.marketplace.FileParentType
. - [Breaking] Removed
app
enum value fordatabricks.sdk.service.marketplace.MarketplaceFileType
. - [Breaking] Removed
custom
enum 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-browser
credentials strategy.
API Changes
- Added
abfss
,dbfs
,error_message
,execution_duration_seconds
,file
,gcs
,s3
,status
,volumes
andworkspace
fields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails
. - [Breaking] Added
forecast_granularity
field fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest
. - Added
jwks_uri
field fordatabricks.sdk.service.oauth2.OidcFederationPolicy
. - Added
fallback_config
field fordatabricks.sdk.service.serving.AiGatewayConfig
. - Added
custom_provider_config
field fordatabricks.sdk.service.serving.ExternalModel
. - Added
fallback_config
field fordatabricks.sdk.service.serving.PutAiGatewayRequest
. - Added
fallback_config
field 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_location
andtags
fields 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_termination
andworkspace_update
enum values fordatabricks.sdk.service.compute.TerminationReasonCode
. - Added
generated_sql_query_too_long_exception
andmissing_sql_query_exception
enum values fordatabricks.sdk.service.dashboards.MessageErrorType
. - Added
balanced
enum value fordatabricks.sdk.service.jobs.PerformanceTarget
. - Added
listing_resource
enum value fordatabricks.sdk.service.marketplace.FileParentType
. - Added
app
enum value fordatabricks.sdk.service.marketplace.MarketplaceFileType
. - Added
custom
enum 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_id
field fordatabricks.sdk.service.compute.NodeInstanceType
to be required. - Changed
category
field fordatabricks.sdk.service.compute.NodeType
to be required. - [Breaking] Changed
functions
field fordatabricks.sdk.service.sharing.ListProviderShareAssetsResponse
to typedatabricks.sdk.service.sharing.DeltaSharingFunctionList
dataclass. - [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_details
andscript
fields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails
. - [Breaking] Removed
supports_elastic_disk
field fordatabricks.sdk.service.compute.NodeType
. - [Breaking] Removed
data_granularity_quantity
anddata_granularity_unit
fields 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_location
andtags
fields 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_id
field fordatabricks.sdk.service.dashboards.GenieQueryAttachment
. - Added
could_not_get_model_deployments_exception
enum value fordatabricks.sdk.service.dashboards.MessageErrorType
. - [Breaking] Removed
jwks_uri
field fordatabricks.sdk.service.oauth2.OidcFederationPolicy
.
v0.45.0
New Features and Improvements
- Update Jobs service to use API 2.2 (#913).
Internal Changes
- Refactor
DatabricksError
to 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_id
andeffective_budget_policy_id
fields fordatabricks.sdk.service.apps.App
. - Added
policy
field fordatabricks.sdk.service.billing.CreateBudgetPolicyRequest
. - Added
databricks_gcp_service_account
field fordatabricks.sdk.service.catalog.ValidateCredentialRequest
. - Added
attachment_id
field fordatabricks.sdk.service.dashboards.GenieAttachment
. - Added
conversation_id
field fordatabricks.sdk.service.dashboards.GenieConversation
. - Added
message_id
field fordatabricks.sdk.service.dashboards.GenieMessage
. - Added
description
,id
,last_updated_timestamp
,query
,query_result_metadata
andtitle
fields fordatabricks.sdk.service.dashboards.GenieQueryAttachment
. - Added
gen_ai_compute_task
field fordatabricks.sdk.service.jobs.RunTask
. - Added
gen_ai_compute_task
field fordatabricks.sdk.service.jobs.SubmitTask
. - Added
gen_ai_compute_task
field fordatabricks.sdk.service.jobs.Task
. - Added
run_name
field fordatabricks.sdk.service.ml.CreateRun
. - Added
run_name
field fordatabricks.sdk.service.ml.RunInfo
. - Added
run_name
field fordatabricks.sdk.service.ml.UpdateRun
. - Added
lifetime
field fordatabricks.sdk.service.oauth2.CreateServicePrincipalSecretRequest
. - Added
expire_time
field fordatabricks.sdk.service.oauth2.CreateServicePrincipalSecretResponse
. - Added
jwks_uri
field fordatabricks.sdk.service.oauth2.OidcFederationPolicy
. - Added
expire_time
field fordatabricks.sdk.service.oauth2.SecretInfo
. - Added
instance_profile_arn
field fordatabricks.sdk.service.serving.AmazonBedrockConfig
. - Added
budget_policy_id
field fordatabricks.sdk.service.serving.CreateServingEndpoint
. - Added
budget_policy_id
field fordatabricks.sdk.service.serving.ServingEndpoint
. - Added
budget_policy_id
field fordatabricks.sdk.service.serving.ServingEndpointDetailed
. - Added
add
,principal
andremove
fields fordatabricks.sdk.service.sharing.PermissionsChange
. - Added
columns_to_rerank
field fordatabricks.sdk.service.vectorsearch.QueryVectorIndexRequest
. - Added
oracle
andteradata
enum values fordatabricks.sdk.service.catalog.ConnectionType
. - Added
function_arguments_invalid_type_exception
andmessage_cancelled_while_executing_exception
enum values fordatabricks.sdk.service.dashboards.MessageErrorType
. - Added
waiting
enum value fordatabricks.sdk.service.jobs.RunLifecycleStateV2State
. - Added
active_only
,all
anddeleted_only
enum values fordatabricks.sdk.service.ml.ViewType
. - Added
oauth_client_credentials
enum value fordatabricks.sdk.service.sharing.AuthenticationType
. - Added
raw
enum value fordatabricks.sdk.service.workspace.ExportFormat
. - [Breaking] Changed
get_by_name()
method for w.experiments workspace-level service to returndatabricks.sdk.service.ml.GetExperimentByNameResponse
dataclass. - [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.GetSharePermissionsResponse
dataclass. - [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.UpdateSharePermissionsResponse
dataclass. - [Breaking] Changed
policy_id
field fordatabricks.sdk.service.billing.BudgetPolicy
to no longer be required. - Changed
policy_id
field fordatabricks.sdk.service.billing.BudgetPolicy
to no longer be required. - [Breaking] Changed
partitions
field fordatabricks.sdk.service.cleanrooms.CleanRoomAssetTableLocalDetails
to typedatabricks.sdk.service.cleanrooms.PartitionList
dataclass. - [Breaking] Changed
query
field fordatabricks.sdk.service.dashboards.GenieAttachment
to typedatabricks.sdk.service.dashboards.GenieQueryAttachment
dataclass. - [Breaking] Changed
digest
,name
,source
andsource_type
fields fordatabricks.sdk.service.ml.Dataset
to be required. - Changed
digest
,name
,source
andsource_type
fields fordatabricks.sdk.service.ml.Dataset
to be required. - [Breaking] Changed
dataset
field fordatabricks.sdk.service.ml.DatasetInput
to be required. - Changed
dataset
field fordatabricks.sdk.service.ml.DatasetInput
to be required. - Changed
key
andvalue
fields fordatabricks.sdk.service.ml.InputTag
to be required. - [Breaking] Changed
key
andvalue
fields fordatabricks.sdk.service.ml.InputTag
to be required. - [Breaking] Changed
view_type
field fordatabricks.sdk.service.ml.ListExperimentsRequest
to typedatabricks.sdk.service.ml.ViewType
dataclass. - [Breaking] Changed
run_id
field fordatabricks.sdk.service.ml.LogInputs
to be required. - [Breaking] Changed
view_type
field fordatabricks.sdk.service.ml.SearchExperiments
to typedatabricks.sdk.service.ml.ViewType
dataclass. - [Breaking] Changed
run_view_type
field fordatabricks.sdk.service.ml.SearchRuns
to typedatabricks.sdk.service.ml.ViewType
dataclass. - [Breaking] Removed
custom_tags
andpolicy_name
fields fordatabricks.sdk.service.billing.CreateBudgetPolicyRequest
. - [Breaking] Removed
cached_query_schema
,description
,id
,instruction_id
,instruction_title
,last_updated_timestamp
,query
,statement_id
andtitle
fields fordatabricks.sdk.service.dashboards.QueryAttachment
. - [Breaking] Removed
max_results
andpage_token
fields fordatabricks.sdk.service.sharing.UpdateSharePermissions
. - [Breaking] Removed
active_only
,all
anddeleted_only
enum values fordatabricks.sdk.service.ml.SearchExperimentsViewType
. - [Breaking] Removed
active_only
,all
anddeleted_only
enum values fordatabricks.sdk.service.ml.SearchRunsRunViewType
.
v0.44.1
v0.44.0
[Release] Release v0.44.0
Internal Changes
- Fix
tests/integration/test_dbutils.py::test_secrets
(#884).
API Changes:
- Added
get_message_query_result_by_attachment()
method for w.genie workspace-level service. - Added
id
field fordatabricks.sdk.service.apps.App
. - Added
limit_config
field fordatabricks.sdk.service.billing.UpdateBudgetPolicyRequest
. - Added
volumes
field fordatabricks.sdk.service.compute.ClusterLogConf
. - Removed
review_state
,reviews
andrunner_collaborators
fields fordatabricks.sdk.service.cleanrooms.CleanRoomAssetNotebook
.
OpenAPI SHA: 99f644e72261ef5ecf8d74db20f4b7a1e09723cc, Date: 2025-02-11
v0.42.0
Bug Fixes
- Fix docs generation when two services have the same name (#872).
Internal Changes
- Add CICD environment to the User Agent (#866).
- Add unit tests for retriable requests (#879).
- Extract "before retry" handler, use it to rewind the stream (#878).
- Update Model Serving
http_request
mixin to correctly use the underlying API. (#876).
Backward Incompatible Changes
- Changed
create()
method for w.serving_endpoints workspace-level service with new required argument order. - Changed
http_request()
method for w.serving_endpoints workspace-level service to typehttp_request()
method for w.serving_endpoints workspace-level service. - Changed
http_request()
method for w.serving_endpoints workspace-level service to returndatabricks.sdk.service.serving.HttpRequestResponse
dataclass. - Changed
config
field fordatabricks.sdk.service.serving.CreateServingEndpoint
to no longer be required. - Removed
securable_kind
field fordatabricks.sdk.service.catalog.CatalogInfo
. - Removed
securable_kind
field fordatabricks.sdk.service.catalog.ConnectionInfo
. - Removed
status_code
andtext
fields fordatabricks.sdk.service.serving.ExternalFunctionResponse
.
API Changes:
- Added a.budget_policy account-level service.
- Added a.enable_ip_access_lists account-level service.
- Added
review_state
,reviews
andrunner_collaborators
fields fordatabricks.sdk.service.cleanrooms.CleanRoomAssetNotebook
. - Added
statement_id
field fordatabricks.sdk.service.dashboards.QueryAttachment
. - Added
effective_performance_target
field fordatabricks.sdk.service.jobs.BaseRun
. - Added
performance_target
field fordatabricks.sdk.service.jobs.CreateJob
. - Added
performance_target
field fordatabricks.sdk.service.jobs.JobSettings
. - Added
effective_performance_target
field fordatabricks.sdk.service.jobs.Run
. - Added
performance_target
field fordatabricks.sdk.service.jobs.RunNow
. - Added
effective_performance_target
field fordatabricks.sdk.service.jobs.RunTask
. - Added
run_as_repl
field fordatabricks.sdk.service.jobs.SparkJarTask
. - Added
user_authorized_scopes
field fordatabricks.sdk.service.oauth2.CreateCustomAppIntegration
. - Added
user_authorized_scopes
field fordatabricks.sdk.service.oauth2.GetCustomAppIntegrationOutput
. - Added
user_authorized_scopes
field fordatabricks.sdk.service.oauth2.UpdateCustomAppIntegration
. - Added
contents
field fordatabricks.sdk.service.serving.HttpRequestResponse
. - Added
clean_room
enum value fordatabricks.sdk.service.catalog.SecurableType
. - Added
budget_policy_limit_exceeded
enum value fordatabricks.sdk.service.jobs.TerminationCodeCode
. - Added
arclight_azure_exchange_token_with_user_delegation_key
enum value fordatabricks.sdk.service.settings.TokenType
.
OpenAPI SHA: 840c660106f820a1a5dff931d51fa5f65cd9fdd9, Date: 2025-01-28
v0.41.0
New Features and Improvements
- Add
serving.http_request
to call external functions. (#857). - Files API client: recover on download failures (#844) (#845).
Bug Fixes
- Properly pass query parameters in apps and oauth2 (#862).
Internal Changes
- Add unit tests for external-browser authentication (#863).
- Decouple oauth2 and serving (#855).
- Migrate workflows that need write access to use hosted runners (#850).
- Stop testing Python 3.7 on Ubuntu (#858).
API Changes:
- Added w.access_control workspace-level service.
- Added
http_request()
method for w.serving_endpoints workspace-level service. - Added
no_compute
field fordatabricks.sdk.service.apps.CreateAppRequest
. - Added
has_more
field fordatabricks.sdk.service.jobs.BaseJob
. - Added
has_more
field fordatabricks.sdk.service.jobs.BaseRun
. - Added
page_token
field fordatabricks.sdk.service.jobs.GetJobRequest
. - Added
has_more
andnext_page_token
fields fordatabricks.sdk.service.jobs.Job
. - Added
has_more
field fordatabricks.sdk.service.jobs.Run
. - Added
clean_rooms_notebook_output
field fordatabricks.sdk.service.jobs.RunOutput
. - Added
scopes
field fordatabricks.sdk.service.oauth2.UpdateCustomAppIntegration
. - Added
run_as
field fordatabricks.sdk.service.pipelines.CreatePipeline
. - Added
run_as
field fordatabricks.sdk.service.pipelines.EditPipeline
. - Added
authorization_details
andendpoint_url
fields fordatabricks.sdk.service.serving.DataPlaneInfo
. - Added
contents
field fordatabricks.sdk.service.serving.GetOpenApiResponse
. - Added
activated
,activation_url
,authentication_type
,cloud
,comment
,created_at
,created_by
,data_recipient_global_metastore_id
,ip_access_list
,metastore_id
,name
,owner
,properties_kvpairs
,region
,sharing_code
,tokens
,updated_at
andupdated_by
fields fordatabricks.sdk.service.sharing.RecipientInfo
. - Added
expiration_time
field fordatabricks.sdk.service.sharing.RecipientInfo
. - Changed
update()
method for a.account_federation_policy account-level service with new required argument order. - Changed
update()
method for a.service_principal_federation_policy account-level service with new required argument order. - Changed
update()
method for w.recipients workspace-level service to returndatabricks.sdk.service.sharing.RecipientInfo
dataclass. - Changed
update()
method for w.recipients workspace-level service return type to become non-empty. - Changed
update()
method for w.recipients workspace-level service to typeupdate()
method for w.recipients workspace-level service. - Changed
get_open_api()
method for w.serving_endpoints workspace-level service return type to become non-empty. - Changed
patch()
method for w.serving_endpoints workspace-level service to typepatch()
method for w.serving_endpoints workspace-level service. - Changed
patch()
method for w.serving_endpoints workspace-level service to returndatabricks.sdk.service.serving.EndpointTags
dataclass. - Changed
databricks.sdk.service.serving.EndpointTagList
dataclass to. - Changed
collaborator_alias
field fordatabricks.sdk.service.cleanrooms.CleanRoomCollaborator
to be required. - Changed
collaborator_alias
field fordatabricks.sdk.service.cleanrooms.CleanRoomCollaborator
to be required. - Changed
update_mask
field fordatabricks.sdk.service.oauth2.UpdateAccountFederationPolicyRequest
to no longer be required. - Changed
update_mask
field fordatabricks.sdk.service.oauth2.UpdateServicePrincipalFederationPolicyRequest
to no longer be required. - Changed
days_of_week
field fordatabricks.sdk.service.pipelines.RestartWindow
to typedatabricks.sdk.service.pipelines.DayOfWeekList
dataclass. - Changed
behavior
field fordatabricks.sdk.service.serving.AiGatewayGuardrailPiiBehavior
to no longer be required. - Changed
behavior
field fordatabricks.sdk.service.serving.AiGatewayGuardrailPiiBehavior
to no longer be required. - Changed
project_id
andregion
fields fordatabricks.sdk.service.serving.GoogleCloudVertexAiConfig
to be required. - Changed
project_id
andregion
fields fordatabricks.sdk.service.serving.GoogleCloudVertexAiConfig
to be required. - Changed
workload_type
field fordatabricks.sdk.service.serving.ServedEntityInput
to typedatabricks.sdk.service.serving.ServingModelWorkloadType
dataclass. - Changed
workload_type
field fordatabricks.sdk.service.serving.ServedEntityOutput
to typedatabricks.sdk.service.serving.ServingModelWorkloadType
dataclass. - Changed
workload_type
field fordatabricks.sdk.service.serving.ServedModelOutput
to typedatabricks.sdk.service.serving.ServingModelWorkloadType
dataclass.
OpenAPI SHA: 58905570a9928fc9ed31fba14a2edaf9a7c55b08, Date: 2025-01-20