Releases: databricks/databricks-sdk-py
v0.23.0
Internal changes:
- Add CONTRIBUTING.md (#585).
- Improve diff generation for changelog.
API Changes:
- Added
databricks.sdk.service.catalog.AwsIamRoleResponse
dataclass. - Added
databricks.sdk.service.catalog.AwsIamRoleRequest
dataclass. - Removed
databricks.sdk.service.catalog.AwsIamRole
dataclass. - Changed
aws_iam_role
field fordatabricks.sdk.service.catalog.CreateStorageCredential
todatabricks.sdk.service.catalog.AwsIamRoleRequest
dataclass. - Changed
aws_iam_role
field fordatabricks.sdk.service.catalog.StorageCredentialInfo
todatabricks.sdk.service.catalog.AwsIamRoleResponse
dataclass. - Changed
aws_iam_role
field fordatabricks.sdk.service.catalog.UpdateStorageCredential
todatabricks.sdk.service.catalog.AwsIamRoleRequest
dataclass. - Changed
aws_iam_role
field fordatabricks.sdk.service.catalog.ValidateStorageCredential
todatabricks.sdk.service.catalog.AwsIamRoleRequest
dataclass. - Added
auto_capture_config
field fordatabricks.sdk.service.serving.EndpointPendingConfig
. - Added
databricks.sdk.service.sharing.SharedDataObjectDataObjectType
dataclass. - Changed
data_object_type
field fordatabricks.sdk.service.sharing.SharedDataObject
todatabricks.sdk.service.sharing.SharedDataObjectDataObjectType
dataclass. - Added
content
field fordatabricks.sdk.service.sharing.SharedDataObject
. - Added
embedding_source_columns
field fordatabricks.sdk.service.vectorsearch.DirectAccessVectorIndexSpec
.
OpenAPI SHA: 93763b0d7ae908520c229c786fff28b8fd623261, Date: 2024-03-20
v0.22.0
Bug fixes
- Fix typos in doc string for select_spark_version (#575).
API Changes
- Changed
notifications
field fordatabricks.sdk.service.catalog.CreateMonitor
,databricks.sdk.service.catalog.MonitorInfo
, anddatabricks.sdk.service.catalog.UpdateMonitor
todatabricks.sdk.service.catalog.MonitorNotificationsConfig
dataclass. - Added
browse_only
field fordatabricks.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
, anddatabricks.sdk.service.catalog.VolumeInfo
. - Added
include_browse
field fordatabricks.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
, anddatabricks.sdk.service.catalog.ReadVolumeRequest
. - Changed
publish()
method for w.lakeview workspace-level service to returndatabricks.sdk.service.dashboards.PublishedDashboard
dataclass. - Added
create()
,get()
,get_published()
,trash()
, andupdate()
methods for w.lakeview workspace-level service. - Added
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
, anddatabricks.sdk.service.dashboards.UpdateDashboardRequest
dataclasses.
OpenAPI SHA: c84caf9e5ef531cc0b1ddd0a76970d9a8b664e32, Date: 2024-03-15
v0.21.0
New Features and Improvements
- Fixed get_workspace_client in GCP (#532).
- Use all-apis scope with external-browser (#563).
- Make a best effort attempt to initialise all Databricks globals (#562).
- Fixed type issue with widgets.getArgument (#581)
- Note: Backwards incompatible changes - Settings are now nested, please see the API changes below.
Documentation
- Added Files API docs to the SDK Documentation (#556).
- Added new example to list compute resource for SUBMIT_RUN job runs (#572).
- Sorted index pages by name in docs (#560).
- Added back enums to docs (#557).
API Changes
Added
Services:
- w.permission_migration workspace-level service.
- w.settings.automatic_cluster_update workspace-level service.
- w.settings.csp_enablement workspace-level service.
- a.settings.csp_enablement_account account-level service.
- w.settings.default_namespace workspace-level service.
- w.settings.esm_enablement workspace-level service.
- a.settings.esm_enablement_account account-level service.
- a.settings.personal_compute account-level service.
- w.settings.restrict_workspace_admins workspace-level service.
Dataclasses:
databricks.sdk.service.settings.AutomaticClusterUpdateSetting
databricks.sdk.service.settings.ClusterAutoRestartMessage
databricks.sdk.service.settings.ClusterAutoRestartMessageEnablementDetails
databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindow
databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowDayOfWeek
databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule
databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency
databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime
databricks.sdk.service.settings.ComplianceStandard
databricks.sdk.service.settings.CspEnablement
databricks.sdk.service.settings.CspEnablementAccount
databricks.sdk.service.settings.CspEnablementAccountSetting
databricks.sdk.service.settings.CspEnablementSetting
databricks.sdk.service.settings.DeleteDefaultNamespaceRequest
databricks.sdk.service.settings.DeletePersonalComputeRequest
databricks.sdk.service.settings.DeleteRestrictWorkspaceAdminRequest
databricks.sdk.service.settings.EsmEnablement
databricks.sdk.service.settings.EsmEnablementAccount
databricks.sdk.service.settings.EsmEnablementAccountSetting
databricks.sdk.service.settings.EsmEnablementSetting
databricks.sdk.service.settings.GetAutomaticClusterUpdateRequest
databricks.sdk.service.settings.GetCspEnablementAccountRequest
databricks.sdk.service.settings.GetCspEnablementRequest
databricks.sdk.service.settings.GetDefaultNamespaceRequest
databricks.sdk.service.settings.GetEsmEnablementAccountRequest
databricks.sdk.service.settings.GetEsmEnablementRequest
databricks.sdk.service.settings.GetPersonalComputeRequest
databricks.sdk.service.settings.GetRestrictWorkspaceAdminRequest
databricks.sdk.service.settings.NccAwsStableIpRule
databricks.sdk.service.settings.UpdateAutomaticClusterUpdateSettingRequest
databricks.sdk.service.settings.UpdateCspEnablementAccountSettingRequest
databricks.sdk.service.settings.UpdateCspEnablementSettingRequest
databricks.sdk.service.settings.UpdateEsmEnablementAccountSettingRequest
databricks.sdk.service.settings.UpdateEsmEnablementSettingRequest
databricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindow
databricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindowDayOfWeek
databricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule
databricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency
databricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime
databricks.sdk.service.vectorsearch.ComplianceStandard
databricks.sdk.service.vectorsearch.CspEnablement
databricks.sdk.service.vectorsearch.CspEnablementAccount
databricks.sdk.service.vectorsearch.CspEnablementAccountSetting
databricks.sdk.service.vectorsearch.CspEnablementSetting
databricks.sdk.service.vectorsearch.DeleteDefaultNamespaceRequest
databricks.sdk.service.vectorsearch.DeletePersonalComputeRequest
databricks.sdk.service.vectorsearch.DeleteRestrictWorkspaceAdminRequest
databricks.sdk.service.vectorsearch.EsmEnablement
databricks.sdk.service.vectorsearch.EsmEnablementAccount
databricks.sdk.service.vectorsearch.EsmEnablementAccountSetting
databricks.sdk.service.vectorsearch.EsmEnablementSetting
databricks.sdk.service.vectorsearch.GetAutomaticClusterUpdateRequest
databricks.sdk.service.vectorsearch.GetCspEnablementAccountRequest
databricks.sdk.service.vectorsearch.GetCspEnablementRequest
databricks.sdk.service.vectorsearch.GetDefaultNamespaceRequest
databricks.sdk.service.vectorsearch.GetEsmEnablementAccountRequest
databricks.sdk.service.vectorsearch.GetEsmEnablementRequest
databricks.sdk.service.vectorsearch.GetPersonalComputeRequest
databricks.sdk.service.vectorsearch.GetRestrictWorkspaceAdminRequest
databricks.sdk.service.vectorsearch.NccAwsStableIpRule
databricks.sdk.service.vectorsearch.UpdateAutomaticClusterUpdateSettingRequest
databricks.sdk.service.vectorsearch.UpdateCspEnablementAccountSettingRequest
databricks.sdk.service.vectorsearch.UpdateCspEnablementSettingRequest
databricks.sdk.service.vectorsearch.UpdateEsmEnablementAccountSettingRequest
databricks.sdk.service.vectorsearch.UpdateEsmEnablementSettingRequest
databricks.sdk.service.iam.PermissionMigrationRequest
databricks.sdk.service.iam.PermissionMigrationResponse
Changed
version
field fordatabricks.sdk.service.serving.AppManifest
todatabricks.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 fordatabricks.sdk.service.vectorsearch.CreateVectorIndexRequest
to be required.
Removed
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.
...
v0.20.0
Major Changes:
- Updated behaviour for raw parameter in
ApiClient.do()
method. The raw data is not returned directly anymore, but as part of a dict with thecontents
key. This dict will also contain response headers if returned by the API.
Internal Changes:
- Add get_workspace_id to docgen blocklist (#549).
- Support HEAD operation and response Headers (#547).
API Changes:
- Changed
delete()
,get()
andupdate()
methods for w.connections workspace-level service with new required argument order. - Changed
update()
method for w.lakehouse_monitors workspace-level service with new required argument order. - Changed
delete()
,get()
andupdate()
methods for w.volumes workspace-level service with new required argument order. - Added w.online_tables workspace-level service.
- Renamed
name_arg
field toname
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
. - Removed
full_name_arg
field fordatabricks.sdk.service.catalog.DeleteVolumeRequest
. - Added
name
field fordatabricks.sdk.service.catalog.DeleteVolumeRequest
. - Added
max_results
field fordatabricks.sdk.service.catalog.ListVolumesRequest
. - Added
page_token
field fordatabricks.sdk.service.catalog.ListVolumesRequest
. - Added
next_page_token
field fordatabricks.sdk.service.catalog.ListVolumesResponseContent
. - Removed
full_name_arg
field fordatabricks.sdk.service.catalog.ReadVolumeRequest
. - Added
name
field fordatabricks.sdk.service.catalog.ReadVolumeRequest
. - Removed
assets_dir
field fordatabricks.sdk.service.catalog.UpdateMonitor
. - Removed
full_name_arg
field fordatabricks.sdk.service.catalog.UpdateVolumeRequestContent
. - Added
name
field fordatabricks.sdk.service.catalog.UpdateVolumeRequestContent
. - Added the following catalog dataclasses:
ContinuousUpdateStatus
,DeleteOnlineTableRequest
,FailedStatus
,
GetOnlineTableRequest
,OnlineTable
,OnlineTableSpec
,OnlineTableState
,OnlineTableStatus
,
PipelineProgress
,ProvisioningStatus
,TriggeredUpdateStatus
andViewData
. - Added
get_directory_metadata()
method for w.files workspace-level service. - Added
get_metadata()
method for w.files workspace-level service. - Added
content_length
,content_type
andlast_modified
fields fordatabricks.sdk.service.files.DownloadResponse
. - Added the following files dataclasses:
FileSize
,GetDirectoryMetadataRequest
,GetMetadataRequest
,
GetMetadataResponse
andLastModifiedHttpDate
. - Removed
trigger_history
field fordatabricks.sdk.service.jobs.Job
. - Removed
databricks.sdk.service.jobs.TriggerEvaluation
dataclass. - Removed
databricks.sdk.service.jobs.TriggerHistory
dataclass. - Added
table
field fordatabricks.sdk.service.jobs.TriggerSettings
. - Added
databricks.sdk.service.jobs.Condition
dataclass. - Added
databricks.sdk.service.jobs.TableTriggerConfiguration
dataclass. - Removed
config
field fordatabricks.sdk.service.serving.ExternalModel
. - Removed
databricks.sdk.service.serving.ExternalModelConfig
dataclass. Fields moved todatabricks.sdk.service.serving.ExternalModel
. - Added
max_provisioned_throughput
andmin_provisioned_throughput
fields fordatabricks.sdk.service.serving.ServedEntityInput
. - Added
max_provisioned_throughput
andmin_provisioned_throughput
fields fordatabricks.sdk.service.serving.ServedEntityOutput
. - Changed
delete()
method for w.clean_rooms workspace-level service with new required argument order. - Changed
get()
method for w.clean_rooms workspace-level service with new required argument order. - Changed
update()
method for w.clean_rooms workspace-level service with new required argument order. - Added
enum_options
field fordatabricks.sdk.service.sql.Parameter
. - Added
multi_values_options
field fordatabricks.sdk.service.sql.Parameter
. - Added
query_id
field fordatabricks.sdk.service.sql.Parameter
. - Added
databricks.sdk.service.sql.MultiValuesOptions
dataclass.
OpenAPI SHA: cdd76a98a4fca7008572b3a94427566dd286c63b, Date: 2024-02-19
v0.19.1
v0.19.0
Improvements and Bug Fixes
- Construct workspace client from account client (#527).
- Enabled Databricks OAuth also for Azure and GCP (#526).
- Do not terminate listing for token-based pagination resources on empty response (#530).
- Renamed
databricks.sdk.errors.mapping
todatabricks.sdk.errors.platform
(#522). - Added Union to content (2nd) parameter in upload function (#493).
- Fixed WorkspaceConf.get_status and WorkspaceConf.set_status (#525).
Documentation
API Changes
Additions:
- Added the following dataclasses:
databricks.sdk.service.catalog.CancelRefreshRequest
databricks.sdk.service.catalog.GetRefreshRequest
databricks.sdk.service.catalog.ListRefreshesRequest
databricks.sdk.service.catalog.MonitorRefreshInfo
databricks.sdk.service.catalog.MonitorRefreshInfoState
databricks.sdk.service.catalog.RunRefreshRequest
databricks.sdk.service.compute.Adlsgen2Info
databricks.sdk.service.compute.GcsStorageInfo
databricks.sdk.service.files.CreateDirectoryRequest
databricks.sdk.service.files.DeleteDirectoryRequest
databricks.sdk.service.files.DirectoryEntry
databricks.sdk.service.files.ListDirectoryContentsRequest
databricks.sdk.service.files.ListDirectoryResponse
databricks.sdk.service.files.PageToken
databricks.sdk.service.jobs.ForEachStats
databricks.sdk.service.jobs.ForEachTask
databricks.sdk.service.jobs.ForEachTaskErrorMessageStats
databricks.sdk.service.jobs.ForEachTaskTaskRunStats
databricks.sdk.service.jobs.RunForEachTask
databricks.sdk.service.pipelines.PipelineClusterAutoscale
databricks.sdk.service.pipelines.PipelineClusterAutoscaleMode
databricks.sdk.service.settings.DeleteDefaultNamespaceSettingRequest
databricks.sdk.service.settings.DeleteDefaultNamespaceSettingResponse
databricks.sdk.service.settings.DeleteRestrictWorkspaceAdminsSettingRequest
databricks.sdk.service.settings.DeleteRestrictWorkspaceAdminsSettingResponse
databricks.sdk.service.settings.GetDefaultNamespaceSettingRequest
databricks.sdk.service.settings.GetPersonalComputeSettingRequest
databricks.sdk.service.settings.GetRestrictWorkspaceAdminsSettingRequest
databricks.sdk.service.settings.RestrictWorkspaceAdminsMessage
databricks.sdk.service.settings.RestrictWorkspaceAdminsMessageStatus
databricks.sdk.service.settings.RestrictWorkspaceAdminsSetting
databricks.sdk.service.settings.UpdateDefaultNamespaceSettingRequest
databricks.sdk.service.settings.UpdateRestrictWorkspaceAdminsSettingRequest
- Added
cancel_refresh()
,get_refresh()
,list_refreshes()
andrun_refresh()
method for w.lakehouse_monitors workspace-level service. - Added
use_preemptible_executors
field fordatabricks.sdk.service.compute.GcpAttributes
. - Added
zone_id
field fordatabricks.sdk.service.compute.GcpAttributes
. - Added
abfss
andgcs
field fordatabricks.sdk.service.compute.InitScriptInfo
. - Added
create_directory()
,delete_directory()
andlist_directory_contents()
method for w.files workspace-level service. - Added
source
field fordatabricks.sdk.service.jobs.DbtTask
anddatabricks.sdk.service.jobs.SqlTaskFile
. - Added
for_each_task
field fordatabricks.sdk.service.jobs.RunTask
,databricks.sdk.service.jobs.SubmitTask
anddatabricks.sdk.service.jobs.Task
. - Added
field_mask
field fordatabricks.sdk.service.settings.UpdatePersonalComputeSettingRequest
. - Added
delta_sync_index_spec
field fordatabricks.sdk.service.vectorsearch.CreateVectorIndexRequest
. - Added
file_type
field fordatabricks.sdk.service.workspace.ExportResponse
. - Added
resource_id
field fordatabricks.sdk.service.workspace.ObjectInfo
. - Added
delete_default_namespace_setting()
,delete_restrict_workspace_admins_setting()
,get_default_namespace_setting()
,get_restrict_workspace_admins_setting()
,update_default_namespace_setting()
andupdate_restrict_workspace_admins_setting()
method for w.settings workspace-level service. - Added
get_personal_compute_setting()
method for a.account_settings account-level service.
Removals:
- Removed the following dataclasses:
databricks.sdk.service.settings.ReadDefaultWorkspaceNamespaceRequest
databricks.sdk.service.settings.ReadPersonalComputeSettingRequest
databricks.sdk.service.settings.UpdateDefaultWorkspaceNamespaceRequest
databricks.sdk.service.settings.DeleteDefaultWorkspaceNamespaceRequest
databricks.sdk.service.settings.DeleteDefaultWorkspaceNamespaceResponse
databricks.sdk.service.pipelines.ResetRequest
- Removed the following methods:
get_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.
- Removed
name
field fordatabricks.sdk.service.catalog.UpdateConnection
,databricks.sdk.service.catalog.UpdateMetastore
,databricks.sdk.service.catalog.UpdateRegisteredModelRequest
.databricks.sdk.service.catalog.UpdateSchema
anddatabricks.sdk.service.catalog.UpdateVolumeRequestContent
. - Removed
delta_sync_vector_index_spec
field fordatabricks.sdk.service.vectorsearch.CreateVectorIndexRequest
.
Changes:
- Changed
max_workers
andmin_workers
field fordatabricks.sdk.service.compute.AutoScale
to no longer be required. - Changed
destination
field fordatabricks.sdk.service.compute.DbfsStorageInfo
,databricks.sdk.service.compute.LocalFileInfo
,databricks.sdk.service.compute.S3StorageInfo
,databricks.sdk.service.compute.VolumesStorageInfo
anddatabricks.sdk.service.compute.WorkspaceStorageInfo
to be required. - Changed
clients
field fordatabricks.sdk.service.compute.WorkloadType
to be required. - Changed
allow_missing
andsetting
field fordatabricks.sdk.service.settings.UpdatePersonalComputeSettingRequest
to be required. - Changed
etag
field fordatabricks.sdk.service.settings.DeletePersonalComputeSettingRequest
to no longer be required. - Changed
autoscale
field fordatabricks.sdk.service.pipelines.PipelineCluster
todatabricks.sdk.service.pipelines.PipelineClusterAutoscale
dataclass. - Changed
delete_personal_compute_setting()
andupdate_personal_compute_setting()
method for a.account_settings account-level service with new required argument order.
Internal Changes
- Generate SDK (#536).
- Use fake clock for faster unit tests (#533).
- Skip test_get_workspace_client in Azure and GCP (#531).
- Regenerate from the tip of main (#524).
- Search for both databricks.exe and databricks binaries in windows (#517).
OpenAPI SHA: 6b897bc95b23abed8b9f5eff0e6b8ec034046180, Date: 2024-02-08
v0.18.0
Bugfixes:
- Fix Databricks OAuth M2M on Azure (#513).
Other noteworthy changes:
- Use
[]
instead ofNone
as default list value for deserialising responses (#361). - Support dev and staging workspaces (#514).
API Changes:
- Added
exists()
method for w.tables workspace-level service. - Added w.lakehouse_monitors workspace-level service.
- Added the following dataclasses:
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
. - Changed
create_obo_token()
method for w.token_management workspace-level service with new required argument order. - Changed
get()
method for w.token_management workspace-level service to returndatabricks.sdk.service.settings.GetTokenResponse
dataclass. - Changed
lifetime_seconds
field fordatabricks.sdk.service.settings.CreateOboTokenRequest
to no longer be required. - Added
databricks.sdk.service.settings.GetTokenResponse
dataclass.
OpenAPI SHA: e05401ed5dd4974c5333d737ec308a7d451f749f, Date: 2024-01-23
v0.17.0
- Use covariant type for
@retried(on=[...])
(#486). - Configure request timeout using existing parameter from Config (#489).
- Make contents of
__init__.py
equal across projects (#488). - Update SDK to Latest OpenAPI Specification (#501).
Note: This release contains breaking changes, please see below for more details.
API Changes:
- [Breaking] Changed
list()
method for w.tokens workspace-level service to returndatabricks.sdk.service.settings.ListPublicTokensResponse
dataclass. - Changed
list()
method for w.external_locations workspace-level service to require request ofdatabricks.sdk.service.catalog.ListExternalLocationsRequest
dataclass and w.storage_credentials workspace-level service to require request ofdatabricks.sdk.service.catalog.ListStorageCredentialsRequest
dataclass. - Added
next_page_token
field fordatabricks.sdk.service.catalog.ListExternalLocationsResponse
,databricks.sdk.service.catalog.ListFunctionsResponse
,databricks.sdk.service.catalog.ListSchemasResponse
anddatabricks.sdk.service.catalog.ListStorageCredentialsResponse
. - Added
max_results
field fordatabricks.sdk.service.catalog.ListFunctionsRequest
anddatabricks.sdk.service.catalog.ListSchemasRequest
. - Added
page_token
field fordatabricks.sdk.service.catalog.ListFunctionsRequest
anddatabricks.sdk.service.catalog.ListSchemasRequest
. - Added
omit_columns
field fordatabricks.sdk.service.catalog.ListTablesRequest
. - Added
omit_properties
field fordatabricks.sdk.service.catalog.ListTablesRequest
. - Added
init_scripts
field fordatabricks.sdk.service.pipelines.PipelineCluster
. - Added
validate_only
field fordatabricks.sdk.service.pipelines.StartUpdate
anddatabricks.sdk.service.pipelines.UpdateInfo
. - Changed
create()
method for w.dashboards workspace-level service . New request type isdatabricks.sdk.service.sql.DashboardPostContent
dataclass. - Added
update()
method for w.dashboards workspace-level service. - Added
http_headers
field fordatabricks.sdk.service.sql.ExternalLink
. - Added
run_as_role
field fordatabricks.sdk.service.sql.QueryEditContent
. - Added package:
databricks.sdk.service.dashboards
anddatabricks.sdk.service.vectorsearch
. - Added dataclass:
databricks.sdk.service.catalog.ListExternalLocationsRequest
,databricks.sdk.service.catalog.ListStorageCredentialsRequest
,databricks.sdk.service.settings.ListPublicTokensResponse
,databricks.sdk.service.sql.DashboardEditContent
anddatabricks.sdk.service.sql.DashboardPostContent
. - Removed dataclass:
databricks.sdk.service.catalog.TableConstraintList
anddatabricks.sdk.service.sql.CreateDashboardRequest
.
OpenAPI SHA: 0e0d4cbe87193e36c73b8b2be3b0dd0f1b013e00, Date: 2024-01-10
v0.16.0
- Sort imports in service template (#479).
- Add
py.typed
to support PEP-561 (#483). - Fixed bug in
@retried
when exception subtypes were not respected (#484). - Make
WorkspaceClient
andAccountClient
more friendly with autospeccing (#480).
API Changes:
- Added
azure_workspace_info
field fordatabricks.sdk.service.provisioning.Workspace
. - Added
databricks.sdk.service.provisioning.AzureWorkspaceInfo
dataclass. - Changed
update_config()
method for w.serving_endpoints workspace-level service with new required argument order. - Changed
served_entities
field fordatabricks.sdk.service.serving.EndpointCoreConfigInput
to no longer be required. - Changed
create()
method for a.account_ip_access_lists account-level service with new required argument order. - Changed
replace()
method for a.account_ip_access_lists account-level service with new required argument order. - Changed
update()
method for a.account_ip_access_lists account-level service with new required argument order. - Changed
create()
method for w.ip_access_lists workspace-level service with new required argument order. - Changed
replace()
method for w.ip_access_lists workspace-level service with new required argument order. - Changed
update()
method for w.ip_access_lists workspace-level service with new required argument order. - Changed
ip_addresses
field fordatabricks.sdk.service.settings.CreateIpAccessList
to no longer be required. - Changed
ip_addresses
field fordatabricks.sdk.service.settings.ReplaceIpAccessList
to no longer be required. - Removed
list_id
field fordatabricks.sdk.service.settings.ReplaceIpAccessList
. - Changed
enabled
field fordatabricks.sdk.service.settings.UpdateIpAccessList
to no longer be required. - Changed
ip_addresses
field fordatabricks.sdk.service.settings.UpdateIpAccessList
to no longer be required. - Changed
label
field fordatabricks.sdk.service.settings.UpdateIpAccessList
to no longer be required. - Removed
list_id
field fordatabricks.sdk.service.settings.UpdateIpAccessList
. - Changed
list_type
field fordatabricks.sdk.service.settings.UpdateIpAccessList
to no longer be required.
OpenAPI SHA: d3853c8dee5806d04da2ae8910f273ffb35719a5, Date: 2023-12-14
v0.15.0
Bugfixes:
Other changes:
- Updated GCP OAuth Readme (#464).
- Reference Documentation Refactoring (#467).
- Installed local library when generating docs (#469).
- Fixed readme links in pypi (#472).
- Updated a note for installing Python SDK on Databricks Runtime 13.1+ (#474).
- Updated GCP auth readme (#470).
API Changes:
- Changed
update()
method for w.connections workspace-level service with new required argument order. - Added
cloudflare_api_token
field fordatabricks.sdk.service.catalog.CreateStorageCredential
. - Added
cloudflare_api_token
field fordatabricks.sdk.service.catalog.StorageCredentialInfo
. - Changed
name
field fordatabricks.sdk.service.catalog.UpdateCatalog
to be required. - Added
new_name
field fordatabricks.sdk.service.catalog.UpdateCatalog
. - Changed
name
field fordatabricks.sdk.service.catalog.UpdateConnection
to no longer be required. - Added
new_name
field fordatabricks.sdk.service.catalog.UpdateConnection
. - Changed
name
field fordatabricks.sdk.service.catalog.UpdateExternalLocation
to be required. - Added
new_name
field fordatabricks.sdk.service.catalog.UpdateExternalLocation
. - Added
new_name
field fordatabricks.sdk.service.catalog.UpdateMetastore
. - Added
new_name
field fordatabricks.sdk.service.catalog.UpdateRegisteredModelRequest
. - Added
new_name
field fordatabricks.sdk.service.catalog.UpdateSchema
. - Changed
name
field fordatabricks.sdk.service.catalog.UpdateStorageCredential
to be required. - Added
cloudflare_api_token
field fordatabricks.sdk.service.catalog.UpdateStorageCredential
. - Added
new_name
field fordatabricks.sdk.service.catalog.UpdateStorageCredential
. - Added
new_name
field fordatabricks.sdk.service.catalog.UpdateVolumeRequestContent
. - Added
cloudflare_api_token
field fordatabricks.sdk.service.catalog.ValidateStorageCredential
. - Added
databricks.sdk.service.catalog.CloudflareApiToken
dataclass. - Removed
continuous
field fordatabricks.sdk.service.jobs.BaseRun
. - Removed
continuous
field fordatabricks.sdk.service.jobs.Run
. - Changed
job_parameters
field fordatabricks.sdk.service.jobs.RunJobTask
todatabricks.sdk.service.jobs.ParamPairs
dataclass. - Added
run_if
field fordatabricks.sdk.service.jobs.SubmitTask
. - Added
run_job_task
field fordatabricks.sdk.service.jobs.SubmitTask
. - Changed
update_config()
method for w.serving_endpoints workspace-level service with new required argument order. - Added
put()
method for w.serving_endpoints workspace-level service. - Added
rate_limits
field fordatabricks.sdk.service.serving.CreateServingEndpoint
. - Changed
served_models
field fordatabricks.sdk.service.serving.EndpointCoreConfigInput
to no longer be required. - Added
auto_capture_config
field fordatabricks.sdk.service.serving.EndpointCoreConfigInput
. - Added
served_entities
field fordatabricks.sdk.service.serving.EndpointCoreConfigInput
. - Added
auto_capture_config
field fordatabricks.sdk.service.serving.EndpointCoreConfigOutput
. - Added
served_entities
field fordatabricks.sdk.service.serving.EndpointCoreConfigOutput
. - Added
served_entities
field fordatabricks.sdk.service.serving.EndpointCoreConfigSummary
. - Added
served_entities
field fordatabricks.sdk.service.serving.EndpointPendingConfig
. - Added
extra_params
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Added
input
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Added
max_tokens
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Added
messages
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Added
n
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Added
prompt
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Added
stop
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Added
stream
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Added
temperature
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Changed
predictions
field fordatabricks.sdk.service.serving.QueryEndpointResponse
to no longer be required. - Added
choices
field fordatabricks.sdk.service.serving.QueryEndpointResponse
. - Added
created
field fordatabricks.sdk.service.serving.QueryEndpointResponse
. - Added
data
field fordatabricks.sdk.service.serving.QueryEndpointResponse
. - Added
id
field fordatabricks.sdk.service.serving.QueryEndpointResponse
. - Added
model
field fordatabricks.sdk.service.serving.QueryEndpointResponse
. - Added
object
field fordatabricks.sdk.service.serving.QueryEndpointResponse
. - Added
usage
field fordatabricks.sdk.service.serving.QueryEndpointResponse
. - Changed
workload_size
field fordatabricks.sdk.service.serving.ServedModelInput
todatabricks.sdk.service.serving.ServedModelInputWorkloadSize
dataclass. - Changed
workload_type
field fordatabricks.sdk.service.serving.ServedModelInput
todatabricks.sdk.service.serving.ServedModelInputWorkloadType
dataclass. - Added
task
field fordatabricks.sdk.service.serving.ServingEndpoint
. - Added
task
field fordatabricks.sdk.service.serving.ServingEndpointDetailed
. - Added
databricks.sdk.service.serving.Ai21LabsConfig
dataclass. - Added
databricks.sdk.service.serving.AnthropicConfig
dataclass. - Added
databricks.sdk.service.serving.AutoCaptureConfigInput
dataclass. - Added
databricks.sdk.service.serving.AutoCaptureConfigOutput
dataclass. - Added
databricks.sdk.service.serving.AutoCaptureState
dataclass. - Added
databricks.sdk.service.serving.AwsBedrockConfig
dataclass. - Added
databricks.sdk.service.serving.AwsBedrockConfigBedrockProvider
dataclass. - Added
databricks.sdk.service.serving.ChatMessage
dataclass. - Added
databricks.sdk.service.serving.ChatMessageRole
dataclass. - Added
databricks.sdk.service.serving.CohereConfig
dataclass. - Added
databricks.sdk.service.serving.DatabricksModelServingConfig
dataclass. - Added
databricks.sdk.service.serving.EmbeddingsV1ResponseEmbeddingElement
dataclass. - Added
databricks.sdk.service.serving.EmbeddingsV1ResponseEmbeddingElementObject
dataclass. - Added
databricks.sdk.service.serving.ExternalModel
dataclass. - Added
databricks.sdk.service.serving.ExternalModelConfig
dataclass. - Added
databricks.sdk.service.serving.ExternalModelProvider
dataclass. - Added
databricks.sdk.service.serving.ExternalModelUsageElement
dataclass. - Added
databricks.sdk.service.serving.FoundationModel
dataclass. - Added
databricks.sdk.service.serving.OpenAiConfig
dataclass. - Added
databricks.sdk.service.serving.PaLmConfig
dataclass. - Added
databricks.sdk.service.serving.PayloadTable
dataclass. - Added
databricks.sdk.service.serving.PutRequest
dataclass. - Added
databricks.sdk.service.serving.PutResponse
dataclass. - Added
databricks.sdk.service.serving.QueryEndpointResponseObject
dataclass. - Added
databricks.sdk.service.serving.RateLimit
dataclass. - Added
databricks.sdk.service.serving.RateLimitKey
dataclass. - Added
databricks.sdk.service.serving.RateLimitRenewalPeriod
dataclass. - Added
databricks.sdk.service.serving.ServedEntityInput
dataclass. - Added
databricks.sdk.service.serving.ServedEntityOutput
dataclass. - Added
databricks.sdk.service.serving.ServedEntitySpec
dataclass. - Added
databricks.sdk.service.serving.ServedModelInputWorkloadSize
dataclass. - Added
databricks.sdk.service.serving.ServedModelInputWorkloadType
dataclass. - Added
databricks.sdk.service.serving.V1ResponseChoiceElement
dataclass. - Removed a.account_network_policy account-level service.
- Removed
databricks.sdk.service.settings.AccountNetworkPolicyMessage
dataclass. - Removed
databricks.sdk.service.settings.DeleteAccountNetworkPolicyRequest
dataclass. - Removed
databricks.sdk.service.settings.DeleteAccountNetworkPolicyResponse
dataclass. - Removed
databricks.sdk.service.settings.ReadAccountNetworkPolicyRequest
dataclass. - Removed
databricks.sdk.service.settings.UpdateAccountNetworkPolicyRequest
dataclass. - Removed
name
field fordatabricks.sdk.service.sharing.UpdateCleanRoom
. - Changed
name
field fordatabricks.sdk.service.sharing.UpdateProvider
to be required. - Added
new_name
field fordatabricks.sdk.service.sharing.UpdateProvider
. - Changed
name
field fordatabricks.sdk.service.sharing.UpdateRecipient
to be required. - Added
new_name
field fordatabricks.sdk.service.sharing.UpdateRecipient
. - Changed
name
field fordatabricks.sdk.service.sharing.UpdateShare
to be required. - Added
new_name
field fordatabricks.sdk.service.sharing.UpdateShare
. - Added
statement_ids
field fordatabricks.sdk.service.sql.QueryFilter
. - Added
databricks.sdk.service.sql.StatementId
dataclass.
OpenAPI SHA: 63caa3cb0c05045e81d3dcf2451fa990d8670f36, Date: 2023-12-12