NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI · #277 most downloaded on PyPI
Databricks SDK for Python (Beta)
Last release today
19 Sep 2026
Ships fairly regularly
a new release about every 2 weeks
Nearly every release is documented
notes for 60 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
3 years old
165 releases · first in 2023
One column per quarter.
Properly escape multi-segment path parameters (#596).
migrate() and unpublish() method fors w.lakeview workspace-level service.databricks.sdk.service.dashboards.MigrateDashboardRequest and databricks.sdk.service.dashboards.UnpublishDashboardRequest dataclasses.description, queue_duration and repair_history fields for databricks.sdk.service.jobs.BaseRun.compute_key and job_cluster_key fields for databricks.sdk.service.jobs.ClusterSpec.left, op and right fields for databricks.sdk.service.jobs.ConditionTask to be required.edit_mode field for databricks.sdk.service.jobs.CreateJob to databricks.sdk.service.jobs.JobEditMode dataclass.databricks.sdk.service.jobs.CreateJobEditMode dataclass by databricks.sdk.service.jobs.JobEditMode.url field for databricks.sdk.service.jobs.FileArrivalTriggerConfiguration to be required.error_message_stats field for databricks.sdk.service.jobs.ForEachStats to databricks.sdk.service.jobs.ForEachTaskErrorMessageStatsList dataclass.new_cluster field for databricks.sdk.service.jobs.JobCluster to be required.edit_mode field for databricks.sdk.service.jobs.JobSettings to databricks.sdk.service.jobs.JobEditMode dataclass.databricks.sdk.service.jobs.JobsSettingsEditMode dataclass by databricks.sdk.service.jobs.JobEditMode.metric, op and value fields for databricks.sdk.service.jobs.JobsHealthRule to be required.run_type field for databricks.sdk.service.jobs.ListRunsRequest to databricks.sdk.service.jobs.RunType dataclass.databricks.sdk.service.jobs.ListRunsRunType dataclass by databricks.sdk.service.jobs.RunType dataclass.pipeline_id field for databricks.sdk.service.jobs.PipelineTask to be required.entry_point and package_name fields for databricks.sdk.service.jobs.PythonWheelTask to be required.job_parameters field for databricks.sdk.service.jobs.RepairRun to dict[str,str] dataclass.base_parameters field for databricks.sdk.service.jobs.ResolvedNotebookTaskValues to dict[str,str] dataclass.parameters field for databricks.sdk.service.jobs.ResolvedParamPairValues to dict[str,str] dataclass.named_parameters field for databricks.sdk.service.jobs.ResolvedPythonWheelTaskValues to dict[str,str] dataclass.named_parameters field for databricks.sdk.service.jobs.ResolvedRunJobTaskValues.parameters field for databricks.sdk.service.jobs.ResolvedRunJobTaskValues to dict[str,str] dataclass.job_parameters field for databricks.sdk.service.jobs.ResolvedRunJobTaskValues.description and queue_duration fields for databricks.sdk.service.jobs.Run.op field for databricks.sdk.service.jobs.RunConditionTask to databricks.sdk.service.jobs.ConditionTaskOp dataclass.databricks.sdk.service.jobs.RunConditionTaskOp dataclass by databricks.sdk.service.jobs.ConditionTaskOp dataclass.inputs and task fields for databricks.sdk.service.jobs.RunForEachTask to be required.job_parameters field for databricks.sdk.service.jobs.RunJobTask to dict[str,str] dataclass.dbt_commands, jar_params, notebook_params, pipeline_params, python_named_params, python_params, spark_submit_params and sql_params fields for databricks.sdk.service.jobs.RunJobTask.job_parameters field for databricks.sdk.service.jobs.RunNow to dict[str,str] dataclass.info field for databricks.sdk.service.jobs.RunOutput.job_parameters field for databricks.sdk.service.jobs.RunParameters.task_key field for databricks.sdk.service.jobs.RunTask to be required.compute_key, email_notifications, job_cluster_key, notification_settings, run_duration, run_page_url, timeout_seconds and webhook_notifications fields for databricks.sdk.service.jobs.RunTask.endpoint_id field for databricks.sdk.service.jobs.SqlQueryOutput.condition_task, dbt_task, notebook_task, pipeline_task, python_wheel_task, run_job_task, spark_jar_task, spark_python_task, spark_submit_task and sql_task fields for databricks.sdk.service.jobs.SubmitRun.description field for databricks.sdk.service.jobs.SubmitTask.disable_auto_optimization field for databricks.sdk.service.jobs.Task.no_alert_for_skipped_runs field for databricks.sdk.service.jobs.TaskEmailNotifications.table_update field for databricks.sdk.service.jobs.TriggerSettings.id field for databricks.sdk.service.jobs.Webhook to be required.on_duration_warning_threshold_exceeded field for databricks.sdk.service.jobs.WebhookNotifications to databricks.sdk.service.jobs.WebhookList dataclass.databricks.sdk.service.jobs.WebhookNotificationsOnDurationWarningThresholdExceededItem dataclass.databricks.sdk.service.jobs.JobEditMode dataclass.databricks.sdk.service.serving.AwsBedrockConfig dataclass by databricks.sdk.service.serving.AmazonBedrockConfig dataclass.databricks.sdk.service.serving.AwsBedrockConfigBedrockProvider dataclass by databricks.sdk.service.serving.AmazonBedrockConfigBedrockProvider dataclass.aws_bedrock_config field for databricks.sdk.service.serving.ExternalModel to amazon_bedrock_config.get() method for w.ip_access_lists workspace-level service . New request type is databricks.sdk.service.settings.GetIpAccessListRequest dataclass.databricks.sdk.service.settings.GetIpAccessList dataclass by databricks.sdk.service.settings.GetIpAccessListRequest dataclass.OpenAPI SHA: d38528c3e47dd81c9bdbd918272a3e49d36e09ce, Date: 2024-03-27
Improve diff generation for changelog.
Internal changes:
API Changes:
databricks.sdk.service.catalog.AwsIamRoleResponse dataclass.databricks.sdk.service.catalog.AwsIamRoleRequest dataclass.databricks.sdk.service.catalog.AwsIamRole dataclass.aws_iam_role field for databricks.sdk.service.catalog.CreateStorageCredential to databricks.sdk.service.catalog.AwsIamRoleRequest dataclass.aws_iam_role field for databricks.sdk.service.catalog.StorageCredentialInfo to databricks.sdk.service.catalog.AwsIamRoleResponse dataclass.aws_iam_role field for databricks.sdk.service.catalog.UpdateStorageCredential to databricks.sdk.service.catalog.AwsIamRoleRequest dataclass.aws_iam_role field for databricks.sdk.service.catalog.ValidateStorageCredential to databricks.sdk.service.catalog.AwsIamRoleRequest dataclass.auto_capture_config field for databricks.sdk.service.serving.EndpointPendingConfig.databricks.sdk.service.sharing.SharedDataObjectDataObjectType dataclass.data_object_type field for databricks.sdk.service.sharing.SharedDataObject to databricks.sdk.service.sharing.SharedDataObjectDataObjectType dataclass.content field for databricks.sdk.service.sharing.SharedDataObject.embedding_source_columns field for databricks.sdk.service.vectorsearch.DirectAccessVectorIndexSpec.OpenAPI SHA: 93763b0d7ae908520c229c786fff28b8fd623261, Date: 2024-03-20
Fix typos in doc string for select_spark_version (#575).
notifications field for databricks.sdk.service.catalog.CreateMonitor, databricks.sdk.service.catalog.MonitorInfo, and databricks.sdk.service.catalog.UpdateMonitor to databricks.sdk.service.catalog.MonitorNotificationsConfig dataclass.browse_only field for databricks.sdk.service.catalog.ExternalLocationInfo, databricks.sdk.service.catalog.FunctionInfo, databricks.sdk.service.catalog.ModelVersionInfo, databricks.sdk.service.catalog.RegisteredModelInfo, databricks.sdk.service.catalog.SchemaInfo, databricks.sdk.service.catalog.TableInfo, and databricks.sdk.service.catalog.VolumeInfo.include_browse field for databricks.sdk.service.catalog.GetCatalogRequest, databricks.sdk.service.catalog.GetExternalLocationRequest, databricks.sdk.service.catalog.GetFunctionRequest, databricks.sdk.service.catalog.GetModelVersionRequest, databricks.sdk.service.catalog.GetRegisteredModelRequest, databricks.sdk.service.catalog.GetSchemaRequest, databricks.sdk.service.catalog.GetTableRequest, databricks.sdk.service.catalog.ListExternalLocationsRequest, databricks.sdk.service.catalog.ListFunctionsRequest, databricks.sdk.service.catalog.ListModelVersionsRequest, databricks.sdk.service.catalog.ListRegisteredModelsRequest, databricks.sdk.service.catalog.ListSchemasRequest, databricks.sdk.service.catalog.ListTablesRequest, databricks.sdk.service.catalog.ListVolumesRequest, and databricks.sdk.service.catalog.ReadVolumeRequest.publish() method for w.lakeview workspace-level service to return databricks.sdk.service.dashboards.PublishedDashboard dataclass.create(), get(), get_published(), trash(), and update() methods for w.lakeview workspace-level service.databricks.sdk.service.dashboards.CreateDashboardRequest, databricks.sdk.service.dashboards.Dashboard, databricks.sdk.service.dashboards.GetLakeviewRequest, databricks.sdk.service.dashboards.GetPublishedRequest, databricks.sdk.service.dashboards.LifecycleState, databricks.sdk.service.dashboards.PublishedDashboard, databricks.sdk.service.dashboards.TrashRequest, and databricks.sdk.service.dashboards.UpdateDashboardRequest dataclasses.OpenAPI SHA: c84caf9e5ef531cc0b1ddd0a76970d9a8b664e32, Date: 2024-03-15
Note: Backwards incompatible changes - Settings are now nested, please see the API changes below.
Services:
Dataclasses:
databricks.sdk.service.settings.AutomaticClusterUpdateSettingdatabricks.sdk.service.settings.ClusterAutoRestartMessagedatabricks.sdk.service.settings.ClusterAutoRestartMessageEnablementDetailsdatabricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowdatabricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowDayOfWeekdatabricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedScheduledatabricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequencydatabricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWindowStartTimedatabricks.sdk.service.settings.ComplianceStandarddatabricks.sdk.service.settings.CspEnablementdatabricks.sdk.service.settings.CspEnablementAccountdatabricks.sdk.service.settings.CspEnablementAccountSettingdatabricks.sdk.service.settings.CspEnablementSettingdatabricks.sdk.service.settings.DeleteDefaultNamespaceRequestdatabricks.sdk.service.settings.DeletePersonalComputeRequestdatabricks.sdk.service.settings.DeleteRestrictWorkspaceAdminRequestdatabricks.sdk.service.settings.EsmEnablementdatabricks.sdk.service.settings.EsmEnablementAccountdatabricks.sdk.service.settings.EsmEnablementAccountSettingdatabricks.sdk.service.settings.EsmEnablementSettingdatabricks.sdk.service.settings.GetAutomaticClusterUpdateRequestdatabricks.sdk.service.settings.GetCspEnablementAccountRequestdatabricks.sdk.service.settings.GetCspEnablementRequestdatabricks.sdk.service.settings.GetDefaultNamespaceRequestdatabricks.sdk.service.settings.GetEsmEnablementAccountRequestdatabricks.sdk.service.settings.GetEsmEnablementRequestdatabricks.sdk.service.settings.GetPersonalComputeRequestdatabricks.sdk.service.settings.GetRestrictWorkspaceAdminRequestdatabricks.sdk.service.settings.NccAwsStableIpRuledatabricks.sdk.service.settings.UpdateAutomaticClusterUpdateSettingRequestdatabricks.sdk.service.settings.UpdateCspEnablementAccountSettingRequestdatabricks.sdk.service.settings.UpdateCspEnablementSettingRequestdatabricks.sdk.service.settings.UpdateEsmEnablementAccountSettingRequestdatabricks.sdk.service.settings.UpdateEsmEnablementSettingRequestdatabricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindowdatabricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindowDayOfWeekdatabricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedScheduledatabricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequencydatabricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindowWindowStartTimedatabricks.sdk.service.vectorsearch.ComplianceStandarddatabricks.sdk.service.vectorsearch.CspEnablementdatabricks.sdk.service.vectorsearch.CspEnablementAccountdatabricks.sdk.service.vectorsearch.CspEnablementAccountSettingdatabricks.sdk.service.vectorsearch.CspEnablementSettingdatabricks.sdk.service.vectorsearch.DeleteDefaultNamespaceRequestdatabricks.sdk.service.vectorsearch.DeletePersonalComputeRequestdatabricks.sdk.service.vectorsearch.DeleteRestrictWorkspaceAdminRequestdatabricks.sdk.service.vectorsearch.EsmEnablementdatabricks.sdk.service.vectorsearch.EsmEnablementAccountdatabricks.sdk.service.vectorsearch.EsmEnablementAccountSettingdatabricks.sdk.service.vectorsearch.EsmEnablementSettingdatabricks.sdk.service.vectorsearch.GetAutomaticClusterUpdateRequestdatabricks.sdk.service.vectorsearch.GetCspEnablementAccountRequestdatabricks.sdk.service.vectorsearch.GetCspEnablementRequestdatabricks.sdk.service.vectorsearch.GetDefaultNamespaceRequestdatabricks.sdk.service.vectorsearch.GetEsmEnablementAccountRequestdatabricks.sdk.service.vectorsearch.GetEsmEnablementRequestdatabricks.sdk.service.vectorsearch.GetPersonalComputeRequestdatabricks.sdk.service.vectorsearch.GetRestrictWorkspaceAdminRequestdatabricks.sdk.service.vectorsearch.NccAwsStableIpRuledatabricks.sdk.service.vectorsearch.UpdateAutomaticClusterUpdateSettingRequestdatabricks.sdk.service.vectorsearch.UpdateCspEnablementAccountSettingRequestdatabricks.sdk.service.vectorsearch.UpdateCspEnablementSettingRequestdatabricks.sdk.service.vectorsearch.UpdateEsmEnablementAccountSettingRequestdatabricks.sdk.service.vectorsearch.UpdateEsmEnablementSettingRequestdatabricks.sdk.service.iam.PermissionMigrationRequestdatabricks.sdk.service.iam.PermissionMigrationResponseversion field for databricks.sdk.service.serving.AppManifest to databricks.sdk.service.serving.AnyValue dataclass.delete_endpoint() method for w.vector_search_endpoints workspace-level service with new required argument order.create_index() method for w.vector_search_indexes workspace-level service with new required argument order.delete_data_vector_index() method for w.vector_search_indexes workspace-level service with new required argument order.upsert_data_vector_index() method for w.vector_search_indexes workspace-level service with new required argument order.endpoint_name field for databricks.sdk.service.vectorsearch.CreateVectorIndexRequest to be required.delete_personal_compute_setting() method for a.account_settings account-level service.get_personal_compute_setting() method for a.account_settings account-level service.update_personal_compute_setting() method for a.account_settings account-level service.delete_default_namespace_setting() method for w.settings workspace-level service.delete_restrict_workspace_admins_setting() method for w.settings workspace-level service.get_default_namespace_setting() method for w.settings workspace-level service.get_restrict_workspace_admins_setting() method for w.settings workspace-level service.update_default_namespace_setting() method for w.settings workspace-level service.update_restrict_workspace_admins_setting() method for w.settings workspace-level service.databricks.sdk.service.settings.DeleteDefaultNamespaceSettingRequest dataclass.databricks.sdk.service.settings.DeletePersonalComputeSettingRequest dataclass.databricks.sdk.service.settings.DeleteRestrictWorkspaceAdminsSettingRequest dataclass.databricks.sdk.service.settings.GetDefaultNamespaceSettingRequest dataclass.databricks.sdk.service.settings.GetPersonalComputeSettingRequest dataclass.databricks.sdk.service.settings.GetRestrictWorkspaceAdminsSettingRequest dataclass.databricks.sdk.service.vectorsearch.EmbeddingConfig dataclass.embedding_config field for databricks.sdk.service.vectorsearch.EmbeddingSourceColumn.name field for databricks.sdk.service.vectorsearch.DeleteDataVectorIndexRequest.name field for databricks.sdk.service.vectorsearch.DeleteEndpointRequest.planning_phases field for databricks.sdk.service.sql.QueryMetrics.delta_sync_vector_index_spec field for databricks.sdk.service.vectorsearch.VectorIndex.direct_access_vector_index_spec field for databricks.sdk.service.vectorsearch.VectorIndex.OpenAPI SHA: 1026b998b14fba1b8317528f47778240dc4e9a5d, Date: 2024-03-06
Updated behaviour for raw parameter in ApiClient.do() method. The raw data is not returned directly anymore, but as part of a dict with the contents k
Major Changes:
ApiClient.do() method. The raw data is not returned directly anymore, but as part of a dict with the contents key. This dict will also contain response headers if returned by the API.Internal Changes:
API Changes:
delete(), get() and update() methods for w.connections workspace-level service with new required argument order.update() method for w.lakehouse_monitors workspace-level service with new required argument order.delete(), get() and update() methods for w.volumes workspace-level service with new required argument order.name_arg field to name for the following dataclasses: databricks.sdk.service.catalog.DeleteConnectionRequest,
databricks.sdk.service.catalog.GetConnectionRequest,
databricks.sdk.service.catalog.UpdateConnection,
databricks.sdk.service.sharing.DeleteCleanRoomRequest,
databricks.sdk.service.sharing.GetCleanRoomRequest and
databricks.sdk.service.sharing.UpdateCleanRoom.full_name_arg field for databricks.sdk.service.catalog.DeleteVolumeRequest.name field for databricks.sdk.service.catalog.DeleteVolumeRequest.max_results field for databricks.sdk.service.catalog.ListVolumesRequest.page_token field for databricks.sdk.service.catalog.ListVolumesRequest.next_page_token field for databricks.sdk.service.catalog.ListVolumesResponseContent.full_name_arg field for databricks.sdk.service.catalog.ReadVolumeRequest.name field for databricks.sdk.service.catalog.ReadVolumeRequest.assets_dir field for databricks.sdk.service.catalog.UpdateMonitor.full_name_arg field for databricks.sdk.service.catalog.UpdateVolumeRequestContent.name field for databricks.sdk.service.catalog.UpdateVolumeRequestContent.ContinuousUpdateStatus, DeleteOnlineTableRequest, FailedStatus,
GetOnlineTableRequest, OnlineTable, OnlineTableSpec, OnlineTableState, OnlineTableStatus,
PipelineProgress, ProvisioningStatus, TriggeredUpdateStatus and ViewData.get_directory_metadata() method for w.files workspace-level service.get_metadata() method for w.files workspace-level service.content_length, content_type and last_modified fields for databricks.sdk.service.files.DownloadResponse.FileSize, GetDirectoryMetadataRequest, GetMetadataRequest,
GetMetadataResponse and LastModifiedHttpDate.trigger_history field for databricks.sdk.service.jobs.Job.databricks.sdk.service.jobs.TriggerEvaluation dataclass.databricks.sdk.service.jobs.TriggerHistory dataclass.table field for databricks.sdk.service.jobs.TriggerSettings.databricks.sdk.service.jobs.Condition dataclass.databricks.sdk.service.jobs.TableTriggerConfiguration dataclass.config field for databricks.sdk.service.serving.ExternalModel.databricks.sdk.service.serving.ExternalModelConfig dataclass. Fields moved to databricks.sdk.service.serving.ExternalModel.max_provisioned_throughput and min_provisioned_throughput fields for databricks.sdk.service.serving.ServedEntityInput.max_provisioned_throughput and min_provisioned_throughput fields for databricks.sdk.service.serving.ServedEntityOutput.delete() method for w.clean_rooms workspace-level service with new required argument order.get() method for w.clean_rooms workspace-level service with new required argument order.update() method for w.clean_rooms workspace-level service with new required argument order.enum_options field for databricks.sdk.service.sql.Parameter.multi_values_options field for databricks.sdk.service.sql.Parameter.query_id field for databricks.sdk.service.sql.Parameter.databricks.sdk.service.sql.MultiValuesOptions dataclass.OpenAPI SHA: cdd76a98a4fca7008572b3a94427566dd286c63b, Date: 2024-02-19
Add get_workspace_id() to WorkspaceClient (#537).
Construct workspace client from account client (#527).
databricks.sdk.errors.mapping to databricks.sdk.errors.platform (#522).Additions:
databricks.sdk.service.catalog.CancelRefreshRequestdatabricks.sdk.service.catalog.GetRefreshRequestdatabricks.sdk.service.catalog.ListRefreshesRequestdatabricks.sdk.service.catalog.MonitorRefreshInfodatabricks.sdk.service.catalog.MonitorRefreshInfoStatedatabricks.sdk.service.catalog.RunRefreshRequestdatabricks.sdk.service.compute.Adlsgen2Infodatabricks.sdk.service.compute.GcsStorageInfodatabricks.sdk.service.files.CreateDirectoryRequestdatabricks.sdk.service.files.DeleteDirectoryRequestdatabricks.sdk.service.files.DirectoryEntrydatabricks.sdk.service.files.ListDirectoryContentsRequestdatabricks.sdk.service.files.ListDirectoryResponsedatabricks.sdk.service.files.PageTokendatabricks.sdk.service.jobs.ForEachStatsdatabricks.sdk.service.jobs.ForEachTaskdatabricks.sdk.service.jobs.ForEachTaskErrorMessageStatsdatabricks.sdk.service.jobs.ForEachTaskTaskRunStatsdatabricks.sdk.service.jobs.RunForEachTaskdatabricks.sdk.service.pipelines.PipelineClusterAutoscaledatabricks.sdk.service.pipelines.PipelineClusterAutoscaleModedatabricks.sdk.service.settings.DeleteDefaultNamespaceSettingRequestdatabricks.sdk.service.settings.DeleteDefaultNamespaceSettingResponsedatabricks.sdk.service.settings.DeleteRestrictWorkspaceAdminsSettingRequestdatabricks.sdk.service.settings.DeleteRestrictWorkspaceAdminsSettingResponsedatabricks.sdk.service.settings.GetDefaultNamespaceSettingRequestdatabricks.sdk.service.settings.GetPersonalComputeSettingRequestdatabricks.sdk.service.settings.GetRestrictWorkspaceAdminsSettingRequestdatabricks.sdk.service.settings.RestrictWorkspaceAdminsMessagedatabricks.sdk.service.settings.RestrictWorkspaceAdminsMessageStatusdatabricks.sdk.service.settings.RestrictWorkspaceAdminsSettingdatabricks.sdk.service.settings.UpdateDefaultNamespaceSettingRequestdatabricks.sdk.service.settings.UpdateRestrictWorkspaceAdminsSettingRequestcancel_refresh(), get_refresh(), list_refreshes() and run_refresh() method for w.lakehouse_monitors workspace-level service.use_preemptible_executors field for databricks.sdk.service.compute.GcpAttributes.zone_id field for databricks.sdk.service.compute.GcpAttributes.abfss and gcs field for databricks.sdk.service.compute.InitScriptInfo.create_directory(), delete_directory() and list_directory_contents() method for w.files workspace-level service.source field for databricks.sdk.service.jobs.DbtTask and databricks.sdk.service.jobs.SqlTaskFile.for_each_task field for databricks.sdk.service.jobs.RunTask, databricks.sdk.service.jobs.SubmitTask and databricks.sdk.service.jobs.Task.field_mask field for databricks.sdk.service.settings.UpdatePersonalComputeSettingRequest.delta_sync_index_spec field for databricks.sdk.service.vectorsearch.CreateVectorIndexRequest.file_type field for databricks.sdk.service.workspace.ExportResponse.resource_id field for databricks.sdk.service.workspace.ObjectInfo.delete_default_namespace_setting(), delete_restrict_workspace_admins_setting(), get_default_namespace_setting(), get_restrict_workspace_admins_setting(), update_default_namespace_setting() and update_restrict_workspace_admins_setting() method for w.settings workspace-level service.get_personal_compute_setting() method for a.account_settings account-level service.Removals:
databricks.sdk.service.settings.ReadDefaultWorkspaceNamespaceRequestdatabricks.sdk.service.settings.ReadPersonalComputeSettingRequestdatabricks.sdk.service.settings.UpdateDefaultWorkspaceNamespaceRequestdatabricks.sdk.service.settings.DeleteDefaultWorkspaceNamespaceRequestdatabricks.sdk.service.settings.DeleteDefaultWorkspaceNamespaceResponsedatabricks.sdk.service.pipelines.ResetRequestget_status() for w.files workspace-level service.reset() for w.pipelines workspace-level service.delete_default_workspace_namespace() for w.settings workspace-level service.read_default_workspace_namespace() for w.settings workspace-level service.update_default_workspace_namespace() for w.settings workspace-level service.read_personal_compute_setting() for a.account_settings account-level service.name field for databricks.sdk.service.catalog.UpdateConnection, databricks.sdk.service.catalog.UpdateMetastore, databricks.sdk.service.catalog.UpdateRegisteredModelRequest. databricks.sdk.service.catalog.UpdateSchemaand databricks.sdk.service.catalog.UpdateVolumeRequestContent.delta_sync_vector_index_spec field for databricks.sdk.service.vectorsearch.CreateVectorIndexRequest.Changes:
max_workers and min_workers field for databricks.sdk.service.compute.AutoScale to no longer be required.destination field for databricks.sdk.service.compute.DbfsStorageInfo, databricks.sdk.service.compute.LocalFileInfo, databricks.sdk.service.compute.S3StorageInfo, databricks.sdk.service.compute.VolumesStorageInfo and databricks.sdk.service.compute.WorkspaceStorageInfo to be required.clients field for databricks.sdk.service.compute.WorkloadType to be required.allow_missing and setting field for databricks.sdk.service.settings.UpdatePersonalComputeSettingRequest to be required.etag field for databricks.sdk.service.settings.DeletePersonalComputeSettingRequest to no longer be required.autoscale field for databricks.sdk.service.pipelines.PipelineCluster to databricks.sdk.service.pipelines.PipelineClusterAutoscale dataclass.delete_personal_compute_setting() and update_personal_compute_setting() method for a.account_settings account-level service with new required argument order.OpenAPI SHA: 6b897bc95b23abed8b9f5eff0e6b8ec034046180, Date: 2024-02-08
Fix Databricks OAuth M2M on Azure (#513).
Bugfixes:
Other noteworthy changes:
[] instead of None as default list value for deserialising responses (#361).API Changes:
exists() method for w.tables workspace-level service.databricks.sdk.service.catalog.CreateMonitor,
databricks.sdk.service.catalog.DeleteLakehouseMonitorRequest,
databricks.sdk.service.catalog.ExistsRequest,
databricks.sdk.service.catalog.GetLakehouseMonitorRequest,
databricks.sdk.service.catalog.MonitorCronSchedule,
databricks.sdk.service.catalog.MonitorCronSchedulePauseStatus,
databricks.sdk.service.catalog.MonitorCustomMetric,
databricks.sdk.service.catalog.MonitorCustomMetricType,
databricks.sdk.service.catalog.MonitorDataClassificationConfig,
databricks.sdk.service.catalog.MonitorDestinations,
databricks.sdk.service.catalog.MonitorInferenceLogProfileType,databricks.sdk.service.catalog.MonitorInferenceLogProfileTypeProblemType,
databricks.sdk.service.catalog.MonitorInfo,
databricks.sdk.service.catalog.MonitorInfoStatus,
databricks.sdk.service.catalog.MonitorNotificationsConfig,
databricks.sdk.service.catalog.MonitorTimeSeriesProfileType,
databricks.sdk.service.catalog.TableExistsResponse and
databricks.sdk.service.catalog.UpdateMonitor.create_obo_token() method for w.token_management workspace-level service with new required argument order.get() method for w.token_management workspace-level service to return databricks.sdk.service.settings.GetTokenResponse dataclass.lifetime_seconds field for databricks.sdk.service.settings.CreateOboTokenRequest to no longer be required.databricks.sdk.service.settings.GetTokenResponse dataclass.OpenAPI SHA: e05401ed5dd4974c5333d737ec308a7d451f749f, Date: 2024-01-23
Note: This release contains breaking changes, please see below for more details.
@retried(on=[...]) (#486).__init__.py equal across projects (#488).Note: This release contains breaking changes, please see below for more details.
API Changes:
list() method for w.tokens workspace-level service to return databricks.sdk.service.settings.ListPublicTokensResponse dataclass.list() method for w.external_locations workspace-level service to require request of databricks.sdk.service.catalog.ListExternalLocationsRequest dataclass and w.storage_credentials workspace-level service to require request of databricks.sdk.service.catalog.ListStorageCredentialsRequest dataclass.next_page_token field for databricks.sdk.service.catalog.ListExternalLocationsResponse, databricks.sdk.service.catalog.ListFunctionsResponse, databricks.sdk.service.catalog.ListSchemasResponse and databricks.sdk.service.catalog.ListStorageCredentialsResponse.max_results field for databricks.sdk.service.catalog.ListFunctionsRequest and databricks.sdk.service.catalog.ListSchemasRequest.page_token field for databricks.sdk.service.catalog.ListFunctionsRequest and databricks.sdk.service.catalog.ListSchemasRequest.omit_columns field for databricks.sdk.service.catalog.ListTablesRequest.omit_properties field for databricks.sdk.service.catalog.ListTablesRequest.init_scripts field for databricks.sdk.service.pipelines.PipelineCluster.validate_only field for databricks.sdk.service.pipelines.StartUpdate and databricks.sdk.service.pipelines.UpdateInfo.create() method for w.dashboards workspace-level service . New request type is databricks.sdk.service.sql.DashboardPostContent dataclass.update() method for w.dashboards workspace-level service.http_headers field for databricks.sdk.service.sql.ExternalLink.run_as_role field for databricks.sdk.service.sql.QueryEditContent.databricks.sdk.service.dashboards and databricks.sdk.service.vectorsearch.databricks.sdk.service.catalog.ListExternalLocationsRequest, databricks.sdk.service.catalog.ListStorageCredentialsRequest, databricks.sdk.service.settings.ListPublicTokensResponse, databricks.sdk.service.sql.DashboardEditContent and databricks.sdk.service.sql.DashboardPostContent.databricks.sdk.service.catalog.TableConstraintList and databricks.sdk.service.sql.CreateDashboardRequest.OpenAPI SHA: 0e0d4cbe87193e36c73b8b2be3b0dd0f1b013e00, Date: 2024-01-10
Sort imports in service template (#479).
py.typed to support PEP-561 (#483).@retried when exception subtypes were not respected (#484).WorkspaceClient and AccountClient more friendly with autospeccing (#480).API Changes:
azure_workspace_info field for databricks.sdk.service.provisioning.Workspace.databricks.sdk.service.provisioning.AzureWorkspaceInfo dataclass.update_config() method for w.serving_endpoints workspace-level service with new required argument order.served_entities field for databricks.sdk.service.serving.EndpointCoreConfigInput to no longer be required.create() method for a.account_ip_access_lists account-level service with new required argument order.replace() method for a.account_ip_access_lists account-level service with new required argument order.update() method for a.account_ip_access_lists account-level service with new required argument order.create() method for w.ip_access_lists workspace-level service with new required argument order.replace() method for w.ip_access_lists workspace-level service with new required argument order.update() method for w.ip_access_lists workspace-level service with new required argument order.ip_addresses field for databricks.sdk.service.settings.CreateIpAccessList to no longer be required.ip_addresses field for databricks.sdk.service.settings.ReplaceIpAccessList to no longer be required.list_id field for databricks.sdk.service.settings.ReplaceIpAccessList.enabled field for databricks.sdk.service.settings.UpdateIpAccessList to no longer be required.ip_addresses field for databricks.sdk.service.settings.UpdateIpAccessList to no longer be required.label field for databricks.sdk.service.settings.UpdateIpAccessList to no longer be required.list_id field for databricks.sdk.service.settings.UpdateIpAccessList.list_type field for databricks.sdk.service.settings.UpdateIpAccessList to no longer be required.OpenAPI SHA: d3853c8dee5806d04da2ae8910f273ffb35719a5, Date: 2023-12-14
Fixed accidental rename (#471).
Bugfixes:
Other changes:
API Changes:
update() method for w.connections workspace-level service with new required argument order.cloudflare_api_token field for databricks.sdk.service.catalog.CreateStorageCredential.cloudflare_api_token field for databricks.sdk.service.catalog.StorageCredentialInfo.name field for databricks.sdk.service.catalog.UpdateCatalog to be required.new_name field for databricks.sdk.service.catalog.UpdateCatalog.name field for databricks.sdk.service.catalog.UpdateConnection to no longer be required.new_name field for databricks.sdk.service.catalog.UpdateConnection.name field for databricks.sdk.service.catalog.UpdateExternalLocation to be required.new_name field for databricks.sdk.service.catalog.UpdateExternalLocation.new_name field for databricks.sdk.service.catalog.UpdateMetastore.new_name field for databricks.sdk.service.catalog.UpdateRegisteredModelRequest.new_name field for databricks.sdk.service.catalog.UpdateSchema.name field for databricks.sdk.service.catalog.UpdateStorageCredential to be required.cloudflare_api_token field for databricks.sdk.service.catalog.UpdateStorageCredential.new_name field for databricks.sdk.service.catalog.UpdateStorageCredential.new_name field for databricks.sdk.service.catalog.UpdateVolumeRequestContent.cloudflare_api_token field for databricks.sdk.service.catalog.ValidateStorageCredential.databricks.sdk.service.catalog.CloudflareApiToken dataclass.continuous field for databricks.sdk.service.jobs.BaseRun.continuous field for databricks.sdk.service.jobs.Run.job_parameters field for databricks.sdk.service.jobs.RunJobTask to databricks.sdk.service.jobs.ParamPairs dataclass.run_if field for databricks.sdk.service.jobs.SubmitTask.run_job_task field for databricks.sdk.service.jobs.SubmitTask.update_config() method for w.serving_endpoints workspace-level service with new required argument order.put() method for w.serving_endpoints workspace-level service.rate_limits field for databricks.sdk.service.serving.CreateServingEndpoint.served_models field for databricks.sdk.service.serving.EndpointCoreConfigInput to no longer be required.auto_capture_config field for databricks.sdk.service.serving.EndpointCoreConfigInput.served_entities field for databricks.sdk.service.serving.EndpointCoreConfigInput.auto_capture_config field for databricks.sdk.service.serving.EndpointCoreConfigOutput.served_entities field for databricks.sdk.service.serving.EndpointCoreConfigOutput.served_entities field for databricks.sdk.service.serving.EndpointCoreConfigSummary.served_entities field for databricks.sdk.service.serving.EndpointPendingConfig.extra_params field for databricks.sdk.service.serving.QueryEndpointInput.input field for databricks.sdk.service.serving.QueryEndpointInput.max_tokens field for databricks.sdk.service.serving.QueryEndpointInput.messages field for databricks.sdk.service.serving.QueryEndpointInput.n field for databricks.sdk.service.serving.QueryEndpointInput.prompt field for databricks.sdk.service.serving.QueryEndpointInput.stop field for databricks.sdk.service.serving.QueryEndpointInput.stream field for databricks.sdk.service.serving.QueryEndpointInput.temperature field for databricks.sdk.service.serving.QueryEndpointInput.predictions field for databricks.sdk.service.serving.QueryEndpointResponse to no longer be required.choices field for databricks.sdk.service.serving.QueryEndpointResponse.created field for databricks.sdk.service.serving.QueryEndpointResponse.data field for databricks.sdk.service.serving.QueryEndpointResponse.id field for databricks.sdk.service.serving.QueryEndpointResponse.model field for databricks.sdk.service.serving.QueryEndpointResponse.object field for databricks.sdk.service.serving.QueryEndpointResponse.usage field for databricks.sdk.service.serving.QueryEndpointResponse.workload_size field for databricks.sdk.service.serving.ServedModelInput to databricks.sdk.service.serving.ServedModelInputWorkloadSize dataclass.workload_type field for databricks.sdk.service.serving.ServedModelInput to databricks.sdk.service.serving.ServedModelInputWorkloadType dataclass.task field for databricks.sdk.service.serving.ServingEndpoint.task field for databricks.sdk.service.serving.ServingEndpointDetailed.databricks.sdk.service.serving.Ai21LabsConfig dataclass.databricks.sdk.service.serving.AnthropicConfig dataclass.databricks.sdk.service.serving.AutoCaptureConfigInput dataclass.databricks.sdk.service.serving.AutoCaptureConfigOutput dataclass.databricks.sdk.service.serving.AutoCaptureState dataclass.databricks.sdk.service.serving.AwsBedrockConfig dataclass.databricks.sdk.service.serving.AwsBedrockConfigBedrockProvider dataclass.databricks.sdk.service.serving.ChatMessage dataclass.databricks.sdk.service.serving.ChatMessageRole dataclass.databricks.sdk.service.serving.CohereConfig dataclass.databricks.sdk.service.serving.DatabricksModelServingConfig dataclass.databricks.sdk.service.serving.EmbeddingsV1ResponseEmbeddingElement dataclass.databricks.sdk.service.serving.EmbeddingsV1ResponseEmbeddingElementObject dataclass.databricks.sdk.service.serving.ExternalModel dataclass.databricks.sdk.service.serving.ExternalModelConfig dataclass.databricks.sdk.service.serving.ExternalModelProvider dataclass.databricks.sdk.service.serving.ExternalModelUsageElement dataclass.databricks.sdk.service.serving.FoundationModel dataclass.databricks.sdk.service.serving.OpenAiConfig dataclass.databricks.sdk.service.serving.PaLmConfig dataclass.databricks.sdk.service.serving.PayloadTable dataclass.databricks.sdk.service.serving.PutRequest dataclass.databricks.sdk.service.serving.PutResponse dataclass.databricks.sdk.service.serving.QueryEndpointResponseObject dataclass.databricks.sdk.service.serving.RateLimit dataclass.databricks.sdk.service.serving.RateLimitKey dataclass.databricks.sdk.service.serving.RateLimitRenewalPeriod dataclass.databricks.sdk.service.serving.ServedEntityInput dataclass.databricks.sdk.service.serving.ServedEntityOutput dataclass.databricks.sdk.service.serving.ServedEntitySpec dataclass.databricks.sdk.service.serving.ServedModelInputWorkloadSize dataclass.databricks.sdk.service.serving.ServedModelInputWorkloadType dataclass.databricks.sdk.service.serving.V1ResponseChoiceElement dataclass.databricks.sdk.service.settings.AccountNetworkPolicyMessage dataclass.databricks.sdk.service.settings.DeleteAccountNetworkPolicyRequest dataclass.databricks.sdk.service.settings.DeleteAccountNetworkPolicyResponse dataclass.databricks.sdk.service.settings.ReadAccountNetworkPolicyRequest dataclass.databricks.sdk.service.settings.UpdateAccountNetworkPolicyRequest dataclass.name field for databricks.sdk.service.sharing.UpdateCleanRoom.name field for databricks.sdk.service.sharing.UpdateProvider to be required.new_name field for databricks.sdk.service.sharing.UpdateProvider.name field for databricks.sdk.service.sharing.UpdateRecipient to be required.new_name field for databricks.sdk.service.sharing.UpdateRecipient.name field for databricks.sdk.service.sharing.UpdateShare to be required.new_name field for databricks.sdk.service.sharing.UpdateShare.statement_ids field for databricks.sdk.service.sql.QueryFilter.databricks.sdk.service.sql.StatementId dataclass.OpenAPI SHA: 63caa3cb0c05045e81d3dcf2451fa990d8670f36, Date: 2023-12-12
GCP Auth is now supported in the Python SDK. To use Google credentials-based authentication, specify your Default Application Credentials in the GOOGL
Major changes:
GOOGLE_CREDENTIALS environment variable or corresponding google_credentials parameter in Config or the client constructors. You may provide either the path to the file containing your credentials or the credentials themselves serialized as JSON. To use Google impersonation, specify the service principal to impersonate in the DATABRICKS_GOOGLE_SERVICE_ACCOUNT environment variable or the corresponding google_service_account parameter in Config or the client constructors. See #444 for the changes.Bug fixes:
Other changes:
databricks.sdk.retries (#453).API Changes:
pipeline_id field for databricks.sdk.service.catalog.TableInfo.enable_predictive_optimization field for databricks.sdk.service.catalog.UpdateCatalog and databricks.sdk.service.catalog.UpdateSchema.databricks.sdk.service.catalog.UpdatePredictiveOptimization and databricks.sdk.service.catalog.UpdatePredictiveOptimizationResponse dataclasses.enable_optimization() method for w.metastores workspace-level service.description field for databricks.sdk.service.jobs.CreateJob and databricks.sdk.service.jobs.JobSettings.list_network_connectivity_configurations() and list_private_endpoint_rules() methods for a.network_connectivity account-level service.databricks.sdk.service.settings.ListNccAzurePrivateEndpointRulesResponse, databricks.sdk.service.settings.ListNetworkConnectivityConfigurationsRequest, databricks.sdk.service.settings.ListNetworkConnectivityConfigurationsResponse, and databricks.sdk.service.settings.ListPrivateEndpointRulesRequest dataclasses.Internal changes:
OpenAPI SHA: 22f09783eb8a84d52026f856be3b2068f9498db3, Date: 2023-11-23 Dependency updates:
Introduce more specific exceptions, like NotFound, AlreadyExists, BadRequest, PermissionDenied, InternalError, and others (#376). This makes it easier
NotFound, AlreadyExists, BadRequest, PermissionDenied, InternalError, and others (#376). This makes it easier to handle errors thrown by the Databricks API. Instead of catching DatabricksError and checking the error_code field, you can catch one of these subtypes of DatabricksError, which is more ergonomic and removes the need to rethrow exceptions that you don't want to catch. For example:try:
return (self._ws
.permissions
.get(object_type, object_id))
except DatabricksError as e:
if e.error_code in [
"RESOURCE_DOES_NOT_EXIST",
"RESOURCE_NOT_FOUND",
"PERMISSION_DENIED",
"FEATURE_DISABLED",
"BAD_REQUEST"]:
logger.warning(...)
return None
raise RetryableError(...) from e
can be replaced with
try:
return (self._ws
.permissions
.get(object_type, object_id))
except PermissionDenied, FeatureDisabled:
logger.warning(...)
return None
except NotFound:
raise RetryableError(...)
API Changes:
create() method for w.functions workspace-level service and corresponding databricks.sdk.service.catalog.CreateFunction and databricks.sdk.service.catalog.FunctionInfo dataclasses.create() method for w.metastores workspace-level service with new required argument order.storage_root field for databricks.sdk.service.catalog.CreateMetastore to be optional.skip_validation field for databricks.sdk.service.catalog.UpdateExternalLocation.libraries field for databricks.sdk.service.compute.CreatePolicy, databricks.sdk.service.compute.EditPolicy and databricks.sdk.service.compute.Policy.init_scripts field for databricks.sdk.service.compute.EventDetails.file field for databricks.sdk.service.compute.InitScriptInfo.zone_id field for databricks.sdk.service.compute.InstancePoolGcpAttributes.databricks.sdk.service.compute.LocalFileInfo dataclass.ui_state field with edit_mode for databricks.sdk.service.jobs.CreateJob and databricks.sdk.service.jobs.JobSettings.databricks.sdk.service.jobs.CreateJobUiState dataclass with databricks.sdk.service.jobs.CreateJobEditMode.include_resolved_values field for databricks.sdk.service.jobs.GetRunRequest.databricks.sdk.service.jobs.JobSettingsUiState dataclass with databricks.sdk.service.jobs.JobSettingsEditMode.network_connectivity_config_id field for databricks.sdk.service.provisioning.UpdateWorkspaceRequest.string_shared_as field for databricks.sdk.service.sharing.SharedDataObject.Internal changes:
OpenAPI SHA: d136ad0541f036372601bad9a4382db06c3c912d, Date: 2023-11-14
Retry on all 429 and 503, even when missing Retry-After header (#402).
API Changes:
attributes, count, excluded_attributes, filter, sort_by, sort_order, and start_index fields for databricks.sdk.service.iam.GetAccountUserRequest and databricks.sdk.service.iam.GetUserRequest.schemas field for databricks.sdk.service.iam.Group, databricks.sdk.service.iam.ListGroupsResponse, databricks.sdk.service.iam.ListServicePrincipalResponse, databricks.sdk.service.iam.ListUsersResponse, databricks.sdk.service.iam.ServicePrincipal, and databricks.sdk.service.iam.User.databricks.sdk.service.iam.GetSortOrder, databricks.sdk.service.iam.GroupSchema, databricks.sdk.service.iam.ListResponseSchema, databricks.sdk.service.iam.ServicePrincipalSchema, and databricks.sdk.service.iam.UserSchema dataclasses.webhook_notifications field for databricks.sdk.service.jobs.SubmitTask.OpenAPI SHA: 5903bb39137fd76ac384b2044e425f9c56840e00, Date: 2023-10-23
Added Python 3.12 to project classifiers (#381).
RPC token bucket limit has been exceeded (#395).Internal:
API Changes:
download() method for a.billable_usage account-level service to start returning databricks.sdk.service.billing.DownloadResponse dataclass.databricks.sdk.service.billing.DownloadResponse dataclass.delete() method for a.account_storage_credentials account-level service with new required argument order.get() method for a.account_storage_credentials account-level service with new required argument order.update() method for a.account_storage_credentials account-level service with new required argument order.get_bindings() method for w.workspace_bindings workspace-level service.update_bindings() method for w.workspace_bindings workspace-level service.name field for databricks.sdk.service.catalog.AccountsUpdateStorageCredential.storage_credential_name field for databricks.sdk.service.catalog.AccountsUpdateStorageCredential.name field for databricks.sdk.service.catalog.DeleteAccountStorageCredentialRequest.storage_credential_name field for databricks.sdk.service.catalog.DeleteAccountStorageCredentialRequest.name field for databricks.sdk.service.catalog.GetAccountStorageCredentialRequest.storage_credential_name field for databricks.sdk.service.catalog.GetAccountStorageCredentialRequest.owner field for databricks.sdk.service.catalog.UpdateConnection.databricks.sdk.service.catalog.GetBindingsRequest dataclass.databricks.sdk.service.catalog.UpdateWorkspaceBindingsParameters dataclass.databricks.sdk.service.catalog.WorkspaceBinding dataclass.databricks.sdk.service.catalog.WorkspaceBindingBindingType dataclass.databricks.sdk.service.catalog.WorkspaceBindingsResponse dataclass.spec field for databricks.sdk.service.compute.ClusterDetails.apply_policy_default_values field for databricks.sdk.service.compute.ClusterSpec.aws_attributes field for databricks.sdk.service.compute.EditInstancePool.azure_attributes field for databricks.sdk.service.compute.EditInstancePool.disk_spec field for databricks.sdk.service.compute.EditInstancePool.enable_elastic_disk field for databricks.sdk.service.compute.EditInstancePool.gcp_attributes field for databricks.sdk.service.compute.EditInstancePool.preloaded_docker_images field for databricks.sdk.service.compute.EditInstancePool.preloaded_spark_versions field for databricks.sdk.service.compute.EditInstancePool.deployment field for databricks.sdk.service.jobs.CreateJob.ui_state field for databricks.sdk.service.jobs.CreateJob.deployment field for databricks.sdk.service.jobs.JobSettings.ui_state field for databricks.sdk.service.jobs.JobSettings.condition_task field for databricks.sdk.service.jobs.RunOutput.webhook_notifications field for databricks.sdk.service.jobs.Task.databricks.sdk.service.jobs.CreateJobUiState dataclass.databricks.sdk.service.jobs.JobDeployment dataclass.databricks.sdk.service.jobs.JobDeploymentKind dataclass.databricks.sdk.service.jobs.JobSettingsUiState dataclass.workload_type field for databricks.sdk.service.serving.ServedModelInput.workload_type field for databricks.sdk.service.serving.ServedModelOutput.list() method for w.ip_access_lists workspace-level service to return databricks.sdk.service.settings.ListIpAccessListResponse dataclass.databricks.sdk.service.settings.AccountNetworkPolicyMessage dataclass.databricks.sdk.service.settings.DeleteAccountNetworkPolicyRequest dataclass.databricks.sdk.service.settings.DeleteAccountNetworkPolicyResponse dataclass.ip_access_lists field for databricks.sdk.service.settings.GetIpAccessListResponse.ip_access_list field for databricks.sdk.service.settings.GetIpAccessListResponse.databricks.sdk.service.settings.ReadAccountNetworkPolicyRequest dataclass.databricks.sdk.service.settings.UpdateAccountNetworkPolicyRequest dataclass.databricks.sdk.service.settings.ListIpAccessListResponse dataclass.OpenAPI SHA: 493a76554afd3afdd15dc858773d01643f80352a, Date: 2023-10-12
Respect retry_timeout_seconds config setting and align retry implementation with Go SDK (#337).
retry_timeout_seconds config setting and align retry implementation with Go SDK (#337).Breaking API Changes:
list() method for a.account_metastore_assignments account-level service to return databricks.sdk.service.catalog.ListAccountMetastoreAssignmentsResponse dataclass.owner field for databricks.sdk.service.catalog.CreateConnection. Instead, use the owner field of UpdateConnection.options field for databricks.sdk.service.catalog.UpdateCatalog.job_parameters field for databricks.sdk.service.jobs.RunNow to databricks.sdk.service.jobs.ParamPairs dataclass.query() method for w.serving_endpoints workspace-level service . New request type is databricks.sdk.service.serving.QueryEndpointInput dataclass.databricks.sdk.service.serving.QueryRequest dataclass to QueryEndpointInput.list() method for w.clean_rooms workspace-level service to require request of databricks.sdk.service.sharing.ListCleanRoomsRequest dataclass.API Changes:
databricks.sdk.service.catalog.ListAccountMetastoreAssignmentsResponse dataclass.job_parameters field for databricks.sdk.service.jobs.RepairRun.job_parameters field for databricks.sdk.service.jobs.RunParameters.notifications field for databricks.sdk.service.pipelines.CreatePipeline.notifications field for databricks.sdk.service.pipelines.EditPipeline.notifications field for databricks.sdk.service.pipelines.PipelineSpec.databricks.sdk.service.pipelines.Notifications dataclass.databricks.sdk.service.serving.DataframeSplitInput dataclass.databricks.sdk.service.settings.DefaultNamespaceSetting dataclass.databricks.sdk.service.settings.DeleteDefaultWorkspaceNamespaceRequest dataclass.databricks.sdk.service.settings.DeleteDefaultWorkspaceNamespaceResponse dataclass.databricks.sdk.service.settings.ReadDefaultWorkspaceNamespaceRequest dataclass.databricks.sdk.service.settings.StringMessage dataclass.databricks.sdk.service.settings.UpdateDefaultWorkspaceNamespaceRequest dataclass.next_page_token field for databricks.sdk.service.sharing.ListCleanRoomsResponse.databricks.sdk.service.sharing.ListCleanRoomsRequest dataclass.OpenAPI SHA: bcbf6e851e3d82fd910940910dd31c10c059746c, Date: 2023-10-02
Don't try to import runtime_auth when not in runtime (#327).
DatabricksError (#353).API Changes:
list() method for a.account_metastore_assignments account-level service to return databricks.sdk.service.catalog.WorkspaceIdList dataclass.artifact_matchers field for databricks.sdk.service.catalog.ArtifactAllowlistInfo to databricks.sdk.service.catalog.ArtifactMatcherList dataclass.artifact_matchers field for databricks.sdk.service.catalog.SetArtifactAllowlist to databricks.sdk.service.catalog.ArtifactMatcherList dataclass.databricks.sdk.service.catalog.WorkspaceId dataclass.cancel_all_runs() method for w.jobs workspace-level service with new required argument order.job_id field for databricks.sdk.service.jobs.CancelAllRuns to no longer be required.all_queued_runs field for databricks.sdk.service.jobs.CancelAllRuns.queue field for databricks.sdk.service.jobs.CreateJob.queue field for databricks.sdk.service.jobs.JobSettings.queue field for databricks.sdk.service.jobs.RunNow.queue_reason field for databricks.sdk.service.jobs.RunState.queue_duration field for databricks.sdk.service.jobs.RunTask.queue field for databricks.sdk.service.jobs.SubmitRun.databricks.sdk.service.jobs.QueueSettings dataclass.databricks.sdk.service.oauth2.GetPublishedAppsOutput dataclass.databricks.sdk.service.oauth2.ListOAuthPublishedAppsRequest dataclass.databricks.sdk.service.oauth2.PublishedAppOutput dataclass.patch() method for w.serving_endpoints workspace-level service.tags field for databricks.sdk.service.serving.CreateServingEndpoint.tags field for databricks.sdk.service.serving.ServingEndpoint.tags field for databricks.sdk.service.serving.ServingEndpointDetailed.databricks.sdk.service.serving.EndpointTag dataclass.databricks.sdk.service.serving.PatchServingEndpointTags dataclass.databricks.sdk.service.settings.ExchangeToken dataclass.databricks.sdk.service.settings.ExchangeTokenRequest dataclass.databricks.sdk.service.settings.ExchangeTokenResponse dataclass.databricks.sdk.service.settings.PartitionId dataclass.databricks.sdk.service.settings.TokenType dataclass.execute_statement() method for w.statement_execution workspace-level service with new required argument order.empty_result_state field for databricks.sdk.service.sql.AlertOptions.databricks.sdk.service.sql.ChunkInfo dataclass.on_wait_timeout field for databricks.sdk.service.sql.ExecuteStatementRequest to databricks.sdk.service.sql.ExecuteStatementRequestOnWaitTimeout dataclass.statement field for databricks.sdk.service.sql.ExecuteStatementRequest to be required.warehouse_id field for databricks.sdk.service.sql.ExecuteStatementRequest to be required.chunks field for databricks.sdk.service.sql.ResultManifest to databricks.sdk.service.sql.BaseChunkInfoList dataclass.truncated field for databricks.sdk.service.sql.ResultManifest.databricks.sdk.service.sql.TimeoutAction dataclass.databricks.sdk.service.sql.AlertOptionsEmptyResultState dataclass.databricks.sdk.service.sql.BaseChunkInfo dataclass.databricks.sdk.service.sql.ExecuteStatementRequestOnWaitTimeout dataclass.OpenAPI SHA: b52a3b410976501f08f76ca0b355fb2dca876953, Date: 2023-09-15
Fixed redeclared test_streaming_response_read_partial test (#335).
test_streaming_response_read_partial test (#335).Incorrect type warning (#336).API Changes:
get_job_permission_levels -> get_permission_levelsget_job_permissions -> get_permissionsset_job_permissions -> set_permissionsupdate_job_permissions -> update_permissionscreate() method for w.volumes workspace-level service with new required argument order.supports_elastic_disk field for databricks.sdk.service.compute.NodeType.create() method for w.dashboards workspace-level service with new required argument order.name field for databricks.sdk.service.sql.CreateDashboardRequest to be required.dashboard_filters_enabled field for databricks.sdk.service.sql.CreateDashboardRequest.run_as_role field for databricks.sdk.service.sql.CreateDashboardRequest.run_as_role field for databricks.sdk.service.sql.Query.run_as_role field for databricks.sdk.service.sql.QueryPostContent.dashboard_id field for databricks.sdk.service.sql.WidgetOptions.position field for databricks.sdk.service.sql.WidgetOptions to databricks.sdk.service.sql.WidgetPosition dataclass.text field for databricks.sdk.service.sql.WidgetOptions.description field for databricks.sdk.service.sql.WidgetOptions.title field for databricks.sdk.service.sql.WidgetOptions.databricks.sdk.service.sql.CreateQueryVisualizationRequest dataclass.databricks.sdk.service.sql.CreateWidget dataclass.databricks.sdk.service.sql.DeleteDashboardWidgetRequest dataclass.databricks.sdk.service.sql.DeleteQueryVisualizationRequest dataclass.databricks.sdk.service.sql.RunAsRole dataclass.databricks.sdk.service.sql.WidgetPosition dataclass.OpenAPI SHA: 09a7fa63d9ae243e5407941f200960ca14d48b07, Date: 2023-09-04
Improve file download performance (#319).
Added support for GZIP'ed streaming responses (#306).
Breaking Changes:
src to contents, and w.files.download() now returns a files.DownloadResponse, whose contents field is a BinaryIO object. When reading a download, the user must explicitly close this object to allow the connection to return to the connection pool.Breaking API Changes:
list() method for a.account_storage_credentials account-level service to return databricks.sdk.service.catalog.StorageCredentialInfoList dataclass.instance_pool_fleet_attributes field for databricks.sdk.service.compute.CreateInstancePool.instance_pool_fleet_attributes field for databricks.sdk.service.compute.EditInstancePool.databricks.sdk.service.compute.FleetLaunchTemplateOverride dataclass.databricks.sdk.service.compute.FleetOnDemandOption dataclass.databricks.sdk.service.compute.FleetOnDemandOptionAllocationStrategy dataclass.databricks.sdk.service.compute.FleetSpotOption dataclass.databricks.sdk.service.compute.FleetSpotOptionAllocationStrategy dataclass.instance_pool_fleet_attributes field for databricks.sdk.service.compute.GetInstancePool.instance_pool_fleet_attributes field for databricks.sdk.service.compute.InstancePoolAndStats.databricks.sdk.service.compute.InstancePoolFleetAttributes dataclass.get_by_name() method for w.experiments workspace-level service to return databricks.sdk.service.ml.GetExperimentResponse dataclass.get_experiment() method for w.experiments workspace-level service to return databricks.sdk.service.ml.GetExperimentResponse dataclass.databricks.sdk.service.ml.GetExperimentByNameResponse dataclass to databricks.sdk.service.ml.GetExperimentResponse.databricks.sdk.service.catalog.ProvisioningState to databricks.sdk.service.catalog.ProvisioningInfoState dataclass.API Changes:
browse_only field for databricks.sdk.service.catalog.CatalogInfo.full_name field for databricks.sdk.service.catalog.CatalogInfo.provisioning_info field for databricks.sdk.service.catalog.CatalogInfo.securable_kind field for databricks.sdk.service.catalog.CatalogInfo.securable_type field for databricks.sdk.service.catalog.CatalogInfo.provisioning_info field for databricks.sdk.service.catalog.ConnectionInfo.options field for databricks.sdk.service.catalog.CreateCatalog.options field for databricks.sdk.service.catalog.UpdateCatalog.databricks.sdk.service.catalog.CatalogInfoSecurableKind dataclass.databricks.sdk.service.catalog.CreateRegisteredModelRequest dataclass.databricks.sdk.service.catalog.DeleteAliasRequest dataclass.databricks.sdk.service.catalog.DeleteModelVersionRequest dataclass.databricks.sdk.service.catalog.DeleteRegisteredModelRequest dataclass.databricks.sdk.service.catalog.GetByAliasRequest dataclass.databricks.sdk.service.catalog.GetModelVersionRequest dataclass.databricks.sdk.service.catalog.GetRegisteredModelRequest dataclass.databricks.sdk.service.catalog.ListModelVersionsRequest dataclass.databricks.sdk.service.catalog.ListModelVersionsResponse dataclass.databricks.sdk.service.catalog.ListRegisteredModelsRequest dataclass.databricks.sdk.service.catalog.ListRegisteredModelsResponse dataclass.databricks.sdk.service.catalog.ModelVersionInfo dataclass.databricks.sdk.service.catalog.ModelVersionInfoStatus dataclass.databricks.sdk.service.catalog.ProvisioningInfo dataclass.databricks.sdk.service.catalog.RegisteredModelAlias dataclass.databricks.sdk.service.catalog.RegisteredModelInfo dataclass.databricks.sdk.service.catalog.SetRegisteredModelAliasRequest dataclass.databricks.sdk.service.catalog.UpdateModelVersionRequest dataclass.databricks.sdk.service.catalog.UpdateRegisteredModelRequest dataclass.volumes field for databricks.sdk.service.compute.InitScriptInfo.databricks.sdk.service.compute.VolumesStorageInfo dataclass.databricks.sdk.service.files.DeleteFileRequest dataclass.databricks.sdk.service.files.DownloadRequest dataclass.databricks.sdk.service.files.DownloadResponse dataclass.databricks.sdk.service.files.UploadRequest dataclass.custom_tags field for databricks.sdk.service.provisioning.CreateWorkspaceRequest.custom_tags field for databricks.sdk.service.provisioning.UpdateWorkspaceRequest.custom_tags field for databricks.sdk.service.provisioning.Workspace.databricks.sdk.service.provisioning.CustomTags dataclass.parameters field for databricks.sdk.service.sql.ExecuteStatementRequest.row_limit field for databricks.sdk.service.sql.ExecuteStatementRequest.databricks.sdk.service.sql.StatementParameterListItem dataclass.SDK Internal Changes:
OpenAPI SHA: 5d0ccbb790d341eae8e85321a685a9e9e2d5bf24, Date: 2023-08-29
Added collection of Databricks Runtime versions used together with Python SDK (#287).
w.clusters.ensure_cluster_is_running(id) when cluster is simultaneously started by two different processes.
(#283).Development Status :: 4 - Beta (#291).New Services:
databricks.sdk.service.catalog.ArtifactAllowlistInfo dataclass.databricks.sdk.service.catalog.ArtifactMatcher dataclass.databricks.sdk.service.catalog.ArtifactType dataclass.databricks.sdk.service.catalog.GetArtifactAllowlistRequest dataclass.databricks.sdk.service.catalog.ListSecurableTagsRequest dataclass.databricks.sdk.service.catalog.ListSecurableType dataclass.databricks.sdk.service.catalog.ListSubentityTagsRequest dataclass.databricks.sdk.service.catalog.MatchType dataclass.databricks.sdk.service.catalog.SetArtifactAllowlist dataclass.databricks.sdk.service.catalog.TagChanges dataclass.databricks.sdk.service.catalog.TagKeyValuePair dataclass.databricks.sdk.service.catalog.TagSecurable dataclass.databricks.sdk.service.catalog.TagSecurableAssignment dataclass.databricks.sdk.service.catalog.TagSecurableAssignmentsList dataclass.databricks.sdk.service.catalog.TagSubentity dataclass.databricks.sdk.service.catalog.TagSubentityAssignmentsList dataclass.databricks.sdk.service.catalog.TagsSubentityAssignment dataclass.databricks.sdk.service.catalog.UpdateSecurableType dataclass.databricks.sdk.service.catalog.UpdateTags dataclass.New APIs:
delete_runs() method for w.experiments workspace-level service.restore_runs() method for w.experiments workspace-level service.databricks.sdk.service.ml.DeleteRuns dataclass.databricks.sdk.service.ml.DeleteRunsResponse dataclass.databricks.sdk.service.ml.RestoreRuns dataclass.databricks.sdk.service.ml.RestoreRunsResponse dataclass.get_secret() method for w.secrets workspace-level service.databricks.sdk.service.workspace.GetSecretRequest dataclass.databricks.sdk.service.workspace.GetSecretResponse dataclass.Service Renames:
effective_auto_maintenance_flag field for databricks.sdk.service.catalog.CatalogInfo.enable_auto_maintenance field for databricks.sdk.service.catalog.CatalogInfo.effective_predictive_optimization_flag field for databricks.sdk.service.catalog.CatalogInfo.enable_predictive_optimization field for databricks.sdk.service.catalog.CatalogInfo.databricks.sdk.service.catalog.EffectiveAutoMaintenanceFlag dataclass.databricks.sdk.service.catalog.EffectiveAutoMaintenanceFlagInheritedFromType dataclass.databricks.sdk.service.catalog.EnableAutoMaintenance dataclass.effective_auto_maintenance_flag field for databricks.sdk.service.catalog.SchemaInfo.enable_auto_maintenance field for databricks.sdk.service.catalog.SchemaInfo.effective_predictive_optimization_flag field for databricks.sdk.service.catalog.SchemaInfo.enable_predictive_optimization field for databricks.sdk.service.catalog.SchemaInfo.effective_auto_maintenance_flag field for databricks.sdk.service.catalog.TableInfo.enable_auto_maintenance field for databricks.sdk.service.catalog.TableInfo.effective_predictive_optimization_flag field for databricks.sdk.service.catalog.TableInfo.enable_predictive_optimization field for databricks.sdk.service.catalog.TableInfo.databricks.sdk.service.catalog.EffectivePredictiveOptimizationFlag dataclass.databricks.sdk.service.catalog.EffectivePredictiveOptimizationFlagInheritedFromType dataclass.databricks.sdk.service.catalog.EnablePredictiveOptimization dataclass.OpenAPI SHA: beff621d7b3e1d59244e2e34fc53a496f310e130, Date: 2023-08-17
Added connection_pool_size configuration property (preview) (#276).
connection_pool_size configuration property (preview) (#276).WorkspaceClient where DATABRICKS_ACCOUNT_ID is present in the environment (#273).API Changes:
create() method for a.account_storage_credentials account-level service to return databricks.sdk.service.catalog.AccountsStorageCredentialInfo dataclass.get() method for a.account_storage_credentials account-level service to return databricks.sdk.service.catalog.AccountsStorageCredentialInfo dataclass.update() method for a.account_storage_credentials account-level service to return databricks.sdk.service.catalog.AccountsStorageCredentialInfo dataclass.create() method for w.connections workspace-level service with new required argument order.update() method for w.connections workspace-level service with new required argument order.options_kvpairs field for databricks.sdk.service.catalog.ConnectionInfo.properties_kvpairs field for databricks.sdk.service.catalog.ConnectionInfo.options field for databricks.sdk.service.catalog.ConnectionInfo.properties field for databricks.sdk.service.catalog.ConnectionInfo.provisioning_state field for databricks.sdk.service.catalog.ConnectionInfo.securable_kind field for databricks.sdk.service.catalog.ConnectionInfo.securable_type field for databricks.sdk.service.catalog.ConnectionInfo.options_kvpairs field for databricks.sdk.service.catalog.CreateConnection.properties_kvpairs field for databricks.sdk.service.catalog.CreateConnection.options field for databricks.sdk.service.catalog.CreateConnection.properties field for databricks.sdk.service.catalog.CreateConnection.algorithm field for databricks.sdk.service.catalog.SseEncryptionDetails to no longer be required.options_kvpairs field for databricks.sdk.service.catalog.UpdateConnection.options field for databricks.sdk.service.catalog.UpdateConnection.databricks.sdk.service.catalog.AccountsStorageCredentialInfo dataclass.databricks.sdk.service.catalog.ConnectionInfoSecurableKind dataclass.databricks.sdk.service.catalog.ProvisioningState dataclass.data_security_mode field for databricks.sdk.service.compute.CreateCluster.docker_image field for databricks.sdk.service.compute.CreateCluster.single_user_name field for databricks.sdk.service.compute.CreateCluster.schema field for databricks.sdk.service.iam.PartialUpdate.schemas field for databricks.sdk.service.iam.PartialUpdate.OpenAPI SHA: 1e3533f94335f0e6c5d9262bc1fea95b3ddcb0e1, Date: 2023-08-11
To simplify documentation and management of object permissions, this release features a major reorganization of how permissions APIs are structured in
To simplify documentation and management of object permissions, this release features a major reorganization of how permissions APIs are structured in the SDK. Rather than using a single permissions.get() API for all services, each service supporting permissions has its own permissions APIs. Follow these steps to migrate to the current SDK:
w.permissions.get() and w.permissions.get_by_request_object_id_and_request_object_type() to w.<Service>.get_<Service>_permissions()w.permissions.get_permission_levels() to w.<Service>.get_<Service>_permission_levels()w.permissions.set() to w.<Service>.set_<Service>_permissions()w.permissions.update() to w.<Service>.update_<Service>_permissions()API Changes:
get_cluster_policy_permission_levels() method for w.cluster_policies workspace-level service.get_cluster_policy_permissions() method for w.cluster_policies workspace-level service.set_cluster_policy_permissions() method for w.cluster_policies workspace-level service.update_cluster_policy_permissions() method for w.cluster_policies workspace-level service.get_cluster_permission_levels() method for w.clusters workspace-level service.get_cluster_permissions() method for w.clusters workspace-level service.set_cluster_permissions() method for w.clusters workspace-level service.update_cluster_permissions() method for w.clusters workspace-level service.get_instance_pool_permission_levels() method for w.instance_pools workspace-level service.get_instance_pool_permissions() method for w.instance_pools workspace-level service.set_instance_pool_permissions() method for w.instance_pools workspace-level service.update_instance_pool_permissions() method for w.instance_pools workspace-level service.databricks.sdk.service.compute.ClusterAccessControlRequest dataclass.databricks.sdk.service.compute.ClusterAccessControlResponse dataclass.databricks.sdk.service.compute.ClusterPermission dataclass.databricks.sdk.service.compute.ClusterPermissionLevel dataclass.databricks.sdk.service.compute.ClusterPermissions dataclass.databricks.sdk.service.compute.ClusterPermissionsDescription dataclass.databricks.sdk.service.compute.ClusterPermissionsRequest dataclass.databricks.sdk.service.compute.ClusterPolicyAccessControlRequest dataclass.databricks.sdk.service.compute.ClusterPolicyAccessControlResponse dataclass.databricks.sdk.service.compute.ClusterPolicyPermission dataclass.databricks.sdk.service.compute.ClusterPolicyPermissionLevel dataclass.databricks.sdk.service.compute.ClusterPolicyPermissions dataclass.databricks.sdk.service.compute.ClusterPolicyPermissionsDescription dataclass.databricks.sdk.service.compute.ClusterPolicyPermissionsRequest dataclass.databricks.sdk.service.compute.GetClusterPermissionLevelsRequest dataclass.databricks.sdk.service.compute.GetClusterPermissionLevelsResponse dataclass.databricks.sdk.service.compute.GetClusterPermissionsRequest dataclass.databricks.sdk.service.compute.GetClusterPolicyPermissionLevelsRequest dataclass.databricks.sdk.service.compute.GetClusterPolicyPermissionLevelsResponse dataclass.databricks.sdk.service.compute.GetClusterPolicyPermissionsRequest dataclass.databricks.sdk.service.compute.GetInstancePoolPermissionLevelsRequest dataclass.databricks.sdk.service.compute.GetInstancePoolPermissionLevelsResponse dataclass.databricks.sdk.service.compute.GetInstancePoolPermissionsRequest dataclass.databricks.sdk.service.compute.InstancePoolAccessControlRequest dataclass.databricks.sdk.service.compute.InstancePoolAccessControlResponse dataclass.databricks.sdk.service.compute.InstancePoolPermission dataclass.databricks.sdk.service.compute.InstancePoolPermissionLevel dataclass.databricks.sdk.service.compute.InstancePoolPermissions dataclass.databricks.sdk.service.compute.InstancePoolPermissionsDescription dataclass.databricks.sdk.service.compute.InstancePoolPermissionsRequest dataclass.set() method for w.permissions workspace-level service to start returning databricks.sdk.service.iam.ObjectPermissions dataclass.update() method for w.permissions workspace-level service to start returning databricks.sdk.service.iam.ObjectPermissions dataclass.get_password_permission_levels() method for w.users workspace-level service.get_password_permissions() method for w.users workspace-level service.set_password_permissions() method for w.users workspace-level service.update_password_permissions() method for w.users workspace-level service.display_name field for databricks.sdk.service.iam.AccessControlResponse.roles field for databricks.sdk.service.iam.GetAssignableRolesForResourceResponse to databricks.sdk.service.iam.RoleList dataclass.databricks.sdk.service.iam.GetPasswordPermissionLevelsResponse dataclass.databricks.sdk.service.iam.PasswordAccessControlRequest dataclass.databricks.sdk.service.iam.PasswordAccessControlResponse dataclass.databricks.sdk.service.iam.PasswordPermission dataclass.databricks.sdk.service.iam.PasswordPermissionLevel dataclass.databricks.sdk.service.iam.PasswordPermissions dataclass.databricks.sdk.service.iam.PasswordPermissionsDescription dataclass.databricks.sdk.service.iam.PasswordPermissionsRequest dataclass.databricks.sdk.service.iam.Role dataclass.get_job_permission_levels() method for w.jobs workspace-level service.get_job_permissions() method for w.jobs workspace-level service.set_job_permissions() method for w.jobs workspace-level service.update_job_permissions() method for w.jobs workspace-level service.databricks.sdk.service.jobs.GetJobPermissionLevelsRequest dataclass.databricks.sdk.service.jobs.GetJobPermissionLevelsResponse dataclass.databricks.sdk.service.jobs.GetJobPermissionsRequest dataclass.databricks.sdk.service.jobs.JobAccessControlRequest dataclass.databricks.sdk.service.jobs.JobAccessControlResponse dataclass.databricks.sdk.service.jobs.JobPermission dataclass.databricks.sdk.service.jobs.JobPermissionLevel dataclass.databricks.sdk.service.jobs.JobPermissions dataclass.databricks.sdk.service.jobs.JobPermissionsDescription dataclass.databricks.sdk.service.jobs.JobPermissionsRequest dataclass.get_experiment_permission_levels() method for w.experiments workspace-level service.get_experiment_permissions() method for w.experiments workspace-level service.set_experiment_permissions() method for w.experiments workspace-level service.update_experiment_permissions() method for w.experiments workspace-level service.get_registered_model_permission_levels() method for w.model_registry workspace-level service.get_registered_model_permissions() method for w.model_registry workspace-level service.set_registered_model_permissions() method for w.model_registry workspace-level service.update_registered_model_permissions() method for w.model_registry workspace-level service.databricks.sdk.service.ml.ExperimentAccessControlRequest dataclass.databricks.sdk.service.ml.ExperimentAccessControlResponse dataclass.databricks.sdk.service.ml.ExperimentPermission dataclass.databricks.sdk.service.ml.ExperimentPermissionLevel dataclass.databricks.sdk.service.ml.ExperimentPermissions dataclass.databricks.sdk.service.ml.ExperimentPermissionsDescription dataclass.databricks.sdk.service.ml.ExperimentPermissionsRequest dataclass.databricks.sdk.service.ml.GetExperimentPermissionLevelsRequest dataclass.databricks.sdk.service.ml.GetExperimentPermissionLevelsResponse dataclass.databricks.sdk.service.ml.GetExperimentPermissionsRequest dataclass.databricks.sdk.service.ml.GetRegisteredModelPermissionLevelsRequest dataclass.databricks.sdk.service.ml.GetRegisteredModelPermissionLevelsResponse dataclass.databricks.sdk.service.ml.GetRegisteredModelPermissionsRequest dataclass.databricks.sdk.service.ml.RegisteredModelAccessControlRequest dataclass.databricks.sdk.service.ml.RegisteredModelAccessControlResponse dataclass.databricks.sdk.service.ml.RegisteredModelPermission dataclass.databricks.sdk.service.ml.RegisteredModelPermissionLevel dataclass.databricks.sdk.service.ml.RegisteredModelPermissions dataclass.databricks.sdk.service.ml.RegisteredModelPermissionsDescription dataclass.databricks.sdk.service.ml.RegisteredModelPermissionsRequest dataclass.scopes field for databricks.sdk.service.oauth2.CreateCustomAppIntegration.get_pipeline_permission_levels() method for w.pipelines workspace-level service.get_pipeline_permissions() method for w.pipelines workspace-level service.set_pipeline_permissions() method for w.pipelines workspace-level service.update_pipeline_permissions() method for w.pipelines workspace-level service.databricks.sdk.service.pipelines.GetPipelinePermissionLevelsRequest dataclass.databricks.sdk.service.pipelines.GetPipelinePermissionLevelsResponse dataclass.databricks.sdk.service.pipelines.GetPipelinePermissionsRequest dataclass.databricks.sdk.service.pipelines.PipelineAccessControlRequest dataclass.databricks.sdk.service.pipelines.PipelineAccessControlResponse dataclass.databricks.sdk.service.pipelines.PipelinePermission dataclass.databricks.sdk.service.pipelines.PipelinePermissionLevel dataclass.databricks.sdk.service.pipelines.PipelinePermissions dataclass.databricks.sdk.service.pipelines.PipelinePermissionsDescription dataclass.databricks.sdk.service.pipelines.PipelinePermissionsRequest dataclass.gcp_managed_network_config field for databricks.sdk.service.provisioning.CreateWorkspaceRequest.gke_config field for databricks.sdk.service.provisioning.CreateWorkspaceRequest.get_serving_endpoint_permission_levels() method for w.serving_endpoints workspace-level service.get_serving_endpoint_permissions() method for w.serving_endpoints workspace-level service.set_serving_endpoint_permissions() method for w.serving_endpoints workspace-level service.update_serving_endpoint_permissions() method for w.serving_endpoints workspace-level service.instance_profile_arn field for databricks.sdk.service.serving.ServedModelInput.instance_profile_arn field for databricks.sdk.service.serving.ServedModelOutput.databricks.sdk.service.serving.GetServingEndpointPermissionLevelsRequest dataclass.databricks.sdk.service.serving.GetServingEndpointPermissionLevelsResponse dataclass.databricks.sdk.service.serving.GetServingEndpointPermissionsRequest dataclass.databricks.sdk.service.serving.ServingEndpointAccessControlRequest dataclass.databricks.sdk.service.serving.ServingEndpointAccessControlResponse dataclass.databricks.sdk.service.serving.ServingEndpointPermission dataclass.databricks.sdk.service.serving.ServingEndpointPermissionLevel dataclass.databricks.sdk.service.serving.ServingEndpointPermissions dataclass.databricks.sdk.service.serving.ServingEndpointPermissionsDescription dataclass.databricks.sdk.service.serving.ServingEndpointPermissionsRequest dataclass.get_token_permission_levels() method for w.token_management workspace-level service.get_token_permissions() method for w.token_management workspace-level service.set_token_permissions() method for w.token_management workspace-level service.update_token_permissions() method for w.token_management workspace-level service.databricks.sdk.service.settings.GetTokenPermissionLevelsResponse dataclass.databricks.sdk.service.settings.TokenAccessControlRequest dataclass.databricks.sdk.service.settings.TokenAccessControlResponse dataclass.databricks.sdk.service.settings.TokenPermission dataclass.databricks.sdk.service.settings.TokenPermissionLevel dataclass.databricks.sdk.service.settings.TokenPermissions dataclass.databricks.sdk.service.settings.TokenPermissionsDescription dataclass.databricks.sdk.service.settings.TokenPermissionsRequest dataclass.get_warehouse_permission_levels() method for w.warehouses workspace-level service.get_warehouse_permissions() method for w.warehouses workspace-level service.set_warehouse_permissions() method for w.warehouses workspace-level service.update_warehouse_permissions() method for w.warehouses workspace-level service.can_subscribe_to_live_query field for databricks.sdk.service.sql.QueryInfo.queued_overload_time_ms field for databricks.sdk.service.sql.QueryMetrics.queued_provisioning_time_ms field for databricks.sdk.service.sql.QueryMetrics.total_files_count field for databricks.sdk.service.sql.QueryMetrics.total_partitions_count field for databricks.sdk.service.sql.QueryMetrics.metadata_time_ms field for databricks.sdk.service.sql.QueryMetrics.overloading_queue_start_timestamp field for databricks.sdk.service.sql.QueryMetrics.planning_phases field for databricks.sdk.service.sql.QueryMetrics.planning_time_ms field for databricks.sdk.service.sql.QueryMetrics.provisioning_queue_start_timestamp field for databricks.sdk.service.sql.QueryMetrics.pruned_bytes field for databricks.sdk.service.sql.QueryMetrics.pruned_files_count field for databricks.sdk.service.sql.QueryMetrics.query_compilation_start_timestamp field for databricks.sdk.service.sql.QueryMetrics.query_execution_time_ms field for databricks.sdk.service.sql.QueryMetrics.databricks.sdk.service.sql.GetWarehousePermissionLevelsRequest dataclass.databricks.sdk.service.sql.GetWarehousePermissionLevelsResponse dataclass.databricks.sdk.service.sql.GetWarehousePermissionsRequest dataclass.databricks.sdk.service.sql.WarehouseAccessControlRequest dataclass.databricks.sdk.service.sql.WarehouseAccessControlResponse dataclass.databricks.sdk.service.sql.WarehousePermission dataclass.databricks.sdk.service.sql.WarehousePermissionLevel dataclass.databricks.sdk.service.sql.WarehousePermissions dataclass.databricks.sdk.service.sql.WarehousePermissionsDescription dataclass.databricks.sdk.service.sql.WarehousePermissionsRequest dataclass.get_repo_permission_levels() method for w.repos workspace-level service.get_repo_permissions() method for w.repos workspace-level service.set_repo_permissions() method for w.repos workspace-level service.update_repo_permissions() method for w.repos workspace-level service.get_workspace_object_permission_levels() method for w.workspace workspace-level service.get_workspace_object_permissions() method for w.workspace workspace-level service.set_workspace_object_permissions() method for w.workspace workspace-level service.update_workspace_object_permissions() method for w.workspace workspace-level service.databricks.sdk.service.workspace.GetRepoPermissionLevelsRequest dataclass.databricks.sdk.service.workspace.GetRepoPermissionLevelsResponse dataclass.databricks.sdk.service.workspace.GetRepoPermissionsRequest dataclass.databricks.sdk.service.workspace.GetWorkspaceObjectPermissionLevelsRequest dataclass.databricks.sdk.service.workspace.GetWorkspaceObjectPermissionLevelsResponse dataclass.databricks.sdk.service.workspace.GetWorkspaceObjectPermissionsRequest dataclass.databricks.sdk.service.workspace.RepoAccessControlRequest dataclass.databricks.sdk.service.workspace.RepoAccessControlResponse dataclass.databricks.sdk.service.workspace.RepoPermission dataclass.databricks.sdk.service.workspace.RepoPermissionLevel dataclass.databricks.sdk.service.workspace.RepoPermissions dataclass.databricks.sdk.service.workspace.RepoPermissionsDescription dataclass.databricks.sdk.service.workspace.RepoPermissionsRequest dataclass.databricks.sdk.service.workspace.WorkspaceObjectAccessControlRequest dataclass.databricks.sdk.service.workspace.WorkspaceObjectAccessControlResponse dataclass.databricks.sdk.service.workspace.WorkspaceObjectPermission dataclass.databricks.sdk.service.workspace.WorkspaceObjectPermissionLevel dataclass.databricks.sdk.service.workspace.WorkspaceObjectPermissions dataclass.databricks.sdk.service.workspace.WorkspaceObjectPermissionsDescription dataclass.databricks.sdk.service.workspace.WorkspaceObjectPermissionsRequest dataclass.OpenAPI SHA: 386b65ecdc825b9c3ed4aa7ca88e2e5baf9d87df, Date: 2023-08-07
Added timeout to w.clusters.ensure_cluster_running() (#227).
Fixed serialization of lists of enum values (#248).
__annotations__ (#239).API Changes:
create() method for a.account_metastore_assignments account-level service to no longer return databricks.sdk.service.catalog.CreateMetastoreAssignmentsResponseItemList dataclass.connection_name field for databricks.sdk.service.catalog.CreateCatalog.access_point field for databricks.sdk.service.catalog.CreateExternalLocation.encryption_details field for databricks.sdk.service.catalog.CreateExternalLocation.databricks.sdk.service.catalog.CreateMetastoreAssignmentsResponseItem dataclass.access_point field for databricks.sdk.service.catalog.ExternalLocationInfo.encryption_details field for databricks.sdk.service.catalog.ExternalLocationInfo.access_point field for databricks.sdk.service.catalog.TableInfo.encryption_details field for databricks.sdk.service.catalog.TableInfo.access_point field for databricks.sdk.service.catalog.UpdateExternalLocation.encryption_details field for databricks.sdk.service.catalog.UpdateExternalLocation.access_point field for databricks.sdk.service.catalog.VolumeInfo.encryption_details field for databricks.sdk.service.catalog.VolumeInfo.databricks.sdk.service.catalog.EncryptionDetails dataclass.databricks.sdk.service.catalog.SseEncryptionDetails dataclass.databricks.sdk.service.catalog.SseEncryptionDetailsAlgorithm dataclass.databricks.sdk.service.settings.AccountNetworkPolicyMessage dataclass.databricks.sdk.service.settings.DeleteAccountNetworkPolicyRequest dataclass.databricks.sdk.service.settings.DeleteAccountNetworkPolicyResponse dataclass.databricks.sdk.service.settings.ReadAccountNetworkPolicyRequest dataclass.databricks.sdk.service.settings.UpdateAccountNetworkPolicyRequest dataclass.OpenAPI SHA: a1b6c1ecfaab6635911d3c060a8dd797ac6b2d4d, Date: 2023-07-27
__annotations__ by @MichaelSpece in https://github.com/databricks/databricks-sdk-py/pull/239Full Changelog: https://github.com/databricks/databricks-sdk-py/compare/v0.2.1...v0.3.0
Support older versions of urllib3 and Databricks Runtime with regards to DEFAULT_METHOD_WHITELIST change to DEFAULT_ALLOWED_METHODS (#240).
urllib3 and Databricks Runtime with regards to DEFAULT_METHOD_WHITELIST change to DEFAULT_ALLOWED_METHODS (#240).Fixed notebook native auth for jobs (#209).
datatime.timedelta() with datetime.timedelta() in codebase (#207).dbutils.widgets (#93)..codegen.json (#236).databricks.sdk.runtime to improve local editor experience (#219).API Changes:
maintenance() method for w.metastores workspace-level service.enable_optimization() method for w.metastores workspace-level service.update() method for w.tables workspace-level service.force field for databricks.sdk.service.catalog.DeleteAccountMetastoreRequest.force field for databricks.sdk.service.catalog.DeleteAccountStorageCredentialRequest.databricks.sdk.service.catalog.UpdateAutoMaintenance dataclass.databricks.sdk.service.catalog.UpdateAutoMaintenanceResponse dataclass.databricks.sdk.service.catalog.UpdatePredictiveOptimization dataclass.databricks.sdk.service.catalog.UpdatePredictiveOptimizationResponse dataclass.databricks.sdk.service.catalog.UpdateTableRequest dataclass.schema field for databricks.sdk.service.iam.PartialUpdate.databricks.sdk.service.iam.PatchSchema dataclass.trigger_info field for databricks.sdk.service.jobs.BaseRun.health field for databricks.sdk.service.jobs.CreateJob.job_source field for databricks.sdk.service.jobs.GitSource.on_duration_warning_threshold_exceeded field for databricks.sdk.service.jobs.JobEmailNotifications.health field for databricks.sdk.service.jobs.JobSettings.trigger_info field for databricks.sdk.service.jobs.Run.run_job_output field for databricks.sdk.service.jobs.RunOutput.run_job_task field for databricks.sdk.service.jobs.RunTask.email_notifications field for databricks.sdk.service.jobs.SubmitRun.health field for databricks.sdk.service.jobs.SubmitRun.email_notifications field for databricks.sdk.service.jobs.SubmitTask.health field for databricks.sdk.service.jobs.SubmitTask.notification_settings field for databricks.sdk.service.jobs.SubmitTask.health field for databricks.sdk.service.jobs.Task.run_job_task field for databricks.sdk.service.jobs.Task.on_duration_warning_threshold_exceeded field for databricks.sdk.service.jobs.TaskEmailNotifications.on_duration_warning_threshold_exceeded field for databricks.sdk.service.jobs.WebhookNotifications.databricks.sdk.service.jobs.JobSource dataclass.databricks.sdk.service.jobs.JobSourceDirtyState dataclass.databricks.sdk.service.jobs.JobsHealthMetric dataclass.databricks.sdk.service.jobs.JobsHealthOperator dataclass.databricks.sdk.service.jobs.JobsHealthRule dataclass.databricks.sdk.service.jobs.JobsHealthRules dataclass.databricks.sdk.service.jobs.RunJobOutput dataclass.databricks.sdk.service.jobs.RunJobTask dataclass.databricks.sdk.service.jobs.TriggerInfo dataclass.databricks.sdk.service.jobs.WebhookNotificationsOnDurationWarningThresholdExceededItem dataclass.whl field for databricks.sdk.service.pipelines.PipelineLibrary.delete_personal_compute_setting() method for a.account_settings account-level service with new required argument order.read_personal_compute_setting() method for a.account_settings account-level service with new required argument order.etag field for databricks.sdk.service.settings.DeletePersonalComputeSettingRequest to be required.etag field for databricks.sdk.service.settings.ReadPersonalComputeSettingRequest to be required.databricks.sdk.service.sharing.CentralCleanRoomInfo dataclass.databricks.sdk.service.sharing.CleanRoomAssetInfo dataclass.databricks.sdk.service.sharing.CleanRoomCatalog dataclass.databricks.sdk.service.sharing.CleanRoomCatalogUpdate dataclass.databricks.sdk.service.sharing.CleanRoomCollaboratorInfo dataclass.databricks.sdk.service.sharing.CleanRoomInfo dataclass.databricks.sdk.service.sharing.CleanRoomNotebookInfo dataclass.databricks.sdk.service.sharing.CleanRoomTableInfo dataclass.databricks.sdk.service.sharing.ColumnInfo dataclass.databricks.sdk.service.sharing.ColumnMask dataclass.databricks.sdk.service.sharing.ColumnTypeName dataclass.databricks.sdk.service.sharing.CreateCleanRoom dataclass.databricks.sdk.service.sharing.DeleteCleanRoomRequest dataclass.databricks.sdk.service.sharing.GetCleanRoomRequest dataclass.databricks.sdk.service.sharing.ListCleanRoomsResponse dataclass.databricks.sdk.service.sharing.UpdateCleanRoom dataclass.query field for databricks.sdk.service.sql.Alert to databricks.sdk.service.sql.AlertQuery dataclass.value field for databricks.sdk.service.sql.AlertOptions to any dataclass.is_db_admin field for databricks.sdk.service.sql.User.profile_image_url field for databricks.sdk.service.sql.User.databricks.sdk.service.sql.AlertQuery dataclass.OpenAPI SHA: 0a1949ba96f71680dad30e06973eaae85b1307bb, Date: 2023-07-18
Documentation improvements (#197).
dbutils type stubs consistent with runtime implementation (#196).API changes:
compute.BaseClusterInfo to compute.ClusterSpeccompute.ClusterInfo to compute.ClusterDetailsjobs.JobTaskSettings to jobs.Taskjobs.RunSubmitTaskSettings to jobs.SubmitTaskjobs.JobWebhookNotifications to jobs.WebhookNotificationsjobs.CreateJobFormat to jobs.Formatjobs.GitSourceGitProvider to jobs.GitProviderjobs.FileArrivalTriggerSettings to jobs.FileArrivalTriggerConfigurationAdded Sphinx documentation (#184, #191, #183, #193).
requests version upper bound to <3 (#138).Regenerate from OpenAPI spec (#176).
Optional type hints (#171, #177).Optional (#170).Added new services from OpenAPI spec (#145, #159).
upload(path, IO) and download(path) -> IO across file-related operations (#148).is not None for primitive fields in as_dict() (#147).True to true in query strings (#156).Regenerated from OpenAPI spec (#124).
Added an extensive set of examples (#113).
dbutils.fs.mount and dbutils.fs.updateMount (#119)..netrc when sending unauthenticated requests for OAuth handshake (#108).pyodide friendly (#114).external-browser auth type (#110).RefreshableCredentials to SessionCredentials (#116).az cli on Windows (#117).Preserve original databricks.sdk.runtime for internal purposes (#96).
databricks.sdk.runtime for internal purposes (#96).Pin version of requests to >=2.28.1,<2.29.0, so that we don't get ImportError: urllib3 v2.0 only supports OpenSSL 1.1.1+, currently the 'ssl' module i
requests to >=2.28.1,<2.29.0, so that we don't get ImportError: urllib3 v2.0 only supports OpenSSL 1.1.1+, currently the 'ssl' module is compiled with LibreSSL 2.8.3. See this issue for more information.Removed experimental redacting logger filter for dbutils.secrets.get('scope', 'key'), that was causing Jupyter Kernels to hang (#92).
Removed redundant newlines from AAD OAuth responses (#85).
Fix dbutils.fs.put() utility by @nfx in https://github.com/databricks/databricks-sdk-py/pull/82
dbutils.fs.put() utility by @nfx in https://github.com/databricks/databricks-sdk-py/pull/82Full Changelog: https://github.com/databricks/databricks-sdk-py/compare/v0.1.1...v0.1.2
* Improve Azure AD auth (#80).
Make code working with new OpenAPI packaging (#78).
bricks CLI authentication (#66).databricks.sdk.oauth logger for single-request server (#74).API changes:
clusterpolicies APIs to compute package.clusters APIs to compute package.commands APIs to compute package.globalinitscripts APIs to compute package.instancepools APIs to compute package.scim APIs to iam package.permissions APIs to iam package.ipaccesslists APIs to settings package.tokenmanagement APIs to settings package.tokens APIs to settings package.workspaceconf APIs to settings package.gitcredentials APIs to workspace package.repos APIs to workspace package.secrets APIs to workspace package.unitcatalog package to catalog and sharing.mlflow package to ml.dbfs package to files.deployment package to provisioning.endpoints package to serving.clusters.List type to compute.ListClustersRequest.jobs.ListRuns type to jobs.ListRunsRequest.jobs.ExportRun type to jobs.ExportRunRequest.clusterpolicies.List type to compute.ListClusterPoliciesRequest.jobs.List type to jobs.ListJobsRequest.permissions.GetPermissionLevels type to iam.GetPermissionLevelsRequest.pipelines.ListPipelineEvents type to pipelines.ListPipelineEventsRequest.pipelines.ListPipelines type to pipelines.ListPipelinesRequest.workspaceconf.GetStatus type to settings.GetStatusRequest.repos.List type to workspace.ListReposRequest.tokenmanagement.List type to settings.ListTokenManagementRequest.workspace.Export type to workspace.ExportRequest.workspace.List type to workspace.ListWorkspaceRequest.Improve long-running operations by @nfx in https://github.com/databricks/databricks-sdk-py/pull/58
dbutils to WorkspaceClient by @nfx in https://github.com/databricks/databricks-sdk-py/pull/59Full Changelog: https://github.com/databricks/databricks-sdk-py/compare/v0.0.5...v0.0.7
Nothing published for this version
Your coding agent can read these notes before it upgrades. Set up the MCP server →