Releases: databricks/databricks-sdk-py
Releases · databricks/databricks-sdk-py
v0.27.1
v0.27.0
New Features
- DBUtils implementation for Volumes (#623, #634, #631). You can now use
w.dbutils.fswith UC volumes paths. Error handling for non-UC, non-DBFS and non-local paths has also been improved.
Bug Fixes
- Fixed codecov for repository (#636).
API Changes:
- Added
ingestion_definitionfield fordatabricks.sdk.service.pipelines.CreatePipeline. - Added
ingestion_definitionfield fordatabricks.sdk.service.pipelines.EditPipeline. - Added
ingestion_definitionfield fordatabricks.sdk.service.pipelines.PipelineSpec. - Added
databricks.sdk.service.pipelines.IngestionConfigdataclass. - Added
databricks.sdk.service.pipelines.ManagedIngestionPipelineDefinitiondataclass. - Added
databricks.sdk.service.pipelines.SchemaSpecdataclass. - Added
databricks.sdk.service.pipelines.TableSpecdataclass. - Changed
create()method for w.apps workspace-level service . New request type isdatabricks.sdk.service.serving.CreateAppRequestdataclass. - Changed
create()method for w.apps workspace-level service to returndatabricks.sdk.service.serving.Appdataclass. - Removed
delete_app()method for w.apps workspace-level service. - Removed
get_app()method for w.apps workspace-level service. - Removed
get_app_deployment_status()method for w.apps workspace-level service. - Removed
get_apps()method for w.apps workspace-level service. - Removed
get_events()method for w.apps workspace-level service. - Added
create_deployment()method for w.apps workspace-level service. - Added
delete()method for w.apps workspace-level service. - Added
get()method for w.apps workspace-level service. - Added
get_deployment()method for w.apps workspace-level service. - Added
get_environment()method for w.apps workspace-level service. - Added
list()method for w.apps workspace-level service. - Added
list_deployments()method for w.apps workspace-level service. - Added
stop()method for w.apps workspace-level service. - Added
update()method for w.apps workspace-level service. - Added
get_open_api()method for w.serving_endpoints workspace-level service. - Removed
databricks.sdk.service.serving.AppEventsdataclass. - Removed
databricks.sdk.service.serving.AppManifestdataclass. - Removed
databricks.sdk.service.serving.AppServiceStatusdataclass. - Removed
databricks.sdk.service.serving.DeleteAppResponsedataclass. - Removed
databricks.sdk.service.serving.DeployAppRequestdataclass. - Removed
databricks.sdk.service.serving.DeploymentStatusdataclass. - Removed
databricks.sdk.service.serving.DeploymentStatusStatedataclass. - Removed
databricks.sdk.service.serving.GetAppDeploymentStatusRequestdataclass. - Removed
databricks.sdk.service.serving.GetAppResponsedataclass. - Removed
databricks.sdk.service.serving.GetEventsRequestdataclass. - Removed
databricks.sdk.service.serving.ListAppEventsResponsedataclass. - Changed
appsfield fordatabricks.sdk.service.serving.ListAppsResponsetodatabricks.sdk.service.serving.AppListdataclass. - Added
databricks.sdk.service.serving.Appdataclass. - Added
databricks.sdk.service.serving.AppDeploymentdataclass. - Added
databricks.sdk.service.serving.AppDeploymentStatedataclass. - Added
databricks.sdk.service.serving.AppDeploymentStatusdataclass. - Added
databricks.sdk.service.serving.AppEnvironmentdataclass. - Added
databricks.sdk.service.serving.AppStatedataclass. - Added
databricks.sdk.service.serving.AppStatusdataclass. - Added
databricks.sdk.service.serving.CreateAppDeploymentRequestdataclass. - Added
databricks.sdk.service.serving.CreateAppRequestdataclass. - Added
databricks.sdk.service.serving.EnvVariabledataclass. - Added
databricks.sdk.service.serving.GetAppDeploymentRequestdataclass. - Added
databricks.sdk.service.serving.GetAppEnvironmentRequestdataclass. - Added
databricks.sdk.service.serving.GetOpenApiRequestdataclass. - Added
anydataclass. - Added
databricks.sdk.service.serving.ListAppDeploymentsRequestdataclass. - Added
databricks.sdk.service.serving.ListAppDeploymentsResponsedataclass. - Added
databricks.sdk.service.serving.ListAppsRequestdataclass. - Added
databricks.sdk.service.serving.StopAppRequestdataclass. - Added
anydataclass. - Added
databricks.sdk.service.serving.UpdateAppRequestdataclass. - Removed w.csp_enablement workspace-level service.
- Removed w.esm_enablement workspace-level service.
- Added w.compliance_security_profile workspace-level service.
- Added w.enhanced_security_monitoring workspace-level service.
- Removed
databricks.sdk.service.settings.CspEnablementdataclass. - Removed
databricks.sdk.service.settings.CspEnablementSettingdataclass. - Removed
databricks.sdk.service.settings.EsmEnablementdataclass. - Removed
databricks.sdk.service.settings.EsmEnablementSettingdataclass. - Removed
databricks.sdk.service.settings.GetCspEnablementSettingRequestdataclass. - Removed
databricks.sdk.service.settings.GetEsmEnablementSettingRequestdataclass. - Removed
databricks.sdk.service.settings.UpdateCspEnablementSettingRequestdataclass. - Removed
databricks.sdk.service.settings.UpdateEsmEnablementSettingRequestdataclass. - Added
databricks.sdk.service.settings.ComplianceSecurityProfiledataclass. - Added
databricks.sdk.service.settings.ComplianceSecurityProfileSettingdataclass. - Added
databricks.sdk.service.settings.EnhancedSecurityMonitoringdataclass. - Added
databricks.sdk.service.settings.EnhancedSecurityMonitoringSettingdataclass. - Added
databricks.sdk.service.settings.GetComplianceSecurityProfileSettingRequestdataclass. - Added
databricks.sdk.service.settings.GetEnhancedSecurityMonitoringSettingRequestdataclass. - Added
databricks.sdk.service.settings.UpdateComplianceSecurityProfileSettingRequestdataclass. - Added
databricks.sdk.service.settings.UpdateEnhancedSecurityMonitoringSettingRequestdataclass. - Added
tagsfield fordatabricks.sdk.service.sql.DashboardEditContent. - Added
tagsfield fordatabricks.sdk.service.sql.QueryEditContent. - Added
catalogfield fordatabricks.sdk.service.sql.QueryOptions. - Added
schemafield fordatabricks.sdk.service.sql.QueryOptions. - Added
tagsfield fordatabricks.sdk.service.sql.QueryPostContent. - Added
queryfield fordatabricks.sdk.service.sql.Visualization.
OpenAPI SHA: 9bb7950fa3390afb97abaa552934bc0a2e069de5, Date: 2024-05-02
v0.26.0
0.26.0
- Increase cluster creation test timeout (#617).
- Added code example for adding a user to a group using group patch API (#625).
- Updated SDK to OpenAPI spec (#624).
Note: This release contains breaking changes, please see the API changes below for more details.
API Changes:
- Added
deploymentfield fordatabricks.sdk.service.pipelines.CreatePipeline,databricks.sdk.service.pipelines.EditPipelineanddatabricks.sdk.service.pipelines.PipelineSpec. - Added
schema_idfield fordatabricks.sdk.service.catalog.SchemaInfo. - Added
operationfield fordatabricks.sdk.service.catalog.ValidationResult. - Added
requirementsfield fordatabricks.sdk.service.compute.Library. - Added
warehouse_idfield fordatabricks.sdk.service.jobs.NotebookTask. - Added
run_asfield fordatabricks.sdk.service.jobs.SubmitRun. - Added
databricks.sdk.service.catalog.ValidationResultOperationdataclass. - Added
databricks.sdk.service.compute.ClusterStatusdataclass. - Added
databricks.sdk.service.compute.ClusterStatusResponsedataclass. - Added
databricks.sdk.service.compute.LibraryInstallStatusdataclass. - Added
databricks.sdk.service.pipelines.DeploymentKinddataclass. - Added
databricks.sdk.service.pipelines.PipelineDeploymentdataclass. - Removed
aws_operationfield fordatabricks.sdk.service.catalog.ValidationResult. - Removed
azure_operationfield fordatabricks.sdk.service.catalog.ValidationResult. - Removed
gcp_operationfield fordatabricks.sdk.service.catalog.ValidationResult. - Removed
databricks.sdk.service.catalog.ValidationResultAwsOperationdataclass. - Removed
databricks.sdk.service.catalog.ValidationResultAzureOperationdataclass. - Removed
databricks.sdk.service.catalog.ValidationResultGcpOperationdataclass. - Removed
databricks.sdk.service.compute.LibraryFullStatusStatusdataclass. - Removed
databricks.sdk.service.compute.ClusterStatusRequestdataclass. - Changed
cluster_status()method for w.libraries workspace-level service . New request type isdatabricks.sdk.service.compute.ClusterStatusdataclass. - Changed
cluster_status()method for w.libraries workspace-level service to returndatabricks.sdk.service.compute.ClusterStatusResponsedataclass. - Changed
statusfield fordatabricks.sdk.service.compute.LibraryFullStatustodatabricks.sdk.service.compute.LibraryInstallStatusdataclass.
OpenAPI SHA: 06d330f43d92c1be864d4638c672cd0723e20a51, Date: 2024-04-22
v0.25.1
v0.25.0
Behavior Changes
- Override INVALID_PARAMETER_VALUE on fetching non-existent job/cluster (#591). When getting a job or cluster by ID that doesn't exist, the API currently returns a 400, corresponding to the
InvalidParameterValueexception. This change throws aResourceNotFoundExceptioninstead in this circumstance. To handle this change, modify error handling by updating yourexceptblocks from:
try:
w.jobs.get_by_id("123")
except InvalidParameterValue:
...to
try:
w.jobs.get_by_id("123")
except ResourceDoesNotExist:
...Internal Changes
- Check downstream backwards compatibility (#600).
- Add support for upcoming Marketplace package (#608).
API Changes:
- Changed
cancel_refresh()method for w.lakehouse_monitors workspace-level service with new required argument order. - Changed
create()method for w.lakehouse_monitors workspace-level service with new required argument order. - Changed
delete()method for w.lakehouse_monitors workspace-level service with new required argument order. - Changed
get()method for w.lakehouse_monitors workspace-level service with new required argument order. - Changed
get_refresh()method for w.lakehouse_monitors workspace-level service with new required argument order. - Changed
list_refreshes()method for w.lakehouse_monitors workspace-level service with new required argument order. - Changed
run_refresh()method for w.lakehouse_monitors workspace-level service with new required argument order. - Changed
update()method for w.lakehouse_monitors workspace-level service with new required argument order. - Removed
databricks.sdk.service.catalog.AzureManagedIdentitydataclass. - Removed
full_namefield fordatabricks.sdk.service.catalog.CancelRefreshRequest. - Added
table_namefield fordatabricks.sdk.service.catalog.CancelRefreshRequest. - Changed
custom_metricsfield fordatabricks.sdk.service.catalog.CreateMonitortodatabricks.sdk.service.catalog.MonitorMetricListdataclass. - Removed
full_namefield fordatabricks.sdk.service.catalog.CreateMonitor. - Changed
inference_logfield fordatabricks.sdk.service.catalog.CreateMonitortodatabricks.sdk.service.catalog.MonitorInferenceLogdataclass. - Changed
notificationsfield fordatabricks.sdk.service.catalog.CreateMonitortodatabricks.sdk.service.catalog.MonitorNotificationsdataclass. - Changed
snapshotfield fordatabricks.sdk.service.catalog.CreateMonitortoanydataclass. - Changed
time_seriesfield fordatabricks.sdk.service.catalog.CreateMonitortodatabricks.sdk.service.catalog.MonitorTimeSeriesdataclass. - Added
table_namefield fordatabricks.sdk.service.catalog.CreateMonitor. - Changed
azure_managed_identityfield fordatabricks.sdk.service.catalog.CreateStorageCredentialtodatabricks.sdk.service.catalog.AzureManagedIdentityRequestdataclass. - Removed
full_namefield fordatabricks.sdk.service.catalog.DeleteLakehouseMonitorRequest. - Added
table_namefield fordatabricks.sdk.service.catalog.DeleteLakehouseMonitorRequest. - Removed
full_namefield fordatabricks.sdk.service.catalog.GetLakehouseMonitorRequest. - Added
table_namefield fordatabricks.sdk.service.catalog.GetLakehouseMonitorRequest. - Removed
full_namefield fordatabricks.sdk.service.catalog.GetRefreshRequest. - Added
table_namefield fordatabricks.sdk.service.catalog.GetRefreshRequest. - Removed
full_namefield fordatabricks.sdk.service.catalog.ListRefreshesRequest. - Added
table_namefield fordatabricks.sdk.service.catalog.ListRefreshesRequest. - Changed
quartz_cron_expressionfield fordatabricks.sdk.service.catalog.MonitorCronScheduleto be required. - Changed
timezone_idfield fordatabricks.sdk.service.catalog.MonitorCronScheduleto be required. - Removed
databricks.sdk.service.catalog.MonitorCustomMetricdataclass. - Removed
databricks.sdk.service.catalog.MonitorCustomMetricTypedataclass. - Removed
databricks.sdk.service.catalog.MonitorDestinationsdataclass. - Removed
databricks.sdk.service.catalog.MonitorInferenceLogProfileTypedataclass. - Removed
databricks.sdk.service.catalog.MonitorInferenceLogProfileTypeProblemTypedataclass. - Changed
custom_metricsfield fordatabricks.sdk.service.catalog.MonitorInfotodatabricks.sdk.service.catalog.MonitorMetricListdataclass. - Changed
drift_metrics_table_namefield fordatabricks.sdk.service.catalog.MonitorInfoto be required. - Changed
inference_logfield fordatabricks.sdk.service.catalog.MonitorInfotodatabricks.sdk.service.catalog.MonitorInferenceLogdataclass. - Changed
monitor_versionfield fordatabricks.sdk.service.catalog.MonitorInfoto be required. - Changed
notificationsfield fordatabricks.sdk.service.catalog.MonitorInfotodatabricks.sdk.service.catalog.MonitorNotificationsdataclass. - Changed
profile_metrics_table_namefield fordatabricks.sdk.service.catalog.MonitorInfoto be required. - Changed
snapshotfield fordatabricks.sdk.service.catalog.MonitorInfotoanydataclass. - Changed
statusfield fordatabricks.sdk.service.catalog.MonitorInfoto be required. - Changed
table_namefield fordatabricks.sdk.service.catalog.MonitorInfoto be required. - Changed
time_seriesfield fordatabricks.sdk.service.catalog.MonitorInfotodatabricks.sdk.service.catalog.MonitorTimeSeriesdataclass. - Removed
databricks.sdk.service.catalog.MonitorNotificationsConfigdataclass. - Changed
refresh_idfield fordatabricks.sdk.service.catalog.MonitorRefreshInfoto be required. - Changed
start_time_msfield fordatabricks.sdk.service.catalog.MonitorRefreshInfoto be required. - Changed
statefield fordatabricks.sdk.service.catalog.MonitorRefreshInfoto be required. - Added
triggerfield fordatabricks.sdk.service.catalog.MonitorRefreshInfo. - Removed
anydataclass. - Removed
databricks.sdk.service.catalog.MonitorTimeSeriesProfileTypedataclass. - Removed
full_namefield fordatabricks.sdk.service.catalog.RunRefreshRequest. - Added
table_namefield fordatabricks.sdk.service.catalog.RunRefreshRequest. - Changed
azure_managed_identityfield fordatabricks.sdk.service.catalog.StorageCredentialInfotodatabricks.sdk.service.catalog.AzureManagedIdentityResponsedataclass. - Removed
namefield fordatabricks.sdk.service.catalog.TableRowFilter. - Added
function_namefield fordatabricks.sdk.service.catalog.TableRowFilter. - Changed
custom_metricsfield fordatabricks.sdk.service.catalog.UpdateMonitortodatabricks.sdk.service.catalog.MonitorMetricListdataclass. - Removed
full_namefield fordatabricks.sdk.service.catalog.UpdateMonitor. - Changed
inference_logfield fordatabricks.sdk.service.catalog.UpdateMonitortodatabricks.sdk.service.catalog.MonitorInferenceLogdataclass. - Changed
notificationsfield fordatabricks.sdk.service.catalog.UpdateMonitortodatabricks.sdk.service.catalog.MonitorNotificationsdataclass. - Changed
snapshotfield fordatabricks.sdk.service.catalog.UpdateMonitortoanydataclass. - Changed
time_seriesfield fordatabricks.sdk.service.catalog.UpdateMonitortodatabricks.sdk.service.catalog.MonitorTimeSeriesdataclass. - Added
table_namefield fordatabricks.sdk.service.catalog.UpdateMonitor. - Changed
azure_managed_identityfield fordatabricks.sdk.service.catalog.UpdateStorageCredentialtodatabricks.sdk.service.catalog.AzureManagedIdentityResponsedataclass. - Changed
azure_managed_identityfield fordatabricks.sdk.service.catalog.ValidateStorageCredentialtodatabricks.sdk.service.catalog.AzureManagedIdentityRequestdataclass. - Removed
operationfield fordatabricks.sdk.service.catalog.ValidationResult. - Added
aws_operationfield fordatabricks.sdk.service.catalog.ValidationResult. - Added
azure_operationfield fordatabricks.sdk.service.catalog.ValidationResult. - Added
gcp_operationfield fordatabricks.sdk.service.catalog.ValidationResult. - Removed
databricks.sdk.service.catalog.ValidationResultOperationdataclass. - Added
databricks.sdk.service.catalog.AzureManagedIdentityRequestdataclass. - Added
databricks.sdk.service.catalog.AzureManagedIdentityResponsedataclass. - Added
databricks.sdk.service.catalog.MonitorDestinationdataclass. - Added
databricks.sdk.service.catalog.MonitorInferenceLogdataclass. - Added
databricks.sdk.service.catalog.MonitorInferenceLogProblemTypedataclass. - Added
databricks.sdk.service.catalog.MonitorMetricdataclass. - Added
databricks.sdk.service.catalog.MonitorMetricTypedataclass. - Added
databricks.sdk.service.catalog.MonitorNotificationsdataclass. - Added
databricks.sdk.service.catalog.MonitorRefreshInfoTriggerdataclass. - Added
anydataclass. - Added
databricks.sdk.service.catalog.MonitorTimeSeriesdataclass. - Added `databricks.sd...
v0.24.0
Improvements and Bug Fixes
- Properly escape multi-segment path parameters (#596).
Internal Changes
- Revert changelog template changes for better diffs (#590).
API Changes
- Added
migrate()andunpublish()method fors w.lakeview workspace-level service. - Added
databricks.sdk.service.dashboards.MigrateDashboardRequestanddatabricks.sdk.service.dashboards.UnpublishDashboardRequestdataclasses. - Added
description,queue_durationandrepair_historyfields fordatabricks.sdk.service.jobs.BaseRun. - Added
compute_keyandjob_cluster_keyfields fordatabricks.sdk.service.jobs.ClusterSpec. - Changed
left,opandrightfields fordatabricks.sdk.service.jobs.ConditionTaskto be required. - Changed
edit_modefield fordatabricks.sdk.service.jobs.CreateJobtodatabricks.sdk.service.jobs.JobEditModedataclass. - Replaced
databricks.sdk.service.jobs.CreateJobEditModedataclass bydatabricks.sdk.service.jobs.JobEditMode. - Changed
urlfield fordatabricks.sdk.service.jobs.FileArrivalTriggerConfigurationto be required. - Changed
error_message_statsfield fordatabricks.sdk.service.jobs.ForEachStatstodatabricks.sdk.service.jobs.ForEachTaskErrorMessageStatsListdataclass. - Changed
new_clusterfield fordatabricks.sdk.service.jobs.JobClusterto be required. - Changed
edit_modefield fordatabricks.sdk.service.jobs.JobSettingstodatabricks.sdk.service.jobs.JobEditModedataclass. - Replaced
databricks.sdk.service.jobs.JobsSettingsEditModedataclass bydatabricks.sdk.service.jobs.JobEditMode. - Changed
metric,opandvaluefields fordatabricks.sdk.service.jobs.JobsHealthRuleto be required. - Changed
run_typefield fordatabricks.sdk.service.jobs.ListRunsRequesttodatabricks.sdk.service.jobs.RunTypedataclass. - Repplaced
databricks.sdk.service.jobs.ListRunsRunTypedataclass bydatabricks.sdk.service.jobs.RunTypedataclass. - Changed
pipeline_idfield fordatabricks.sdk.service.jobs.PipelineTaskto be required. - Changed
entry_pointandpackage_namefields fordatabricks.sdk.service.jobs.PythonWheelTaskto be required. - Changed
job_parametersfield fordatabricks.sdk.service.jobs.RepairRunto dict[str,str] dataclass. - Changed
base_parametersfield fordatabricks.sdk.service.jobs.ResolvedNotebookTaskValuesto dict[str,str] dataclass. - Changed
parametersfield fordatabricks.sdk.service.jobs.ResolvedParamPairValuesto dict[str,str] dataclass. - Changed
named_parametersfield fordatabricks.sdk.service.jobs.ResolvedPythonWheelTaskValuesto dict[str,str] dataclass. - Removed
named_parametersfield fordatabricks.sdk.service.jobs.ResolvedRunJobTaskValues. - Changed
parametersfield fordatabricks.sdk.service.jobs.ResolvedRunJobTaskValuesto dict[str,str] dataclass. - Added
job_parametersfield fordatabricks.sdk.service.jobs.ResolvedRunJobTaskValues. - Added
descriptionandqueue_durationfields fordatabricks.sdk.service.jobs.Run. - Changed
opfield fordatabricks.sdk.service.jobs.RunConditionTasktodatabricks.sdk.service.jobs.ConditionTaskOpdataclass. - Replaced
databricks.sdk.service.jobs.RunConditionTaskOpdataclass bydatabricks.sdk.service.jobs.ConditionTaskOpdataclass. - Changed
inputsandtaskfields fordatabricks.sdk.service.jobs.RunForEachTaskto be required. - Changed
job_parametersfield fordatabricks.sdk.service.jobs.RunJobTaskto dict[str,str] dataclass. - Added
dbt_commands,jar_params,notebook_params,pipeline_params,python_named_params,python_params,spark_submit_paramsandsql_paramsfields fordatabricks.sdk.service.jobs.RunJobTask. - Changed
job_parametersfield fordatabricks.sdk.service.jobs.RunNowto dict[str,str] dataclass. - Added
infofield fordatabricks.sdk.service.jobs.RunOutput. - Removed
job_parametersfield fordatabricks.sdk.service.jobs.RunParameters. - Changed
task_keyfield fordatabricks.sdk.service.jobs.RunTaskto be required. - Added
compute_key,email_notifications,job_cluster_key,notification_settings,run_duration,run_page_url,timeout_secondsandwebhook_notificationsfields fordatabricks.sdk.service.jobs.RunTask. - Added
endpoint_idfield fordatabricks.sdk.service.jobs.SqlQueryOutput. - Added
condition_task,dbt_task,notebook_task,pipeline_task,python_wheel_task,run_job_task,spark_jar_task,spark_python_task,spark_submit_taskandsql_taskfields fordatabricks.sdk.service.jobs.SubmitRun. - Added
descriptionfield fordatabricks.sdk.service.jobs.SubmitTask. - Added
disable_auto_optimizationfield fordatabricks.sdk.service.jobs.Task. - Added
no_alert_for_skipped_runsfield fordatabricks.sdk.service.jobs.TaskEmailNotifications. - Added
table_updatefield fordatabricks.sdk.service.jobs.TriggerSettings. - Changed
idfield fordatabricks.sdk.service.jobs.Webhookto be required. - Changed
on_duration_warning_threshold_exceededfield fordatabricks.sdk.service.jobs.WebhookNotificationstodatabricks.sdk.service.jobs.WebhookListdataclass. - Removed
databricks.sdk.service.jobs.WebhookNotificationsOnDurationWarningThresholdExceededItemdataclass. - Added
databricks.sdk.service.jobs.JobEditModedataclass. - Replaced
databricks.sdk.service.serving.AwsBedrockConfigdataclass bydatabricks.sdk.service.serving.AmazonBedrockConfigdataclass. - Replaced
databricks.sdk.service.serving.AwsBedrockConfigBedrockProviderdataclass bydatabricks.sdk.service.serving.AmazonBedrockConfigBedrockProviderdataclass. - Renamed
aws_bedrock_configfield fordatabricks.sdk.service.serving.ExternalModeltoamazon_bedrock_config. - Changed
get()method for w.ip_access_lists workspace-level service . New request type isdatabricks.sdk.service.settings.GetIpAccessListRequestdataclass. - Replaced
databricks.sdk.service.settings.GetIpAccessListdataclass bydatabricks.sdk.service.settings.GetIpAccessListRequestdataclass.
OpenAPI SHA: d38528c3e47dd81c9bdbd918272a3e49d36e09ce, Date: 2024-03-27
v0.23.0
Internal changes:
- Add CONTRIBUTING.md (#585).
- Improve diff generation for changelog.
API Changes:
- Added
databricks.sdk.service.catalog.AwsIamRoleResponsedataclass. - Added
databricks.sdk.service.catalog.AwsIamRoleRequestdataclass. - Removed
databricks.sdk.service.catalog.AwsIamRoledataclass. - Changed
aws_iam_rolefield fordatabricks.sdk.service.catalog.CreateStorageCredentialtodatabricks.sdk.service.catalog.AwsIamRoleRequestdataclass. - Changed
aws_iam_rolefield fordatabricks.sdk.service.catalog.StorageCredentialInfotodatabricks.sdk.service.catalog.AwsIamRoleResponsedataclass. - Changed
aws_iam_rolefield fordatabricks.sdk.service.catalog.UpdateStorageCredentialtodatabricks.sdk.service.catalog.AwsIamRoleRequestdataclass. - Changed
aws_iam_rolefield fordatabricks.sdk.service.catalog.ValidateStorageCredentialtodatabricks.sdk.service.catalog.AwsIamRoleRequestdataclass. - Added
auto_capture_configfield fordatabricks.sdk.service.serving.EndpointPendingConfig. - Added
databricks.sdk.service.sharing.SharedDataObjectDataObjectTypedataclass. - Changed
data_object_typefield fordatabricks.sdk.service.sharing.SharedDataObjecttodatabricks.sdk.service.sharing.SharedDataObjectDataObjectTypedataclass. - Added
contentfield fordatabricks.sdk.service.sharing.SharedDataObject. - Added
embedding_source_columnsfield 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
notificationsfield fordatabricks.sdk.service.catalog.CreateMonitor,databricks.sdk.service.catalog.MonitorInfo, anddatabricks.sdk.service.catalog.UpdateMonitortodatabricks.sdk.service.catalog.MonitorNotificationsConfigdataclass. - Added
browse_onlyfield 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_browsefield 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.PublishedDashboarddataclass. - 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.UpdateDashboardRequestdataclasses.
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.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.PermissionMigrationResponse
Changed
versionfield fordatabricks.sdk.service.serving.AppManifesttodatabricks.sdk.service.serving.AnyValuedataclass.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_namefield fordatabricks.sdk.service.vectorsearch.CreateVectorIndexRequestto 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.DeleteDefaultNamespaceSettingRequestdataclass.
...
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 thecontentskey. 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_argfield tonamefor 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.GetCleanRoomRequestand
databricks.sdk.service.sharing.UpdateCleanRoom. - Removed
full_name_argfield fordatabricks.sdk.service.catalog.DeleteVolumeRequest. - Added
namefield fordatabricks.sdk.service.catalog.DeleteVolumeRequest. - Added
max_resultsfield fordatabricks.sdk.service.catalog.ListVolumesRequest. - Added
page_tokenfield fordatabricks.sdk.service.catalog.ListVolumesRequest. - Added
next_page_tokenfield fordatabricks.sdk.service.catalog.ListVolumesResponseContent. - Removed
full_name_argfield fordatabricks.sdk.service.catalog.ReadVolumeRequest. - Added
namefield fordatabricks.sdk.service.catalog.ReadVolumeRequest. - Removed
assets_dirfield fordatabricks.sdk.service.catalog.UpdateMonitor. - Removed
full_name_argfield fordatabricks.sdk.service.catalog.UpdateVolumeRequestContent. - Added
namefield fordatabricks.sdk.service.catalog.UpdateVolumeRequestContent. - Added the following catalog dataclasses:
ContinuousUpdateStatus,DeleteOnlineTableRequest,FailedStatus,
GetOnlineTableRequest,OnlineTable,OnlineTableSpec,OnlineTableState,OnlineTableStatus,
PipelineProgress,ProvisioningStatus,TriggeredUpdateStatusandViewData. - 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_typeandlast_modifiedfields fordatabricks.sdk.service.files.DownloadResponse. - Added the following files dataclasses:
FileSize,GetDirectoryMetadataRequest,GetMetadataRequest,
GetMetadataResponseandLastModifiedHttpDate. - Removed
trigger_historyfield fordatabricks.sdk.service.jobs.Job. - Removed
databricks.sdk.service.jobs.TriggerEvaluationdataclass. - Removed
databricks.sdk.service.jobs.TriggerHistorydataclass. - Added
tablefield fordatabricks.sdk.service.jobs.TriggerSettings. - Added
databricks.sdk.service.jobs.Conditiondataclass. - Added
databricks.sdk.service.jobs.TableTriggerConfigurationdataclass. - Removed
configfield fordatabricks.sdk.service.serving.ExternalModel. - Removed
databricks.sdk.service.serving.ExternalModelConfigdataclass. Fields moved todatabricks.sdk.service.serving.ExternalModel. - Added
max_provisioned_throughputandmin_provisioned_throughputfields fordatabricks.sdk.service.serving.ServedEntityInput. - Added
max_provisioned_throughputandmin_provisioned_throughputfields 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_optionsfield fordatabricks.sdk.service.sql.Parameter. - Added
multi_values_optionsfield fordatabricks.sdk.service.sql.Parameter. - Added
query_idfield fordatabricks.sdk.service.sql.Parameter. - Added
databricks.sdk.service.sql.MultiValuesOptionsdataclass.
OpenAPI SHA: cdd76a98a4fca7008572b3a94427566dd286c63b, Date: 2024-02-19