Releases: databricks/databricks-sdk-py
Releases · databricks/databricks-sdk-py
v0.27.0
New Features
- DBUtils implementation for Volumes (#623, #634, #631). You can now use
w.dbutils.fs
with 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_definition
field fordatabricks.sdk.service.pipelines.CreatePipeline
. - Added
ingestion_definition
field fordatabricks.sdk.service.pipelines.EditPipeline
. - Added
ingestion_definition
field fordatabricks.sdk.service.pipelines.PipelineSpec
. - Added
databricks.sdk.service.pipelines.IngestionConfig
dataclass. - Added
databricks.sdk.service.pipelines.ManagedIngestionPipelineDefinition
dataclass. - Added
databricks.sdk.service.pipelines.SchemaSpec
dataclass. - Added
databricks.sdk.service.pipelines.TableSpec
dataclass. - Changed
create()
method for w.apps workspace-level service . New request type isdatabricks.sdk.service.serving.CreateAppRequest
dataclass. - Changed
create()
method for w.apps workspace-level service to returndatabricks.sdk.service.serving.App
dataclass. - 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.AppEvents
dataclass. - Removed
databricks.sdk.service.serving.AppManifest
dataclass. - Removed
databricks.sdk.service.serving.AppServiceStatus
dataclass. - Removed
databricks.sdk.service.serving.DeleteAppResponse
dataclass. - Removed
databricks.sdk.service.serving.DeployAppRequest
dataclass. - Removed
databricks.sdk.service.serving.DeploymentStatus
dataclass. - Removed
databricks.sdk.service.serving.DeploymentStatusState
dataclass. - Removed
databricks.sdk.service.serving.GetAppDeploymentStatusRequest
dataclass. - Removed
databricks.sdk.service.serving.GetAppResponse
dataclass. - Removed
databricks.sdk.service.serving.GetEventsRequest
dataclass. - Removed
databricks.sdk.service.serving.ListAppEventsResponse
dataclass. - Changed
apps
field fordatabricks.sdk.service.serving.ListAppsResponse
todatabricks.sdk.service.serving.AppList
dataclass. - Added
databricks.sdk.service.serving.App
dataclass. - Added
databricks.sdk.service.serving.AppDeployment
dataclass. - Added
databricks.sdk.service.serving.AppDeploymentState
dataclass. - Added
databricks.sdk.service.serving.AppDeploymentStatus
dataclass. - Added
databricks.sdk.service.serving.AppEnvironment
dataclass. - Added
databricks.sdk.service.serving.AppState
dataclass. - Added
databricks.sdk.service.serving.AppStatus
dataclass. - Added
databricks.sdk.service.serving.CreateAppDeploymentRequest
dataclass. - Added
databricks.sdk.service.serving.CreateAppRequest
dataclass. - Added
databricks.sdk.service.serving.EnvVariable
dataclass. - Added
databricks.sdk.service.serving.GetAppDeploymentRequest
dataclass. - Added
databricks.sdk.service.serving.GetAppEnvironmentRequest
dataclass. - Added
databricks.sdk.service.serving.GetOpenApiRequest
dataclass. - Added
any
dataclass. - Added
databricks.sdk.service.serving.ListAppDeploymentsRequest
dataclass. - Added
databricks.sdk.service.serving.ListAppDeploymentsResponse
dataclass. - Added
databricks.sdk.service.serving.ListAppsRequest
dataclass. - Added
databricks.sdk.service.serving.StopAppRequest
dataclass. - Added
any
dataclass. - Added
databricks.sdk.service.serving.UpdateAppRequest
dataclass. - 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.CspEnablement
dataclass. - Removed
databricks.sdk.service.settings.CspEnablementSetting
dataclass. - Removed
databricks.sdk.service.settings.EsmEnablement
dataclass. - Removed
databricks.sdk.service.settings.EsmEnablementSetting
dataclass. - Removed
databricks.sdk.service.settings.GetCspEnablementSettingRequest
dataclass. - Removed
databricks.sdk.service.settings.GetEsmEnablementSettingRequest
dataclass. - Removed
databricks.sdk.service.settings.UpdateCspEnablementSettingRequest
dataclass. - Removed
databricks.sdk.service.settings.UpdateEsmEnablementSettingRequest
dataclass. - Added
databricks.sdk.service.settings.ComplianceSecurityProfile
dataclass. - Added
databricks.sdk.service.settings.ComplianceSecurityProfileSetting
dataclass. - Added
databricks.sdk.service.settings.EnhancedSecurityMonitoring
dataclass. - Added
databricks.sdk.service.settings.EnhancedSecurityMonitoringSetting
dataclass. - Added
databricks.sdk.service.settings.GetComplianceSecurityProfileSettingRequest
dataclass. - Added
databricks.sdk.service.settings.GetEnhancedSecurityMonitoringSettingRequest
dataclass. - Added
databricks.sdk.service.settings.UpdateComplianceSecurityProfileSettingRequest
dataclass. - Added
databricks.sdk.service.settings.UpdateEnhancedSecurityMonitoringSettingRequest
dataclass. - Added
tags
field fordatabricks.sdk.service.sql.DashboardEditContent
. - Added
tags
field fordatabricks.sdk.service.sql.QueryEditContent
. - Added
catalog
field fordatabricks.sdk.service.sql.QueryOptions
. - Added
schema
field fordatabricks.sdk.service.sql.QueryOptions
. - Added
tags
field fordatabricks.sdk.service.sql.QueryPostContent
. - Added
query
field 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
deployment
field fordatabricks.sdk.service.pipelines.CreatePipeline
,databricks.sdk.service.pipelines.EditPipeline
anddatabricks.sdk.service.pipelines.PipelineSpec
. - Added
schema_id
field fordatabricks.sdk.service.catalog.SchemaInfo
. - Added
operation
field fordatabricks.sdk.service.catalog.ValidationResult
. - Added
requirements
field fordatabricks.sdk.service.compute.Library
. - Added
warehouse_id
field fordatabricks.sdk.service.jobs.NotebookTask
. - Added
run_as
field fordatabricks.sdk.service.jobs.SubmitRun
. - Added
databricks.sdk.service.catalog.ValidationResultOperation
dataclass. - Added
databricks.sdk.service.compute.ClusterStatus
dataclass. - Added
databricks.sdk.service.compute.ClusterStatusResponse
dataclass. - Added
databricks.sdk.service.compute.LibraryInstallStatus
dataclass. - Added
databricks.sdk.service.pipelines.DeploymentKind
dataclass. - Added
databricks.sdk.service.pipelines.PipelineDeployment
dataclass. - Removed
aws_operation
field fordatabricks.sdk.service.catalog.ValidationResult
. - Removed
azure_operation
field fordatabricks.sdk.service.catalog.ValidationResult
. - Removed
gcp_operation
field fordatabricks.sdk.service.catalog.ValidationResult
. - Removed
databricks.sdk.service.catalog.ValidationResultAwsOperation
dataclass. - Removed
databricks.sdk.service.catalog.ValidationResultAzureOperation
dataclass. - Removed
databricks.sdk.service.catalog.ValidationResultGcpOperation
dataclass. - Removed
databricks.sdk.service.compute.LibraryFullStatusStatus
dataclass. - Removed
databricks.sdk.service.compute.ClusterStatusRequest
dataclass. - Changed
cluster_status()
method for w.libraries workspace-level service . New request type isdatabricks.sdk.service.compute.ClusterStatus
dataclass. - Changed
cluster_status()
method for w.libraries workspace-level service to returndatabricks.sdk.service.compute.ClusterStatusResponse
dataclass. - Changed
status
field fordatabricks.sdk.service.compute.LibraryFullStatus
todatabricks.sdk.service.compute.LibraryInstallStatus
dataclass.
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
InvalidParameterValue
exception. This change throws aResourceNotFoundException
instead in this circumstance. To handle this change, modify error handling by updating yourexcept
blocks 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.AzureManagedIdentity
dataclass. - Removed
full_name
field fordatabricks.sdk.service.catalog.CancelRefreshRequest
. - Added
table_name
field fordatabricks.sdk.service.catalog.CancelRefreshRequest
. - Changed
custom_metrics
field fordatabricks.sdk.service.catalog.CreateMonitor
todatabricks.sdk.service.catalog.MonitorMetricList
dataclass. - Removed
full_name
field fordatabricks.sdk.service.catalog.CreateMonitor
. - Changed
inference_log
field fordatabricks.sdk.service.catalog.CreateMonitor
todatabricks.sdk.service.catalog.MonitorInferenceLog
dataclass. - Changed
notifications
field fordatabricks.sdk.service.catalog.CreateMonitor
todatabricks.sdk.service.catalog.MonitorNotifications
dataclass. - Changed
snapshot
field fordatabricks.sdk.service.catalog.CreateMonitor
toany
dataclass. - Changed
time_series
field fordatabricks.sdk.service.catalog.CreateMonitor
todatabricks.sdk.service.catalog.MonitorTimeSeries
dataclass. - Added
table_name
field fordatabricks.sdk.service.catalog.CreateMonitor
. - Changed
azure_managed_identity
field fordatabricks.sdk.service.catalog.CreateStorageCredential
todatabricks.sdk.service.catalog.AzureManagedIdentityRequest
dataclass. - Removed
full_name
field fordatabricks.sdk.service.catalog.DeleteLakehouseMonitorRequest
. - Added
table_name
field fordatabricks.sdk.service.catalog.DeleteLakehouseMonitorRequest
. - Removed
full_name
field fordatabricks.sdk.service.catalog.GetLakehouseMonitorRequest
. - Added
table_name
field fordatabricks.sdk.service.catalog.GetLakehouseMonitorRequest
. - Removed
full_name
field fordatabricks.sdk.service.catalog.GetRefreshRequest
. - Added
table_name
field fordatabricks.sdk.service.catalog.GetRefreshRequest
. - Removed
full_name
field fordatabricks.sdk.service.catalog.ListRefreshesRequest
. - Added
table_name
field fordatabricks.sdk.service.catalog.ListRefreshesRequest
. - Changed
quartz_cron_expression
field fordatabricks.sdk.service.catalog.MonitorCronSchedule
to be required. - Changed
timezone_id
field fordatabricks.sdk.service.catalog.MonitorCronSchedule
to be required. - Removed
databricks.sdk.service.catalog.MonitorCustomMetric
dataclass. - Removed
databricks.sdk.service.catalog.MonitorCustomMetricType
dataclass. - Removed
databricks.sdk.service.catalog.MonitorDestinations
dataclass. - Removed
databricks.sdk.service.catalog.MonitorInferenceLogProfileType
dataclass. - Removed
databricks.sdk.service.catalog.MonitorInferenceLogProfileTypeProblemType
dataclass. - Changed
custom_metrics
field fordatabricks.sdk.service.catalog.MonitorInfo
todatabricks.sdk.service.catalog.MonitorMetricList
dataclass. - Changed
drift_metrics_table_name
field fordatabricks.sdk.service.catalog.MonitorInfo
to be required. - Changed
inference_log
field fordatabricks.sdk.service.catalog.MonitorInfo
todatabricks.sdk.service.catalog.MonitorInferenceLog
dataclass. - Changed
monitor_version
field fordatabricks.sdk.service.catalog.MonitorInfo
to be required. - Changed
notifications
field fordatabricks.sdk.service.catalog.MonitorInfo
todatabricks.sdk.service.catalog.MonitorNotifications
dataclass. - Changed
profile_metrics_table_name
field fordatabricks.sdk.service.catalog.MonitorInfo
to be required. - Changed
snapshot
field fordatabricks.sdk.service.catalog.MonitorInfo
toany
dataclass. - Changed
status
field fordatabricks.sdk.service.catalog.MonitorInfo
to be required. - Changed
table_name
field fordatabricks.sdk.service.catalog.MonitorInfo
to be required. - Changed
time_series
field fordatabricks.sdk.service.catalog.MonitorInfo
todatabricks.sdk.service.catalog.MonitorTimeSeries
dataclass. - Removed
databricks.sdk.service.catalog.MonitorNotificationsConfig
dataclass. - Changed
refresh_id
field fordatabricks.sdk.service.catalog.MonitorRefreshInfo
to be required. - Changed
start_time_ms
field fordatabricks.sdk.service.catalog.MonitorRefreshInfo
to be required. - Changed
state
field fordatabricks.sdk.service.catalog.MonitorRefreshInfo
to be required. - Added
trigger
field fordatabricks.sdk.service.catalog.MonitorRefreshInfo
. - Removed
any
dataclass. - Removed
databricks.sdk.service.catalog.MonitorTimeSeriesProfileType
dataclass. - Removed
full_name
field fordatabricks.sdk.service.catalog.RunRefreshRequest
. - Added
table_name
field fordatabricks.sdk.service.catalog.RunRefreshRequest
. - Changed
azure_managed_identity
field fordatabricks.sdk.service.catalog.StorageCredentialInfo
todatabricks.sdk.service.catalog.AzureManagedIdentityResponse
dataclass. - Removed
name
field fordatabricks.sdk.service.catalog.TableRowFilter
. - Added
function_name
field fordatabricks.sdk.service.catalog.TableRowFilter
. - Changed
custom_metrics
field fordatabricks.sdk.service.catalog.UpdateMonitor
todatabricks.sdk.service.catalog.MonitorMetricList
dataclass. - Removed
full_name
field fordatabricks.sdk.service.catalog.UpdateMonitor
. - Changed
inference_log
field fordatabricks.sdk.service.catalog.UpdateMonitor
todatabricks.sdk.service.catalog.MonitorInferenceLog
dataclass. - Changed
notifications
field fordatabricks.sdk.service.catalog.UpdateMonitor
todatabricks.sdk.service.catalog.MonitorNotifications
dataclass. - Changed
snapshot
field fordatabricks.sdk.service.catalog.UpdateMonitor
toany
dataclass. - Changed
time_series
field fordatabricks.sdk.service.catalog.UpdateMonitor
todatabricks.sdk.service.catalog.MonitorTimeSeries
dataclass. - Added
table_name
field fordatabricks.sdk.service.catalog.UpdateMonitor
. - Changed
azure_managed_identity
field fordatabricks.sdk.service.catalog.UpdateStorageCredential
todatabricks.sdk.service.catalog.AzureManagedIdentityResponse
dataclass. - Changed
azure_managed_identity
field fordatabricks.sdk.service.catalog.ValidateStorageCredential
todatabricks.sdk.service.catalog.AzureManagedIdentityRequest
dataclass. - Removed
operation
field fordatabricks.sdk.service.catalog.ValidationResult
. - Added
aws_operation
field fordatabricks.sdk.service.catalog.ValidationResult
. - Added
azure_operation
field fordatabricks.sdk.service.catalog.ValidationResult
. - Added
gcp_operation
field fordatabricks.sdk.service.catalog.ValidationResult
. - Removed
databricks.sdk.service.catalog.ValidationResultOperation
dataclass. - Added
databricks.sdk.service.catalog.AzureManagedIdentityRequest
dataclass. - Added
databricks.sdk.service.catalog.AzureManagedIdentityResponse
dataclass. - Added
databricks.sdk.service.catalog.MonitorDestination
dataclass. - Added
databricks.sdk.service.catalog.MonitorInferenceLog
dataclass. - Added
databricks.sdk.service.catalog.MonitorInferenceLogProblemType
dataclass. - Added
databricks.sdk.service.catalog.MonitorMetric
dataclass. - Added
databricks.sdk.service.catalog.MonitorMetricType
dataclass. - Added
databricks.sdk.service.catalog.MonitorNotifications
dataclass. - Added
databricks.sdk.service.catalog.MonitorRefreshInfoTrigger
dataclass. - Added
any
dataclass. - Added
databricks.sdk.service.catalog.MonitorTimeSeries
dataclass. - 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.MigrateDashboardRequest
anddatabricks.sdk.service.dashboards.UnpublishDashboardRequest
dataclasses. - Added
description
,queue_duration
andrepair_history
fields fordatabricks.sdk.service.jobs.BaseRun
. - Added
compute_key
andjob_cluster_key
fields fordatabricks.sdk.service.jobs.ClusterSpec
. - Changed
left
,op
andright
fields fordatabricks.sdk.service.jobs.ConditionTask
to be required. - Changed
edit_mode
field fordatabricks.sdk.service.jobs.CreateJob
todatabricks.sdk.service.jobs.JobEditMode
dataclass. - Replaced
databricks.sdk.service.jobs.CreateJobEditMode
dataclass bydatabricks.sdk.service.jobs.JobEditMode
. - Changed
url
field fordatabricks.sdk.service.jobs.FileArrivalTriggerConfiguration
to be required. - Changed
error_message_stats
field fordatabricks.sdk.service.jobs.ForEachStats
todatabricks.sdk.service.jobs.ForEachTaskErrorMessageStatsList
dataclass. - Changed
new_cluster
field fordatabricks.sdk.service.jobs.JobCluster
to be required. - Changed
edit_mode
field fordatabricks.sdk.service.jobs.JobSettings
todatabricks.sdk.service.jobs.JobEditMode
dataclass. - Replaced
databricks.sdk.service.jobs.JobsSettingsEditMode
dataclass bydatabricks.sdk.service.jobs.JobEditMode
. - Changed
metric
,op
andvalue
fields fordatabricks.sdk.service.jobs.JobsHealthRule
to be required. - Changed
run_type
field fordatabricks.sdk.service.jobs.ListRunsRequest
todatabricks.sdk.service.jobs.RunType
dataclass. - Repplaced
databricks.sdk.service.jobs.ListRunsRunType
dataclass bydatabricks.sdk.service.jobs.RunType
dataclass. - Changed
pipeline_id
field fordatabricks.sdk.service.jobs.PipelineTask
to be required. - Changed
entry_point
andpackage_name
fields fordatabricks.sdk.service.jobs.PythonWheelTask
to be required. - Changed
job_parameters
field fordatabricks.sdk.service.jobs.RepairRun
to dict[str,str
] dataclass. - Changed
base_parameters
field fordatabricks.sdk.service.jobs.ResolvedNotebookTaskValues
to dict[str,str
] dataclass. - Changed
parameters
field fordatabricks.sdk.service.jobs.ResolvedParamPairValues
to dict[str,str
] dataclass. - Changed
named_parameters
field fordatabricks.sdk.service.jobs.ResolvedPythonWheelTaskValues
to dict[str,str
] dataclass. - Removed
named_parameters
field fordatabricks.sdk.service.jobs.ResolvedRunJobTaskValues
. - Changed
parameters
field fordatabricks.sdk.service.jobs.ResolvedRunJobTaskValues
to dict[str,str
] dataclass. - Added
job_parameters
field fordatabricks.sdk.service.jobs.ResolvedRunJobTaskValues
. - Added
description
andqueue_duration
fields fordatabricks.sdk.service.jobs.Run
. - Changed
op
field fordatabricks.sdk.service.jobs.RunConditionTask
todatabricks.sdk.service.jobs.ConditionTaskOp
dataclass. - Replaced
databricks.sdk.service.jobs.RunConditionTaskOp
dataclass bydatabricks.sdk.service.jobs.ConditionTaskOp
dataclass. - Changed
inputs
andtask
fields fordatabricks.sdk.service.jobs.RunForEachTask
to be required. - Changed
job_parameters
field fordatabricks.sdk.service.jobs.RunJobTask
to dict[str,str
] dataclass. - Added
dbt_commands
,jar_params
,notebook_params
,pipeline_params
,python_named_params
,python_params
,spark_submit_params
andsql_params
fields fordatabricks.sdk.service.jobs.RunJobTask
. - Changed
job_parameters
field fordatabricks.sdk.service.jobs.RunNow
to dict[str,str
] dataclass. - Added
info
field fordatabricks.sdk.service.jobs.RunOutput
. - Removed
job_parameters
field fordatabricks.sdk.service.jobs.RunParameters
. - Changed
task_key
field fordatabricks.sdk.service.jobs.RunTask
to be required. - Added
compute_key
,email_notifications
,job_cluster_key
,notification_settings
,run_duration
,run_page_url
,timeout_seconds
andwebhook_notifications
fields fordatabricks.sdk.service.jobs.RunTask
. - Added
endpoint_id
field 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_task
andsql_task
fields fordatabricks.sdk.service.jobs.SubmitRun
. - Added
description
field fordatabricks.sdk.service.jobs.SubmitTask
. - Added
disable_auto_optimization
field fordatabricks.sdk.service.jobs.Task
. - Added
no_alert_for_skipped_runs
field fordatabricks.sdk.service.jobs.TaskEmailNotifications
. - Added
table_update
field fordatabricks.sdk.service.jobs.TriggerSettings
. - Changed
id
field fordatabricks.sdk.service.jobs.Webhook
to be required. - Changed
on_duration_warning_threshold_exceeded
field fordatabricks.sdk.service.jobs.WebhookNotifications
todatabricks.sdk.service.jobs.WebhookList
dataclass. - Removed
databricks.sdk.service.jobs.WebhookNotificationsOnDurationWarningThresholdExceededItem
dataclass. - Added
databricks.sdk.service.jobs.JobEditMode
dataclass. - Replaced
databricks.sdk.service.serving.AwsBedrockConfig
dataclass bydatabricks.sdk.service.serving.AmazonBedrockConfig
dataclass. - Replaced
databricks.sdk.service.serving.AwsBedrockConfigBedrockProvider
dataclass bydatabricks.sdk.service.serving.AmazonBedrockConfigBedrockProvider
dataclass. - Renamed
aws_bedrock_config
field fordatabricks.sdk.service.serving.ExternalModel
toamazon_bedrock_config
. - Changed
get()
method for w.ip_access_lists workspace-level service . New request type isdatabricks.sdk.service.settings.GetIpAccessListRequest
dataclass. - Replaced
databricks.sdk.service.settings.GetIpAccessList
dataclass bydatabricks.sdk.service.settings.GetIpAccessListRequest
dataclass.
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.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