Version changelog
July 9, 2026 · View on GitHub
Release v0.121.0 (2026-07-09)
API Changes
- Add
list()andlist_effective()methods for w.grants workspace-level service. - Add
update_timefield fordatabricks.sdk.service.bundledeployments.Resource. - Add
stable_workspace_idfield fordatabricks.sdk.service.disasterrecovery.StableUrl. - Add
deployment_idandversion_idfields fordatabricks.sdk.service.jobs.BaseRun. - Add
parent_pathfield fordatabricks.sdk.service.jobs.CreateJob. - Add
parent_pathfield fordatabricks.sdk.service.jobs.JobSettings. - Add
deployment_idandversion_idfields fordatabricks.sdk.service.jobs.Run. - Add
first_distinctandlast_distinctfields fordatabricks.sdk.service.ml.AggregationFunction. - Add
trace_locationfield fordatabricks.sdk.service.ml.CreateExperiment. - Add
trace_locationfield fordatabricks.sdk.service.ml.Experiment. - Add
avro_schemaandproto_schemafields fordatabricks.sdk.service.ml.SchemaConfig. - Add
freshness_targetfield fordatabricks.sdk.service.ml.StreamingMode. - Add
long_rollingfield fordatabricks.sdk.service.ml.TimeWindow. - Add
git_credential_idfield fordatabricks.sdk.service.workspace.CreateRepoRequest. - Add
git_credential_idfield fordatabricks.sdk.service.workspace.UpdateRepoRequest. - Add
cpu_largeandcpu_mediumenum values fordatabricks.sdk.service.serving.ServedModelInputWorkloadType. - Add
cpu_largeandcpu_mediumenum values fordatabricks.sdk.service.serving.ServingModelWorkloadType. - [Breaking] Change
rolefield fordatabricks.sdk.service.postgres.DatabaseDatabaseSpecto be required. - Change
rolefield fordatabricks.sdk.service.postgres.DatabaseDatabaseSpecto be required. - [Breaking] Remove
include_browsefield fordatabricks.sdk.service.catalog.GetSecretRequest. - [Breaking] Remove
include_browsefield fordatabricks.sdk.service.catalog.ListSecretsRequest. - [Breaking] Remove
browse_onlyandexternal_secret_idfields fordatabricks.sdk.service.catalog.Secret. - [Breaking] Remove
first_distinct_nandlast_distinct_nfields fordatabricks.sdk.service.ml.AggregationFunction. - [Breaking] Remove
group_namefield fordatabricks.sdk.service.postgres.GenerateDatabaseCredentialRequest.
Documentation
- Document all 18 valid
auth_typevalues in a new Authentication Types Reference page, linked from the README and authentication docs.
Release v0.120.0 (2026-07-01)
API Changes
- Add
download_message_attachment_visualization()method for w.genie workspace-level service. - Add
omit_permissions_in_responsefield fordatabricks.sdk.service.catalog.UpdatePermissions. - Add
vizfield fordatabricks.sdk.service.dashboards.GenieAttachment. - Add
enable_visualizationfield fordatabricks.sdk.service.dashboards.GenieCreateConversationMessageRequest. - Add
enable_visualizationfield fordatabricks.sdk.service.dashboards.GenieStartConversationMessageRequest. - Add
excluded_schemasfield fordatabricks.sdk.service.dataclassification.CatalogConfig. - Add
etagfield fordatabricks.sdk.service.disasterrecovery.UpdateFailoverGroupRequest. - Add
specfield fordatabricks.sdk.service.environments.WorkspaceBaseEnvironment. - Add
full_namefield fordatabricks.sdk.service.iamv2.User. - Add
status_messagefield fordatabricks.sdk.service.jobs.AiRuntimeTaskOutput. - Add
sql_conditionfield fordatabricks.sdk.service.jobs.CronSchedule. - Add
sql_conditionfield fordatabricks.sdk.service.jobs.TriggerInfo. - Add
sql_conditionfield fordatabricks.sdk.service.jobs.TriggerSettings. - Add
sql_conditionfield fordatabricks.sdk.service.jobs.TriggerStateProto. - Add
first_distinct_n,first_n,last_distinct_nandlast_nfields fordatabricks.sdk.service.ml.AggregationFunction. - Add
replace_existingfield fordatabricks.sdk.service.postgres.CreateDatabaseRequest. - Add
replace_existingfield fordatabricks.sdk.service.postgres.CreateRoleRequest. - Add
read_only_pooled_hostandread_write_pooled_hostfields fordatabricks.sdk.service.postgres.EndpointHosts. - Add
last_active_timefield fordatabricks.sdk.service.postgres.EndpointStatus. - Add
expire_time,group_nameandttlfields fordatabricks.sdk.service.postgres.GenerateDatabaseCredentialRequest. - Add
autoscaling_limit_max_cu,autoscaling_limit_min_cu,no_suspensionandsuspend_timeout_durationfields fordatabricks.sdk.service.postgres.InitialEndpointSpec. - Add
initial_branch_specfield fordatabricks.sdk.service.postgres.Project. - Add
compute_last_active_timefield fordatabricks.sdk.service.postgres.ProjectStatus. - Add
telemetry_configfield fordatabricks.sdk.service.serving.CreateServingEndpoint. - Add
telemetry_configfield fordatabricks.sdk.service.serving.ServingEndpoint. - Add
telemetry_configfield fordatabricks.sdk.service.serving.ServingEndpointDetailed. - Add
read_metadataenum value fordatabricks.sdk.service.catalog.Privilege. - [Breaking] Remove
namefield fordatabricks.sdk.service.iamv2.User.
Release v0.119.0 (2026-06-24)
New Features and Improvements
- Added a
meta-harnessuser-agent dimension that reports the omnigent meta-harness (detected via theOMNIGENTenvironment variable) independently of agent detection.
API Changes
- Add
cancel_pending_cluster_enforcement()method for w.policy_compliance_for_clusters workspace-level service. - Add
bundle_root_pathfield fordatabricks.sdk.service.bundledeployments.WorkspaceInfo. - Add
pending_enforcementfield fordatabricks.sdk.service.compute.ClusterCompliance. - Add
enforce_modefield fordatabricks.sdk.service.compute.EnforceClusterComplianceRequest. - Add
enforce_resultfield fordatabricks.sdk.service.compute.EnforceClusterComplianceResponse. - Add
pending_enforcementfield fordatabricks.sdk.service.compute.GetClusterComplianceResponse. - Add
ai_runtime_taskfield fordatabricks.sdk.service.jobs.ResolvedValues. - Add
ai_runtime_task_outputfield fordatabricks.sdk.service.jobs.RunOutput. - Add
ai_runtime_taskfield fordatabricks.sdk.service.jobs.RunTask. - Add
ai_runtime_taskfield fordatabricks.sdk.service.jobs.SubmitTask. - Add
ai_runtime_taskfield fordatabricks.sdk.service.jobs.Task. - Add
xlargeenum value fordatabricks.sdk.service.apps.ComputeSize. - Add
deferred_policy_enforcement_scheduledanddeferred_policy_enforcement_failedenum values fordatabricks.sdk.service.compute.EventType. - [Breaking] Change
replicate_workspace_assetsfield fordatabricks.sdk.service.disasterrecovery.WorkspaceSetto no longer be required. - Change
replicate_workspace_assetsfield fordatabricks.sdk.service.disasterrecovery.WorkspaceSetto no longer be required.
Release v0.118.0 (2026-06-18)
API Changes
- Add
create_data_api(),delete_data_api(),get_data_api()andupdate_data_api()methods for w.postgres workspace-level service. - Add
capacity_reservation_groupfield fordatabricks.sdk.service.compute.AzureAttributes. - Add
serverless_compute_idfield fordatabricks.sdk.service.pipelines.ClonePipelineRequest. - Add
serverless_compute_idfield fordatabricks.sdk.service.pipelines.CreatePipeline. - Add
serverless_compute_idfield fordatabricks.sdk.service.pipelines.EditPipeline. - Add
serverless_compute_idfield fordatabricks.sdk.service.pipelines.PipelineSpec. - Add
endpoint_idfield fordatabricks.sdk.service.vectorsearch.MiniVectorIndex. - Add
endpoint_idfield fordatabricks.sdk.service.vectorsearch.VectorIndex. - Add
dynamics365enum value fordatabricks.sdk.service.catalog.ConnectionType.
Release v0.117.0 (2026-06-11)
API Changes
- Add
type_overridesfield fordatabricks.sdk.service.database.SyncedTableSpec. - Add
type_overridesfield fordatabricks.sdk.service.postgres.SyncedTableSyncedTableSpec. - Change
resource_idfield fordatabricks.sdk.service.bundledeployments.Operationto no longer be required. - [Breaking] Change
resource_idfield fordatabricks.sdk.service.bundledeployments.Operationto no longer be required.
Bug Fixes
- Cache tokens minted by
DatabricksOidcTokenSource(Workload Identity Federation / account-wide token federation). Previously a fresh/oidc/v1/tokenexchange was performed on every authenticated API call, adding latency, amplifying transient federation-policy errors, and hitting OIDC token-endpoint rate limits. The token source now reuses the cached token until it is stale or expired, fetching a fresh ID token on each refresh to support rotation. - Make
WorkspaceClient.dbutilslazy (functools.cached_property). The constructor no longer importsdatabricks.sdk.runtimeeagerly, so on Spark Connect (shared-access-mode) clusters, consumers that never read.dbutils— such asdbt-databricksPython models — no longer crash withCONTEXT_UNAVAILABLE_FOR_REMOTE_CLIENTduring client construction. - Fall back to the remote runtime implementation when the legacy user
namespace cannot be materialized. On Spark Connect runtimes (e.g.
shared-access-mode clusters), importing
databricks.sdk.runtime— which happens when constructing aWorkspaceClienton such a cluster — tried to build a legacySparkContextand raisedCONTEXT_UNAVAILABLE_FOR_REMOTE_CLIENTat import time. It now logs a warning and falls back to the Spark Connect-compatible remote implementation instead of crashing.
Internal Changes
- Declare
urllib3as an explicit dependency. The SDK imports it directly; previously it was only available transitively throughrequests. No resolution change for users.
Release v0.116.0 (2026-06-10)
API Changes
- Add
databricks.sdk.service.aisearchanddatabricks.sdk.service.bundledeploymentspackages. - Add w.ai_search workspace-level service.
- Add w.bundle_deployments workspace-level service.
- Add
running_instancesfield fordatabricks.sdk.service.apps.ApplicationStatus. - Add
custom_max_retention_hoursfield fordatabricks.sdk.service.catalog.CatalogInfo. - Add
environment_settingsfield fordatabricks.sdk.service.catalog.ConnectionInfo. - Add
custom_max_retention_hoursfield fordatabricks.sdk.service.catalog.CreateCatalog. - Add
environment_settingsfield fordatabricks.sdk.service.catalog.CreateConnection. - Add
custom_max_retention_hoursfield fordatabricks.sdk.service.catalog.CreateSchema. - Add
custom_max_retention_hoursfield fordatabricks.sdk.service.catalog.SchemaInfo. - Add
custom_max_retention_hoursfield fordatabricks.sdk.service.catalog.UpdateCatalog. - Add
environment_settingsfield fordatabricks.sdk.service.catalog.UpdateConnection. - Add
custom_max_retention_hoursfield fordatabricks.sdk.service.catalog.UpdateSchema. - Add
stream_sourcefield fordatabricks.sdk.service.ml.DataSource. - Add
ingestion_configfield fordatabricks.sdk.service.ml.KafkaConfig. - Add
clustering_columns,enable_auto_clusteringandtable_propertiesfields fordatabricks.sdk.service.pipelines.TableSpecificConfig. - Add
branch_idfield fordatabricks.sdk.service.postgres.Branch. - Add
catalog_idfield fordatabricks.sdk.service.postgres.Catalog. - Add
database_idfield fordatabricks.sdk.service.postgres.Database. - Add
endpoint_idfield fordatabricks.sdk.service.postgres.Endpoint. - Add
project_idfield fordatabricks.sdk.service.postgres.Project. - Add
role_idfield fordatabricks.sdk.service.postgres.Role. - Add
synced_table_idfield fordatabricks.sdk.service.postgres.SyncedTable. - Add
allowed_databricks_destinationsfield fordatabricks.sdk.service.settings.EgressNetworkPolicyNetworkAccessPolicy. - Add
facets,query_columnsandsort_columnsfields fordatabricks.sdk.service.vectorsearch.QueryVectorIndexRequest. - Add
facet_resultfield fordatabricks.sdk.service.vectorsearch.QueryVectorIndexResponse. - Add
facet_column_countandfacet_columnsfields fordatabricks.sdk.service.vectorsearch.ResultManifest. - Add
dangerously_force_discard_allfield fordatabricks.sdk.service.workspace.UpdateRepoRequest. - [Breaking] Remove
databricks.sdk.service.bundlepackage. - [Breaking] Remove w.bundle workspace-level service.
- Add
accelerated_syncfield fordatabricks.sdk.service.database.SyncedTableSpec. - Add
accelerated_syncfield fordatabricks.sdk.service.postgres.SyncedTableSyncedTableSpec.
Release v0.115.0 (2026-06-08)
New Features and Improvements
- Honor the Vercel
AI_AGENT=<name>env var as a secondary fallback for AI agent detection in the User-Agent header (after the agents.mdAGENT=<name>standard). Unrecognized fallback values now pass through the User-Agent sanitized and length-capped at 64 chars instead of being coerced toagent/unknown, so versioned variants such asclaude-code_2-1-141_agentsurface as-is.
Release v0.114.0 (2026-06-02)
API Changes
- Add
deployment_modefield fordatabricks.sdk.service.bundle.Deployment. - Add
deployment_modefield fordatabricks.sdk.service.bundle.Version. - Add
collaboration_platform_connectivityandeffective_collaboration_platform_connectivityfields fordatabricks.sdk.service.settingsv2.Setting.
Release v0.113.0 (2026-06-01)
Internal Changes
- Switch workspace addressing header on workspace-scoped API calls from
X-Databricks-Org-IdtoX-Databricks-Workspace-Id. The value continues to come fromConfig.workspace_id(DATABRICKS_WORKSPACE_ID), and now accepts either a classic numeric workspace ID or another workspace identifier format (server disambiguates).
API Changes
- Add
create_stream(),delete_stream(),get_stream(),list_streams()andupdate_stream()methods for w.feature_engineering workspace-level service. - Add
update_token_management()method for w.token_management workspace-level service. - Add
deployment_idandversion_idfields fordatabricks.sdk.service.jobs.JobDeployment. - Add
parametersfield fordatabricks.sdk.service.jobs.PipelineTask. - Add
pipeline_taskfield fordatabricks.sdk.service.jobs.ResolvedValues. - Add
parametersfield fordatabricks.sdk.service.pipelines.CreatePipeline. - Add
parametersfield fordatabricks.sdk.service.pipelines.EditPipeline. - Add
parametersfield fordatabricks.sdk.service.pipelines.GetPipelineResponse. - Add
deployment_idandversion_idfields fordatabricks.sdk.service.pipelines.PipelineDeployment. - Add
autoscope_enabledfield fordatabricks.sdk.service.settings.CreateOboTokenRequest. - Add
autoscope_enabledfield fordatabricks.sdk.service.settings.CreateTokenRequest. - Add
autoscope_state,backfill_scopes,inferred_scopesandscopesfields fordatabricks.sdk.service.settings.PublicTokenInfo. - Add
autoscope_state,backfill_scopes,inferred_scopesandscopesfields fordatabricks.sdk.service.settings.TokenInfo. - [Breaking] Remove
catalog_idfield fordatabricks.sdk.service.postgres.CatalogCatalogStatus. - [Breaking] Remove
synced_table_idfield fordatabricks.sdk.service.postgres.SyncedTableSyncedTableStatus. - Add
resource_typefield fordatabricks.sdk.service.bundle.Operation.
Release v0.112.0 (2026-05-27)
Internal Changes
- Switch the formatter and linter from black/isort/autoflake to ruff (format + lint), aligning the SDK formatter with Databricks' internal Python formatting guidelines in preparation for moving the source of truth to a separate internal repository.
make fmtnow runsruff format+ruff check --fix-only;make lintrunsruff checkandruff format --checkacrossdatabricksandtests. No behavioral changes to the published SDK.
Release v0.111.0 (2026-05-25)
API Changes
- Add
databricks.sdk.service.bundlepackage. - Add w.bundle workspace-level service.
- Add
revert()method for w.lakeview workspace-level service. - Add
undelete_branch()method for w.postgres workspace-level service. - Add
parent_pathfield fordatabricks.sdk.service.dashboards.GenieUpdateSpaceRequest. - Add
attributesandexcluded_attributesfields fordatabricks.sdk.service.iam.MeRequest. - Add
include_trigger_statefield fordatabricks.sdk.service.jobs.GetJobRequest. - Add
mtls_configfield fordatabricks.sdk.service.ml.AuthConfig. - Add
delete_timeandpurge_timefields fordatabricks.sdk.service.postgres.BranchStatus. - Add
purgefield fordatabricks.sdk.service.postgres.DeleteBranchRequest. - Add
show_deletedfield fordatabricks.sdk.service.postgres.ListBranchesRequest. - Add
deletedenum value fordatabricks.sdk.service.postgres.BranchStatusState. - [Breaking] Change
tagsfield fordatabricks.sdk.service.marketplace.ListListingsRequestto typedatabricks.sdk.service.marketplace.ListingTagdataclass. - [Breaking] Change pagination for ClustersAPI.events method.
- Add
compute_max_instancesandcompute_min_instancesfields fordatabricks.sdk.service.apps.App. - Add
compute_max_instancesandcompute_min_instancesfields fordatabricks.sdk.service.apps.AppUpdate. - Add
cron_schedule_trigger,streaming_modeandtable_triggerfields fordatabricks.sdk.service.ml.MaterializedFeature. - Add
synced_table_idfield fordatabricks.sdk.service.postgres.SyncedTableSyncedTableStatus.
Release v0.110.0 (2026-05-19)
API Changes
- Add
full_refresh_selection,refresh_flow_selection,refresh_selectionandreset_checkpoint_selectionfields fordatabricks.sdk.service.jobs.PipelineParams. - Add
full_refresh_selection,refresh_flow_selection,refresh_selectionandreset_checkpoint_selectionfields fordatabricks.sdk.service.jobs.PipelineTask. - Add
effective_operational_email_custom_recipientandoperational_email_custom_recipientfields fordatabricks.sdk.service.settingsv2.Setting.
Release v0.109.0 (2026-05-18)
API Changes
- Add
create_workspace_assignment_detail(),delete_workspace_assignment_detail(),get_workspace_assignment_detail(),list_workspace_assignment_details()andupdate_workspace_assignment_detail()methods for a.account_iam_v2 account-level service. - Add
create_workspace_assignment_detail_proxy(),delete_workspace_assignment_detail_proxy(),get_workspace_assignment_detail_proxy(),list_workspace_assignment_details_proxy()andupdate_workspace_assignment_detail_proxy()methods for w.workspace_iam_v2 workspace-level service. - Add
failover_group_namefield fordatabricks.sdk.service.disasterrecovery.StableUrl. - Add
catalog_name,created_at,created_by,nameandschema_namefields fordatabricks.sdk.service.ml.Feature. - [Breaking] Add
catalog_nameandschema_namefields fordatabricks.sdk.service.ml.ListFeaturesRequest. - Add
cross_workspace_accessfield fordatabricks.sdk.service.settings.CustomerFacingIngressNetworkPolicy. - Add
allowed_apps_user_api_scopesandeffective_allowed_apps_user_api_scopesfields fordatabricks.sdk.service.settingsv2.Setting. - Add
gpu_xlargeenum value fordatabricks.sdk.service.serving.ServedModelInputWorkloadType. - Add
gpu_xlargeenum value fordatabricks.sdk.service.serving.ServingModelWorkloadType. - [Breaking] Change
list_features()method for w.feature_engineering workspace-level service with new required argument order. - Add
python_operator_taskfield fordatabricks.sdk.service.jobs.RunTask. - Add
python_operator_taskfield fordatabricks.sdk.service.jobs.SubmitTask. - Add
python_operator_taskfield fordatabricks.sdk.service.jobs.Task. - Add
rollingfield fordatabricks.sdk.service.ml.TimeWindow.
Release v0.108.0 (2026-05-12)
API Changes
- Add
disabledfield fordatabricks.sdk.service.jobs.RunTask. - Add
disabledfield fordatabricks.sdk.service.jobs.SubmitTask. - Add
hubspot,github,outlookandsmartsheetenum values fordatabricks.sdk.service.catalog.ConnectionType. - [Breaking] Remove
unspecified_resource_namefield fordatabricks.sdk.service.postgres.RequestedResource.
Release v0.107.0 (2026-05-11)
Internal Changes
- Pass
--force-refreshto Databricks CLIauth tokencommand so the SDK always receives a freshly minted token instead of a potentially stale one from the CLI's internal cache.
API Changes
- Add
create_example(),delete_example(),get_example(),get_permission_levels(),get_permissions(),list_examples(),set_permissions(),update_example()andupdate_permissions()methods for w.supervisor_agents workspace-level service. - Add
meta_ads_optionsfield fordatabricks.sdk.service.pipelines.ConnectorOptions. - Add
meta_marketingandzendeskenum values fordatabricks.sdk.service.catalog.ConnectionType. - Add
meta_marketingenum value fordatabricks.sdk.service.pipelines.IngestionSourceType. - Change
guidelinesfield fordatabricks.sdk.service.knowledgeassistants.Exampleto no longer be required. - [Breaking] Change
guidelinesfield fordatabricks.sdk.service.knowledgeassistants.Exampleto no longer be required. - Change
descriptionfield fordatabricks.sdk.service.supervisoragents.Toolto no longer be required. - [Breaking] Change
descriptionfield fordatabricks.sdk.service.supervisoragents.Toolto no longer be required. - Add
r2_temp_credentialsfield fordatabricks.sdk.service.catalog.TemporaryCredentials. - Add
zendesk_support_optionsfield fordatabricks.sdk.service.pipelines.ConnectorOptions. - Add
azure_key_infofield fordatabricks.sdk.service.provisioning.CreateCustomerManagedKeyRequest. - Add
target_qpsfield fordatabricks.sdk.service.vectorsearch.CreateEndpoint. - Add
requested_target_qpsfield fordatabricks.sdk.service.vectorsearch.EndpointScalingInfo. - Add
target_qpsfield fordatabricks.sdk.service.vectorsearch.PatchEndpointRequest. - Add
jiraandzendeskenum values fordatabricks.sdk.service.pipelines.IngestionSourceType. - [Breaking] Remove
min_qpsfield fordatabricks.sdk.service.vectorsearch.CreateEndpoint. - [Breaking] Remove
requested_min_qpsfield fordatabricks.sdk.service.vectorsearch.EndpointScalingInfo. - [Breaking] Remove
min_qpsfield fordatabricks.sdk.service.vectorsearch.PatchEndpointRequest. - Add
get_permission_levels(),get_permissions(),set_permissions()andupdate_permissions()methods for w.vector_search_endpoints workspace-level service. - Add
kafka_optionsfield fordatabricks.sdk.service.pipelines.ConnectorOptions. - Add
private_accessfield fordatabricks.sdk.service.settings.CustomerFacingIngressNetworkPolicy. - Add
account_api,account_databricks_oneandaccount_uifields fordatabricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyRequestDestination. - Add
scope_qualifierfield fordatabricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyWorkspaceApiDestination. - Add
display_nameandpreview_phasefields fordatabricks.sdk.service.settingsv2.SettingsMetadata. - Add
columns_to_indexfield fordatabricks.sdk.service.vectorsearch.DeltaSyncVectorIndexSpecRequest. - Add
columns_to_indexfield fordatabricks.sdk.service.vectorsearch.DeltaSyncVectorIndexSpecResponse.
Release v0.106.0 (2026-04-30)
Bug Fixes
- Fixed Databricks CLI
--profilefallback by detecting the CLI version at init time. The previous error-based detection was broken because--profileis a global Cobra flag silently accepted by old CLIs.
Internal Changes
- Detect Databricks CLI version at init time via
databricks version, enabling version-gated flag support without additional subprocess calls. - Validate Databricks CLI configuration at
DatabricksCliTokenSource.__init__time. Misconfiguration (missing profile and host, or--profile-unsupported CLI without a host fallback) now surfaces asIOErrorsynchronously from construction rather than lazily from the firstrefresh()call. The exception type matches the previousrefresh()-time behaviour, so callers who already catchIOErrorare unaffected.
API Changes
- Add w.temporary_volume_credentials workspace-level service.
- Add
get_permission_levels(),get_permissions(),set_permissions()andupdate_permissions()methods for w.knowledge_assistants workspace-level service. - Add
undelete_project()method for w.postgres workspace-level service. - Add
thumbnail_urlfield fordatabricks.sdk.service.apps.App. - Add
confidential_compute_typefield fordatabricks.sdk.service.compute.GcpAttributes. - Add
jira_options,outlook_optionsandsmartsheet_optionsfields fordatabricks.sdk.service.pipelines.ConnectorOptions. - Add
google_ads_configfield fordatabricks.sdk.service.pipelines.SourceConfig. - Add
replace_existingfield fordatabricks.sdk.service.postgres.CreateBranchRequest. - Add
replace_existingfield fordatabricks.sdk.service.postgres.CreateEndpointRequest. - Add
purgefield fordatabricks.sdk.service.postgres.DeleteProjectRequest. - Add
show_deletedfield fordatabricks.sdk.service.postgres.ListProjectsRequest. - Add
delete_timeandpurge_timefields fordatabricks.sdk.service.postgres.Project. - Add
uc_connectionfield fordatabricks.sdk.service.supervisoragents.Tool. - Change
namefield fordatabricks.sdk.service.supervisoragents.Connectionto no longer be required. - [Breaking] Change
namefield fordatabricks.sdk.service.supervisoragents.Connectionto no longer be required. - Add
databricks.sdk.service.disasterrecoverypackage. - Add a.disaster_recovery account-level service.
- Add
create_example(),delete_example(),get_example(),list_examples()andupdate_example()methods for w.knowledge_assistants workspace-level service. - Add
delta_table_namefield fordatabricks.sdk.service.ml.BackfillSource. - Add
confluence_optionsfield fordatabricks.sdk.service.pipelines.ConnectorOptions. - Add
confluenceenum value fordatabricks.sdk.service.catalog.ConnectionType. - Add
confluenceenum value fordatabricks.sdk.service.pipelines.IngestionSourceType. - Change
descriptionfield fordatabricks.sdk.service.supervisoragents.SupervisorAgentto no longer be required. - [Breaking] Change
descriptionfield fordatabricks.sdk.service.supervisoragents.SupervisorAgentto no longer be required. - [Breaking] Remove
connectionfield fordatabricks.sdk.service.supervisoragents.Tool.
Release v0.105.0 (2026-04-23)
API Changes
- Add
databricks.sdk.service.supervisoragentspackage. - Add w.secrets_uc workspace-level service.
- Add w.supervisor_agents workspace-level service.
- Add
update()method for w.tokens workspace-level service. - Add
etagfield fordatabricks.sdk.service.dashboards.GenieSpace. - Add
etagfield fordatabricks.sdk.service.dashboards.GenieUpdateSpaceRequest. - Add
branch_idfield fordatabricks.sdk.service.postgres.BranchStatus. - Add
catalog_idfield fordatabricks.sdk.service.postgres.CatalogCatalogStatus. - Add
database_idfield fordatabricks.sdk.service.postgres.DatabaseDatabaseStatus. - Add
endpoint_idfield fordatabricks.sdk.service.postgres.EndpointStatus. - Add
project_idfield fordatabricks.sdk.service.postgres.ProjectStatus. - Add
role_idfield fordatabricks.sdk.service.postgres.RoleRoleStatus. - Add
projectfield fordatabricks.sdk.service.postgres.SyncedTableSyncedTableStatus. - Add
manualfield fordatabricks.sdk.service.provisioning.CreateGcpKeyInfo. - Add
manualfield fordatabricks.sdk.service.provisioning.GcpKeyInfo. - Add
apps_runtimeandlakebase_runtimefields fordatabricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyRequestDestination. - Add
blocked_internet_destinationsfield fordatabricks.sdk.service.settings.EgressNetworkPolicyNetworkAccessPolicy. - Add
columns_to_syncfield fordatabricks.sdk.service.vectorsearch.DeltaSyncVectorIndexSpecResponse. - Add
breaking_changeenum value fordatabricks.sdk.service.jobs.TerminationCodeCode. - [Breaking] Change
update_catalog_config()method for w.data_classification workspace-level service. Method path has changed. - [Breaking] Change
update_default_workspace_base_environment()method for w.environments workspace-level service. Method path has changed. - [Breaking] Change
update_knowledge_assistant()method for w.knowledge_assistants workspace-level service. Method path has changed. - [Breaking] Change
update_branch(),update_database(),update_endpoint(),update_project()andupdate_role()methods for w.postgres workspace-level service. Method path has changed. - [Breaking] Change
update_default_warehouse_override()method for w.warehouses workspace-level service. Method path has changed.
Release v0.104.0 (2026-04-23)
Bug Fixes
- Add
X-Databricks-Org-Idheader toWorkspaceExt.upload()andWorkspaceExt.download()for SPOG host compatibility. WorkspaceClient.get_workspace_id()now returnsConfig.workspace_iddirectly when set, instead of calling/api/2.0/preview/scim/v2/Me. This removes an API round-trip on every call where the workspace ID is already known (profile,?o=query param, env var, or host metadata) and fixes a failure on SPOG hosts where the unauthenticated probe request was rejected withUnable to load OAuth Config.- Add
X-Databricks-Org-Idheader toSharesExt.list()for SPOG host compatibility.
Internal Changes
- Expanded AI agent detection: added Goose, Amp, Augment, Copilot (VS Code), Kiro, Windsurf. Honors the
AGENT=<name>standard (resolves to a known product if the value matches one, otherwiseunknown). Presence-only env var matchers now treat an empty string as "set" for parity with the Go and Java SDKs. Explicit agent env vars (e.g.CLAUDECODE,GOOSE_TERMINAL) always take precedence over the genericAGENT=<name>signal. When multiple agent env vars are present (e.g. a Cursor CLI subagent invoked from Claude Code), the user-agent reportsagent/multiple.
Release v0.103.0 (2026-04-20)
New Features and Improvements
- Add support for unified hosts. A single configuration profile can now be used for both account-level and workspace-level operations when the host supports it and both
account_idandworkspace_idare available. Theexperimental_is_unified_hostflag has been removed; unified host detection is now automatic. - Accept
DATABRICKS_OIDC_TOKEN_FILEPATHenvironment variable for consistency with other Databricks SDKs (Go, CLI, Terraform). The previousDATABRICKS_OIDC_TOKEN_FILEis still supported as an alias.
Breaking Changes
- Drop support for Python 3.8 and 3.9. The minimum supported Python version is now 3.10, in line with the oldest supported Databricks Runtime LTS (DBR 13.3).
Internal Changes
- Replace the async-disabling mechanism on token refresh failure with a 1-minute retry backoff. Previously, a single failed async refresh would disable proactive token renewal until the token expired. Now, the SDK waits a short cooldown period and retries, improving resilience to transient errors.
- Extract
_resolve_profileto simplify config file loading and improve__settings__error messages. - Resolve
token_audiencefrom thetoken_federation_default_oidc_audiencesfield in the host metadata discovery endpoint, removing the need for explicit audience configuration.
API Changes
- Add
create_catalog(),create_synced_table(),delete_catalog(),delete_synced_table(),get_catalog()andget_synced_table()methods for w.postgres workspace-level service. - Add
effective_file_event_queuefield fordatabricks.sdk.service.catalog.CreateExternalLocation. - Add
effective_file_event_queuefield fordatabricks.sdk.service.catalog.ExternalLocationInfo. - Add
effective_file_event_queuefield fordatabricks.sdk.service.catalog.UpdateExternalLocation. - Add
column_selectionfield fordatabricks.sdk.service.ml.Function. - Add
cascadefield fordatabricks.sdk.service.pipelines.DeletePipelineRequest. - Add
default_branchfield fordatabricks.sdk.service.postgres.ProjectSpec. - Add
default_branchfield fordatabricks.sdk.service.postgres.ProjectStatus. - Add
ingressandingress_dry_runfields fordatabricks.sdk.service.settings.AccountNetworkPolicy. - Add
delete_app_thumbnail()andupdate_app_thumbnail()methods for w.apps workspace-level service. - Add
create_message_comment(),list_conversation_comments()andlist_message_comments()methods for w.genie workspace-level service. - Add
apply_environment()method for w.pipelines workspace-level service. - Add
nameandpermissionfields fordatabricks.sdk.service.apps.AppResourceApp. - Add
managed_encryption_settingsfield fordatabricks.sdk.service.catalog.CatalogInfo. - Add
managed_encryption_settingsfield fordatabricks.sdk.service.catalog.CreateCatalog. - Add
managed_encryption_settingsfield fordatabricks.sdk.service.catalog.UpdateCatalog. - Add
commentfield fordatabricks.sdk.service.dashboards.GenieFeedback. - Add
thoughtsfield fordatabricks.sdk.service.dashboards.GenieQueryAttachment. - Add
commentfield fordatabricks.sdk.service.dashboards.GenieSendMessageFeedbackRequest. - Add
request_sourcefield fordatabricks.sdk.service.ml.DataSource. - Add
is_onlinefield fordatabricks.sdk.service.ml.MaterializedFeature. - Add
connector_optionsfield fordatabricks.sdk.service.pipelines.SchemaSpec. - Add
connector_optionsfield fordatabricks.sdk.service.pipelines.TableSpec. - Add
scopesfield fordatabricks.sdk.service.settings.CreateOboTokenRequest. - Add
gcp_endpointfield fordatabricks.sdk.service.settings.CreatePrivateEndpointRule. - Add
scopesfield fordatabricks.sdk.service.settings.CreateTokenRequest. - Add
gcp_endpointfield fordatabricks.sdk.service.settings.NccPrivateEndpointRule. - Add
gcp_endpointfield fordatabricks.sdk.service.settings.UpdatePrivateEndpointRule. - Add
sql_statefield fordatabricks.sdk.service.sql.StatementStatus. - Add
usage_policy_idfield fordatabricks.sdk.service.vectorsearch.CreateEndpoint. - Add
index_subtypefield fordatabricks.sdk.service.vectorsearch.CreateVectorIndexRequest. - Add
budget_policy_idfield fordatabricks.sdk.service.vectorsearch.EndpointInfo. - Add
index_subtypefield fordatabricks.sdk.service.vectorsearch.MiniVectorIndex. - Add
budget_policy_idfield fordatabricks.sdk.service.vectorsearch.PatchEndpointBudgetPolicyResponse. - Add
index_subtypefield fordatabricks.sdk.service.vectorsearch.VectorIndex. - Add
table_delta_uniform_iceberg_external_deltasharingenum value fordatabricks.sdk.service.catalog.SecurableKind. - Add
google_driveenum value fordatabricks.sdk.service.pipelines.IngestionSourceType. - Add
storage_optimizedenum value fordatabricks.sdk.service.vectorsearch.EndpointType. - [Breaking] Remove
projectfield fordatabricks.sdk.service.postgres.SyncedTableSyncedTableSpec. - [Breaking] Remove
appsandlakebasefields fordatabricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyRequestDestination.
Release v0.102.0 (2026-03-19)
New Features and Improvements
- Added automatic detection of AI coding agents (Antigravity, Claude Code, Cline, Codex, Copilot CLI, Cursor, Gemini CLI, OpenCode) in the user-agent string. The SDK now appends
agent/<name>to HTTP request headers when running inside a known AI agent environment.
API Changes
- Add
disable_gov_tag_creationfield fordatabricks.sdk.service.settings.RestrictWorkspaceAdminsMessage. - Add
disable_gov_tag_creationfield fordatabricks.sdk.service.settingsv2.RestrictWorkspaceAdminsMessage.
Release v0.101.0 (2026-03-18)
API Changes
- Add
databricks.sdk.service.environmentspackage. - Add w.environments workspace-level service.
- Add
parent_pathfield fordatabricks.sdk.service.dashboards.GenieSpace. - Add
can_create_appenum value fordatabricks.sdk.service.iam.PermissionLevel.
Release v0.100.0 (2026-03-16)
New Features and Improvements
- Support
default_profilein[__settings__]section of.databrickscfgfor consistent default profile resolution across CLI and SDKs.
API Changes
- Add
alert_outputfield fordatabricks.sdk.service.jobs.RunOutput. - Add
alert_taskfield fordatabricks.sdk.service.jobs.RunTask. - Add
alert_taskfield fordatabricks.sdk.service.jobs.SubmitTask. - Add
alert_taskfield fordatabricks.sdk.service.jobs.Task.
Release v0.99.0 (2026-03-12)
API Changes
- Add
connector_typeanddata_staging_optionsfields fordatabricks.sdk.service.pipelines.IngestionPipelineDefinition. - Add
ingestion_source_catalog_name,ingestion_source_connection_name,ingestion_source_schema_name,ingestion_source_table_nameandingestion_source_table_versionfields fordatabricks.sdk.service.pipelines.Origin. - Add
sub_domainfield fordatabricks.sdk.service.serving.ExternalFunctionRequest.
Release v0.98.0 (2026-03-11)
API Changes
- Add
genie_create_eval_run(),genie_get_eval_result_details(),genie_get_eval_run(),genie_list_eval_results()andgenie_list_eval_runs()methods for w.genie workspace-level service. - Add
update_role()method for w.postgres workspace-level service. - Add
telemetry_export_destinationsfield fordatabricks.sdk.service.apps.App. - Add
entitiesandtimeseries_columnfields fordatabricks.sdk.service.ml.Feature. - Add
aggregation_functionfield fordatabricks.sdk.service.ml.Function. - Add
filter_conditionfield fordatabricks.sdk.service.ml.KafkaSource. - Add
attributesfield fordatabricks.sdk.service.postgres.RoleRoleStatus. - [Breaking] Change
entity_columnsandtimeseries_columnfields fordatabricks.sdk.service.ml.DeltaTableSourceto no longer be required. - Change
entity_columnsandtimeseries_columnfields fordatabricks.sdk.service.ml.DeltaTableSourceto no longer be required. - Change
inputsfield fordatabricks.sdk.service.ml.Featureto no longer be required. - [Breaking] Change
inputsfield fordatabricks.sdk.service.ml.Featureto no longer be required. - [Breaking] Change
function_typefield fordatabricks.sdk.service.ml.Functionto no longer be required. - Change
function_typefield fordatabricks.sdk.service.ml.Functionto no longer be required. - Change
entity_column_identifiersandtimeseries_column_identifierfields fordatabricks.sdk.service.ml.KafkaSourceto no longer be required. - [Breaking] Change
entity_column_identifiersandtimeseries_column_identifierfields fordatabricks.sdk.service.ml.KafkaSourceto no longer be required.
Release v0.97.0 (2026-03-09)
Bug Fixes
- Fixed Databricks CLI authentication to detect when the cached token's scopes don't match the SDK's configured scopes. Previously, a scope mismatch was silently ignored, causing requests to use wrong permissions. The SDK now raises an error with instructions to re-authenticate.
API Changes
- Add
databricks.sdk.service.dataclassificationanddatabricks.sdk.service.knowledgeassistantspackages. - Add w.data_classification workspace-level service.
- Add w.knowledge_assistants workspace-level service.
Release v0.96.0 (2026-03-03)
Internal Changes
- Implement dynamic auth token stale period based on initial token lifetime. Increased up to 20 mins for standard OAuth with proportionally shorter periods for short-lived tokens. Providing a stale_duration in the constructor of the Refreshable class will use that fixed value instead. To match the previous default, pass stale_duration=timedelta(minutes=5).
Release v0.95.0 (2026-03-02)
New Features and Improvements
- Added
Config.discovery_urlconfig field (DATABRICKS_DISCOVERY_URLenv var). When set, OIDC endpoints are fetched directly from this URL instead of the default host-type-based logic. MirrorsdiscoveryUrlin the Java SDK. - The OAuth token cache filename now includes the config profile name (if set) and uses a serialized map to prevent hash collisions. All users will need to reauthenticate once after upgrading.
API Changes
- Add
dataframe_schema,filter_conditionandtransformation_sqlfields fordatabricks.sdk.service.ml.DeltaTableSource. - Add
environment_versionfield fordatabricks.sdk.service.pipelines.PipelinesEnvironment. - Add
reset_checkpoint_selectionfield fordatabricks.sdk.service.pipelines.StartUpdate. - [Breaking] Remove
oauth2_app_client_idandoauth2_app_integration_idfields fordatabricks.sdk.service.apps.Space. - Add
create_database(),delete_database(),get_database(),list_databases()andupdate_database()methods for w.postgres workspace-level service. - Add
postgresfield fordatabricks.sdk.service.apps.AppResource. - Add
enable_pg_native_loginfield fordatabricks.sdk.service.postgres.ProjectSpec. - Add
enable_pg_native_loginfield fordatabricks.sdk.service.postgres.ProjectStatus. - [Breaking] Remove
node_type_flexibilityfield fordatabricks.sdk.service.compute.EditInstancePool.
Release v0.94.0 (2026-02-26)
New Features and Improvements
- Added
Config.discovery_urlconfig field (DATABRICKS_DISCOVERY_URLenv var). When set, OIDC endpoints are fetched directly from this URL instead of the default host-type-based logic. MirrorsdiscoveryUrlin the Java SDK.
Bug Fixes
- Pass
--profileto CLI token source when profile is set, and add read-fallback to migrate legacy host-keyed tokens to profile keys.
API Changes
- Add
effective_publishing_modefield fordatabricks.sdk.service.pipelines.GetPipelineResponse. - Add
dbr_autoscaleenum value fordatabricks.sdk.service.compute.EventDetailsCause. - Change
output_catalogfield fordatabricks.sdk.service.cleanrooms.CreateCleanRoomOutputCatalogResponseto be required. - [Breaking] Remove
internal_attributesfield fordatabricks.sdk.service.sharing.Table. - [Breaking] Remove
internal_attributesfield fordatabricks.sdk.service.sharing.Volume.
Release v0.93.0 (2026-02-25)
API Changes
- Add
parametersfield fordatabricks.sdk.service.pipelines.StartUpdate. - Add
parametersfield fordatabricks.sdk.service.pipelines.UpdateInfo. - [Breaking] Change
get_download_full_query_result()method for w.genie workspace-level service with new required argument order. - [Breaking] Change
namefield fordatabricks.sdk.service.apps.Spaceto be required. - Change
namefield fordatabricks.sdk.service.apps.Spaceto be required. - [Breaking] Change
idanduser_idfields fordatabricks.sdk.service.dashboards.GenieConversationto no longer be required. - [Breaking] Change
created_timestampandtitlefields fordatabricks.sdk.service.dashboards.GenieConversationSummaryto no longer be required. - [Breaking] Change
download_id_signaturefield fordatabricks.sdk.service.dashboards.GenieGetDownloadFullQueryResultRequestto be required. - [Breaking] Change
idfield fordatabricks.sdk.service.dashboards.GenieMessageto no longer be required.
Release v0.92.0 (2026-02-24)
Documentation
- Added "Retries" section to README.
API Changes
- Add
read_only_hostfield fordatabricks.sdk.service.postgres.EndpointHosts. - Add
groupfield fordatabricks.sdk.service.postgres.EndpointSpec. - Add
groupfield fordatabricks.sdk.service.postgres.EndpointStatus. - Add
initial_endpoint_specfield fordatabricks.sdk.service.postgres.Project. - Add
degradedenum value fordatabricks.sdk.service.postgres.EndpointStatusState. - Add
patch_endpoint()method for w.vector_search_endpoints workspace-level service. - Add
appfield fordatabricks.sdk.service.apps.AppResource. - Add
securable_kindfield fordatabricks.sdk.service.apps.AppResourceUcSecurable. - Add
min_qpsfield fordatabricks.sdk.service.vectorsearch.CreateEndpoint. - Add
scaling_infofield fordatabricks.sdk.service.vectorsearch.EndpointInfo. - Add
modifyenum value fordatabricks.sdk.service.apps.AppResourceUcSecurableUcSecurablePermission. - Add
could_not_get_dashboard_schema_exceptionenum value fordatabricks.sdk.service.dashboards.MessageErrorType. - Add
replace_where_overridesfield fordatabricks.sdk.service.pipelines.StartUpdate. - Add
hivemetastore_connectivity_failureenum value fordatabricks.sdk.service.compute.TerminationReasonCode. - Add
hivemetastore_connectivity_failureenum value fordatabricks.sdk.service.sql.TerminationReasonCode.
Release v0.91.0 (2026-02-19)
Bug Fixes
- Make
useragent.with_extra()idempotent to prevent User-Agent header growth in long-lived processes.
API Changes
- Add
attributesandmembership_rolesfields fordatabricks.sdk.service.postgres.RoleRoleSpec. - Add
membership_rolesfield fordatabricks.sdk.service.postgres.RoleRoleStatus. - Add
general_accessenum value fordatabricks.sdk.service.provisioning.EndpointUseCase.
Release v0.90.0 (2026-02-18)
API Changes
- Add
databricks.sdk.service.networkingpackage. - Add a.endpoints account-level service.
- Add
create_space(),delete_space(),get_space(),get_space_operation(),list_spaces()andupdate_space()methods for w.apps workspace-level service. - Add
spacefield fordatabricks.sdk.service.apps.App. - Add
spacefield fordatabricks.sdk.service.apps.ListAppsRequest. - Add
source_type,update_timeandupdated_byfields fordatabricks.sdk.service.catalog.EntityTagAssignment. - Add
skip_notifyfield fordatabricks.sdk.service.dashboards.Subscription. - Add
sparse_checkoutfield fordatabricks.sdk.service.jobs.GitSource. - Add
disable_auto_optimization,max_retries,min_retry_interval_millisandretry_on_timeoutfields fordatabricks.sdk.service.jobs.RunTask. - Add
disable_auto_optimization,max_retries,min_retry_interval_millisandretry_on_timeoutfields fordatabricks.sdk.service.jobs.SubmitTask. - Add
budget_policy_idandcustom_tagsfields fordatabricks.sdk.service.postgres.ProjectSpec. - Add
budget_policy_idandcustom_tagsfields fordatabricks.sdk.service.postgres.ProjectStatus. - Add
edgegrid_akamaienum value fordatabricks.sdk.service.catalog.CredentialType. - Add
using_argumentsfield fordatabricks.sdk.service.catalog.ColumnMask. - Add
effective_enable_file_eventsfield fordatabricks.sdk.service.catalog.CreateExternalLocation. - Add
effective_enable_file_eventsfield fordatabricks.sdk.service.catalog.ExternalLocationInfo. - Add
input_argumentsfield fordatabricks.sdk.service.catalog.TableRowFilter. - Add
effective_enable_file_eventsfield fordatabricks.sdk.service.catalog.UpdateExternalLocation.
Release v0.89.0 (2026-02-17)
New Features and Improvements
- Remove cloud type restrictions from Azure/GCP credential providers. Azure and GCP authentication now works with any Databricks host when credentials are properly configured,enabling authentication against cloud-agnostic endpoints such as aliased hosts.
Release v0.88.0 (2026-02-12)
New Features and Improvements
- FilesExt retry logic now respects a retry count limit in addition to the time-based timeout. Operations will stop retrying when either the retry count (
experimental_files_ext_cloud_api_max_retries, default: 3) or timeout (retry_timeout_seconds) is exceeded, whichever comes first. This provides faster feedback when APIs are consistently unavailable.
Bug Fixes
- FilesExt no longer retries on 500 (Internal Server Error) responses. These errors now fail immediately or fallback to alternative upload methods as appropriate.
API Changes
- Deprecated
WorkspaceClient.serving_endpoints.get_open_ai_client()andWorkspaceClient.serving_endpoints.get_langchain_chat_open_ai_client()methods in favor of dedicated packages. Users should migrate todatabricks-openai(usingDatabricksOpenAI) anddatabricks-langchain(usingChatDatabricks) respectively (#1238).
Release v0.87.0 (2026-02-11)
Bug Fixes
- Fixed Databricks M2M OAuth to correctly use Databricks OIDC endpoints instead of incorrectly using Azure endpoints when
ARM_CLIENT_IDis set. Added newdatabricks_oidc_endpointsproperty that returns only Databricks OIDC endpoints, and updated all Databricks OAuth flows to use it. The oldoidc_endpointsproperty is deprecated but maintained for backward compatibility.
Release v0.86.0 (2026-02-10)
New Features and Improvements
- Added
custom_headersparameter toWorkspaceClientandAccountClientto support custom HTTP headers in all API requests (#1245).
API Changes
- Add
idfield fordatabricks.sdk.service.sharing.CreateRecipient. - Add
idfield fordatabricks.sdk.service.sharing.RecipientInfo. - Add
idfield fordatabricks.sdk.service.sharing.UpdateRecipient. - Add
query_tagsfield fordatabricks.sdk.service.sql.ExecuteStatementRequest. - Add
query_tagsfield fordatabricks.sdk.service.sql.QueryInfo. - Add
uc_volume_misconfiguredenum value fordatabricks.sdk.service.compute.EventType. - Add
filtersfield fordatabricks.sdk.service.jobs.DashboardTask. - Add
ssws_tokenenum value fordatabricks.sdk.service.catalog.CredentialType.
Release v0.85.0 (2026-02-05)
API Changes
- [Breaking] Change
usernamefield fordatabricks.sdk.service.iamv2.Userto no longer be required.
Release v0.84.0 (2026-02-04)
API Changes
- Add
base_environmentfield fordatabricks.sdk.service.compute.Environment.
Release v0.83.0 (2026-02-03)
New Features and Improvements
- Add support for single Profile for Account and Workspace operations in Unified Mode.
API Changes
- Add
generate_download_full_query_result()andget_download_full_query_result()methods for w.genie workspace-level service. - Add
active_instancesfield fordatabricks.sdk.service.apps.ComputeStatus. - [Breaking] Change
create_role()method for w.postgres workspace-level service. HTTP method/verb has changed. - Add
computefield fordatabricks.sdk.service.jobs.RunTask. - Add
computefield fordatabricks.sdk.service.jobs.SubmitTask. - Add
computefield fordatabricks.sdk.service.jobs.Task. - Add
mtls_port_connectivity_failureenum value fordatabricks.sdk.service.compute.TerminationReasonCode. - Add
mtls_port_connectivity_failureenum value fordatabricks.sdk.service.sql.TerminationReasonCode.
Release v0.82.0 (2026-01-29)
API Changes
- Add
backfill_sourcefield fordatabricks.sdk.service.ml.KafkaConfig. - Add
clone_modefield fordatabricks.sdk.service.pipelines.ClonePipelineRequest. - Add
burst_scaling_enabledfield fordatabricks.sdk.service.serving.ServedEntityInput. - Add
burst_scaling_enabledfield fordatabricks.sdk.service.serving.ServedEntityOutput. - Add
burst_scaling_enabledfield fordatabricks.sdk.service.serving.ServedModelInput. - Add
burst_scaling_enabledfield fordatabricks.sdk.service.serving.ServedModelOutput. - [Breaking] Change
create_role()method for w.postgres workspace-level service with new required argument order. - Change
role_idfield fordatabricks.sdk.service.postgres.CreateRoleRequestto no longer be required.
Release v0.81.0 (2026-01-27)
API Changes
- Add
postgres_rolefield fordatabricks.sdk.service.postgres.RoleRoleSpec. - Add
postgres_rolefield fordatabricks.sdk.service.postgres.RoleRoleStatus. - Add
purgefield fordatabricks.sdk.service.sql.TrashAlertV2Request.
Release v0.80.0 (2026-01-22)
Internal Changes
- Support CLI Profiles for Unified Host.
Release v0.79.0 (2026-01-22)
API Changes
- Add
full_refresh_windowfield fordatabricks.sdk.service.pipelines.IngestionPipelineDefinition. - Add
auto_full_refresh_policyfield fordatabricks.sdk.service.pipelines.TableSpecificConfig. - Add
hostsfield fordatabricks.sdk.service.postgres.EndpointStatus. - Add
ownerfield fordatabricks.sdk.service.postgres.ProjectStatus. - Add
validity_check_configurationsfield fordatabricks.sdk.service.qualitymonitorv2.QualityMonitor. - Add
burst_scaling_enabledfield fordatabricks.sdk.service.serving.PtServedModel. - Add
system_managedenum value fordatabricks.sdk.service.jobs.JobDeploymentKind. - Add
endpoint_type_read_writeandendpoint_type_read_onlyenum values fordatabricks.sdk.service.postgres.EndpointType. - Add
deletedenum value fordatabricks.sdk.service.vectorsearch.EndpointStatusState. - [Breaking] Remove
host,last_active_time,start_timeandsuspend_timefields fordatabricks.sdk.service.postgres.EndpointStatus. - [Breaking] Remove
compute_last_active_timefield fordatabricks.sdk.service.postgres.ProjectStatus. - [Breaking] Remove
read_writeandread_onlyenum values fordatabricks.sdk.service.postgres.EndpointType. - Add
create_default_warehouse_override(),delete_default_warehouse_override(),get_default_warehouse_override(),list_default_warehouse_overrides()andupdate_default_warehouse_override()methods for w.warehouses workspace-level service. - Add
driver_node_type_flexibilityandworker_node_type_flexibilityfields fordatabricks.sdk.service.compute.ClusterAttributes. - Add
driver_node_type_flexibilityandworker_node_type_flexibilityfields fordatabricks.sdk.service.compute.ClusterDetails. - Add
driver_node_type_flexibilityandworker_node_type_flexibilityfields fordatabricks.sdk.service.compute.ClusterSpec. - Add
driver_node_type_flexibilityandworker_node_type_flexibilityfields fordatabricks.sdk.service.compute.CreateCluster. - Add
node_type_flexibilityfield fordatabricks.sdk.service.compute.CreateInstancePool. - Add
driver_node_type_flexibilityandworker_node_type_flexibilityfields fordatabricks.sdk.service.compute.EditCluster. - Add
node_type_flexibilityfield fordatabricks.sdk.service.compute.EditInstancePool. - Add
node_type_flexibilityfield fordatabricks.sdk.service.compute.GetInstancePool. - Add
node_type_flexibilityfield fordatabricks.sdk.service.compute.InstancePoolAndStats. - Add
driver_node_type_flexibilityandworker_node_type_flexibilityfields fordatabricks.sdk.service.compute.UpdateClusterResource. - Add
expire_timeandttlfields fordatabricks.sdk.service.postgres.BranchSpec. - Add
expire_timefield fordatabricks.sdk.service.postgres.BranchStatus. - [Breaking] Change
create_branch(),create_endpoint()andcreate_project()methods for w.postgres workspace-level service with new required argument order. - [Breaking] Change
branch_idfield fordatabricks.sdk.service.postgres.CreateBranchRequestto be required. - [Breaking] Change
endpoint_idfield fordatabricks.sdk.service.postgres.CreateEndpointRequestto be required. - [Breaking] Change
project_idfield fordatabricks.sdk.service.postgres.CreateProjectRequestto be required. - [Breaking] Remove
defaultfield fordatabricks.sdk.service.postgres.BranchSpec. - [Breaking] Remove
settingsfield fordatabricks.sdk.service.postgres.ProjectSpec. - [Breaking] Remove
settingsfield fordatabricks.sdk.service.postgres.ProjectStatus. - Add
generate_database_credential()method for w.postgres workspace-level service. - Add
get_public_account_user_preference(),list_account_user_preferences_metadata()andpatch_public_account_user_preference()methods for a.account_settings_v2 account-level service. - Add
stderrfield fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails. - Add
no_expiryfield fordatabricks.sdk.service.postgres.BranchSpec. - Add
outputsfield fordatabricks.sdk.service.serving.QueryEndpointResponse. - Add
session_idfield fordatabricks.sdk.service.sql.QueryInfo. - Add
principal_idfield fordatabricks.sdk.service.workspace.CreateCredentialsRequest. - Add
principal_idfield fordatabricks.sdk.service.workspace.DeleteCredentialsRequest. - Add
principal_idfield fordatabricks.sdk.service.workspace.GetCredentialsRequest. - Add
principal_idfield fordatabricks.sdk.service.workspace.ListCredentialsRequest. - Add
principal_idfield fordatabricks.sdk.service.workspace.UpdateCredentialsRequest. - Add
forcefield fordatabricks.sdk.service.pipelines.DeletePipelineRequest. - Add
no_suspensionfield fordatabricks.sdk.service.postgres.EndpointSpec. - Add
no_suspensionfield fordatabricks.sdk.service.postgres.ProjectDefaultEndpointSettings.
Release v0.78.0 (2026-01-15)
New Features and Improvements
- Increase async cache stale period from 3 to 5 minutes to cover the maximum monthly downtime of a 99.99% uptime SLA.
API Changes
- Add
table_deltasharing_open_dir_basedenum value fordatabricks.sdk.service.catalog.SecurableKind. - Add
creatingandcreate_failedenum values fordatabricks.sdk.service.settings.NccPrivateEndpointRulePrivateLinkConnectionState. - [Breaking] Remove
access_modesandstorage_locationfields fordatabricks.sdk.service.sharing.Table. - Add
error_messagefield fordatabricks.sdk.service.settings.CreatePrivateEndpointRule. - Add
error_messagefield fordatabricks.sdk.service.settings.NccPrivateEndpointRule. - Add
error_messagefield fordatabricks.sdk.service.settings.UpdatePrivateEndpointRule. - Add
rate_limitedenum value fordatabricks.sdk.service.compute.TerminationReasonCode. - Add
rate_limitedenum value fordatabricks.sdk.service.sql.TerminationReasonCode. - [Breaking] Add long-running operation configuration for PostgresAPI.delete_branch method.
- [Breaking] Add long-running operation configuration for PostgresAPI.delete_endpoint method.
- [Breaking] Add long-running operation configuration for PostgresAPI.delete_project method.
- [Breaking] Change
delete_branch(),delete_endpoint()anddelete_project()methods for w.postgres workspace-level service to returndatabricks.sdk.service.postgres.Operationdataclass. - [Breaking] Remove
pgbouncer_settingsfield fordatabricks.sdk.service.postgres.EndpointSettings. - [Breaking] Remove
pooler_modefield fordatabricks.sdk.service.postgres.EndpointSpec. - [Breaking] Remove
pooler_modefield fordatabricks.sdk.service.postgres.EndpointStatus. - [Breaking] Remove
pgbouncer_settingsfield fordatabricks.sdk.service.postgres.ProjectDefaultEndpointSettings.
Release v0.77.0 (2026-01-06)
API Changes
- Add
git_repositoryfield fordatabricks.sdk.service.apps.App. - Add
git_sourcefield fordatabricks.sdk.service.apps.AppDeployment. - Add
experiment_specfield fordatabricks.sdk.service.apps.AppManifestAppResourceSpec. - Add
experimentfield fordatabricks.sdk.service.apps.AppResource. - Add
git_repositoryfield fordatabricks.sdk.service.apps.AppUpdate. - Add
excluded_table_full_namesfield fordatabricks.sdk.service.dataquality.AnomalyDetectionConfig. - Add
group_namefield fordatabricks.sdk.service.jobs.JobRunAs. - Add
row_filterfield fordatabricks.sdk.service.pipelines.TableSpecificConfig. - Add
specandstatusfields fordatabricks.sdk.service.postgres.Endpoint. - Add
excluded_table_full_namesfield fordatabricks.sdk.service.qualitymonitorv2.AnomalyDetectionConfig. - Add
executeanduse_connectionenum values fordatabricks.sdk.service.apps.AppManifestAppResourceUcSecurableSpecUcSecurablePermission. - Add
functionandconnectionenum values fordatabricks.sdk.service.apps.AppManifestAppResourceUcSecurableSpecUcSecurableType. - Add
select,executeanduse_connectionenum values fordatabricks.sdk.service.apps.AppResourceUcSecurableUcSecurablePermission. - Add
table,functionandconnectionenum values fordatabricks.sdk.service.apps.AppResourceUcSecurableUcSecurableType. - [Breaking] Remove
apply_environment()method for w.pipelines workspace-level service. - [Breaking] Remove
autoscaling_limit_max_cu,autoscaling_limit_min_cu,current_state,disabled,effective_autoscaling_limit_max_cu,effective_autoscaling_limit_min_cu,effective_disabled,effective_pooler_mode,effective_settings,effective_suspend_timeout_duration,endpoint_type,host,last_active_time,pending_state,pooler_mode,settings,start_time,suspend_timeandsuspend_timeout_durationfields fordatabricks.sdk.service.postgres.Endpoint. - Add
create_role(),delete_role(),get_role()andlist_roles()methods for w.postgres workspace-level service. - Add
destination_source_securablefield fordatabricks.sdk.service.catalog.AccessRequestDestinations. - Add
specandstatusfields fordatabricks.sdk.service.postgres.Branch. - Add
specandstatusfields fordatabricks.sdk.service.postgres.Project. - Add
access_modesandstorage_locationfields fordatabricks.sdk.service.sharing.Table. - [Breaking] Remove
current_state,default,effective_default,effective_is_protected,effective_source_branch,effective_source_branch_lsn,effective_source_branch_time,is_protected,logical_size_bytes,pending_state,source_branch,source_branch_lsn,source_branch_timeandstate_change_timefields fordatabricks.sdk.service.postgres.Branch. - [Breaking] Remove
branch_logical_size_limit_bytes,compute_last_active_time,default_endpoint_settings,display_name,effective_default_endpoint_settings,effective_display_name,effective_history_retention_duration,effective_pg_version,effective_settings,history_retention_duration,pg_version,settingsandsynthetic_storage_size_bytesfields fordatabricks.sdk.service.postgres.Project. - Add
commandandenv_varsfields fordatabricks.sdk.service.apps.AppDeployment. - Add
full_nameandsecurable_typefields fordatabricks.sdk.service.catalog.AccessRequestDestinations. - [Breaking] Change
delete_kafka_config()method for w.feature_engineering workspace-level service . Method path has changed. - [Breaking] Change long-running operation configuration for PostgresAPI.delete_role method . Long running operation response type changed to
Nonedataclass.
Release v0.76.0 (2025-12-17)
New Features and Improvements
- Add support for unified hosts with experimental flag
Release v0.75.0 (2025-12-17)
API Changes
- Add
databricks.sdk.service.postgrespackage. - Add w.postgres workspace-level service.
- Add
apply_environment()method for w.pipelines workspace-level service. - Add
effective_usage_policy_idandusage_policy_idfields fordatabricks.sdk.service.apps.App. - Add
external_access_enabledfield fordatabricks.sdk.service.catalog.CreateAccountsMetastore. - Add
external_access_enabledfield fordatabricks.sdk.service.catalog.CreateMetastore. - Add
external_access_enabledfield fordatabricks.sdk.service.catalog.UpdateAccountsMetastore. - Add
external_access_enabledfield fordatabricks.sdk.service.catalog.UpdateMetastore. - Add
usage_policy_idfield fordatabricks.sdk.service.ml.OnlineStore. - Add
error_messagefield fordatabricks.sdk.service.settings.CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule. - Add
error_messagefield fordatabricks.sdk.service.settings.NccAzurePrivateEndpointRule. - Add
control_plane_connection_failureandcontrol_plane_connection_failure_due_to_misconfigenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - Add
control_plane_connection_failureandcontrol_plane_connection_failure_due_to_misconfigenum values fordatabricks.sdk.service.sql.TerminationReasonCode.
Release v0.74.0 (2025-12-10)
New Features and Improvements
- Add new auth type (
runtime-oauth) for notebooks: Introduce a new authentication mechanism that allows notebooks to authenticate using OAuth tokens
Bug Fixes
- Fixed an issue where download from Shared Volumes could fail by falling back to Files API whenever Presigned URLs are not available.
API Changes
- Add
create_space()andupdate_space()methods for w.genie workspace-level service. - Add
create_kafka_config(),delete_kafka_config(),get_kafka_config(),list_kafka_configs()andupdate_kafka_config()methods for w.feature_engineering workspace-level service. - Add
delete_online_table()method for w.feature_store workspace-level service. - Add
retrieve_user_visible_metrics()method for w.vector_search_endpoints workspace-level service. - Add
major_versionfield fordatabricks.sdk.service.billing.CreateBillingUsageDashboardRequest. - Add
include_serialized_spacefield fordatabricks.sdk.service.dashboards.GenieGetSpaceRequest. - Add
serialized_spacefield fordatabricks.sdk.service.dashboards.GenieSpace. - Add
purposefield fordatabricks.sdk.service.dashboards.TextAttachment. - Add
budget_policy_idfield fordatabricks.sdk.service.database.NewPipelineSpec. - Add
modelfield fordatabricks.sdk.service.jobs.TriggerSettings. - Add
kafka_sourcefield fordatabricks.sdk.service.ml.DataSource. - Add
connection_parametersfield fordatabricks.sdk.service.pipelines.IngestionGatewayPipelineDefinition. - Add
ingest_from_uc_foreign_catalogfield fordatabricks.sdk.service.pipelines.IngestionPipelineDefinition. - Add
rewind_specfield fordatabricks.sdk.service.pipelines.StartUpdate. - Add
type_textfield fordatabricks.sdk.service.vectorsearch.ColumnInfo. - Add
foreign_catalogenum value fordatabricks.sdk.service.pipelines.IngestionSourceType. - Add
creatingandcreate_failedenum values fordatabricks.sdk.service.settings.CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState. - Add
creatingandcreate_failedenum values fordatabricks.sdk.service.settings.NccAzurePrivateEndpointRuleConnectionState. - [Breaking] Change
destinationsfield fordatabricks.sdk.service.catalog.AccessRequestDestinationsto no longer be required. - Change
destinationsfield fordatabricks.sdk.service.catalog.AccessRequestDestinationsto no longer be required. - [Breaking] Change
online_store_configfield fordatabricks.sdk.service.ml.MaterializedFeatureto typedatabricks.sdk.service.ml.OnlineStoreConfigdataclass. - Add w.workspace_entity_tag_assignments workspace-level service.
- Add
clone()method for w.pipelines workspace-level service. - Add
dataset_cataloganddataset_schemafields fordatabricks.sdk.service.dashboards.CreateDashboardRequest. - Add
dataset_cataloganddataset_schemafields fordatabricks.sdk.service.dashboards.UpdateDashboardRequest. - Add
purge_datafield fordatabricks.sdk.service.database.DeleteSyncedDatabaseTableRequest. - Add
cron_schedulefield fordatabricks.sdk.service.ml.MaterializedFeature. - Add
truncationfield fordatabricks.sdk.service.pipelines.PipelineEvent. - Add
gcp_service_accountfield fordatabricks.sdk.service.provisioning.CreateGcpKeyInfo. - Add
gcp_service_accountfield fordatabricks.sdk.service.provisioning.GcpKeyInfo. - Add
has_delta_uniform_icebergfield fordatabricks.sdk.service.sharing.TableInternalAttributes. - Add
foreign_tableandvolumeenum values fordatabricks.sdk.service.sharing.SharedDataObjectDataObjectType. - Change
time_windowfield fordatabricks.sdk.service.ml.Featureto no longer be required. - [Breaking] Change
time_windowfield fordatabricks.sdk.service.ml.Featureto no longer be required.
Release v0.73.0 (2025-11-05)
Security
- Update
protobufdependency constraints to exclude known vulnerable versions (related toSNYK-PYTHON-PROTOBUF-10364902).
Release v0.72.0 (2025-11-04)
Bug Fixes
-
Fix
FilesExtcan fail to upload and download data when Presigned URLs are not available in certain environments (e.g. Serverless GPU clusters). -
Fix
FilesExt.uploadandFilesExt.upload_fromwould fail when the source content is empty anduse_parallel=True.
API Changes
- Add
google_ads,tiktok_ads,salesforce_marketing_cloud,hubspot,workday_hcm,guidewireandzendeskenum values fordatabricks.sdk.service.pipelines.IngestionSourceType. - Add
batch_create_materialized_features()method for w.feature_engineering workspace-level service. - Add
lineage_contextfield fordatabricks.sdk.service.ml.Feature. - Add
autoscale_v2enum value fordatabricks.sdk.service.compute.EventDetailsCause. - Add
unsupported_conversation_type_exceptionenum value fordatabricks.sdk.service.dashboards.MessageErrorType. - Add
red_stateandyellow_stateenum values fordatabricks.sdk.service.vectorsearch.EndpointStatusState. - [Breaking] Change
table_namesfield fordatabricks.sdk.service.jobs.TableUpdateTriggerConfigurationto be required. - Change
table_namesfield fordatabricks.sdk.service.jobs.TableUpdateTriggerConfigurationto be required.
Release v0.71.0 (2025-10-30)
Bug Fixes
- Fix the issue where
FilesExt.upload's second parameter was changed fromcontentstocontentunintentionally. Now the interface is backward compatible to versions previous than 0.69.0.
API Changes
- Add
instance_profile_arnfield fordatabricks.sdk.service.compute.InstancePoolAwsAttributes. - Add
continuous,slidingandtumblingfields fordatabricks.sdk.service.ml.TimeWindow. - Add
usage_policy_idfield fordatabricks.sdk.service.pipelines.CreatePipeline. - Add
usage_policy_idfield fordatabricks.sdk.service.pipelines.EditPipeline. - Add
usage_policy_idfield fordatabricks.sdk.service.pipelines.PipelineSpec. - Add
read_files_bytesfield fordatabricks.sdk.service.sql.QueryMetrics. - Add
selectenum value fordatabricks.sdk.service.apps.AppManifestAppResourceUcSecurableSpecUcSecurablePermission. - Add
tableenum value fordatabricks.sdk.service.apps.AppManifestAppResourceUcSecurableSpecUcSecurableType. - Add
decommission_startedanddecommission_endedenum values fordatabricks.sdk.service.compute.EventType. - Add
dbr_image_resolution_failureenum value fordatabricks.sdk.service.compute.TerminationReasonCode. - Add
dbr_image_resolution_failureenum value fordatabricks.sdk.service.sql.TerminationReasonCode. - [Breaking] Change
offline_store_configandonline_store_configfields fordatabricks.sdk.service.ml.MaterializedFeatureto no longer be required. - Change
offline_store_configandonline_store_configfields fordatabricks.sdk.service.ml.MaterializedFeatureto no longer be required. - [Breaking] Change
lifecycle_statefield fordatabricks.sdk.service.sql.AlertV2to typedatabricks.sdk.service.sql.AlertLifecycleStatedataclass. - [Breaking] Remove
tablefield fordatabricks.sdk.service.jobs.TriggerSettings. - [Breaking] Remove
durationandoffsetfields fordatabricks.sdk.service.ml.TimeWindow.
Release v0.70.0 (2025-10-23)
Bug Fixes
- Improving the error message that is shown when the unsupported
dbutils.credentials.getServiceCredentialsProvidermethod is used. This method can only be used inside of a notebook.
API Changes
- Add
create_materialized_feature(),delete_materialized_feature(),get_materialized_feature(),list_materialized_features()andupdate_materialized_feature()methods for w.feature_engineering workspace-level service. - Add
filter_conditionfield fordatabricks.sdk.service.ml.Feature. - Add
absolute_session_lifetime_in_minutesandenable_single_use_refresh_tokensfields fordatabricks.sdk.service.oauth2.TokenAccessPolicy. - Add
network_connectivity_config_idfield fordatabricks.sdk.service.provisioning.CreateWorkspaceRequest. - Add
oauth_mtlsenum value fordatabricks.sdk.service.catalog.CredentialType. - Add
network_check_nic_failure_due_to_misconfig,network_check_dns_server_failure_due_to_misconfig,network_check_storage_failure_due_to_misconfig,network_check_metadata_endpoint_failure_due_to_misconfig,network_check_control_plane_failure_due_to_misconfigandnetwork_check_multiple_components_failure_due_to_misconfigenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - Add
creatingandcreate_failedenum values fordatabricks.sdk.service.settings.NccPrivateEndpointRulePrivateLinkConnectionState. - Add
network_check_nic_failure_due_to_misconfig,network_check_dns_server_failure_due_to_misconfig,network_check_storage_failure_due_to_misconfig,network_check_metadata_endpoint_failure_due_to_misconfig,network_check_control_plane_failure_due_to_misconfigandnetwork_check_multiple_components_failure_due_to_misconfigenum values fordatabricks.sdk.service.sql.TerminationReasonCode. - [Breaking] Change
display_name,evaluation,query_text,scheduleandwarehouse_idfields fordatabricks.sdk.service.sql.AlertV2to be required. - Change
display_name,evaluation,query_text,scheduleandwarehouse_idfields fordatabricks.sdk.service.sql.AlertV2to be required. - Change
comparison_operatorandsourcefields fordatabricks.sdk.service.sql.AlertV2Evaluationto be required. - [Breaking] Change
comparison_operatorandsourcefields fordatabricks.sdk.service.sql.AlertV2Evaluationto be required. - Change
namefield fordatabricks.sdk.service.sql.AlertV2OperandColumnto be required. - [Breaking] Change
namefield fordatabricks.sdk.service.sql.AlertV2OperandColumnto be required. - [Breaking] Change
quartz_cron_scheduleandtimezone_idfields fordatabricks.sdk.service.sql.CronScheduleto be required. - Change
quartz_cron_scheduleandtimezone_idfields fordatabricks.sdk.service.sql.CronScheduleto be required. - [Breaking] Remove
update()method for w.recipient_federation_policies workspace-level service. - [Breaking] Remove
resultsfield fordatabricks.sdk.service.sql.ListAlertsV2Response.
Release v0.69.0 (2025-10-20)
New Features and Improvements
- Add a new interface
upload_fromtodatabricks.sdk.mixins.FilesExtto support upload from a file in local filesystem. - Improve
databricks.sdk.mixins.FilesExtupload throughput by uploading data in parallel by default. - Add a new interface
download_totodatabricks.sdk.mixins.FilesExtto support download to a file in local filesystem. This interface will also download the file in parallel by default. Parallel downloading is currently unavailable on Windows. - Improve
databricks.sdk.mixins.FilesExt.uploadto support uploading when Presigned URL is not enabled for the Workspace by introducing a fallback to Single Part Upload.
API Changes
- Add
upload_from(),download_to()method fordatabricks.sdk.mixins.FilesExt. - Add
use_parallel,parallelism,part_sizefield fordatabricks.sdk.mixins.FilesExt.upload. - [Breaking] Change
files_api_client_download_max_total_recoverstofiles_ext_client_download_max_total_recoversfordatabricks.sdk.Config - [Breaking] Change
files_api_client_download_max_total_recovers_without_progressingtofiles_ext_client_download_max_total_recovers_without_progressingfordatabricks.sdk.Config - [Breaking] Change
multipart_upload_min_stream_sizetofiles_ext_multipart_upload_min_stream_sizefordatabricks.sdk.Config - [Breaking] Change
multipart_upload_batch_url_counttofiles_ext_multipart_upload_batch_url_countfordatabricks.sdk.Config - [Breaking] Change
multipart_upload_chunk_sizetofiles_ext_multipart_upload_default_part_sizefordatabricks.sdk.Config - [Breaking] Change
multipart_upload_url_expiration_durationtofiles_ext_multipart_upload_url_expiration_durationfordatabricks.sdk.Config - [Breaking] Change
multipart_upload_max_retriestofiles_ext_multipart_upload_max_retriesfordatabricks.sdk.Config - Add
files_ext_client_download_streaming_chunk_size,files_ext_multipart_upload_part_size_options,files_ext_multipart_upload_max_part_size,files_ext_multipart_upload_default_parallelism,files_ext_presigned_download_url_expiration_duration,files_ext_parallel_download_default_parallelism,files_ext_parallel_download_min_file_size,files_ext_parallel_download_default_part_size,files_ext_parallel_download_max_retriesfordatabricks.sdk.Config
Release v0.68.0 (2025-10-14)
New Features and Improvements
- Add native support for authentication through Azure DevOps OIDC.
Bug Fixes
- Fix a security issue that resulted in bearer tokens being logged in exception messages.
API Changes
- Add
databricks.sdk.service.dataqualitypackage. - Add w.data_quality workspace-level service.
- Add
create_update()andget_update()methods for w.apps workspace-level service. - Add
compute_sizefield fordatabricks.sdk.service.apps.App. - Add
genie_spacefield fordatabricks.sdk.service.apps.AppResource. - Add
skip_validationfield fordatabricks.sdk.service.catalog.AccountsCreateStorageCredential. - Add
skip_validationfield fordatabricks.sdk.service.catalog.AccountsUpdateStorageCredential. - Add
aliases,browse_only,created_at,created_by,full_name,metastore_id,owner,updated_atandupdated_byfields fordatabricks.sdk.service.catalog.CreateRegisteredModelRequest. - Add
catalog_name,id,model_nameandschema_namefields fordatabricks.sdk.service.catalog.RegisteredModelAlias. - Add
aliases,catalog_name,created_at,created_by,id,metastore_id,model_name,model_version_dependencies,run_id,run_workspace_id,schema_name,source,status,storage_location,updated_atandupdated_byfields fordatabricks.sdk.service.catalog.UpdateModelVersionRequest. - Add
aliases,browse_only,catalog_name,created_at,created_by,metastore_id,name,schema_name,storage_location,updated_atandupdated_byfields fordatabricks.sdk.service.catalog.UpdateRegisteredModelRequest. - Add
key_regionfield fordatabricks.sdk.service.provisioning.CreateAwsKeyInfo. - Add
role_arnfield fordatabricks.sdk.service.provisioning.CreateStorageConfigurationRequest. - Add
azure_key_infofield fordatabricks.sdk.service.provisioning.CustomerManagedKey. - [Breaking] Add
customer_facing_private_access_settingsfield fordatabricks.sdk.service.provisioning.ReplacePrivateAccessSettingsRequest. - Add
role_arnfield fordatabricks.sdk.service.provisioning.StorageConfiguration. - [Breaking] Add
customer_facing_workspacefield fordatabricks.sdk.service.provisioning.UpdateWorkspaceRequest. - Add
update_maskfield fordatabricks.sdk.service.provisioning.UpdateWorkspaceRequest. - Add
compute_mode,network,network_connectivity_config_idandstorage_modefields fordatabricks.sdk.service.provisioning.Workspace. - Add
enable_serverless_computefield fordatabricks.sdk.service.sql.GetWorkspaceWarehouseConfigResponse. - Add
page_sizeandpage_tokenfields fordatabricks.sdk.service.sql.ListWarehousesRequest. - Add
next_page_tokenfield fordatabricks.sdk.service.sql.ListWarehousesResponse. - Add
enable_serverless_computefield fordatabricks.sdk.service.sql.SetWorkspaceWarehouseConfigRequest. - Add
model_version_status_unknownenum value fordatabricks.sdk.service.catalog.ModelVersionInfoStatus. - Add
k8s_active_pod_quota_exceededandcloud_account_pod_quota_exceededenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - Add
internal_catalog_asset_creation_ongoing_exception,internal_catalog_asset_creation_failed_exceptionandinternal_catalog_asset_creation_unsupported_exceptionenum values fordatabricks.sdk.service.dashboards.MessageErrorType. - Add
ssh_bootstrap_failure,aws_inaccessible_kms_key_failure,init_container_not_finished,spark_image_download_throttled,spark_image_not_found,cluster_operation_throttled,cluster_operation_timeout,serverless_long_running_terminated,azure_packed_deployment_partial_failure,invalid_worker_image_failure,workspace_update,invalid_aws_parameter,driver_out_of_disk,driver_out_of_memory,driver_launch_timeout,driver_unexpected_failure,unexpected_pod_recreation,gcp_inaccessible_kms_key_failure,gcp_kms_key_permission_denied,driver_eviction,user_initiated_vm_termination,gcp_iam_timeout,aws_resource_quota_exceeded,cloud_account_setup_failure,aws_invalid_key_pair,driver_pod_creation_failure,maintenance_mode,internal_capacity_failure,executor_pod_unscheduled,storage_download_failure_slow,storage_download_failure_throttled,dynamic_spark_conf_size_exceeded,aws_instance_profile_update_failure,instance_pool_not_found,instance_pool_max_capacity_reached,aws_invalid_kms_key_state,gcp_insufficient_capacity,gcp_api_rate_quota_exceeded,gcp_resource_quota_exceeded,gcp_ip_space_exhausted,gcp_service_account_access_denied,gcp_service_account_not_found,gcp_forbidden,gcp_not_found,resource_usage_blocked,data_access_config_changed,access_token_failure,invalid_instance_placement_protocol,budget_policy_resolution_failure,in_penalty_box,disaster_recovery_replication,bootstrap_timeout_due_to_misconfig,instance_unreachable_due_to_misconfig,storage_download_failure_due_to_misconfig,control_plane_request_failure_due_to_misconfig,cloud_provider_launch_failure_due_to_misconfig,gcp_subnet_not_ready,cloud_operation_cancelled,cloud_provider_instance_not_launched,gcp_trusted_image_projects_violated,budget_policy_limit_enforcement_activated,eos_spark_image,no_matched_k8s,lazy_allocation_timeout,driver_node_unreachable,secret_creation_failure,pod_scheduling_failure,pod_assignment_failure,allocation_timeout,allocation_timeout_no_unallocated_clusters,allocation_timeout_no_matched_clusters,allocation_timeout_no_ready_clusters,allocation_timeout_no_warmed_up_clusters,allocation_timeout_node_daemon_not_ready,allocation_timeout_no_healthy_clusters,netvisor_setup_timeout,no_matched_k8s_testing_tag,cloud_provider_resource_stockout_due_to_misconfig,gke_based_cluster_termination,allocation_timeout_no_healthy_and_warmed_up_clusters,docker_invalid_os_exception,docker_container_creation_exception,docker_image_too_large_for_instance_exception,dns_resolution_error,gcp_denied_by_org_policy,secret_permission_denied,network_check_nic_failure,network_check_dns_server_failure,network_check_storage_failure,network_check_metadata_endpoint_failure,network_check_control_plane_failure,network_check_multiple_components_failure,driver_unhealthy,security_agents_failed_initial_verification,driver_dns_resolution_failure,no_activated_k8s,usage_policy_entitlement_denied,no_activated_k8s_testing_tag,k8s_active_pod_quota_exceededandcloud_account_pod_quota_exceededenum values fordatabricks.sdk.service.sql.TerminationReasonCode. - [Breaking] Change
create()method for a.account_metastore_assignments account-level service to start returningdatabricks.sdk.service.catalog.AccountsCreateMetastoreAssignmentResponsedataclass. - [Breaking] Change
delete()method for a.account_metastore_assignments account-level service to start returningdatabricks.sdk.service.catalog.AccountsDeleteMetastoreAssignmentResponsedataclass. - [Breaking] Change
update()method for a.account_metastore_assignments account-level service to start returningdatabricks.sdk.service.catalog.AccountsUpdateMetastoreAssignmentResponsedataclass. - [Breaking] Change
create()method for a.account_metastores account-level service to returndatabricks.sdk.service.catalog.AccountsCreateMetastoreResponsedataclass. - [Breaking] Change
delete()method for a.account_metastores account-level service to start returningdatabricks.sdk.service.catalog.AccountsDeleteMetastoreResponsedataclass. - [Breaking] Change
get()method for a.account_metastores account-level service to returndatabricks.sdk.service.catalog.AccountsGetMetastoreResponsedataclass. - [Breaking] Change
list()method for a.account_metastores account-level service to returndatabricks.sdk.service.catalog.AccountsListMetastoresResponsedataclass. - [Breaking] Change
update()method for a.account_metastores account-level service to returndatabricks.sdk.service.catalog.AccountsUpdateMetastoreResponsedataclass. - [Breaking] Change
create()method for a.account_storage_credentials account-level service to returndatabricks.sdk.service.catalog.AccountsCreateStorageCredentialInfodataclass. - [Breaking] Change
delete()method for a.account_storage_credentials account-level service to start returningdatabricks.sdk.service.catalog.AccountsDeleteStorageCredentialResponsedataclass. - [Breaking] Change
update()method for a.account_storage_credentials account-level service to returndatabricks.sdk.service.catalog.AccountsUpdateStorageCredentialResponsedataclass. - [Breaking] Change
create()method for w.registered_models workspace-level service with new required argument order. - [Breaking] Change
delete()method for a.credentials account-level service to start returningdatabricks.sdk.service.provisioning.Credentialdataclass. - [Breaking] Change
delete()method for a.encryption_keys account-level service to start returningdatabricks.sdk.service.provisioning.CustomerManagedKeydataclass. - [Breaking] Change
create()method for a.networks account-level service with new required argument order. - [Breaking] Change
delete()method for a.networks account-level service to start returningdatabricks.sdk.service.provisioning.Networkdataclass. - [Breaking] Change
create()andreplace()methods for a.private_access account-level service with new required argument order. - [Breaking] Change
delete()andreplace()methods for a.private_access account-level service to start returningdatabricks.sdk.service.provisioning.PrivateAccessSettingsdataclass. - [Breaking] Change
delete()method for a.storage account-level service to start returningdatabricks.sdk.service.provisioning.StorageConfigurationdataclass. - [Breaking] Change
create()method for a.vpc_endpoints account-level service with new required argument order. - [Breaking] Change
delete()method for a.vpc_endpoints account-level service to start returningdatabricks.sdk.service.provisioning.VpcEndpointdataclass. - [Breaking] Change
create()andupdate()methods for a.workspaces account-level service with new required argument order. - [Breaking] Change
delete()andupdate()methods for a.workspaces account-level service to start returningdatabricks.sdk.service.provisioning.Workspacedataclass. - [Breaking] Change
execute_statement()method for w.statement_execution workspace-level service . Method path has changed. - [Breaking] Change
metastore_infofield fordatabricks.sdk.service.catalog.AccountsCreateMetastoreto typedatabricks.sdk.service.catalog.CreateAccountsMetastoredataclass. - [Breaking] Change
credential_infofield fordatabricks.sdk.service.catalog.AccountsCreateStorageCredentialto typedatabricks.sdk.service.catalog.CreateAccountsStorageCredentialdataclass. - [Breaking] Change
metastore_infofield fordatabricks.sdk.service.catalog.AccountsUpdateMetastoreto typedatabricks.sdk.service.catalog.UpdateAccountsMetastoredataclass. - [Breaking] Change
credential_infofield fordatabricks.sdk.service.catalog.AccountsUpdateStorageCredentialto typedatabricks.sdk.service.catalog.UpdateAccountsStorageCredentialdataclass. - Change
catalog_name,nameandschema_namefields fordatabricks.sdk.service.catalog.CreateRegisteredModelRequestto no longer be required. - Change
network_namefield fordatabricks.sdk.service.provisioning.CreateNetworkRequestto no longer be required. - Change
private_access_settings_nameandregionfields fordatabricks.sdk.service.provisioning.CreatePrivateAccessSettingsRequestto no longer be required. - Change
vpc_endpoint_namefield fordatabricks.sdk.service.provisioning.CreateVpcEndpointRequestto no longer be required. - Change
workspace_namefield fordatabricks.sdk.service.provisioning.CreateWorkspaceRequestto no longer be required. - [Breaking] Change
dataplane_relayandrest_apifields fordatabricks.sdk.service.provisioning.NetworkVpcEndpointsto no longer be required. - Change
dataplane_relayandrest_apifields fordatabricks.sdk.service.provisioning.NetworkVpcEndpointsto no longer be required. - [Breaking] Change waiter for WorkspacesAPI.update method.
- [Breaking] Remove
browse_onlyfield fordatabricks.sdk.service.catalog.ModelVersionInfo. - [Breaking] Remove
jar_dependenciesfield fordatabricks.sdk.service.compute.Environment. - [Breaking] Remove
is_no_public_ip_enabledfield fordatabricks.sdk.service.provisioning.CreateWorkspaceRequest. - [Breaking] Remove
allowed_vpc_endpoint_ids,private_access_level,private_access_settings_name,public_access_enabledandregionfields fordatabricks.sdk.service.provisioning.ReplacePrivateAccessSettingsRequest. - [Breaking] Remove
external_idfield fordatabricks.sdk.service.provisioning.StsRole. - [Breaking] Remove
aws_region,credentials_id,custom_tags,managed_services_customer_managed_key_id,network_connectivity_config_id,network_id,private_access_settings_id,storage_configuration_idandstorage_customer_managed_key_idfields fordatabricks.sdk.service.provisioning.UpdateWorkspaceRequest. - [Breaking] Remove
external_customer_infoandis_no_public_ip_enabledfields fordatabricks.sdk.service.provisioning.Workspace. - [Breaking] Remove
status_unspecifiedenum value fordatabricks.sdk.service.sql.Status. - Add
browse_onlyfield fordatabricks.sdk.service.catalog.ModelVersionInfo. - Add
jar_dependenciesfield fordatabricks.sdk.service.compute.Environment. - Add
is_no_public_ip_enabledfield fordatabricks.sdk.service.provisioning.CreateWorkspaceRequest. - Add
allowed_vpc_endpoint_ids,private_access_levelandpublic_access_enabledfields fordatabricks.sdk.service.provisioning.ReplacePrivateAccessSettingsRequest. - [Breaking] Add
private_access_settings_nameandregionfields fordatabricks.sdk.service.provisioning.ReplacePrivateAccessSettingsRequest. - Add
external_idfield fordatabricks.sdk.service.provisioning.StsRole. - Add
aws_region,credentials_id,custom_tags,managed_services_customer_managed_key_id,network_connectivity_config_id,network_id,private_access_settings_id,storage_configuration_idandstorage_customer_managed_key_idfields fordatabricks.sdk.service.provisioning.UpdateWorkspaceRequest. - Add
external_customer_infoandis_no_public_ip_enabledfields fordatabricks.sdk.service.provisioning.Workspace. - Add
status_unspecifiedenum value fordatabricks.sdk.service.sql.Status. - [Breaking] Change
create()method for a.account_metastore_assignments account-level service to no longer returndatabricks.sdk.service.catalog.AccountsCreateMetastoreAssignmentResponsedataclass. - [Breaking] Change
delete()method for a.account_metastore_assignments account-level service to no longer returndatabricks.sdk.service.catalog.AccountsDeleteMetastoreAssignmentResponsedataclass. - [Breaking] Change
update()method for a.account_metastore_assignments account-level service to no longer returndatabricks.sdk.service.catalog.AccountsUpdateMetastoreAssignmentResponsedataclass. - [Breaking] Change
create(),get()andupdate()methods for a.account_metastores account-level service to returndatabricks.sdk.service.catalog.AccountsMetastoreInfodataclass. - [Breaking] Change
delete()method for a.account_metastores account-level service to no longer returndatabricks.sdk.service.catalog.AccountsDeleteMetastoreResponsedataclass. - [Breaking] Change
list()method for a.account_metastores account-level service to returndatabricks.sdk.service.catalog.ListMetastoresResponsedataclass. - [Breaking] Change
create()andupdate()methods for a.account_storage_credentials account-level service to returndatabricks.sdk.service.catalog.AccountsStorageCredentialInfodataclass. - [Breaking] Change
delete()method for a.account_storage_credentials account-level service to no longer returndatabricks.sdk.service.catalog.AccountsDeleteStorageCredentialResponsedataclass. - [Breaking] Change
create()method for w.registered_models workspace-level service with new required argument order. - [Breaking] Change
delete()method for a.credentials account-level service to no longer returndatabricks.sdk.service.provisioning.Credentialdataclass. - [Breaking] Change
delete()method for a.encryption_keys account-level service to no longer returndatabricks.sdk.service.provisioning.CustomerManagedKeydataclass. - [Breaking] Change
create()method for a.networks account-level service with new required argument order. - [Breaking] Change
delete()method for a.networks account-level service to no longer returndatabricks.sdk.service.provisioning.Networkdataclass. - [Breaking] Change
create()andreplace()methods for a.private_access account-level service with new required argument order. - [Breaking] Change
delete()andreplace()methods for a.private_access account-level service to no longer returndatabricks.sdk.service.provisioning.PrivateAccessSettingsdataclass. - [Breaking] Change
delete()method for a.storage account-level service to no longer returndatabricks.sdk.service.provisioning.StorageConfigurationdataclass. - [Breaking] Change
create()method for a.vpc_endpoints account-level service with new required argument order. - [Breaking] Change
delete()method for a.vpc_endpoints account-level service to no longer returndatabricks.sdk.service.provisioning.VpcEndpointdataclass. - [Breaking] Change
create()andupdate()methods for a.workspaces account-level service with new required argument order. - [Breaking] Change
delete()andupdate()methods for a.workspaces account-level service to no longer returndatabricks.sdk.service.provisioning.Workspacedataclass. - [Breaking] Change
execute_statement()method for w.statement_execution workspace-level service . Method path has changed. - [Breaking] Change
metastore_infofield fordatabricks.sdk.service.catalog.AccountsCreateMetastoreto typedatabricks.sdk.service.catalog.CreateMetastoredataclass. - [Breaking] Change
credential_infofield fordatabricks.sdk.service.catalog.AccountsCreateStorageCredentialto typedatabricks.sdk.service.catalog.CreateStorageCredentialdataclass. - [Breaking] Change
metastore_infofield fordatabricks.sdk.service.catalog.AccountsUpdateMetastoreto typedatabricks.sdk.service.catalog.UpdateMetastoredataclass. - [Breaking] Change
credential_infofield fordatabricks.sdk.service.catalog.AccountsUpdateStorageCredentialto typedatabricks.sdk.service.catalog.UpdateStorageCredentialdataclass. - [Breaking] Change
catalog_name,nameandschema_namefields fordatabricks.sdk.service.catalog.CreateRegisteredModelRequestto be required. - [Breaking] Change
namefield fordatabricks.sdk.service.database.DatabaseInstanceRoleto no longer be required. - Change
namefield fordatabricks.sdk.service.database.DatabaseInstanceRoleto no longer be required. - [Breaking] Change
network_namefield fordatabricks.sdk.service.provisioning.CreateNetworkRequestto be required. - [Breaking] Change
private_access_settings_nameandregionfields fordatabricks.sdk.service.provisioning.CreatePrivateAccessSettingsRequestto be required. - [Breaking] Change
vpc_endpoint_namefield fordatabricks.sdk.service.provisioning.CreateVpcEndpointRequestto be required. - [Breaking] Change
workspace_namefield fordatabricks.sdk.service.provisioning.CreateWorkspaceRequestto be required. - Change
dataplane_relayandrest_apifields fordatabricks.sdk.service.provisioning.NetworkVpcEndpointsto be required. - [Breaking] Change
dataplane_relayandrest_apifields fordatabricks.sdk.service.provisioning.NetworkVpcEndpointsto be required. - [Breaking] Change waiter for WorkspacesAPI.update method.
- [Breaking] Remove
databricks.sdk.service.dataqualitypackage. - [Breaking] Remove
create_update()andget_update()methods for w.apps workspace-level service. - [Breaking] Remove
update_notifications()method for w.serving_endpoints workspace-level service. - [Breaking] Remove
compute_sizefield fordatabricks.sdk.service.apps.App. - [Breaking] Remove
genie_spacefield fordatabricks.sdk.service.apps.AppResource. - [Breaking] Remove
skip_validationfield fordatabricks.sdk.service.catalog.AccountsCreateStorageCredential. - [Breaking] Remove
skip_validationfield fordatabricks.sdk.service.catalog.AccountsUpdateStorageCredential. - [Breaking] Remove
aliases,browse_only,created_at,created_by,full_name,metastore_id,owner,updated_atandupdated_byfields fordatabricks.sdk.service.catalog.CreateRegisteredModelRequest. - [Breaking] Remove
catalog_name,id,model_nameandschema_namefields fordatabricks.sdk.service.catalog.RegisteredModelAlias. - [Breaking] Remove
aliases,catalog_name,created_at,created_by,id,metastore_id,model_name,model_version_dependencies,run_id,run_workspace_id,schema_name,source,status,storage_location,updated_atandupdated_byfields fordatabricks.sdk.service.catalog.UpdateModelVersionRequest. - [Breaking] Remove
aliases,browse_only,catalog_name,created_at,created_by,metastore_id,name,schema_name,storage_location,updated_atandupdated_byfields fordatabricks.sdk.service.catalog.UpdateRegisteredModelRequest. - [Breaking] Remove
parametersfield fordatabricks.sdk.service.dashboards.GenieQueryAttachment. - [Breaking] Remove
database_instance_namefield fordatabricks.sdk.service.database.CreateDatabaseInstanceRoleRequest. - [Breaking] Remove
custom_tags,effective_custom_tags,effective_usage_policy_idandusage_policy_idfields fordatabricks.sdk.service.database.DatabaseInstance. - [Breaking] Remove
effective_attributesandinstance_namefields fordatabricks.sdk.service.database.DatabaseInstanceRole. - [Breaking] Remove
key_regionfield fordatabricks.sdk.service.provisioning.CreateAwsKeyInfo. - [Breaking] Remove
role_arnfield fordatabricks.sdk.service.provisioning.CreateStorageConfigurationRequest. - [Breaking] Remove
azure_key_infofield fordatabricks.sdk.service.provisioning.CustomerManagedKey. - [Breaking] Remove
customer_facing_private_access_settingsfield fordatabricks.sdk.service.provisioning.ReplacePrivateAccessSettingsRequest. - [Breaking] Remove
role_arnfield fordatabricks.sdk.service.provisioning.StorageConfiguration. - [Breaking] Remove
customer_facing_workspaceandupdate_maskfields fordatabricks.sdk.service.provisioning.UpdateWorkspaceRequest. - [Breaking] Remove
compute_mode,network,network_connectivity_config_idandstorage_modefields fordatabricks.sdk.service.provisioning.Workspace. - [Breaking] Remove
enable_serverless_computefield fordatabricks.sdk.service.sql.GetWorkspaceWarehouseConfigResponse. - [Breaking] Remove
page_sizeandpage_tokenfields fordatabricks.sdk.service.sql.ListWarehousesRequest. - [Breaking] Remove
next_page_tokenfield fordatabricks.sdk.service.sql.ListWarehousesResponse. - [Breaking] Remove
enable_serverless_computefield fordatabricks.sdk.service.sql.SetWorkspaceWarehouseConfigRequest. - [Breaking] Remove
model_version_status_unknownenum value fordatabricks.sdk.service.catalog.ModelVersionInfoStatus. - [Breaking] Remove
stream_nativeenum value fordatabricks.sdk.service.catalog.SystemType. - [Breaking] Remove
k8s_active_pod_quota_exceededandcloud_account_pod_quota_exceededenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - [Breaking] Remove
exceeded_max_token_length_exception,internal_catalog_asset_creation_ongoing_exception,internal_catalog_asset_creation_failed_exceptionandinternal_catalog_asset_creation_unsupported_exceptionenum values fordatabricks.sdk.service.dashboards.MessageErrorType. - [Breaking] Remove
ssh_bootstrap_failure,aws_inaccessible_kms_key_failure,init_container_not_finished,spark_image_download_throttled,spark_image_not_found,cluster_operation_throttled,cluster_operation_timeout,serverless_long_running_terminated,azure_packed_deployment_partial_failure,invalid_worker_image_failure,workspace_update,invalid_aws_parameter,driver_out_of_disk,driver_out_of_memory,driver_launch_timeout,driver_unexpected_failure,unexpected_pod_recreation,gcp_inaccessible_kms_key_failure,gcp_kms_key_permission_denied,driver_eviction,user_initiated_vm_termination,gcp_iam_timeout,aws_resource_quota_exceeded,cloud_account_setup_failure,aws_invalid_key_pair,driver_pod_creation_failure,maintenance_mode,internal_capacity_failure,executor_pod_unscheduled,storage_download_failure_slow,storage_download_failure_throttled,dynamic_spark_conf_size_exceeded,aws_instance_profile_update_failure,instance_pool_not_found,instance_pool_max_capacity_reached,aws_invalid_kms_key_state,gcp_insufficient_capacity,gcp_api_rate_quota_exceeded,gcp_resource_quota_exceeded,gcp_ip_space_exhausted,gcp_service_account_access_denied,gcp_service_account_not_found,gcp_forbidden,gcp_not_found,resource_usage_blocked,data_access_config_changed,access_token_failure,invalid_instance_placement_protocol,budget_policy_resolution_failure,in_penalty_box,disaster_recovery_replication,bootstrap_timeout_due_to_misconfig,instance_unreachable_due_to_misconfig,storage_download_failure_due_to_misconfig,control_plane_request_failure_due_to_misconfig,cloud_provider_launch_failure_due_to_misconfig,gcp_subnet_not_ready,cloud_operation_cancelled,cloud_provider_instance_not_launched,gcp_trusted_image_projects_violated,budget_policy_limit_enforcement_activated,eos_spark_image,no_matched_k8s,lazy_allocation_timeout,driver_node_unreachable,secret_creation_failure,pod_scheduling_failure,pod_assignment_failure,allocation_timeout,allocation_timeout_no_unallocated_clusters,allocation_timeout_no_matched_clusters,allocation_timeout_no_ready_clusters,allocation_timeout_no_warmed_up_clusters,allocation_timeout_node_daemon_not_ready,allocation_timeout_no_healthy_clusters,netvisor_setup_timeout,no_matched_k8s_testing_tag,cloud_provider_resource_stockout_due_to_misconfig,gke_based_cluster_termination,allocation_timeout_no_healthy_and_warmed_up_clusters,docker_invalid_os_exception,docker_container_creation_exception,docker_image_too_large_for_instance_exception,dns_resolution_error,gcp_denied_by_org_policy,secret_permission_denied,network_check_nic_failure,network_check_dns_server_failure,network_check_storage_failure,network_check_metadata_endpoint_failure,network_check_control_plane_failure,network_check_multiple_components_failure,driver_unhealthy,security_agents_failed_initial_verification,driver_dns_resolution_failure,no_activated_k8s,usage_policy_entitlement_denied,no_activated_k8s_testing_tag,k8s_active_pod_quota_exceededandcloud_account_pod_quota_exceededenum values fordatabricks.sdk.service.sql.TerminationReasonCode. - Add
databricks.sdk.service.dataqualitypackage. - Add w.data_quality workspace-level service.
- Add
create_update()andget_update()methods for w.apps workspace-level service. - Add
update_notifications()method for w.serving_endpoints workspace-level service. - Add
compute_sizefield fordatabricks.sdk.service.apps.App. - Add
genie_spacefield fordatabricks.sdk.service.apps.AppResource. - Add
skip_validationfield fordatabricks.sdk.service.catalog.AccountsCreateStorageCredential. - Add
skip_validationfield fordatabricks.sdk.service.catalog.AccountsUpdateStorageCredential. - Add
aliases,browse_only,created_at,created_by,full_name,metastore_id,owner,updated_atandupdated_byfields fordatabricks.sdk.service.catalog.CreateRegisteredModelRequest. - Add
include_unboundfield fordatabricks.sdk.service.catalog.ListCatalogsRequest. - Add
include_unboundfield fordatabricks.sdk.service.catalog.ListCredentialsRequest. - Add
include_unboundfield fordatabricks.sdk.service.catalog.ListExternalLocationsRequest. - Add
include_unboundfield fordatabricks.sdk.service.catalog.ListStorageCredentialsRequest. - Add
catalog_name,id,model_nameandschema_namefields fordatabricks.sdk.service.catalog.RegisteredModelAlias. - Add
aliases,catalog_name,created_at,created_by,id,metastore_id,model_name,model_version_dependencies,run_id,run_workspace_id,schema_name,source,status,storage_location,updated_atandupdated_byfields fordatabricks.sdk.service.catalog.UpdateModelVersionRequest. - Add
aliases,browse_only,catalog_name,created_at,created_by,metastore_id,name,schema_name,storage_location,updated_atandupdated_byfields fordatabricks.sdk.service.catalog.UpdateRegisteredModelRequest. - Add
parametersfield fordatabricks.sdk.service.dashboards.GenieQueryAttachment. - Add
database_instance_namefield fordatabricks.sdk.service.database.CreateDatabaseInstanceRoleRequest. - Add
custom_tags,effective_custom_tags,effective_usage_policy_idandusage_policy_idfields fordatabricks.sdk.service.database.DatabaseInstance. - Add
effective_attributesandinstance_namefields fordatabricks.sdk.service.database.DatabaseInstanceRole. - Add
key_regionfield fordatabricks.sdk.service.provisioning.CreateAwsKeyInfo. - Add
role_arnfield fordatabricks.sdk.service.provisioning.CreateStorageConfigurationRequest. - Add
azure_key_infofield fordatabricks.sdk.service.provisioning.CustomerManagedKey. - [Breaking] Add
customer_facing_private_access_settingsfield fordatabricks.sdk.service.provisioning.ReplacePrivateAccessSettingsRequest. - Add
role_arnfield fordatabricks.sdk.service.provisioning.StorageConfiguration. - [Breaking] Add
customer_facing_workspacefield fordatabricks.sdk.service.provisioning.UpdateWorkspaceRequest. - Add
update_maskfield fordatabricks.sdk.service.provisioning.UpdateWorkspaceRequest. - Add
compute_mode,network,network_connectivity_config_idandstorage_modefields fordatabricks.sdk.service.provisioning.Workspace. - Add
enable_serverless_computefield fordatabricks.sdk.service.sql.GetWorkspaceWarehouseConfigResponse. - Add
page_sizeandpage_tokenfields fordatabricks.sdk.service.sql.ListWarehousesRequest. - Add
next_page_tokenfield fordatabricks.sdk.service.sql.ListWarehousesResponse. - Add
enable_serverless_computefield fordatabricks.sdk.service.sql.SetWorkspaceWarehouseConfigRequest. - Add
model_version_status_unknownenum value fordatabricks.sdk.service.catalog.ModelVersionInfoStatus. - Add
stream_nativeenum value fordatabricks.sdk.service.catalog.SystemType. - Add
k8s_active_pod_quota_exceededandcloud_account_pod_quota_exceededenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - Add
exceeded_max_token_length_exception,internal_catalog_asset_creation_ongoing_exception,internal_catalog_asset_creation_failed_exceptionandinternal_catalog_asset_creation_unsupported_exceptionenum values fordatabricks.sdk.service.dashboards.MessageErrorType. - Add
asset_type_mcpenum value fordatabricks.sdk.service.marketplace.AssetType. - Add
ssh_bootstrap_failure,aws_inaccessible_kms_key_failure,init_container_not_finished,spark_image_download_throttled,spark_image_not_found,cluster_operation_throttled,cluster_operation_timeout,serverless_long_running_terminated,azure_packed_deployment_partial_failure,invalid_worker_image_failure,workspace_update,invalid_aws_parameter,driver_out_of_disk,driver_out_of_memory,driver_launch_timeout,driver_unexpected_failure,unexpected_pod_recreation,gcp_inaccessible_kms_key_failure,gcp_kms_key_permission_denied,driver_eviction,user_initiated_vm_termination,gcp_iam_timeout,aws_resource_quota_exceeded,cloud_account_setup_failure,aws_invalid_key_pair,driver_pod_creation_failure,maintenance_mode,internal_capacity_failure,executor_pod_unscheduled,storage_download_failure_slow,storage_download_failure_throttled,dynamic_spark_conf_size_exceeded,aws_instance_profile_update_failure,instance_pool_not_found,instance_pool_max_capacity_reached,aws_invalid_kms_key_state,gcp_insufficient_capacity,gcp_api_rate_quota_exceeded,gcp_resource_quota_exceeded,gcp_ip_space_exhausted,gcp_service_account_access_denied,gcp_service_account_not_found,gcp_forbidden,gcp_not_found,resource_usage_blocked,data_access_config_changed,access_token_failure,invalid_instance_placement_protocol,budget_policy_resolution_failure,in_penalty_box,disaster_recovery_replication,bootstrap_timeout_due_to_misconfig,instance_unreachable_due_to_misconfig,storage_download_failure_due_to_misconfig,control_plane_request_failure_due_to_misconfig,cloud_provider_launch_failure_due_to_misconfig,gcp_subnet_not_ready,cloud_operation_cancelled,cloud_provider_instance_not_launched,gcp_trusted_image_projects_violated,budget_policy_limit_enforcement_activated,eos_spark_image,no_matched_k8s,lazy_allocation_timeout,driver_node_unreachable,secret_creation_failure,pod_scheduling_failure,pod_assignment_failure,allocation_timeout,allocation_timeout_no_unallocated_clusters,allocation_timeout_no_matched_clusters,allocation_timeout_no_ready_clusters,allocation_timeout_no_warmed_up_clusters,allocation_timeout_node_daemon_not_ready,allocation_timeout_no_healthy_clusters,netvisor_setup_timeout,no_matched_k8s_testing_tag,cloud_provider_resource_stockout_due_to_misconfig,gke_based_cluster_termination,allocation_timeout_no_healthy_and_warmed_up_clusters,docker_invalid_os_exception,docker_container_creation_exception,docker_image_too_large_for_instance_exception,dns_resolution_error,gcp_denied_by_org_policy,secret_permission_denied,network_check_nic_failure,network_check_dns_server_failure,network_check_storage_failure,network_check_metadata_endpoint_failure,network_check_control_plane_failure,network_check_multiple_components_failure,driver_unhealthy,security_agents_failed_initial_verification,driver_dns_resolution_failure,no_activated_k8s,usage_policy_entitlement_denied,no_activated_k8s_testing_tag,k8s_active_pod_quota_exceededandcloud_account_pod_quota_exceededenum values fordatabricks.sdk.service.sql.TerminationReasonCode. - [Breaking] Change
create()method for a.account_metastore_assignments account-level service to start returningdatabricks.sdk.service.catalog.AccountsCreateMetastoreAssignmentResponsedataclass. - [Breaking] Change
delete()method for a.account_metastore_assignments account-level service to start returningdatabricks.sdk.service.catalog.AccountsDeleteMetastoreAssignmentResponsedataclass. - [Breaking] Change
update()method for a.account_metastore_assignments account-level service to start returningdatabricks.sdk.service.catalog.AccountsUpdateMetastoreAssignmentResponsedataclass. - [Breaking] Change
create()method for a.account_metastores account-level service to returndatabricks.sdk.service.catalog.AccountsCreateMetastoreResponsedataclass. - [Breaking] Change
delete()method for a.account_metastores account-level service to start returningdatabricks.sdk.service.catalog.AccountsDeleteMetastoreResponsedataclass. - [Breaking] Change
get()method for a.account_metastores account-level service to returndatabricks.sdk.service.catalog.AccountsGetMetastoreResponsedataclass. - [Breaking] Change
list()method for a.account_metastores account-level service to returndatabricks.sdk.service.catalog.AccountsListMetastoresResponsedataclass. - [Breaking] Change
update()method for a.account_metastores account-level service to returndatabricks.sdk.service.catalog.AccountsUpdateMetastoreResponsedataclass. - [Breaking] Change
create()method for a.account_storage_credentials account-level service to returndatabricks.sdk.service.catalog.AccountsCreateStorageCredentialInfodataclass. - [Breaking] Change
delete()method for a.account_storage_credentials account-level service to start returningdatabricks.sdk.service.catalog.AccountsDeleteStorageCredentialResponsedataclass. - [Breaking] Change
update()method for a.account_storage_credentials account-level service to returndatabricks.sdk.service.catalog.AccountsUpdateStorageCredentialResponsedataclass. - [Breaking] Change
create()method for w.registered_models workspace-level service with new required argument order. - [Breaking] Change
delete()method for a.credentials account-level service to start returningdatabricks.sdk.service.provisioning.Credentialdataclass. - [Breaking] Change
delete()method for a.encryption_keys account-level service to start returningdatabricks.sdk.service.provisioning.CustomerManagedKeydataclass. - [Breaking] Change
create()method for a.networks account-level service with new required argument order. - [Breaking] Change
delete()method for a.networks account-level service to start returningdatabricks.sdk.service.provisioning.Networkdataclass. - [Breaking] Change
create()andreplace()methods for a.private_access account-level service with new required argument order. - [Breaking] Change
delete()andreplace()methods for a.private_access account-level service to start returningdatabricks.sdk.service.provisioning.PrivateAccessSettingsdataclass. - [Breaking] Change
delete()method for a.storage account-level service to start returningdatabricks.sdk.service.provisioning.StorageConfigurationdataclass. - [Breaking] Change
create()method for a.vpc_endpoints account-level service with new required argument order. - [Breaking] Change
delete()method for a.vpc_endpoints account-level service to start returningdatabricks.sdk.service.provisioning.VpcEndpointdataclass. - [Breaking] Change
create()andupdate()methods for a.workspaces account-level service with new required argument order. - [Breaking] Change
delete()andupdate()methods for a.workspaces account-level service to start returningdatabricks.sdk.service.provisioning.Workspacedataclass. - [Breaking] Change
execute_statement()method for w.statement_execution workspace-level service . Method path has changed. - [Breaking] Change
metastore_infofield fordatabricks.sdk.service.catalog.AccountsCreateMetastoreto typedatabricks.sdk.service.catalog.CreateAccountsMetastoredataclass. - [Breaking] Change
credential_infofield fordatabricks.sdk.service.catalog.AccountsCreateStorageCredentialto typedatabricks.sdk.service.catalog.CreateAccountsStorageCredentialdataclass. - [Breaking] Change
metastore_infofield fordatabricks.sdk.service.catalog.AccountsUpdateMetastoreto typedatabricks.sdk.service.catalog.UpdateAccountsMetastoredataclass. - [Breaking] Change
credential_infofield fordatabricks.sdk.service.catalog.AccountsUpdateStorageCredentialto typedatabricks.sdk.service.catalog.UpdateAccountsStorageCredentialdataclass. - Change
catalog_name,nameandschema_namefields fordatabricks.sdk.service.catalog.CreateRegisteredModelRequestto no longer be required. - [Breaking] Change
namefield fordatabricks.sdk.service.database.DatabaseInstanceRoleto be required. - Change
namefield fordatabricks.sdk.service.database.DatabaseInstanceRoleto be required. - Change
network_namefield fordatabricks.sdk.service.provisioning.CreateNetworkRequestto no longer be required. - Change
private_access_settings_nameandregionfields fordatabricks.sdk.service.provisioning.CreatePrivateAccessSettingsRequestto no longer be required. - Change
vpc_endpoint_namefield fordatabricks.sdk.service.provisioning.CreateVpcEndpointRequestto no longer be required. - Change
workspace_namefield fordatabricks.sdk.service.provisioning.CreateWorkspaceRequestto no longer be required. - Change
dataplane_relayandrest_apifields fordatabricks.sdk.service.provisioning.NetworkVpcEndpointsto no longer be required. - [Breaking] Change
dataplane_relayandrest_apifields fordatabricks.sdk.service.provisioning.NetworkVpcEndpointsto no longer be required. - [Breaking] Change waiter for WorkspacesAPI.update method.
- [Breaking] Remove
browse_onlyfield fordatabricks.sdk.service.catalog.ModelVersionInfo. - [Breaking] Remove
jar_dependenciesfield fordatabricks.sdk.service.compute.Environment. - [Breaking] Remove
is_no_public_ip_enabledfield fordatabricks.sdk.service.provisioning.CreateWorkspaceRequest. - [Breaking] Remove
allowed_vpc_endpoint_ids,private_access_level,private_access_settings_name,public_access_enabledandregionfields fordatabricks.sdk.service.provisioning.ReplacePrivateAccessSettingsRequest. - [Breaking] Remove
external_idfield fordatabricks.sdk.service.provisioning.StsRole. - [Breaking] Remove
aws_region,credentials_id,custom_tags,managed_services_customer_managed_key_id,network_connectivity_config_id,network_id,private_access_settings_id,storage_configuration_idandstorage_customer_managed_key_idfields fordatabricks.sdk.service.provisioning.UpdateWorkspaceRequest. - [Breaking] Remove
external_customer_infoandis_no_public_ip_enabledfields fordatabricks.sdk.service.provisioning.Workspace. - [Breaking] Remove
status_unspecifiedenum value fordatabricks.sdk.service.sql.Status. - Add
compute_modefield fordatabricks.sdk.service.provisioning.CreateWorkspaceRequest. - Add
expected_workspace_statusfield fordatabricks.sdk.service.provisioning.Workspace. - Add
dependency_storage_locationsfield fordatabricks.sdk.service.sharing.TableInternalAttributes. - Add
git_emailfield fordatabricks.sdk.service.workspace.CreateCredentialsRequest. - Add
git_emailfield fordatabricks.sdk.service.workspace.CreateCredentialsResponse. - Add
git_emailfield fordatabricks.sdk.service.workspace.CredentialInfo. - Add
git_emailfield fordatabricks.sdk.service.workspace.GetCredentialsResponse. - Add
git_emailfield fordatabricks.sdk.service.workspace.UpdateCredentialsRequest. - Add
germany_tisaxenum value fordatabricks.sdk.service.settings.ComplianceStandard. - [Breaking] Remove
prediction_probability_columnfield fordatabricks.sdk.service.dataquality.InferenceLogConfig.
Release v0.67.0 (2025-09-25)
API Changes
- Add
update_notifications()method for w.serving_endpoints workspace-level service. - Add
parametersfield fordatabricks.sdk.service.dashboards.GenieQueryAttachment. - Add
database_instance_namefield fordatabricks.sdk.service.database.CreateDatabaseInstanceRoleRequest. - Add
custom_tags,effective_custom_tags,effective_usage_policy_idandusage_policy_idfields fordatabricks.sdk.service.database.DatabaseInstance. - Add
effective_attributesandinstance_namefields fordatabricks.sdk.service.database.DatabaseInstanceRole. - Add
external_use_schemaenum value fordatabricks.sdk.service.catalog.Privilege. - Add
stream_nativeenum value fordatabricks.sdk.service.catalog.SystemType. - Add
exceeded_max_token_length_exceptionenum value fordatabricks.sdk.service.dashboards.MessageErrorType. - Change
namefield fordatabricks.sdk.service.database.DatabaseInstanceRoleto be required. - [Breaking] Change
namefield fordatabricks.sdk.service.database.DatabaseInstanceRoleto be required.
Release v0.66.0 (2025-09-22)
New Features and Improvements
- Add a public helper function to build a
CredentialsProviderdirectly from anIdTokenSource.
API Changes
- Added
databricks.sdk.service.iamv2package. - Added a.account_groups_v2 account-level service, a.account_service_principals_v2 account-level service, a.account_users_v2 account-level service, w.groups_v2 workspace-level service, w.service_principals_v2 workspace-level service and w.users_v2 workspace-level service.
- Added a.account_iam_v2 account-level service and w.workspace_iam_v2 workspace-level service.
- Added w.feature_engineering workspace-level service.
- Added
java_dependenciesfield fordatabricks.sdk.service.compute.Environment. - Added
followup_questionsfield fordatabricks.sdk.service.dashboards.GenieAttachment. - Added
feedbackfield fordatabricks.sdk.service.dashboards.GenieMessage. - Added
effective_capacityfield fordatabricks.sdk.service.database.DatabaseInstance. - Added
disabledfield fordatabricks.sdk.service.jobs.Task. - Added
netsuite_jar_pathfield fordatabricks.sdk.service.pipelines.IngestionPipelineDefinition. - Added
workday_report_parametersfield fordatabricks.sdk.service.pipelines.TableSpecificConfig. - Added
auxiliary_managed_locationfield fordatabricks.sdk.service.sharing.TableInternalAttributes. - Added
alertsfield fordatabricks.sdk.service.sql.ListAlertsV2Response. - Added
create_timeandupdate_timefields fordatabricks.sdk.service.tags.TagPolicy. - Added
table_delta_uniform_iceberg_foreign_deltasharingenum value fordatabricks.sdk.service.catalog.SecurableKind. - Added
no_activated_k8sandusage_policy_entitlement_deniedenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - Added
internal_catalog_path_overlap_exceptionandinternal_catalog_missing_uc_path_exceptionenum values fordatabricks.sdk.service.dashboards.MessageErrorType. - Added
foreign_catalogenum value fordatabricks.sdk.service.pipelines.IngestionSourceType. - Added
foreign_iceberg_tableenum value fordatabricks.sdk.service.sharing.TableInternalAttributesSharedTableType. - [Breaking] Removed
disabledfield fordatabricks.sdk.service.jobs.RunTask. - [Breaking] Removed
default_data_security_modeandeffective_default_data_security_modefields fordatabricks.sdk.service.settingsv2.Setting. - Added
list_shares()method for w.shares workspace-level service. - Added
suggested_questionsfield fordatabricks.sdk.service.dashboards.GenieAttachment. - Added
warehouse_idfield fordatabricks.sdk.service.dashboards.GenieSpace. - Added
palantirenum value fordatabricks.sdk.service.catalog.ConnectionType. - Added
table_metric_view_deltasharingandtable_foreign_palantirenum values fordatabricks.sdk.service.catalog.SecurableKind. - Added
no_activated_k8s_testing_tagenum value fordatabricks.sdk.service.compute.TerminationReasonCode. - Added
metric_viewenum value fordatabricks.sdk.service.sharing.TableInternalAttributesSharedTableType. - [Breaking] Removed
followup_questionsfield fordatabricks.sdk.service.dashboards.GenieAttachment. - [Breaking] Removed
commentfield fordatabricks.sdk.service.dashboards.GenieFeedback. - [Breaking] Removed
commentfield fordatabricks.sdk.service.dashboards.GenieSendMessageFeedbackRequest.
Release v0.65.0 (2025-09-02)
New Features and Improvements
- Added support for passing additional kwargs to
WorkspaceClient().serving_endpoints.get_open_ai_client()(#1025). Users can now pass standard OpenAI client parameters liketimeoutandmax_retrieswhen creating an OpenAI client for Databricks Model Serving.
API Changes
- Added
commentfield fordatabricks.sdk.service.dashboards.GenieSendMessageFeedbackRequest. - [Breaking] Added
ratingfield fordatabricks.sdk.service.dashboards.GenieSendMessageFeedbackRequest. - Added
effective_enable_pg_native_loginandenable_pg_native_loginfields fordatabricks.sdk.service.database.DatabaseInstance. - Added
task_retry_modefield fordatabricks.sdk.service.jobs.Continuous. - Added
source_configurationsfield fordatabricks.sdk.service.pipelines.IngestionPipelineDefinition. - Added
app_id,app_id_set,auth_secret,auth_secret_set,channel_url,channel_url_set,tenant_idandtenant_id_setfields fordatabricks.sdk.service.settings.MicrosoftTeamsConfig. - Added
ensure_reranker_compatiblefield fordatabricks.sdk.service.vectorsearch.GetIndexRequest. - Added
rerankerfield fordatabricks.sdk.service.vectorsearch.QueryVectorIndexRequest. - [Breaking] Changed
create_clean_room_asset_review()method for w.clean_room_assets workspace-level service with new required argument order. - [Breaking] Changed
send_message_feedback()method for w.genie workspace-level service with new required argument order. - Changed
notebook_reviewfield fordatabricks.sdk.service.cleanrooms.CreateCleanRoomAssetReviewRequestto no longer be required. - [Breaking] Changed
featuresfield fordatabricks.sdk.service.ml.FeatureListto type list[databricks.sdk.service.ml.LinkedFeature] dataclass. - [Breaking] Removed
feedback_ratingandfeedback_textfields fordatabricks.sdk.service.dashboards.GenieSendMessageFeedbackRequest.
Release v0.64.0 (2025-08-20)
API Changes
- Added
databricks.sdk.service.settingsv2anddatabricks.sdk.service.tagspackages. - Added w.apps_settings workspace-level service.
- Added w.entity_tag_assignments workspace-level service and w.rfa workspace-level service.
- Added a.account_settings_v2 account-level service and w.workspace_settings_v2 workspace-level service.
- Added w.tag_policies workspace-level service.
- Added
delete_conversation_message(),list_conversation_messages()andsend_message_feedback()methods for w.genie workspace-level service. - Added
include_allfield fordatabricks.sdk.service.dashboards.GenieListConversationsRequest. - Added
effective_usage_policy_idfield fordatabricks.sdk.service.jobs.BaseJob. - Added
effective_usage_policy_idfield fordatabricks.sdk.service.jobs.BaseRun. - Added
effective_usage_policy_idfield fordatabricks.sdk.service.jobs.Job. - Added
effective_usage_policy_idfield fordatabricks.sdk.service.jobs.Run. - Added
tokensfield fordatabricks.sdk.service.serving.AiGatewayRateLimit. - Added
usage_policy_idfield fordatabricks.sdk.service.serving.ServingEndpoint. - Added
effective_run_asandrun_asfields fordatabricks.sdk.service.sql.AlertV2. - Added
cache_query_idfield fordatabricks.sdk.service.sql.QueryInfo. - Added
model_endpoint_name_for_queryfield fordatabricks.sdk.service.vectorsearch.EmbeddingSourceColumn. - [Breaking] Removed
environment_settingsfield fordatabricks.sdk.service.catalog.ConnectionInfo. - [Breaking] Removed
environment_settingsfield fordatabricks.sdk.service.catalog.CreateConnection. - [Breaking] Removed
environment_settingsfield fordatabricks.sdk.service.catalog.UpdateConnection. - [Breaking] Removed
comment,display_nameandtagsfields fordatabricks.sdk.service.sharing.Share.
Release v0.63.0 (2025-08-13)
API Changes
- Added w.policies workspace-level service and w.temporary_path_credentials workspace-level service.
- Added
create()method for w.tables workspace-level service. - Added
list_database_catalogs(),list_synced_database_tables(),update_database_catalog()andupdate_synced_database_table()methods for w.database workspace-level service. - Added
first_on_demandfield fordatabricks.sdk.service.compute.GcpAttributes. - Added
usage_policy_idfield fordatabricks.sdk.service.jobs.CreateJob. - Added
usage_policy_idfield fordatabricks.sdk.service.jobs.JobSettings. - Added
usage_policy_idfield fordatabricks.sdk.service.jobs.SubmitRun. - Added
client_request_idandusage_contextfields fordatabricks.sdk.service.serving.QueryEndpointInput. - Added
channel_id,channel_id_set,oauth_tokenandoauth_token_setfields fordatabricks.sdk.service.settings.SlackConfig. - Added
snapshotenum value fordatabricks.sdk.service.ml.PublishSpecPublishMode. - [Breaking] Changed
publish_modefield fordatabricks.sdk.service.ml.PublishSpecto be required.
Release v0.62.0 (2025-08-06)
Bug Fixes
- Fix
Config.oauth_token()to avoid re-creating a newCredentialsProviderat each call. This fix indirectly makesoauth_token()benefit from the internal caching mechanism of some providers.
API Changes
- Added
statement_id_signaturefield fordatabricks.sdk.service.dashboards.Result. - Added
effective_database_instance_nameandeffective_logical_database_namefields fordatabricks.sdk.service.database.SyncedDatabaseTable. - Added
tablefield fordatabricks.sdk.service.jobs.TriggerStateProto. - Added
email_notificationsfield fordatabricks.sdk.service.serving.CreatePtEndpointRequest. - Added
email_notificationsfield fordatabricks.sdk.service.serving.CreateServingEndpoint. - Added
email_notificationsfield fordatabricks.sdk.service.serving.ServingEndpointDetailed. - [Breaking] Changed
list()method for w.consumer_providers workspace-level service . New request type isdatabricks.sdk.service.marketplace.ListConsumerProvidersRequestdataclass. - [Breaking] Changed
create()method for a.private_access account-level service with new required argument order. - [Breaking] Changed
create()method for a.private_access account-level service . New request type isdatabricks.sdk.service.provisioning.CreatePrivateAccessSettingsRequestdataclass. - [Breaking] Changed
replace()method for a.private_access account-level service . New request type isdatabricks.sdk.service.provisioning.ReplacePrivateAccessSettingsRequestdataclass. - [Breaking] Removed
is_featuredfield fordatabricks.sdk.service.marketplace.ListProvidersRequest.
Release v0.61.0 (2025-07-31)
API Changes
- Added w.clean_room_asset_revisions workspace-level service and w.clean_room_auto_approval_rules workspace-level service.
- Added
create_clean_room_asset_review()method for w.clean_room_assets workspace-level service. - Added
latest_monitor_failure_msgfield fordatabricks.sdk.service.catalog.CreateMonitor. - Added
latest_monitor_failure_msgfield fordatabricks.sdk.service.catalog.UpdateMonitor. - Added
sharefield fordatabricks.sdk.service.sharing.ListProviderShareAssetsResponse. - Added
projected_remaining_wallclock_time_msfield fordatabricks.sdk.service.sql.QueryMetrics. - Added
unspecifiedenum value fordatabricks.sdk.service.catalog.MonitorCronSchedulePauseStatus. - Added
unknownenum value fordatabricks.sdk.service.catalog.MonitorRefreshInfoState. - Added
unknown_triggerenum value fordatabricks.sdk.service.catalog.MonitorRefreshInfoTrigger. - Added
message_attachment_too_long_errorenum value fordatabricks.sdk.service.dashboards.MessageErrorType. - Added
maskenum value fordatabricks.sdk.service.serving.AiGatewayGuardrailPiiBehaviorBehavior. - [Breaking] Added waiter for CleanRoomsAPI.create method.
- [Breaking] Added waiter for DatabaseAPI.create_database_instance method.
- [Breaking] Changed
cancel_refresh()method for w.quality_monitors workspace-level service to start returningdatabricks.sdk.service.catalog.CancelRefreshResponsedataclass. - [Breaking] Changed
create()method for w.quality_monitors workspace-level service with new required argument order. - [Breaking] Changed
delete()method for w.quality_monitors workspace-level service to start returningdatabricks.sdk.service.catalog.DeleteMonitorResponsedataclass. - [Breaking] Changed
refresh_idfield fordatabricks.sdk.service.catalog.CancelRefreshRequestto typeintdataclass. - [Breaking] Changed
refresh_idfield fordatabricks.sdk.service.catalog.GetRefreshRequestto typeintdataclass. - [Breaking] Changed
monitor_versionfield fordatabricks.sdk.service.catalog.MonitorInfoto typeintdataclass. - Changed
output_schema_namefield fordatabricks.sdk.service.catalog.MonitorInfoto be required.
Release v0.60.0 (2025-07-24)
New Features and Improvements
- Added headers to HttpRequestResponse in OpenAI client.
Bug Fixes
- Correctly issue in OIDC implementation that prevented the use of the feature (see #994).
- Fix a reported issue where
FilesExtfails to retry if it receives certain status code from server.
Internal Changes
- Refactor unit tests for
FilesExtto improve its readability.
API Changes
- Added
databricks.sdk.service.agentbrickspackage. - Added
provisioning_phasefield fordatabricks.sdk.service.database.SyncedTablePipelineProgress. - Added
redshiftandsqldwenum values fordatabricks.sdk.service.pipelines.IngestionSourceType. - Added
germany_c5enum value fordatabricks.sdk.service.settings.ComplianceStandard. - Changed
asset_typeandnamefields fordatabricks.sdk.service.cleanrooms.CleanRoomAssetto be required. - [Breaking] Changed
asset_typeandnamefields fordatabricks.sdk.service.cleanrooms.CleanRoomAssetto be required. - [Breaking] Changed
local_namefield fordatabricks.sdk.service.cleanrooms.CleanRoomAssetForeignTableLocalDetailsto be required. - Changed
local_namefield fordatabricks.sdk.service.cleanrooms.CleanRoomAssetForeignTableLocalDetailsto be required. - Changed
notebook_contentfield fordatabricks.sdk.service.cleanrooms.CleanRoomAssetNotebookto be required. - [Breaking] Changed
notebook_contentfield fordatabricks.sdk.service.cleanrooms.CleanRoomAssetNotebookto be required. - Changed
local_namefield fordatabricks.sdk.service.cleanrooms.CleanRoomAssetTableLocalDetailsto be required. - [Breaking] Changed
local_namefield fordatabricks.sdk.service.cleanrooms.CleanRoomAssetTableLocalDetailsto be required. - [Breaking] Changed
local_namefield fordatabricks.sdk.service.cleanrooms.CleanRoomAssetViewLocalDetailsto be required. - Changed
local_namefield fordatabricks.sdk.service.cleanrooms.CleanRoomAssetViewLocalDetailsto be required. - [Breaking] Changed
local_namefield fordatabricks.sdk.service.cleanrooms.CleanRoomAssetVolumeLocalDetailsto be required. - Changed
local_namefield fordatabricks.sdk.service.cleanrooms.CleanRoomAssetVolumeLocalDetailsto be required. - [Breaking] Removed
databricks.sdk.service.aibuilderpackage.
Release v0.59.0 (2025-07-17)
API Changes
- Added w.service_principal_secrets_proxy workspace-level service.
- Added w.default_warehouse_id workspace-level service.
- Added
databasefield fordatabricks.sdk.service.apps.AppResource. - Added
environment_settingsfield fordatabricks.sdk.service.catalog.ConnectionInfo. - Added
environment_settingsfield fordatabricks.sdk.service.catalog.CreateConnection. - Added
environment_settingsfield fordatabricks.sdk.service.catalog.UpdateConnection. - Added
read_replica_countfield fordatabricks.sdk.service.ml.OnlineStore. - Added
page_sizefield fordatabricks.sdk.service.oauth2.ListServicePrincipalSecretsRequest. - Added
query_based_connector_configfield fordatabricks.sdk.service.pipelines.TableSpecificConfig. - Added
projected_remaining_task_total_time_ms,remaining_task_count,runnable_tasksandwork_to_be_donefields fordatabricks.sdk.service.sql.QueryMetrics. - Added
is_default_for_providerandnamefields fordatabricks.sdk.service.workspace.CreateCredentialsRequest. - Added
is_default_for_providerandnamefields fordatabricks.sdk.service.workspace.CreateCredentialsResponse. - Added
is_default_for_providerandnamefields fordatabricks.sdk.service.workspace.CredentialInfo. - Added
is_default_for_providerandnamefields fordatabricks.sdk.service.workspace.GetCredentialsResponse. - Added
is_default_for_providerandnamefields fordatabricks.sdk.service.workspace.UpdateCredentialsRequest. - Added
databricksenum value fordatabricks.sdk.service.catalog.SystemType. - Added
driver_dns_resolution_failureenum value fordatabricks.sdk.service.compute.TerminationReasonCode. - Added
confluenceandmeta_marketingenum values fordatabricks.sdk.service.pipelines.IngestionSourceType. - Added
delta_iceberg_tableenum value fordatabricks.sdk.service.sharing.TableInternalAttributesSharedTableType. - [Breaking] Changed
delete()method for w.table_constraints workspace-level service to start returningdatabricks.sdk.service.catalog.DeleteTableConstraintResponsedataclass. - [Breaking] Changed
service_principal_idfield fordatabricks.sdk.service.oauth2.CreateServicePrincipalSecretRequestto typestrdataclass. - [Breaking] Changed
service_principal_idfield fordatabricks.sdk.service.oauth2.DeleteServicePrincipalSecretRequestto typestrdataclass. - [Breaking] Changed
service_principal_idfield fordatabricks.sdk.service.oauth2.ListServicePrincipalSecretsRequestto typestrdataclass. - [Breaking] Changed
callsfield fordatabricks.sdk.service.serving.AiGatewayRateLimitto no longer be required. - Changed
callsfield fordatabricks.sdk.service.serving.AiGatewayRateLimitto no longer be required. - [Breaking] Removed
create()method for w.dashboards workspace-level service. - [Breaking] Removed
rangeandif_unmodified_sincefields fordatabricks.sdk.service.files.DownloadRequest. - [Breaking] Removed
rangeandif_unmodified_sincefields fordatabricks.sdk.service.files.GetMetadataRequest.
Release v0.58.0 (2025-07-09)
API Changes
- Added
remote_disk_throughputandtotal_initial_remote_disk_sizefields fordatabricks.sdk.service.compute.ClusterAttributes. - Added
remote_disk_throughputandtotal_initial_remote_disk_sizefields fordatabricks.sdk.service.compute.ClusterDetails. - Added
remote_disk_throughputandtotal_initial_remote_disk_sizefields fordatabricks.sdk.service.compute.ClusterSpec. - Added
remote_disk_throughputandtotal_initial_remote_disk_sizefields fordatabricks.sdk.service.compute.CreateCluster. - Added
remote_disk_throughputandtotal_initial_remote_disk_sizefields fordatabricks.sdk.service.compute.CreateInstancePool. - Added
remote_disk_throughputandtotal_initial_remote_disk_sizefields fordatabricks.sdk.service.compute.EditCluster. - Added
remote_disk_throughputandtotal_initial_remote_disk_sizefields fordatabricks.sdk.service.compute.EditInstancePool. - Added
remote_disk_throughputandtotal_initial_remote_disk_sizefields fordatabricks.sdk.service.compute.GetInstancePool. - Added
remote_disk_throughputandtotal_initial_remote_disk_sizefields fordatabricks.sdk.service.compute.InstancePoolAndStats. - Added
remote_disk_throughputandtotal_initial_remote_disk_sizefields fordatabricks.sdk.service.compute.UpdateClusterResource. - Added
renum value fordatabricks.sdk.service.compute.Language. - Added
continuousandcontinuous_restartenum values fordatabricks.sdk.service.jobs.TriggerType. - Added w.external_lineage workspace-level service and w.external_metadata workspace-level service.
- Added w.materialized_features workspace-level service.
- Added
delete_conversation(),list_conversations()andtrash_space()methods for w.genie workspace-level service. - Added
create_database_instance_role(),delete_database_instance_role(),get_database_instance_role()andlist_database_instance_roles()methods for w.database workspace-level service. - Added
connectionandcredentialfields fordatabricks.sdk.service.catalog.Dependency. - Added
relyfield fordatabricks.sdk.service.catalog.ForeignKeyConstraint. - Added
relyfield fordatabricks.sdk.service.catalog.PrimaryKeyConstraint. - Added
securable_kind_manifestfield fordatabricks.sdk.service.catalog.TableInfo. - Added
securable_kind_manifestfield fordatabricks.sdk.service.catalog.TableSummary. - Added
child_instance_refs,effective_enable_readable_secondaries,effective_node_count,effective_retention_window_in_days,enable_readable_secondaries,node_count,parent_instance_ref,read_only_dnsandretention_window_in_daysfields fordatabricks.sdk.service.database.DatabaseInstance. - Added
claimsfield fordatabricks.sdk.service.database.GenerateDatabaseCredentialRequest. - Added
last_syncfield fordatabricks.sdk.service.database.SyncedTableStatus. - Added
activityfield fordatabricks.sdk.service.ml.DeleteTransitionRequestResponse. - Added
max_resultsfield fordatabricks.sdk.service.ml.ListWebhooksRequest. - Added
bodyandstatus_codefields fordatabricks.sdk.service.ml.TestRegistryWebhookResponse. - Added
model_version_databricksfield fordatabricks.sdk.service.ml.TransitionStageResponse. - Added
registered_modelfield fordatabricks.sdk.service.ml.UpdateModelResponse. - Added
model_versionfield fordatabricks.sdk.service.ml.UpdateModelVersionResponse. - Added
webhookfield fordatabricks.sdk.service.ml.UpdateWebhookResponse. - Added
run_asfield fordatabricks.sdk.service.pipelines.GetPipelineResponse. - Added
principalfield fordatabricks.sdk.service.serving.AiGatewayRateLimit. - Added
descriptionfield fordatabricks.sdk.service.serving.CreateServingEndpoint. - Added
served_entity_namefield fordatabricks.sdk.service.serving.Route. - Added
any_static_credentialenum value fordatabricks.sdk.service.catalog.CredentialType. - Added
databricks_row_store_format,delta_uniform_hudi,delta_uniform_iceberg,hive,iceberg,mongodb_format,oracle_format,salesforce_data_cloud_formatandteradata_formatenum values fordatabricks.sdk.service.catalog.DataSourceFormat. - Added
metric_viewenum value fordatabricks.sdk.service.catalog.TableType. - Added
security_agents_failed_initial_verificationenum value fordatabricks.sdk.service.compute.TerminationReasonCode. - Added
can_create_registered_modelenum value fordatabricks.sdk.service.ml.PermissionLevel. - Added
bigqueryenum value fordatabricks.sdk.service.pipelines.IngestionSourceType. - Added
append_onlyenum value fordatabricks.sdk.service.pipelines.TableSpecificConfigScdType. - Added
service_principalanduser_groupenum values fordatabricks.sdk.service.serving.AiGatewayRateLimitKey. - [Breaking] Changed
cancel_optimize()anddelete_custom_llm()methods for w.ai_builder workspace-level service to returnanydataclass. - [Breaking] Changed
delete()method for a.budget_policy account-level service to returnanydataclass. - [Breaking] Changed
delete()method for w.online_tables workspace-level service to returnanydataclass. - [Breaking] Changed
delete()method for w.clean_rooms workspace-level service to returnanydataclass. - [Breaking] Changed
delete_schedule()anddelete_subscription()methods for w.lakeview workspace-level service to returnanydataclass. - [Breaking] Changed
delete_database_catalog(),delete_database_instance(),delete_database_table()anddelete_synced_database_table()methods for w.database workspace-level service to returnanydataclass. - [Breaking] Changed
delete_online_store()method for w.feature_store workspace-level service to returnanydataclass. - [Breaking] Changed
delete_transition_request(),update_model(),update_model_version()andupdate_webhook()methods for w.model_registry workspace-level service return type to become non-empty. - [Breaking] Changed
delete_webhook()method for w.model_registry workspace-level service with new required argument order. - [Breaking] Changed
delete()method for a.account_federation_policy account-level service to returnanydataclass. - [Breaking] Changed
delete()method for a.service_principal_federation_policy account-level service to returnanydataclass. - [Breaking] Changed
delete_quality_monitor()method for w.quality_monitor_v2 workspace-level service to returnanydataclass. - [Breaking] Changed
delete_network_connectivity_configuration()method for a.network_connectivity account-level service to returnanydataclass. - [Breaking] Changed
delete_network_policy_rpc()method for a.network_policies account-level service to returnanydataclass. - [Breaking] Changed
delete()method for w.recipient_federation_policies workspace-level service to returnanydataclass. - [Breaking] Changed
list()method for w.alerts_legacy workspace-level service . New request type isanydataclass. - [Breaking] Changed
update()method for w.dashboard_widgets workspace-level service . New request type isdatabricks.sdk.service.sql.UpdateWidgetRequestdataclass. - [Breaking] Changed
list()method for w.data_sources workspace-level service . New request type isanydataclass. - [Breaking] Changed
create()method for w.query_visualizations_legacy workspace-level service with new required argument order. - [Breaking] Changed
from_stageandto_stagefields fordatabricks.sdk.service.ml.Activityto typestrdataclass. - [Breaking] Changed
stagefield fordatabricks.sdk.service.ml.ApproveTransitionRequestto typestrdataclass. - [Breaking] Changed
stagefield fordatabricks.sdk.service.ml.CreateTransitionRequestto typestrdataclass. - [Breaking] Changed
stagefield fordatabricks.sdk.service.ml.DeleteTransitionRequestRequestto typestrdataclass. - [Breaking] Changed
idfield fordatabricks.sdk.service.ml.DeleteWebhookRequestto be required. - [Breaking] Changed
capacityfield fordatabricks.sdk.service.ml.OnlineStoreto be required. - Changed
capacityfield fordatabricks.sdk.service.ml.OnlineStoreto be required. - [Breaking] Changed
online_table_namefield fordatabricks.sdk.service.ml.PublishSpecto be required. - [Breaking] Changed
stagefield fordatabricks.sdk.service.ml.RejectTransitionRequestto typestrdataclass. - [Breaking] Changed
stagefield fordatabricks.sdk.service.ml.TransitionModelVersionStageDatabricksto typestrdataclass. - [Breaking] Changed
to_stagefield fordatabricks.sdk.service.ml.TransitionRequestto typestrdataclass. - Changed
served_model_namefield fordatabricks.sdk.service.serving.Routeto no longer be required. - [Breaking] Changed
served_model_namefield fordatabricks.sdk.service.serving.Routeto no longer be required. - Changed pagination for TablesAPI.list method.
- Changed pagination for TablesAPI.list_summaries method.
- [Breaking] Removed
generate_download_full_query_result()andget_download_full_query_result()methods for w.genie workspace-level service. - [Breaking] Removed
include_delta_metadatafield fordatabricks.sdk.service.catalog.ListTablesRequest. - [Breaking] Removed
webhookfield fordatabricks.sdk.service.ml.TestRegistryWebhookResponse. - [Breaking] Removed
model_versionfield fordatabricks.sdk.service.ml.TransitionStageResponse. - [Breaking] Removed
unknown_catalog_typeenum value fordatabricks.sdk.service.catalog.CatalogType. - [Breaking] Removed
hive_customandhive_serdeenum values fordatabricks.sdk.service.catalog.DataSourceFormat. - [Breaking] Removed
unknown_securable_typeenum value fordatabricks.sdk.service.catalog.SecurableType. - [Breaking] Removed
archived,none,productionandstagingenum values fordatabricks.sdk.service.ml.DeleteTransitionRequestStage. - [Breaking] Removed
archived,none,productionandstagingenum values fordatabricks.sdk.service.ml.Stage.
Release v0.57.0 (2025-06-12)
API Changes
- Added w.ai_builder workspace-level service.
- Added w.feature_store workspace-level service.
- Added
expiration_timefield fordatabricks.sdk.service.database.DatabaseCredential. - Added
effective_stoppedfield fordatabricks.sdk.service.database.DatabaseInstance. - Added
existing_pipeline_idfield fordatabricks.sdk.service.database.SyncedTableSpec. - Added
pipeline_idfield fordatabricks.sdk.service.database.SyncedTableStatus. - Added
dbt_platform_outputfield fordatabricks.sdk.service.jobs.RunOutput. - Added
dbt_platform_taskfield fordatabricks.sdk.service.jobs.RunTask. - Added
dbt_platform_taskfield fordatabricks.sdk.service.jobs.SubmitTask. - Added
dbt_platform_taskfield fordatabricks.sdk.service.jobs.Task. - Added
environmentfield fordatabricks.sdk.service.pipelines.CreatePipeline. - Added
environmentfield fordatabricks.sdk.service.pipelines.EditPipeline. - Added
environmentfield fordatabricks.sdk.service.pipelines.PipelineSpec. - Added
descriptionfield fordatabricks.sdk.service.serving.ServingEndpoint. - Added
descriptionfield fordatabricks.sdk.service.serving.ServingEndpointDetailed. - Added
cancelled,error,queued,running,startingandsuccessenum values fordatabricks.sdk.service.jobs.DbtPlatformRunStatus. - [Breaking] Changed
statusfield fordatabricks.sdk.service.jobs.DbtCloudJobRunStepto typedatabricks.sdk.service.jobs.DbtPlatformRunStatusdataclass. - [Breaking] Removed w.custom_llms workspace-level service.
- [Breaking] Removed
table_serving_urlfield fordatabricks.sdk.service.database.DatabaseTable. - [Breaking] Removed
table_serving_urlfield fordatabricks.sdk.service.database.SyncedDatabaseTable. - [Breaking] Removed
pipeline_idfield fordatabricks.sdk.service.database.SyncedTableSpec. - [Breaking] Removed
cancelled,error,queued,running,startingandsuccessenum values fordatabricks.sdk.service.jobs.DbtCloudRunStatus.
Release v0.56.0 (2025-06-05)
API Changes
- Added
databricks.sdk.service.aibuilder,databricks.sdk.service.databaseanddatabricks.sdk.service.qualitymonitorv2packages. - Added w.custom_llms workspace-level service.
- Added w.dashboard_email_subscriptions workspace-level service and w.sql_results_download workspace-level service.
- Added w.database workspace-level service.
- Added w.quality_monitor_v2 workspace-level service.
- Added
update_private_endpoint_rule()method for a.network_connectivity account-level service. - Added
list_spaces()method for w.genie workspace-level service. - Added
page_tokenfield fordatabricks.sdk.service.billing.ListLogDeliveryRequest. - Added
next_page_tokenfield fordatabricks.sdk.service.billing.WrappedLogDeliveryConfigurations. - Added
next_page_tokenfield fordatabricks.sdk.service.catalog.EffectivePermissionsList. - Added
max_resultsandpage_tokenfields fordatabricks.sdk.service.catalog.GetEffectiveRequest. - Added
max_resultsandpage_tokenfields fordatabricks.sdk.service.catalog.GetGrantRequest. - Added
next_page_tokenfield fordatabricks.sdk.service.catalog.ListMetastoresResponse. - Added
clean_room_namefield fordatabricks.sdk.service.cleanrooms.CleanRoomAsset. - [Breaking] Added
namefield fordatabricks.sdk.service.cleanrooms.DeleteCleanRoomAssetRequest. - [Breaking] Added
namefield fordatabricks.sdk.service.cleanrooms.GetCleanRoomAssetRequest. - Added
trigger_statefield fordatabricks.sdk.service.jobs.BaseJob. - Added
trigger_statefield fordatabricks.sdk.service.jobs.Job. - Added
dbt_cloud_outputfield fordatabricks.sdk.service.jobs.RunOutput. - Added
dbt_cloud_taskfield fordatabricks.sdk.service.jobs.RunTask. - Added
dbt_cloud_taskfield fordatabricks.sdk.service.jobs.SubmitTask. - Added
dbt_cloud_taskfield fordatabricks.sdk.service.jobs.Task. - Added
tagsfield fordatabricks.sdk.service.pipelines.CreatePipeline. - Added
tagsfield fordatabricks.sdk.service.pipelines.EditPipeline. - Added
tagsfield fordatabricks.sdk.service.pipelines.PipelineSpec. - Added
max_provisioned_concurrencyandmin_provisioned_concurrencyfields fordatabricks.sdk.service.serving.ServedEntityInput. - Added
max_provisioned_concurrencyandmin_provisioned_concurrencyfields fordatabricks.sdk.service.serving.ServedEntityOutput. - Added
max_provisioned_concurrencyandmin_provisioned_concurrencyfields fordatabricks.sdk.service.serving.ServedModelInput. - Added
max_provisioned_concurrencyandmin_provisioned_concurrencyfields fordatabricks.sdk.service.serving.ServedModelOutput. - Added
endpoint_serviceandresource_namesfields fordatabricks.sdk.service.settings.CreatePrivateEndpointRule. - Added
aws_private_endpoint_rulesfield fordatabricks.sdk.service.settings.NccEgressTargetRules. - Added
task_time_over_time_rangefield fordatabricks.sdk.service.sql.QueryMetrics. - Added
deltasharing_catalog,foreign_catalog,internal_catalog,managed_catalog,managed_online_catalog,system_catalogandunknown_catalog_typeenum values fordatabricks.sdk.service.catalog.CatalogType. - Added
ga4_raw_data,power_bi,salesforce,salesforce_data_cloud,servicenow,unknown_connection_typeandworkday_raasenum values fordatabricks.sdk.service.catalog.ConnectionType. - Added
oauth_access_token,oauth_m2m,oauth_refresh_token,oauth_resource_owner_password,oauth_u2m,oauth_u2m_mapping,oidc_token,pem_private_key,service_credentialandunknown_credential_typeenum values fordatabricks.sdk.service.catalog.CredentialType. - Added
internalandinternal_and_externalenum values fordatabricks.sdk.service.catalog.DeltaSharingScopeEnum. - Added
catalog,clean_room,connection,credential,external_location,external_metadata,function,metastore,pipeline,provider,recipient,schema,share,staging_table,storage_credential,table,unknown_securable_typeandvolumeenum values fordatabricks.sdk.service.catalog.SecurableType. - Added
cluster_migratedenum value fordatabricks.sdk.service.compute.EventType. - Added
driver_unhealthyenum value fordatabricks.sdk.service.compute.TerminationReasonCode. - Added
teradataenum value fordatabricks.sdk.service.pipelines.IngestionSourceType. - Added
oidc_federationenum value fordatabricks.sdk.service.sharing.AuthenticationType. - [Breaking] Changed
create()method for a.log_delivery account-level service with new required argument order. - [Breaking] Changed
get()method for a.log_delivery account-level service to returndatabricks.sdk.service.billing.GetLogDeliveryConfigurationResponsedataclass. - [Breaking] Changed
create_private_endpoint_rule(),delete_private_endpoint_rule()andget_private_endpoint_rule()methods for a.network_connectivity account-level service to returndatabricks.sdk.service.settings.NccPrivateEndpointRuledataclass. - [Breaking] Changed
list_private_endpoint_rules()method for a.network_connectivity account-level service to returndatabricks.sdk.service.settings.ListPrivateEndpointRulesResponsedataclass. - [Breaking] Changed
delete()andget()methods for w.clean_room_assets workspace-level service . Method path has changed. - [Breaking] Changed
delete()andget()methods for w.clean_room_assets workspace-level service with new required argument order. - [Breaking] Changed
get()method for w.grants workspace-level service to returndatabricks.sdk.service.catalog.GetPermissionsResponsedataclass. - [Breaking] Changed
update()method for w.grants workspace-level service to returndatabricks.sdk.service.catalog.UpdatePermissionsResponsedataclass. - [Breaking] Changed
list()method for w.metastores workspace-level service to require request ofdatabricks.sdk.service.catalog.ListMetastoresRequestdataclass. - Changed
account_id,credentials_id,log_type,output_formatandstorage_configuration_idfields fordatabricks.sdk.service.billing.LogDeliveryConfigurationto be required. - Changed
messageandstatusfields fordatabricks.sdk.service.billing.LogDeliveryStatusto be required. - [Breaking] Changed
log_delivery_configurationfield fordatabricks.sdk.service.billing.WrappedCreateLogDeliveryConfigurationto be required. - [Breaking] Changed
securable_typefield fordatabricks.sdk.service.catalog.ConnectionInfoto typedatabricks.sdk.service.catalog.SecurableTypedataclass. - [Breaking] Changed
securable_typefield fordatabricks.sdk.service.catalog.GetEffectiveRequestto typestrdataclass. - [Breaking] Changed
securable_typefield fordatabricks.sdk.service.catalog.GetGrantRequestto typestrdataclass. - [Breaking] Changed
delta_sharing_scopefield fordatabricks.sdk.service.catalog.GetMetastoreSummaryResponseto typedatabricks.sdk.service.catalog.DeltaSharingScopeEnumdataclass. - [Breaking] Changed
delta_sharing_scopefield fordatabricks.sdk.service.catalog.MetastoreInfoto typedatabricks.sdk.service.catalog.DeltaSharingScopeEnumdataclass. - [Breaking] Changed
catalog_typefield fordatabricks.sdk.service.catalog.SchemaInfoto typedatabricks.sdk.service.catalog.CatalogTypedataclass. - [Breaking] Changed
delta_sharing_scopefield fordatabricks.sdk.service.catalog.UpdateMetastoreto typedatabricks.sdk.service.catalog.DeltaSharingScopeEnumdataclass. - [Breaking] Changed
securable_typefield fordatabricks.sdk.service.catalog.UpdatePermissionsto typestrdataclass. - Changed
resource_idfield fordatabricks.sdk.service.settings.CreatePrivateEndpointRuleto no longer be required. - [Breaking] Changed pagination for NetworkConnectivityAPI.list_private_endpoint_rules method.
- [Breaking] Removed w.database_instances workspace-level service.
- [Breaking] Removed w.query_execution workspace-level service.
- [Breaking] Removed
update_ncc_azure_private_endpoint_rule_public()method for a.network_connectivity account-level service. - [Breaking] Removed
get_credentials_for_trace_data_download(),get_credentials_for_trace_data_upload()andlist_logged_model_artifacts()methods for w.experiments workspace-level service. - [Breaking] Removed
get_published_dashboard_embedded()method for w.lakeview_embedded workspace-level service. - [Breaking] Removed
asset_full_namefield fordatabricks.sdk.service.cleanrooms.DeleteCleanRoomAssetRequest. - [Breaking] Removed
asset_full_namefield fordatabricks.sdk.service.cleanrooms.GetCleanRoomAssetRequest. - [Breaking] Removed
internalandinternal_and_externalenum values fordatabricks.sdk.service.catalog.GetMetastoreSummaryResponseDeltaSharingScope. - [Breaking] Removed
internalandinternal_and_externalenum values fordatabricks.sdk.service.catalog.MetastoreInfoDeltaSharingScope. - [Breaking] Removed
catalog,clean_room,connection,credential,external_location,external_metadata,function,metastore,pipeline,provider,recipient,schema,share,staging_table,storage_credential,table,unknown_securable_typeandvolumeenum values fordatabricks.sdk.service.catalog.SecurableType. - [Breaking] Removed
internalandinternal_and_externalenum values fordatabricks.sdk.service.catalog.UpdateMetastoreDeltaSharingScope.
Release v0.55.0 (2025-05-27)
New Features and Improvements
- Add support for OIDC ID token authentication from an environment variable (PR #977).
- Add support for OIDC ID token authentication from a file (PR #977).
Bug Fixes
- Fix a reported highlighting problem with the way API clients are imported in WorkspaceClient/AccountClient (#979).
Release v0.54.0 (2025-05-22)
API Changes
- Added a.llm_proxy_partner_powered_account account-level service, a.llm_proxy_partner_powered_enforce account-level service, w.llm_proxy_partner_powered_workspace workspace-level service, a.network_policies account-level service and a.workspace_network_configuration account-level service.
- Added w.database_instances workspace-level service.
- Added w.recipient_federation_policies workspace-level service.
- Added
create_logged_model(),delete_logged_model(),delete_logged_model_tag(),finalize_logged_model(),get_logged_model(),list_logged_model_artifacts(),log_logged_model_params(),log_outputs(),search_logged_models()andset_logged_model_tags()methods for w.experiments workspace-level service. - Added
create_provisioned_throughput_endpoint()andupdate_provisioned_throughput_endpoint_config()methods for w.serving_endpoints workspace-level service. - Added
uc_securablefield fordatabricks.sdk.service.apps.AppResource. - Added
enable_file_eventsandfile_event_queuefields fordatabricks.sdk.service.catalog.CreateExternalLocation. - Added
catalog_namefield fordatabricks.sdk.service.catalog.EnableRequest. - Added
enable_file_eventsandfile_event_queuefields fordatabricks.sdk.service.catalog.ExternalLocationInfo. - Added
timeseries_columnsfield fordatabricks.sdk.service.catalog.PrimaryKeyConstraint. - Added
enable_file_eventsandfile_event_queuefields fordatabricks.sdk.service.catalog.UpdateExternalLocation. - Added
review_state,reviewsandrunner_collaborator_aliasesfields fordatabricks.sdk.service.cleanrooms.CleanRoomAssetNotebook. - Added
notebook_etagandnotebook_updated_atfields fordatabricks.sdk.service.cleanrooms.CleanRoomNotebookTaskRun. - Added
policy_idandservice_principal_idfields fordatabricks.sdk.service.oauth2.FederationPolicy. - Added
root_pathfield fordatabricks.sdk.service.pipelines.CreatePipeline. - Added
root_pathfield fordatabricks.sdk.service.pipelines.EditPipeline. - Added
source_typefield fordatabricks.sdk.service.pipelines.IngestionPipelineDefinition. - Added
globfield fordatabricks.sdk.service.pipelines.PipelineLibrary. - Added
root_pathfield fordatabricks.sdk.service.pipelines.PipelineSpec. - Added
provisioned_model_unitsfield fordatabricks.sdk.service.serving.ServedEntityInput. - Added
provisioned_model_unitsfield fordatabricks.sdk.service.serving.ServedEntityOutput. - Added
provisioned_model_unitsfield fordatabricks.sdk.service.serving.ServedModelInput. - Added
provisioned_model_unitsfield fordatabricks.sdk.service.serving.ServedModelOutput. - Added
materialization_namespacefield fordatabricks.sdk.service.sharing.Table. - Added
omit_permissions_listfield fordatabricks.sdk.service.sharing.UpdateSharePermissions. - Added
auto_resolve_display_namefield fordatabricks.sdk.service.sql.UpdateAlertRequest. - Added
auto_resolve_display_namefield fordatabricks.sdk.service.sql.UpdateQueryRequest. - Added
internal_catalog,managed_online_catalogandunknown_catalog_typeenum values fordatabricks.sdk.service.catalog.CatalogType. - Added
catalog,clean_room,connection,credential,external_location,external_metadata,function,metastore,pipeline,provider,recipient,schema,share,staging_table,storage_credential,table,unknown_securable_typeandvolumeenum values fordatabricks.sdk.service.catalog.SecurableType. - Added
describe_query_invalid_sql_error,describe_query_timeout,describe_query_unexpected_failure,invalid_chat_completion_arguments_json_exception,invalid_sql_multiple_dataset_references_exception,invalid_sql_multiple_statements_exceptionandinvalid_sql_unknown_table_exceptionenum values fordatabricks.sdk.service.dashboards.MessageErrorType. - Added
can_createandcan_monitor_onlyenum values fordatabricks.sdk.service.iam.PermissionLevel. - Added
success_with_failuresenum value fordatabricks.sdk.service.jobs.TerminationCodeCode. - Added
infrastructure_maintenanceenum value fordatabricks.sdk.service.pipelines.StartUpdateCause. - Added
infrastructure_maintenanceenum value fordatabricks.sdk.service.pipelines.UpdateInfoCause. - [Breaking] Changed
create_alert()andupdate_alert()methods for w.alerts_v2 workspace-level service with new required argument order. - [Breaking] Changed
set()method for w.permissions workspace-level service . New request type isdatabricks.sdk.service.iam.SetObjectPermissionsdataclass. - [Breaking] Changed
update()method for w.permissions workspace-level service . New request type isdatabricks.sdk.service.iam.UpdateObjectPermissionsdataclass. - [Breaking] Changed
get()method for w.workspace_bindings workspace-level service to returndatabricks.sdk.service.catalog.GetCatalogWorkspaceBindingsResponsedataclass. - [Breaking] Changed
get_bindings()method for w.workspace_bindings workspace-level service to returndatabricks.sdk.service.catalog.GetWorkspaceBindingsResponsedataclass. - [Breaking] Changed
update()method for w.workspace_bindings workspace-level service to returndatabricks.sdk.service.catalog.UpdateCatalogWorkspaceBindingsResponsedataclass. - [Breaking] Changed
update_bindings()method for w.workspace_bindings workspace-level service to returndatabricks.sdk.service.catalog.UpdateWorkspaceBindingsResponsedataclass. - [Breaking] Changed
securable_typefield fordatabricks.sdk.service.catalog.CatalogInfoto typedatabricks.sdk.service.catalog.SecurableTypedataclass. - [Breaking] Changed
securable_typefield fordatabricks.sdk.service.catalog.GetBindingsRequestto typestrdataclass. - Changed
schemaandstatefields fordatabricks.sdk.service.catalog.SystemSchemaInfoto be required. - [Breaking] Changed
statefield fordatabricks.sdk.service.catalog.SystemSchemaInfoto typestrdataclass. - [Breaking] Changed
securable_typefield fordatabricks.sdk.service.catalog.UpdateWorkspaceBindingsParametersto typestrdataclass. - [Breaking] Changed
workspace_idfield fordatabricks.sdk.service.catalog.WorkspaceBindingto be required. - Changed
etagandnamefields fordatabricks.sdk.service.iam.RuleSetResponseto be required. - Changed
gpu_node_pool_idfield fordatabricks.sdk.service.jobs.ComputeConfigto no longer be required. - [Breaking] Changed
gpu_node_pool_idfield fordatabricks.sdk.service.jobs.ComputeConfigto no longer be required. - [Breaking] Changed
alertfield fordatabricks.sdk.service.sql.CreateAlertV2Requestto be required. - [Breaking] Changed
alertfield fordatabricks.sdk.service.sql.UpdateAlertV2Requestto be required. - [Breaking] Removed
access_pointfield fordatabricks.sdk.service.catalog.CreateExternalLocation. - [Breaking] Removed
access_pointfield fordatabricks.sdk.service.catalog.ExternalLocationInfo. - [Breaking] Removed
access_pointfield fordatabricks.sdk.service.catalog.UpdateExternalLocation. - [Breaking] Removed
node_type_flexibilityfield fordatabricks.sdk.service.compute.EditInstancePool. - [Breaking] Removed
node_type_flexibilityfield fordatabricks.sdk.service.compute.GetInstancePool. - [Breaking] Removed
node_type_flexibilityfield fordatabricks.sdk.service.compute.InstancePoolAndStats. - [Breaking] Removed
catalog,credential,external_locationandstorage_credentialenum values fordatabricks.sdk.service.catalog.GetBindingsSecurableType. - [Breaking] Removed
available,disable_initialized,enable_completed,enable_initializedandunavailableenum values fordatabricks.sdk.service.catalog.SystemSchemaInfoState. - [Breaking] Removed
catalog,credential,external_locationandstorage_credentialenum values fordatabricks.sdk.service.catalog.UpdateBindingsSecurableType.
Release v0.53.0 (2025-05-02)
Bug Fixes
- Fixed the deserialization of responses in VectorSearchAPI's
query_index()method (#961).
Release v0.52.0 (2025-05-02)
API Changes
- Added
future_feature_data_pathfield fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - Added
exclude_columnsandinclude_columnsfields fordatabricks.sdk.service.pipelines.TableSpecificConfig. - Added
network_check_control_plane_failure,network_check_dns_server_failure,network_check_metadata_endpoint_failure,network_check_multiple_components_failure,network_check_nic_failure,network_check_storage_failureandsecret_permission_deniedenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - [Breaking] Changed
pipeline_idfield fordatabricks.sdk.service.pipelines.EditPipelineto be required. - Changed
connection_name,gateway_storage_catalogandgateway_storage_schemafields fordatabricks.sdk.service.pipelines.IngestionGatewayPipelineDefinitionto be required. - [Breaking] Changed
connection_name,gateway_storage_catalogandgateway_storage_schemafields fordatabricks.sdk.service.pipelines.IngestionGatewayPipelineDefinitionto be required. - Changed
kindfield fordatabricks.sdk.service.pipelines.PipelineDeploymentto be required. - [Breaking] Changed
kindfield fordatabricks.sdk.service.pipelines.PipelineDeploymentto be required. - Changed
destination_catalog,destination_schemaandsource_urlfields fordatabricks.sdk.service.pipelines.ReportSpecto be required. - [Breaking] Changed
destination_catalog,destination_schemaandsource_urlfields fordatabricks.sdk.service.pipelines.ReportSpecto be required. - Changed
destination_catalog,destination_schemaandsource_schemafields fordatabricks.sdk.service.pipelines.SchemaSpecto be required. - [Breaking] Changed
destination_catalog,destination_schemaandsource_schemafields fordatabricks.sdk.service.pipelines.SchemaSpecto be required. - [Breaking] Changed
destination_catalog,destination_schemaandsource_tablefields fordatabricks.sdk.service.pipelines.TableSpecto be required. - Changed
destination_catalog,destination_schemaandsource_tablefields fordatabricks.sdk.service.pipelines.TableSpecto be required. - [Breaking] Changed
resultsfield fordatabricks.sdk.service.sql.ListAlertsV2Responseto typedatabricks.sdk.service.sql.AlertV2Listdataclass. - [Breaking] Changed pagination for AlertsV2API.list_alerts method.
- Fixed waiter for GenieAPI.create_message method.
Release v0.51.0 (2025-04-30)
New Features and Improvements
- Enabled asynchronous token refreshes by default. A new
disable_async_token_refreshconfiguration option has been added to allow disabling this feature if necessary (#952). To disable asynchronous token refresh, set the environment variableDATABRICKS_DISABLE_ASYNC_TOKEN_REFRESH=trueor configure it within your configuration object. The previousenable_experimental_async_token_refreshoption has been removed as asynchronous refresh is now the default behavior. - Introduce support for Databricks Workload Identity Federation in GitHub workflows (933). See README.md for instructions.
- [Breaking] Users running their workflows in GitHub Actions, which use Cloud native authentication and also have a
DATABRICKS_CLIENT_IDandDATABRICKS_HOSTenvironment variables set may see their authentication start failing due to the order in which the SDK tries different authentication methods.
API Changes
- Added w.alerts_v2 workspace-level service.
- Added
update_ncc_azure_private_endpoint_rule_public()method for a.network_connectivity account-level service. - Added
update_endpoint_budget_policy()andupdate_endpoint_custom_tags()methods for w.vector_search_endpoints workspace-level service. - Added
created_at,created_byandmetastore_idfields fordatabricks.sdk.service.catalog.SetArtifactAllowlist. - Added
node_type_flexibilityfield fordatabricks.sdk.service.compute.EditInstancePool. - Added
page_sizeandpage_tokenfields fordatabricks.sdk.service.compute.GetEvents. - Added
next_page_tokenandprev_page_tokenfields fordatabricks.sdk.service.compute.GetEventsResponse. - Added
node_type_flexibilityfield fordatabricks.sdk.service.compute.GetInstancePool. - Added
node_type_flexibilityfield fordatabricks.sdk.service.compute.InstancePoolAndStats. - Added
effective_performance_targetfield fordatabricks.sdk.service.jobs.RepairHistoryItem. - Added
performance_targetfield fordatabricks.sdk.service.jobs.RepairRun. - [Breaking] Added
network_connectivity_configfield fordatabricks.sdk.service.settings.CreateNetworkConnectivityConfigRequest. - [Breaking] Added
private_endpoint_rulefield fordatabricks.sdk.service.settings.CreatePrivateEndpointRuleRequest. - Added
domain_namesfield fordatabricks.sdk.service.settings.NccAzurePrivateEndpointRule. - Added
auto_resolve_display_namefield fordatabricks.sdk.service.sql.CreateAlertRequest. - Added
auto_resolve_display_namefield fordatabricks.sdk.service.sql.CreateQueryRequest. - Added
budget_policy_idfield fordatabricks.sdk.service.vectorsearch.CreateEndpoint. - Added
custom_tagsandeffective_budget_policy_idfields fordatabricks.sdk.service.vectorsearch.EndpointInfo. - Added
create_clean_room,execute_clean_room_taskandmodify_clean_roomenum values fordatabricks.sdk.service.catalog.Privilege. - Added
dns_resolution_errorandgcp_denied_by_org_policyenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - Added
disabledenum value fordatabricks.sdk.service.jobs.TerminationCodeCode. - Added
expiredenum value fordatabricks.sdk.service.settings.NccAzurePrivateEndpointRuleConnectionState. - [Breaking] Changed
create_network_connectivity_configuration()andcreate_private_endpoint_rule()methods for a.network_connectivity account-level service with new required argument order. - [Breaking] Changed
create_index()method for w.vector_search_indexes workspace-level service to returndatabricks.sdk.service.vectorsearch.VectorIndexdataclass. - [Breaking] Changed
delete_data_vector_index()method for w.vector_search_indexes workspace-level service . HTTP method/verb has changed. - [Breaking] Changed
delete_data_vector_index()method for w.vector_search_indexes workspace-level service with new required argument order. - [Breaking] Changed
databricks.sdk.service.vectorsearch.Listdataclass to. - [Breaking] Changed
workload_sizefield fordatabricks.sdk.service.serving.ServedModelInputto typestrdataclass. - [Breaking] Changed
group_idfield fordatabricks.sdk.service.settings.NccAzurePrivateEndpointRuleto typestrdataclass. - [Breaking] Changed
target_servicesfield fordatabricks.sdk.service.settings.NccAzureServiceEndpointRuleto typedatabricks.sdk.service.settings.EgressResourceTypeListdataclass. - [Breaking] Changed
data_arrayfield fordatabricks.sdk.service.vectorsearch.ResultDatato typedatabricks.sdk.service.vectorsearch.ListValueListdataclass. - [Breaking] Changed waiter for VectorSearchEndpointsAPI.create_endpoint method.
- [Breaking] Removed
nameandregionfields fordatabricks.sdk.service.settings.CreateNetworkConnectivityConfigRequest. - [Breaking] Removed
group_idandresource_idfields fordatabricks.sdk.service.settings.CreatePrivateEndpointRuleRequest. - [Breaking] Removed
null_valuefield fordatabricks.sdk.service.vectorsearch.Value. - [Breaking] Removed
large,mediumandsmallenum values fordatabricks.sdk.service.serving.ServedModelInputWorkloadSize. - [Breaking] Removed
blob,dfs,mysql_serverandsql_serverenum values fordatabricks.sdk.service.settings.NccAzurePrivateEndpointRuleGroupId.
Release v0.50.0 (2025-04-14)
API Changes
- Added w.enable_export_notebook workspace-level service, w.enable_notebook_table_clipboard workspace-level service and w.enable_results_downloading workspace-level service.
- Added
get_credentials_for_trace_data_download()andget_credentials_for_trace_data_upload()methods for w.experiments workspace-level service. - Added
get_download_full_query_result()method for w.genie workspace-level service. - Added
get_published_dashboard_token_info()method for w.lakeview_embedded workspace-level service. - Added
binding_workspace_idsfield fordatabricks.sdk.service.billing.BudgetPolicy. - Added
download_idfield fordatabricks.sdk.service.dashboards.GenieGenerateDownloadFullQueryResultResponse. - Added
dashboard_outputfield fordatabricks.sdk.service.jobs.RunOutput. - Added
dashboard_taskandpower_bi_taskfields fordatabricks.sdk.service.jobs.RunTask. - Added
dashboard_taskandpower_bi_taskfields fordatabricks.sdk.service.jobs.SubmitTask. - Added
dashboard_taskandpower_bi_taskfields fordatabricks.sdk.service.jobs.Task. - Added
include_featuresfield fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - Added
modelsfield fordatabricks.sdk.service.ml.LogInputs. - Added
dataset_digest,dataset_nameandmodel_idfields fordatabricks.sdk.service.ml.LogMetric. - Added
dataset_digest,dataset_name,model_idandrun_idfields fordatabricks.sdk.service.ml.Metric. - Added
model_inputsfield fordatabricks.sdk.service.ml.RunInputs. - Added
client_applicationfield fordatabricks.sdk.service.sql.QueryInfo. - Added
geographyandgeometryenum values fordatabricks.sdk.service.catalog.ColumnTypeName. - Added
allocation_timeout_no_healthy_and_warmed_up_clusters,docker_container_creation_exception,docker_image_too_large_for_instance_exceptionanddocker_invalid_os_exceptionenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - Added
standardenum value fordatabricks.sdk.service.jobs.PerformanceTarget. - Added
can_viewenum value fordatabricks.sdk.service.sql.WarehousePermissionLevel. - [Breaking] Changed
generate_download_full_query_result()method for w.genie workspace-level service . Method path has changed. - [Breaking] Changed waiter for CommandExecutionAPI.create method.
- [Breaking] Changed waiter for CommandExecutionAPI.execute method.
- [Breaking] Removed
error,statusandtransient_statement_idfields fordatabricks.sdk.service.dashboards.GenieGenerateDownloadFullQueryResultResponse. - [Breaking] Removed
balancedandcost_optimizedenum values fordatabricks.sdk.service.jobs.PerformanceTarget. - [Breaking] Removed PipelinesAPI.wait_get_pipeline_running method.
Release v0.49.0 (2025-03-28)
API Changes
- Added
generate_download_full_query_result()method for w.genie workspace-level service. - Added
effective_user_api_scopes,oauth2_app_client_id,oauth2_app_integration_idanduser_api_scopesfields fordatabricks.sdk.service.apps.App. - Added
abfss,dbfs,error_message,execution_duration_seconds,file,gcs,s3,status,volumesandworkspacefields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails. - [Breaking] Added
forecast_granularityfield fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - Added
jwks_urifield fordatabricks.sdk.service.oauth2.OidcFederationPolicy. - Added
event_logfield fordatabricks.sdk.service.pipelines.CreatePipeline. - Added
event_logfield fordatabricks.sdk.service.pipelines.EditPipeline. - Added
event_logfield fordatabricks.sdk.service.pipelines.PipelineSpec. - Added
fallback_configfield fordatabricks.sdk.service.serving.AiGatewayConfig. - Added
custom_provider_configfield fordatabricks.sdk.service.serving.ExternalModel. - Added
fallback_configfield fordatabricks.sdk.service.serving.PutAiGatewayRequest. - Added
fallback_configfield fordatabricks.sdk.service.serving.PutAiGatewayResponse. - Added
aliases,comment,data_type,dependency_list,full_data_type,id,input_params,name,properties,routine_definition,schema,securable_kind,share,share_id,storage_locationandtagsfields fordatabricks.sdk.service.sharing.DeltaSharingFunction. - Added
query_sourcefield fordatabricks.sdk.service.sql.QueryInfo. - Added
foreign_catalogenum value fordatabricks.sdk.service.catalog.CatalogType. - Added
browseenum value fordatabricks.sdk.service.catalog.Privilege. - Added
access_token_failure,allocation_timeout,allocation_timeout_node_daemon_not_ready,allocation_timeout_no_healthy_clusters,allocation_timeout_no_matched_clusters,allocation_timeout_no_ready_clusters,allocation_timeout_no_unallocated_clusters,allocation_timeout_no_warmed_up_clusters,aws_inaccessible_kms_key_failure,aws_instance_profile_update_failure,aws_invalid_key_pair,aws_invalid_kms_key_state,aws_resource_quota_exceeded,azure_packed_deployment_partial_failure,bootstrap_timeout_due_to_misconfig,budget_policy_limit_enforcement_activated,budget_policy_resolution_failure,cloud_account_setup_failure,cloud_operation_cancelled,cloud_provider_instance_not_launched,cloud_provider_launch_failure_due_to_misconfig,cloud_provider_resource_stockout_due_to_misconfig,cluster_operation_throttled,cluster_operation_timeout,control_plane_request_failure_due_to_misconfig,data_access_config_changed,disaster_recovery_replication,driver_eviction,driver_launch_timeout,driver_node_unreachable,driver_out_of_disk,driver_out_of_memory,driver_pod_creation_failure,driver_unexpected_failure,dynamic_spark_conf_size_exceeded,eos_spark_image,executor_pod_unscheduled,gcp_api_rate_quota_exceeded,gcp_forbidden,gcp_iam_timeout,gcp_inaccessible_kms_key_failure,gcp_insufficient_capacity,gcp_ip_space_exhausted,gcp_kms_key_permission_denied,gcp_not_found,gcp_resource_quota_exceeded,gcp_service_account_access_denied,gcp_service_account_not_found,gcp_subnet_not_ready,gcp_trusted_image_projects_violated,gke_based_cluster_termination,init_container_not_finished,instance_pool_max_capacity_reached,instance_pool_not_found,instance_unreachable_due_to_misconfig,internal_capacity_failure,invalid_aws_parameter,invalid_instance_placement_protocol,invalid_worker_image_failure,in_penalty_box,lazy_allocation_timeout,maintenance_mode,netvisor_setup_timeout,no_matched_k8s,no_matched_k8s_testing_tag,pod_assignment_failure,pod_scheduling_failure,resource_usage_blocked,secret_creation_failure,serverless_long_running_terminated,spark_image_download_throttled,spark_image_not_found,ssh_bootstrap_failure,storage_download_failure_due_to_misconfig,storage_download_failure_slow,storage_download_failure_throttled,unexpected_pod_recreation,user_initiated_vm_terminationandworkspace_updateenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - Added
generated_sql_query_too_long_exceptionandmissing_sql_query_exceptionenum values fordatabricks.sdk.service.dashboards.MessageErrorType. - Added
balancedenum value fordatabricks.sdk.service.jobs.PerformanceTarget. - Added
listing_resourceenum value fordatabricks.sdk.service.marketplace.FileParentType. - Added
appenum value fordatabricks.sdk.service.marketplace.MarketplaceFileType. - Added
customenum value fordatabricks.sdk.service.serving.ExternalModelProvider. - Added
arclight_multi_tenant_azure_exchange_tokenandarclight_multi_tenant_azure_exchange_token_with_user_delegation_keyenum values fordatabricks.sdk.service.settings.TokenType. - [Breaking] Changed
create_experiment()method for w.forecasting workspace-level service with new required argument order. - Changed
instance_type_idfield fordatabricks.sdk.service.compute.NodeInstanceTypeto be required. - Changed
categoryfield fordatabricks.sdk.service.compute.NodeTypeto be required. - [Breaking] Changed
functionsfield fordatabricks.sdk.service.sharing.ListProviderShareAssetsResponseto typedatabricks.sdk.service.sharing.DeltaSharingFunctionListdataclass. - [Breaking] Removed
execution_detailsandscriptfields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails. - [Breaking] Removed
supports_elastic_diskfield fordatabricks.sdk.service.compute.NodeType. - [Breaking] Removed
data_granularity_quantityanddata_granularity_unitfields fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - [Breaking] Removed
aliases,comment,data_type,dependency_list,full_data_type,id,input_params,name,properties,routine_definition,schema,securable_kind,share,share_id,storage_locationandtagsfields fordatabricks.sdk.service.sharing.Function.
Release v0.48.0 (2025-03-27)
API Changes
- Added
execution_detailsandscriptfields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails. - Added
supports_elastic_diskfield fordatabricks.sdk.service.compute.NodeType. - Added
data_granularity_quantityfield fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - [Breaking] Added
data_granularity_unitfield fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - Added
aliases,comment,data_type,dependency_list,full_data_type,id,input_params,name,properties,routine_definition,schema,securable_kind,share,share_id,storage_locationandtagsfields fordatabricks.sdk.service.sharing.Function. - [Breaking] Changed
create_experiment()method for w.forecasting workspace-level service with new required argument order. - [Breaking] Changed
instance_type_idfield fordatabricks.sdk.service.compute.NodeInstanceTypeto no longer be required. - [Breaking] Changed
categoryfield fordatabricks.sdk.service.compute.NodeTypeto no longer be required. - [Breaking] Changed
functionsfield fordatabricks.sdk.service.sharing.ListProviderShareAssetsResponseto typedatabricks.sdk.service.sharing.FunctionListdataclass. - [Breaking] Removed
abfss,dbfs,error_message,execution_duration_seconds,file,gcs,s3,status,volumesandworkspacefields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails. - [Breaking] Removed
forecast_granularityfield fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - [Breaking] Removed
jwks_urifield fordatabricks.sdk.service.oauth2.OidcFederationPolicy. - [Breaking] Removed
fallback_configfield fordatabricks.sdk.service.serving.AiGatewayConfig. - [Breaking] Removed
custom_provider_configfield fordatabricks.sdk.service.serving.ExternalModel. - [Breaking] Removed
fallback_configfield fordatabricks.sdk.service.serving.PutAiGatewayRequest. - [Breaking] Removed
fallback_configfield fordatabricks.sdk.service.serving.PutAiGatewayResponse. - [Breaking] Removed
aliases,comment,data_type,dependency_list,full_data_type,id,input_params,name,properties,routine_definition,schema,securable_kind,share,share_id,storage_locationandtagsfields fordatabricks.sdk.service.sharing.DeltaSharingFunction. - [Breaking] Removed
access_token_failure,allocation_timeout,allocation_timeout_node_daemon_not_ready,allocation_timeout_no_healthy_clusters,allocation_timeout_no_matched_clusters,allocation_timeout_no_ready_clusters,allocation_timeout_no_unallocated_clusters,allocation_timeout_no_warmed_up_clusters,aws_inaccessible_kms_key_failure,aws_instance_profile_update_failure,aws_invalid_key_pair,aws_invalid_kms_key_state,aws_resource_quota_exceeded,azure_packed_deployment_partial_failure,bootstrap_timeout_due_to_misconfig,budget_policy_limit_enforcement_activated,budget_policy_resolution_failure,cloud_account_setup_failure,cloud_operation_cancelled,cloud_provider_instance_not_launched,cloud_provider_launch_failure_due_to_misconfig,cloud_provider_resource_stockout_due_to_misconfig,cluster_operation_throttled,cluster_operation_timeout,control_plane_request_failure_due_to_misconfig,data_access_config_changed,disaster_recovery_replication,driver_eviction,driver_launch_timeout,driver_node_unreachable,driver_out_of_disk,driver_out_of_memory,driver_pod_creation_failure,driver_unexpected_failure,dynamic_spark_conf_size_exceeded,eos_spark_image,executor_pod_unscheduled,gcp_api_rate_quota_exceeded,gcp_forbidden,gcp_iam_timeout,gcp_inaccessible_kms_key_failure,gcp_insufficient_capacity,gcp_ip_space_exhausted,gcp_kms_key_permission_denied,gcp_not_found,gcp_resource_quota_exceeded,gcp_service_account_access_denied,gcp_service_account_not_found,gcp_subnet_not_ready,gcp_trusted_image_projects_violated,gke_based_cluster_termination,init_container_not_finished,instance_pool_max_capacity_reached,instance_pool_not_found,instance_unreachable_due_to_misconfig,internal_capacity_failure,invalid_aws_parameter,invalid_instance_placement_protocol,invalid_worker_image_failure,in_penalty_box,lazy_allocation_timeout,maintenance_mode,netvisor_setup_timeout,no_matched_k8s,no_matched_k8s_testing_tag,pod_assignment_failure,pod_scheduling_failure,resource_usage_blocked,secret_creation_failure,serverless_long_running_terminated,spark_image_download_throttled,spark_image_not_found,ssh_bootstrap_failure,storage_download_failure_due_to_misconfig,storage_download_failure_slow,storage_download_failure_throttled,unexpected_pod_recreation,user_initiated_vm_terminationandworkspace_updateenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - [Breaking] Removed
generated_sql_query_too_long_exceptionandmissing_sql_query_exceptionenum values fordatabricks.sdk.service.dashboards.MessageErrorType. - [Breaking] Removed
balancedenum value fordatabricks.sdk.service.jobs.PerformanceTarget. - [Breaking] Removed
listing_resourceenum value fordatabricks.sdk.service.marketplace.FileParentType. - [Breaking] Removed
appenum value fordatabricks.sdk.service.marketplace.MarketplaceFileType. - [Breaking] Removed
customenum value fordatabricks.sdk.service.serving.ExternalModelProvider.
Release v0.47.0 (2025-03-21)
Bug Fixes
- Ensure that refresh tokens are returned when using the
external-browsercredentials strategy.
API Changes
- Added
abfss,dbfs,error_message,execution_duration_seconds,file,gcs,s3,status,volumesandworkspacefields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails. - [Breaking] Added
forecast_granularityfield fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - Added
jwks_urifield fordatabricks.sdk.service.oauth2.OidcFederationPolicy. - Added
fallback_configfield fordatabricks.sdk.service.serving.AiGatewayConfig. - Added
custom_provider_configfield fordatabricks.sdk.service.serving.ExternalModel. - Added
fallback_configfield fordatabricks.sdk.service.serving.PutAiGatewayRequest. - Added
fallback_configfield fordatabricks.sdk.service.serving.PutAiGatewayResponse. - Added
aliases,comment,data_type,dependency_list,full_data_type,id,input_params,name,properties,routine_definition,schema,securable_kind,share,share_id,storage_locationandtagsfields fordatabricks.sdk.service.sharing.DeltaSharingFunction. - Added
access_token_failure,allocation_timeout,allocation_timeout_node_daemon_not_ready,allocation_timeout_no_healthy_clusters,allocation_timeout_no_matched_clusters,allocation_timeout_no_ready_clusters,allocation_timeout_no_unallocated_clusters,allocation_timeout_no_warmed_up_clusters,aws_inaccessible_kms_key_failure,aws_instance_profile_update_failure,aws_invalid_key_pair,aws_invalid_kms_key_state,aws_resource_quota_exceeded,azure_packed_deployment_partial_failure,bootstrap_timeout_due_to_misconfig,budget_policy_limit_enforcement_activated,budget_policy_resolution_failure,cloud_account_setup_failure,cloud_operation_cancelled,cloud_provider_instance_not_launched,cloud_provider_launch_failure_due_to_misconfig,cloud_provider_resource_stockout_due_to_misconfig,cluster_operation_throttled,cluster_operation_timeout,control_plane_request_failure_due_to_misconfig,data_access_config_changed,disaster_recovery_replication,driver_eviction,driver_launch_timeout,driver_node_unreachable,driver_out_of_disk,driver_out_of_memory,driver_pod_creation_failure,driver_unexpected_failure,dynamic_spark_conf_size_exceeded,eos_spark_image,executor_pod_unscheduled,gcp_api_rate_quota_exceeded,gcp_forbidden,gcp_iam_timeout,gcp_inaccessible_kms_key_failure,gcp_insufficient_capacity,gcp_ip_space_exhausted,gcp_kms_key_permission_denied,gcp_not_found,gcp_resource_quota_exceeded,gcp_service_account_access_denied,gcp_service_account_not_found,gcp_subnet_not_ready,gcp_trusted_image_projects_violated,gke_based_cluster_termination,init_container_not_finished,instance_pool_max_capacity_reached,instance_pool_not_found,instance_unreachable_due_to_misconfig,internal_capacity_failure,invalid_aws_parameter,invalid_instance_placement_protocol,invalid_worker_image_failure,in_penalty_box,lazy_allocation_timeout,maintenance_mode,netvisor_setup_timeout,no_matched_k8s,no_matched_k8s_testing_tag,pod_assignment_failure,pod_scheduling_failure,resource_usage_blocked,secret_creation_failure,serverless_long_running_terminated,spark_image_download_throttled,spark_image_not_found,ssh_bootstrap_failure,storage_download_failure_due_to_misconfig,storage_download_failure_slow,storage_download_failure_throttled,unexpected_pod_recreation,user_initiated_vm_terminationandworkspace_updateenum values fordatabricks.sdk.service.compute.TerminationReasonCode. - Added
generated_sql_query_too_long_exceptionandmissing_sql_query_exceptionenum values fordatabricks.sdk.service.dashboards.MessageErrorType. - Added
balancedenum value fordatabricks.sdk.service.jobs.PerformanceTarget. - Added
listing_resourceenum value fordatabricks.sdk.service.marketplace.FileParentType. - Added
appenum value fordatabricks.sdk.service.marketplace.MarketplaceFileType. - Added
customenum value fordatabricks.sdk.service.serving.ExternalModelProvider. - [Breaking] Changed
create_experiment()method for w.forecasting workspace-level service with new required argument order. - Changed
instance_type_idfield fordatabricks.sdk.service.compute.NodeInstanceTypeto be required. - Changed
categoryfield fordatabricks.sdk.service.compute.NodeTypeto be required. - [Breaking] Changed
functionsfield fordatabricks.sdk.service.sharing.ListProviderShareAssetsResponseto typedatabricks.sdk.service.sharing.DeltaSharingFunctionListdataclass. - [Breaking] Changed waiter for ClustersAPI.create method.
- [Breaking] Changed waiter for ClustersAPI.delete method.
- [Breaking] Changed waiter for ClustersAPI.edit method.
- [Breaking] Changed waiter for ClustersAPI.get method.
- [Breaking] Changed waiter for ClustersAPI.resize method.
- [Breaking] Changed waiter for ClustersAPI.restart method.
- [Breaking] Changed waiter for ClustersAPI.start method.
- [Breaking] Changed waiter for ClustersAPI.update method.
- [Breaking] Removed
execution_detailsandscriptfields fordatabricks.sdk.service.compute.InitScriptInfoAndExecutionDetails. - [Breaking] Removed
supports_elastic_diskfield fordatabricks.sdk.service.compute.NodeType. - [Breaking] Removed
data_granularity_quantityanddata_granularity_unitfields fordatabricks.sdk.service.ml.CreateForecastingExperimentRequest. - [Breaking] Removed
aliases,comment,data_type,dependency_list,full_data_type,id,input_params,name,properties,routine_definition,schema,securable_kind,share,share_id,storage_locationandtagsfields fordatabricks.sdk.service.sharing.Function.
Release v0.46.0 (2025-03-12)
New Features and Improvements
- [Experimental] Add support for async token refresh (#916).
This can be enabled with by setting the following setting:
This feature and its setting are experimental and may be removed in future releases.export DATABRICKS_ENABLE_EXPERIMENTAL_ASYNC_TOKEN_REFRESH=1.
API Changes
- Added w.forecasting workspace-level service.
- Added
statement_idfield fordatabricks.sdk.service.dashboards.GenieQueryAttachment. - Added
could_not_get_model_deployments_exceptionenum value fordatabricks.sdk.service.dashboards.MessageErrorType. - [Breaking] Removed
jwks_urifield fordatabricks.sdk.service.oauth2.OidcFederationPolicy.
Release v0.45.0 (2025-03-07)
New Features and Improvements
- Update Jobs service to use API 2.2 (#913).
Internal Changes
- Refactor
DatabricksErrorto expose different types of error details (#912). - Update Jobs ListJobs API to support paginated responses (#896)
- Update Jobs ListRuns API to support paginated responses (#890)
- Introduce automated tagging (#888)
- Update Jobs GetJob API to support paginated responses (#869).
- Update On Behalf Of User Authentication in Multithreaded applications (#907)
API Changes
- Added
execute_message_attachment_query(),get_message_attachment_query_result()andget_space()methods for w.genie workspace-level service. - Added
list_provider_share_assets()method for w.providers workspace-level service. - Added
budget_policy_idandeffective_budget_policy_idfields fordatabricks.sdk.service.apps.App. - Added
policyfield fordatabricks.sdk.service.billing.CreateBudgetPolicyRequest. - Added
databricks_gcp_service_accountfield fordatabricks.sdk.service.catalog.ValidateCredentialRequest. - Added
attachment_idfield fordatabricks.sdk.service.dashboards.GenieAttachment. - Added
conversation_idfield fordatabricks.sdk.service.dashboards.GenieConversation. - Added
message_idfield fordatabricks.sdk.service.dashboards.GenieMessage. - Added
description,id,last_updated_timestamp,query,query_result_metadataandtitlefields fordatabricks.sdk.service.dashboards.GenieQueryAttachment. - Added
gen_ai_compute_taskfield fordatabricks.sdk.service.jobs.RunTask. - Added
gen_ai_compute_taskfield fordatabricks.sdk.service.jobs.SubmitTask. - Added
gen_ai_compute_taskfield fordatabricks.sdk.service.jobs.Task. - Added
run_namefield fordatabricks.sdk.service.ml.CreateRun. - Added
run_namefield fordatabricks.sdk.service.ml.RunInfo. - Added
run_namefield fordatabricks.sdk.service.ml.UpdateRun. - Added
lifetimefield fordatabricks.sdk.service.oauth2.CreateServicePrincipalSecretRequest. - Added
expire_timefield fordatabricks.sdk.service.oauth2.CreateServicePrincipalSecretResponse. - Added
jwks_urifield fordatabricks.sdk.service.oauth2.OidcFederationPolicy. - Added
expire_timefield fordatabricks.sdk.service.oauth2.SecretInfo. - Added
instance_profile_arnfield fordatabricks.sdk.service.serving.AmazonBedrockConfig. - Added
budget_policy_idfield fordatabricks.sdk.service.serving.CreateServingEndpoint. - Added
budget_policy_idfield fordatabricks.sdk.service.serving.ServingEndpoint. - Added
budget_policy_idfield fordatabricks.sdk.service.serving.ServingEndpointDetailed. - Added
add,principalandremovefields fordatabricks.sdk.service.sharing.PermissionsChange. - Added
columns_to_rerankfield fordatabricks.sdk.service.vectorsearch.QueryVectorIndexRequest. - Added
oracleandteradataenum values fordatabricks.sdk.service.catalog.ConnectionType. - Added
function_arguments_invalid_type_exceptionandmessage_cancelled_while_executing_exceptionenum values fordatabricks.sdk.service.dashboards.MessageErrorType. - Added
waitingenum value fordatabricks.sdk.service.jobs.RunLifecycleStateV2State. - Added
active_only,allanddeleted_onlyenum values fordatabricks.sdk.service.ml.ViewType. - Added
oauth_client_credentialsenum value fordatabricks.sdk.service.sharing.AuthenticationType. - Added
rawenum value fordatabricks.sdk.service.workspace.ExportFormat. - [Breaking] Changed
get_by_name()method for w.experiments workspace-level service to returndatabricks.sdk.service.ml.GetExperimentByNameResponsedataclass. - [Breaking] Changed
log_inputs()method for w.experiments workspace-level service with new required argument order. - [Breaking] Changed
share_permissions()method for w.shares workspace-level service to returndatabricks.sdk.service.sharing.GetSharePermissionsResponsedataclass. - [Breaking] Changed
share_permissions()andupdate_permissions()methods for w.shares workspace-level service return type to become non-empty. - [Breaking] Changed
update_permissions()method for w.shares workspace-level service to returndatabricks.sdk.service.sharing.UpdateSharePermissionsResponsedataclass. - [Breaking] Changed
policy_idfield fordatabricks.sdk.service.billing.BudgetPolicyto no longer be required. - Changed
policy_idfield fordatabricks.sdk.service.billing.BudgetPolicyto no longer be required. - [Breaking] Changed
partitionsfield fordatabricks.sdk.service.cleanrooms.CleanRoomAssetTableLocalDetailsto typedatabricks.sdk.service.cleanrooms.PartitionListdataclass. - [Breaking] Changed
queryfield fordatabricks.sdk.service.dashboards.GenieAttachmentto typedatabricks.sdk.service.dashboards.GenieQueryAttachmentdataclass. - [Breaking] Changed
digest,name,sourceandsource_typefields fordatabricks.sdk.service.ml.Datasetto be required. - Changed
digest,name,sourceandsource_typefields fordatabricks.sdk.service.ml.Datasetto be required. - [Breaking] Changed
datasetfield fordatabricks.sdk.service.ml.DatasetInputto be required. - Changed
datasetfield fordatabricks.sdk.service.ml.DatasetInputto be required. - Changed
keyandvaluefields fordatabricks.sdk.service.ml.InputTagto be required. - [Breaking] Changed
keyandvaluefields fordatabricks.sdk.service.ml.InputTagto be required. - [Breaking] Changed
view_typefield fordatabricks.sdk.service.ml.ListExperimentsRequestto typedatabricks.sdk.service.ml.ViewTypedataclass. - [Breaking] Changed
run_idfield fordatabricks.sdk.service.ml.LogInputsto be required. - [Breaking] Changed
view_typefield fordatabricks.sdk.service.ml.SearchExperimentsto typedatabricks.sdk.service.ml.ViewTypedataclass. - [Breaking] Changed
run_view_typefield fordatabricks.sdk.service.ml.SearchRunsto typedatabricks.sdk.service.ml.ViewTypedataclass. - [Breaking] Removed
custom_tagsandpolicy_namefields fordatabricks.sdk.service.billing.CreateBudgetPolicyRequest. - [Breaking] Removed
cached_query_schema,description,id,instruction_id,instruction_title,last_updated_timestamp,query,statement_idandtitlefields fordatabricks.sdk.service.dashboards.QueryAttachment. - [Breaking] Removed
max_resultsandpage_tokenfields fordatabricks.sdk.service.sharing.UpdateSharePermissions. - [Breaking] Removed
active_only,allanddeleted_onlyenum values fordatabricks.sdk.service.ml.SearchExperimentsViewType. - [Breaking] Removed
active_only,allanddeleted_onlyenum values fordatabricks.sdk.service.ml.SearchRunsRunViewType.
Release v0.44.1 (2025-02-13)
New Features and Improvements
- Introduce new Credential Strategies for Agents (#882).
Internal Changes
- GetRun logic paginates more arrays (#867).
Release v0.44.0 (2025-02-11)
Internal Changes
- Fix
tests/integration/test_dbutils.py::test_secrets(#884).
API Changes:
- Added
get_message_query_result_by_attachment()method for w.genie workspace-level service. - Added
idfield fordatabricks.sdk.service.apps.App. - Added
limit_configfield fordatabricks.sdk.service.billing.UpdateBudgetPolicyRequest. - Added
volumesfield fordatabricks.sdk.service.compute.ClusterLogConf. - Removed
review_state,reviewsandrunner_collaboratorsfields fordatabricks.sdk.service.cleanrooms.CleanRoomAssetNotebook.
OpenAPI SHA: 99f644e72261ef5ecf8d74db20f4b7a1e09723cc, Date: 2025-02-11
Release v0.43.0 (2025-02-03)
API Changes:
- Added w.lakeview_embedded workspace-level service and w.query_execution workspace-level service.
- Added w.redash_config workspace-level service.
- Added
gcp_oauth_tokenfield fordatabricks.sdk.service.catalog.TemporaryCredentials. - Added
optionsfield fordatabricks.sdk.service.catalog.UpdateCatalog. - Added
disabledfield fordatabricks.sdk.service.jobs.RunTask.
OpenAPI SHA: c72c58f97b950fcb924a90ef164bcb10cfcd5ece, Date: 2025-02-03
Bug Fixes
- Fix docs generation when two services have the same name (#872).
Internal Changes
- Add CICD environment to the User Agent (#866).
- Add unit tests for retriable requests (#879).
- Extract "before retry" handler, use it to rewind the stream (#878).
- Update Model Serving
http_requestmixin to correctly use the underlying API. (#876).
Backward Incompatible Changes
- Changed
create()method for w.serving_endpoints workspace-level service with new required argument order. - Changed
http_request()method for w.serving_endpoints workspace-level service to typehttp_request()method for w.serving_endpoints workspace-level service. - Changed
http_request()method for w.serving_endpoints workspace-level service to returndatabricks.sdk.service.serving.HttpRequestResponsedataclass. - Changed
configfield fordatabricks.sdk.service.serving.CreateServingEndpointto no longer be required. - Removed
securable_kindfield fordatabricks.sdk.service.catalog.CatalogInfo. - Removed
securable_kindfield fordatabricks.sdk.service.catalog.ConnectionInfo. - Removed
status_codeandtextfields fordatabricks.sdk.service.serving.ExternalFunctionResponse.
API Changes:
- Added a.budget_policy account-level service.
- Added a.enable_ip_access_lists account-level service.
- Added
review_state,reviewsandrunner_collaboratorsfields fordatabricks.sdk.service.cleanrooms.CleanRoomAssetNotebook. - Added
statement_idfield fordatabricks.sdk.service.dashboards.QueryAttachment. - Added
effective_performance_targetfield fordatabricks.sdk.service.jobs.BaseRun. - Added
performance_targetfield fordatabricks.sdk.service.jobs.CreateJob. - Added
performance_targetfield fordatabricks.sdk.service.jobs.JobSettings. - Added
effective_performance_targetfield fordatabricks.sdk.service.jobs.Run. - Added
performance_targetfield fordatabricks.sdk.service.jobs.RunNow. - Added
effective_performance_targetfield fordatabricks.sdk.service.jobs.RunTask. - Added
run_as_replfield fordatabricks.sdk.service.jobs.SparkJarTask. - Added
user_authorized_scopesfield fordatabricks.sdk.service.oauth2.CreateCustomAppIntegration. - Added
user_authorized_scopesfield fordatabricks.sdk.service.oauth2.GetCustomAppIntegrationOutput. - Added
user_authorized_scopesfield fordatabricks.sdk.service.oauth2.UpdateCustomAppIntegration. - Added
contentsfield fordatabricks.sdk.service.serving.HttpRequestResponse. - Added
clean_roomenum value fordatabricks.sdk.service.catalog.SecurableType. - Added
budget_policy_limit_exceededenum value fordatabricks.sdk.service.jobs.TerminationCodeCode. - Added
arclight_azure_exchange_token_with_user_delegation_keyenum value fordatabricks.sdk.service.settings.TokenType.
OpenAPI SHA: 840c660106f820a1a5dff931d51fa5f65cd9fdd9, Date: 2025-01-28
Release v0.41.0 (2025-01-20)
New Features and Improvements
- Add
serving.http_requestto call external functions. (#857). - Files API client: recover on download failures (#844) (#845).
Bug Fixes
- Properly pass query parameters in apps and oauth2 (#862).
Internal Changes
- Add unit tests for external-browser authentication (#863).
- Decouple oauth2 and serving (#855).
- Migrate workflows that need write access to use hosted runners (#850).
- Stop testing Python 3.7 on Ubuntu (#858).
API Changes:
- Added w.access_control workspace-level service.
- Added
http_request()method for w.serving_endpoints workspace-level service. - Added
no_computefield fordatabricks.sdk.service.apps.CreateAppRequest. - Added
has_morefield fordatabricks.sdk.service.jobs.BaseJob. - Added
has_morefield fordatabricks.sdk.service.jobs.BaseRun. - Added
page_tokenfield fordatabricks.sdk.service.jobs.GetJobRequest. - Added
has_moreandnext_page_tokenfields fordatabricks.sdk.service.jobs.Job. - Added
has_morefield fordatabricks.sdk.service.jobs.Run. - Added
clean_rooms_notebook_outputfield fordatabricks.sdk.service.jobs.RunOutput. - Added
scopesfield fordatabricks.sdk.service.oauth2.UpdateCustomAppIntegration. - Added
run_asfield fordatabricks.sdk.service.pipelines.CreatePipeline. - Added
run_asfield fordatabricks.sdk.service.pipelines.EditPipeline. - Added
authorization_detailsandendpoint_urlfields fordatabricks.sdk.service.serving.DataPlaneInfo. - Added
contentsfield fordatabricks.sdk.service.serving.GetOpenApiResponse. - Added
activated,activation_url,authentication_type,cloud,comment,created_at,created_by,data_recipient_global_metastore_id,ip_access_list,metastore_id,name,owner,properties_kvpairs,region,sharing_code,tokens,updated_atandupdated_byfields fordatabricks.sdk.service.sharing.RecipientInfo. - Added
expiration_timefield fordatabricks.sdk.service.sharing.RecipientInfo. - Changed
update()method for a.account_federation_policy account-level service with new required argument order. - Changed
update()method for a.service_principal_federation_policy account-level service with new required argument order. - Changed
update()method for w.recipients workspace-level service to returndatabricks.sdk.service.sharing.RecipientInfodataclass. - Changed
update()method for w.recipients workspace-level service return type to become non-empty. - Changed
update()method for w.recipients workspace-level service to typeupdate()method for w.recipients workspace-level service. - Changed
get_open_api()method for w.serving_endpoints workspace-level service return type to become non-empty. - Changed
patch()method for w.serving_endpoints workspace-level service to typepatch()method for w.serving_endpoints workspace-level service. - Changed
patch()method for w.serving_endpoints workspace-level service to returndatabricks.sdk.service.serving.EndpointTagsdataclass. - Changed
databricks.sdk.service.serving.EndpointTagListdataclass to. - Changed
collaborator_aliasfield fordatabricks.sdk.service.cleanrooms.CleanRoomCollaboratorto be required. - Changed
collaborator_aliasfield fordatabricks.sdk.service.cleanrooms.CleanRoomCollaboratorto be required. - Changed
update_maskfield fordatabricks.sdk.service.oauth2.UpdateAccountFederationPolicyRequestto no longer be required. - Changed
update_maskfield fordatabricks.sdk.service.oauth2.UpdateServicePrincipalFederationPolicyRequestto no longer be required. - Changed
days_of_weekfield fordatabricks.sdk.service.pipelines.RestartWindowto typedatabricks.sdk.service.pipelines.DayOfWeekListdataclass. - Changed
behaviorfield fordatabricks.sdk.service.serving.AiGatewayGuardrailPiiBehaviorto no longer be required. - Changed
behaviorfield fordatabricks.sdk.service.serving.AiGatewayGuardrailPiiBehaviorto no longer be required. - Changed
project_idandregionfields fordatabricks.sdk.service.serving.GoogleCloudVertexAiConfigto be required. - Changed
project_idandregionfields fordatabricks.sdk.service.serving.GoogleCloudVertexAiConfigto be required. - Changed
workload_typefield fordatabricks.sdk.service.serving.ServedEntityInputto typedatabricks.sdk.service.serving.ServingModelWorkloadTypedataclass. - Changed
workload_typefield fordatabricks.sdk.service.serving.ServedEntityOutputto typedatabricks.sdk.service.serving.ServingModelWorkloadTypedataclass. - Changed
workload_typefield fordatabricks.sdk.service.serving.ServedModelOutputto typedatabricks.sdk.service.serving.ServingModelWorkloadTypedataclass.
OpenAPI SHA: 58905570a9928fc9ed31fba14a2edaf9a7c55b08, Date: 2025-01-20
Release v0.40.0 (2024-12-19)
API Changes:
- Added a.account_federation_policy account-level service and a.service_principal_federation_policy account-level service.
- Added
is_single_node,kindanduse_ml_runtimefields fordatabricks.sdk.service.compute.ClusterAttributes. - Added
is_single_node,kindanduse_ml_runtimefields fordatabricks.sdk.service.compute.ClusterDetails. - Added
is_single_node,kindanduse_ml_runtimefields fordatabricks.sdk.service.compute.ClusterSpec. - Added
is_single_node,kindanduse_ml_runtimefields fordatabricks.sdk.service.compute.CreateCluster. - Added
is_single_node,kindanduse_ml_runtimefields fordatabricks.sdk.service.compute.EditCluster. - Added
is_single_node,kindanduse_ml_runtimefields fordatabricks.sdk.service.compute.UpdateClusterResource. - Added
update_parameter_syntaxfield fordatabricks.sdk.service.dashboards.MigrateDashboardRequest. - Added
clean_rooms_notebook_taskfield fordatabricks.sdk.service.jobs.RunTask. - Added
clean_rooms_notebook_taskfield fordatabricks.sdk.service.jobs.SubmitTask. - Added
clean_rooms_notebook_taskfield fordatabricks.sdk.service.jobs.Task. - Changed
days_of_weekfield fordatabricks.sdk.service.pipelines.RestartWindowto typedatabricks.sdk.service.pipelines.RestartWindowDaysOfWeekListdataclass.
OpenAPI SHA: a6a317df8327c9b1e5cb59a03a42ffa2aabeef6d, Date: 2024-12-16
Release v0.39.0 (2024-12-11)
Bug Fixes
- Update Changelog file (#830).
Internal Changes
API Changes:
- Added
databricks.sdk.service.cleanroomspackage. - Added
delete()method for w.aibi_dashboard_embedding_access_policy workspace-level service. - Added
delete()method for w.aibi_dashboard_embedding_approved_domains workspace-level service. - Added
databricks_gcp_service_accountfield fordatabricks.sdk.service.catalog.CreateCredentialRequest. - Added
databricks_gcp_service_accountfield fordatabricks.sdk.service.catalog.CredentialInfo. - Added
gcp_optionsfield fordatabricks.sdk.service.catalog.GenerateTemporaryServiceCredentialRequest. - Added
databricks_gcp_service_accountfield fordatabricks.sdk.service.catalog.UpdateCredentialRequest. - Added
cached_query_schemafield fordatabricks.sdk.service.dashboards.QueryAttachment. - Added .
- Removed
gcp_service_account_keyfield fordatabricks.sdk.service.catalog.CreateCredentialRequest.
OpenAPI SHA: 7016dcbf2e011459416cf408ce21143bcc4b3a25, Date: 2024-12-05
Release v0.38.0 (2024-11-18)
New Features and Improvements
- Read streams by 1MB chunks by default. (#817).
Bug Fixes
- Rewind seekable streams before retrying (#821).
- Properly serialize nested data classes.
Internal Changes
- Reformat SDK with YAPF 0.43. (#822).
- Update Jobs GetRun API to support paginated responses for jobs and ForEach tasks (#819).
API Changes:
- Added
service_principal_client_idfield fordatabricks.sdk.service.apps.App. - Added
azure_service_principal,gcp_service_account_keyandread_onlyfields fordatabricks.sdk.service.catalog.CreateCredentialRequest. - Added
azure_service_principal,read_onlyandused_for_managed_storagefields fordatabricks.sdk.service.catalog.CredentialInfo. - Added
omit_usernamefield fordatabricks.sdk.service.catalog.ListTablesRequest. - Added
azure_service_principalandread_onlyfields fordatabricks.sdk.service.catalog.UpdateCredentialRequest. - Added
external_location_name,read_onlyandurlfields fordatabricks.sdk.service.catalog.ValidateCredentialRequest. - Added
is_dirfield fordatabricks.sdk.service.catalog.ValidateCredentialResponse. - Added
onlyfield fordatabricks.sdk.service.jobs.RunNow. - Added
restart_windowfield fordatabricks.sdk.service.pipelines.CreatePipeline. - Added
restart_windowfield fordatabricks.sdk.service.pipelines.EditPipeline. - Added
restart_windowfield fordatabricks.sdk.service.pipelines.PipelineSpec. - Added
private_access_settings_idfield fordatabricks.sdk.service.provisioning.UpdateWorkspaceRequest. - Changed
create_credential()andgenerate_temporary_service_credential()methods for w.credentials workspace-level service with new required argument order. - Changed
access_connector_idfield fordatabricks.sdk.service.catalog.AzureManagedIdentityto be required. - Changed
access_connector_idfield fordatabricks.sdk.service.catalog.AzureManagedIdentityto be required. - Changed
namefield fordatabricks.sdk.service.catalog.CreateCredentialRequestto be required. - Changed
credential_namefield fordatabricks.sdk.service.catalog.GenerateTemporaryServiceCredentialRequestto be required.
OpenAPI SHA: f2385add116e3716c8a90a0b68e204deb40f996c, Date: 2024-11-15
Release v0.37.0 (2024-11-05)
Bug Fixes
- Correctly generate classes with nested body fields (#808).
Internal Changes
- Add
cleanroomspackage (#806). - Add test instructions for external contributors (#804).
- Always write message for manual test execution (#811).
- Automatically trigger integration tests on PR (#800).
- Better isolate ML serving auth unit tests (#803).
- Move templates in the code generator (#809).
API Changes:
- Added w.aibi_dashboard_embedding_access_policy workspace-level service and w.aibi_dashboard_embedding_approved_domains workspace-level service.
- Added w.credentials workspace-level service.
- Added
app_deploymentfield fordatabricks.sdk.service.apps.CreateAppDeploymentRequest. - Added
appfield fordatabricks.sdk.service.apps.CreateAppRequest. - Added
appfield fordatabricks.sdk.service.apps.UpdateAppRequest. - Added
tablefield fordatabricks.sdk.service.catalog.CreateOnlineTableRequest. - Added
azure_aadfield fordatabricks.sdk.service.catalog.GenerateTemporaryTableCredentialResponse. - Added
full_namefield fordatabricks.sdk.service.catalog.StorageCredentialInfo. - Added
dashboardfield fordatabricks.sdk.service.dashboards.CreateDashboardRequest. - Added
schedulefield fordatabricks.sdk.service.dashboards.CreateScheduleRequest. - Added
subscriptionfield fordatabricks.sdk.service.dashboards.CreateSubscriptionRequest. - Added
warehouse_idfield fordatabricks.sdk.service.dashboards.Schedule. - Added
dashboardfield fordatabricks.sdk.service.dashboards.UpdateDashboardRequest. - Added
schedulefield fordatabricks.sdk.service.dashboards.UpdateScheduleRequest. - Added
page_tokenfield fordatabricks.sdk.service.oauth2.ListServicePrincipalSecretsRequest. - Added
next_page_tokenfield fordatabricks.sdk.service.oauth2.ListServicePrincipalSecretsResponse. - Added
connection_namefield fordatabricks.sdk.service.pipelines.IngestionGatewayPipelineDefinition. - Added
is_no_public_ip_enabledfield fordatabricks.sdk.service.provisioning.CreateWorkspaceRequest. - Added
external_customer_infoandis_no_public_ip_enabledfields fordatabricks.sdk.service.provisioning.Workspace. - Added
last_used_dayfield fordatabricks.sdk.service.settings.TokenInfo. - Changed
create()method for w.apps workspace-level service with new required argument order. - Changed
execute_message_query()method for w.genie workspace-level service . New request type isdatabricks.sdk.service.dashboards.GenieExecuteMessageQueryRequestdataclass. - Changed
execute_message_query()method for w.genie workspace-level service to typeexecute_message_query()method for w.genie workspace-level service. - Changed
create(),create_schedule(),create_subscription()andupdate_schedule()methods for w.lakeview workspace-level service with new required argument order. - Removed w.clean_rooms workspace-level service.
- Removed
deployment_id,modeandsource_code_pathfields fordatabricks.sdk.service.apps.CreateAppDeploymentRequest. - Removed
description,nameandresourcesfields fordatabricks.sdk.service.apps.CreateAppRequest. - Removed
descriptionandresourcesfields fordatabricks.sdk.service.apps.UpdateAppRequest. - Removed
nameandspecfields fordatabricks.sdk.service.catalog.CreateOnlineTableRequest. - Removed
display_name,parent_path,serialized_dashboardandwarehouse_idfields fordatabricks.sdk.service.dashboards.CreateDashboardRequest. - Removed
cron_schedule,display_nameandpause_statusfields fordatabricks.sdk.service.dashboards.CreateScheduleRequest. - Removed
subscriberfield fordatabricks.sdk.service.dashboards.CreateSubscriptionRequest. - Removed
display_name,etag,serialized_dashboardandwarehouse_idfields fordatabricks.sdk.service.dashboards.UpdateDashboardRequest. - Removed
cron_schedule,display_name,etagandpause_statusfields fordatabricks.sdk.service.dashboards.UpdateScheduleRequest. - Removed
prev_page_tokenfield fordatabricks.sdk.service.jobs.Run.
OpenAPI SHA: 5285ce76f81314f342c1702d5c2ad4ef42488781, Date: 2024-11-04
Release v0.36.0 (2024-10-22)
Breaking Changes
external_browsernow uses thedatabricks-cliapp instead of the third-party "6128a518-99a9-425b-8333-4cc94f04cacd" application when performing the U2M login flow for Azure workspaces when a client ID is not otherwise specified. This matches the AWS behavior.- The signatures of several OAuth-related constructors have changed to support U2M OAuth with Azure Entra ID application registrations. See https://github.com/databricks/databricks-sdk-py/blob/main/examples/flask_app_with_oauth.py for examples of how to use these classes.
OAuthClient(): renamed toOAuthClient.from_host()SessionCredentials()andSessionCredentials.from_dict(): now acceptstoken_endpoint,client_id,client_secret, andrefresh_urlas parameters, rather than accepting theOAuthClient.TokenCache(): now acceptshost,token_endpoint,client_id,client_secret, andrefresh_urlas parameters, rather than accepting theOAuthClient.
Bug Fixes
- Decouple OAuth functionality from
Config(#784).
Release
- Release v0.35.0 (#793).
Release v0.35.0 (2024-10-17)
New Features and Improvements
- Open AI Client Mixin (#779).
Bug Fixes
- Update Serving Endpoint mixing template and docs generation logic (#792).
API Changes:
- Added
databricks.sdk.service.pipelines.ReportSpecdataclass. - Added
unity_catalog_provisioning_statefield fordatabricks.sdk.service.catalog.OnlineTable. - Added
is_truncatedfield fordatabricks.sdk.service.dashboards.Result. - Added
effective_budget_policy_idfield fordatabricks.sdk.service.jobs.BaseJob. - Added
budget_policy_idfield fordatabricks.sdk.service.jobs.CreateJob. - Added
effective_budget_policy_idfield fordatabricks.sdk.service.jobs.Job. - Added
budget_policy_idfield fordatabricks.sdk.service.jobs.JobSettings. - Added
budget_policy_idfield fordatabricks.sdk.service.jobs.SubmitRun. - Added
reportfield fordatabricks.sdk.service.pipelines.IngestionConfig. - Added
sequence_byfield fordatabricks.sdk.service.pipelines.TableSpecificConfig. - Added
notify_on_okfield fordatabricks.sdk.service.sql.Alert. - Added
notify_on_okfield fordatabricks.sdk.service.sql.CreateAlertRequestAlert. - Added
notify_on_okfield fordatabricks.sdk.service.sql.ListAlertsResponseAlert. - Added
notify_on_okfield fordatabricks.sdk.service.sql.UpdateAlertRequestAlert.
OpenAPI SHA: cf9c61453990df0f9453670f2fe68e1b128647a2, Date: 2024-10-14
Release v0.34.0 (2024-10-07)
Bug Fixes
- Fix Model Serving Test (#781).
- Include package name for external types when deserializing responses (#786).
Internal Changes
- Refactor ApiClient into
_BaseClientandApiClient(#785). - Update to latest OpenAPI spec (#787).
- revert Support Models in
dbutils.fsoperations (#750) (#778).
API Changes:
- Added w.disable_legacy_dbfs workspace-level service.
- Added
default_source_code_pathandresourcesfields fordatabricks.sdk.service.apps.App. - Added
resourcesfield fordatabricks.sdk.service.apps.CreateAppRequest. - Added
resourcesfield fordatabricks.sdk.service.apps.UpdateAppRequest.
OpenAPI SHA: bc17b474818138f19b78a7bea0675707dead2b87, Date: 2024-10-07
Release v0.33.0 (2024-09-26)
Internal Changes
API Changes:
- Added w.disable_legacy_access workspace-level service and a.disable_legacy_features account-level service.
- Added w.temporary_table_credentials workspace-level service.
- Added
put_ai_gateway()method for w.serving_endpoints workspace-level service. - Added
databricks.sdk.service.apps.ApplicationState,databricks.sdk.service.apps.ApplicationStatus,databricks.sdk.service.apps.ComputeStateanddatabricks.sdk.service.apps.ComputeStatusdataclasses. - Added
databricks.sdk.service.catalog.AwsCredentials,databricks.sdk.service.catalog.AzureUserDelegationSas,databricks.sdk.service.catalog.GcpOauthToken,databricks.sdk.service.catalog.GenerateTemporaryTableCredentialRequest,databricks.sdk.service.catalog.GenerateTemporaryTableCredentialResponse,databricks.sdk.service.catalog.R2Credentialsanddatabricks.sdk.service.catalog.TableOperationdataclasses. - Added
databricks.sdk.service.serving.AiGatewayConfig,databricks.sdk.service.serving.AiGatewayGuardrailParameters,databricks.sdk.service.serving.AiGatewayGuardrailPiiBehavior,databricks.sdk.service.serving.AiGatewayGuardrailPiiBehaviorBehavior,databricks.sdk.service.serving.AiGatewayGuardrails,databricks.sdk.service.serving.AiGatewayInferenceTableConfig,databricks.sdk.service.serving.AiGatewayRateLimit,databricks.sdk.service.serving.AiGatewayRateLimitKey,databricks.sdk.service.serving.AiGatewayRateLimitRenewalPeriod,databricks.sdk.service.serving.AiGatewayUsageTrackingConfig,databricks.sdk.service.serving.PutAiGatewayRequestanddatabricks.sdk.service.serving.PutAiGatewayResponsedataclasses. - Added
databricks.sdk.service.settings.BooleanMessage,databricks.sdk.service.settings.DeleteDisableLegacyAccessRequest,databricks.sdk.service.settings.DeleteDisableLegacyAccessResponse,databricks.sdk.service.settings.DeleteDisableLegacyFeaturesRequest,databricks.sdk.service.settings.DeleteDisableLegacyFeaturesResponse,databricks.sdk.service.settings.DisableLegacyAccess,databricks.sdk.service.settings.DisableLegacyFeatures,databricks.sdk.service.settings.GetDisableLegacyAccessRequest,databricks.sdk.service.settings.GetDisableLegacyFeaturesRequest,databricks.sdk.service.settings.UpdateDisableLegacyAccessRequestanddatabricks.sdk.service.settings.UpdateDisableLegacyFeaturesRequestdataclasses. - Added
databricks.sdk.service.workspace.CreateCredentialsRequest,databricks.sdk.service.workspace.CreateRepoRequest,databricks.sdk.service.workspace.CreateRepoResponse,databricks.sdk.service.workspace.DeleteCredentialsRequest,any,any,databricks.sdk.service.workspace.GetCredentialsRequest,databricks.sdk.service.workspace.GetRepoResponse,databricks.sdk.service.workspace.ListCredentialsResponse,databricks.sdk.service.workspace.UpdateCredentialsRequest,any,databricks.sdk.service.workspace.UpdateRepoRequestandanydataclasses. - Added
app_statusandcompute_statusfields fordatabricks.sdk.service.apps.App. - Added
deployment_idfield fordatabricks.sdk.service.apps.CreateAppDeploymentRequest. - Added
external_access_enabledfield fordatabricks.sdk.service.catalog.GetMetastoreSummaryResponse. - Added
include_manifest_capabilitiesfield fordatabricks.sdk.service.catalog.GetTableRequest. - Added
include_manifest_capabilitiesfield fordatabricks.sdk.service.catalog.ListSummariesRequest. - Added
include_manifest_capabilitiesfield fordatabricks.sdk.service.catalog.ListTablesRequest. - Added
external_access_enabledfield fordatabricks.sdk.service.catalog.MetastoreInfo. - Added
budget_policy_idandschemafields fordatabricks.sdk.service.pipelines.CreatePipeline. - Added
budget_policy_idandschemafields fordatabricks.sdk.service.pipelines.EditPipeline. - Added
effective_budget_policy_idfield fordatabricks.sdk.service.pipelines.GetPipelineResponse. - Added
budget_policy_idandschemafields fordatabricks.sdk.service.pipelines.PipelineSpec. - Added
ai_gatewayfield fordatabricks.sdk.service.serving.CreateServingEndpoint. - Added
ai_gatewayfield fordatabricks.sdk.service.serving.ServingEndpoint. - Added
ai_gatewayfield fordatabricks.sdk.service.serving.ServingEndpointDetailed. - Added
workspace_idfield fordatabricks.sdk.service.settings.TokenInfo. - Added
credential_id,git_providerandgit_usernamefields fordatabricks.sdk.service.workspace.GetCredentialsResponse. - Changed
delete(),start()andstop()methods for w.apps workspace-level service to returndatabricks.sdk.service.apps.Appdataclass. - Changed
deploy()method for w.apps workspace-level service with new required argument order. - Changed
create()method for w.git_credentials workspace-level service . New request type isdatabricks.sdk.service.workspace.CreateCredentialsRequestdataclass. - Changed
delete()method for w.git_credentials workspace-level service . New request type isdatabricks.sdk.service.workspace.DeleteCredentialsRequestdataclass. - Changed
delete()method for w.git_credentials workspace-level service to returnanydataclass. - Changed
get()method for w.git_credentials workspace-level service . New request type isdatabricks.sdk.service.workspace.GetCredentialsRequestdataclass. - Changed
get()method for w.git_credentials workspace-level service to returndatabricks.sdk.service.workspace.GetCredentialsResponsedataclass. - Changed
list()method for w.git_credentials workspace-level service to returndatabricks.sdk.service.workspace.ListCredentialsResponsedataclass. - Changed
update()method for w.git_credentials workspace-level service . New request type isdatabricks.sdk.service.workspace.UpdateCredentialsRequestdataclass. - Changed
update()method for w.git_credentials workspace-level service to returnanydataclass. - Changed
create()method for w.repos workspace-level service to returndatabricks.sdk.service.workspace.CreateRepoResponsedataclass. - Changed
create()method for w.repos workspace-level service . New request type isdatabricks.sdk.service.workspace.CreateRepoRequestdataclass. - Changed
delete()method for w.repos workspace-level service to returnanydataclass. - Changed
get()method for w.repos workspace-level service to returndatabricks.sdk.service.workspace.GetRepoResponsedataclass. - Changed
update()method for w.repos workspace-level service to returnanydataclass. - Changed
update()method for w.repos workspace-level service . New request type isdatabricks.sdk.service.workspace.UpdateRepoRequestdataclass. - Changed
source_code_pathfield fordatabricks.sdk.service.apps.AppDeploymentto no longer be required. - Changed
source_code_pathfield fordatabricks.sdk.service.apps.CreateAppDeploymentRequestto no longer be required. - Changed
return_paramsandroutine_dependenciesfields fordatabricks.sdk.service.catalog.CreateFunctionto no longer be required. - Changed
credential_idandgit_providerfields fordatabricks.sdk.service.workspace.CreateCredentialsResponseto be required. - Changed
credential_idfield fordatabricks.sdk.service.workspace.CredentialInfoto be required. - Changed
patternsfield fordatabricks.sdk.service.workspace.SparseCheckouttodatabricks.sdk.service.workspace.Listdataclass. - Changed
patternsfield fordatabricks.sdk.service.workspace.SparseCheckoutUpdatetodatabricks.sdk.service.workspace.Listdataclass. - Removed
databricks.sdk.service.apps.AppState,databricks.sdk.service.apps.AppStatus,anyandanydataclasses. - Removed
databricks.sdk.service.sql.ClientCallContext,databricks.sdk.service.sql.EncodedText,databricks.sdk.service.sql.EncodedTextEncoding,databricks.sdk.service.sql.QuerySource,databricks.sdk.service.sql.QuerySourceDriverInfo,databricks.sdk.service.sql.QuerySourceEntryPoint,databricks.sdk.service.sql.QuerySourceJobManager,databricks.sdk.service.sql.QuerySourceTriggeranddatabricks.sdk.service.sql.ServerlessChannelInfodataclasses. - Removed
databricks.sdk.service.workspace.CreateCredentials,databricks.sdk.service.workspace.CreateRepo,databricks.sdk.service.workspace.DeleteGitCredentialRequest,databricks.sdk.service.workspace.GetGitCredentialRequest,databricks.sdk.service.workspace.SparseCheckoutPattern,databricks.sdk.service.workspace.UpdateCredentials,databricks.sdk.service.workspace.UpdateRepoandanydataclasses. - Removed
statusfield fordatabricks.sdk.service.apps.App. - Removed
query_sourcefield fordatabricks.sdk.service.sql.QueryInfo. - Removed
credentialsfield fordatabricks.sdk.service.workspace.GetCredentialsResponse.
OpenAPI SHA: 248f4ad9668661da9d0bf4a7b0119a2d44fd1e75, Date: 2024-09-25
Release v0.32.3 (2024-09-19)
New Features and Improvements
- Integrate Databricks SDK with Model Serving Auth Provider (#761).
Bug Fixes
- Add DataPlane docs to the index (#764).
mypyerror: Skipping analyzing "google": module is installed, but missing library stubs or py.typed marker (#769).
Release v0.32.2 (2024-09-17)
New Features and Improvements
- Support Models in
dbutils.fsoperations (#750).
Bug Fixes
- Do not specify --tenant flag when fetching managed identity access token from the CLI (#748).
- Fix deserialization of 401/403 errors (#758).
- Use correct optional typing in
WorkspaceClientformypy(#760).
Release v0.32.1 (2024-09-10)
Bug Fixes
- Properly include message when handing SCIM errors (#753).
Release v0.32.0 (2024-09-04)
Bug Fixes
- Handle non-JSON errors gracefully (#741).
Documentation
- Add Data Plane access documentation (#732).
Internal Changes
- Fix test_iam::test_scim_error_unmarshall integration test (#743).
API Changes:
- Added
regenerate_dashboard()method for w.quality_monitors workspace-level service. - Added
databricks.sdk.service.catalog.RegenerateDashboardRequestanddatabricks.sdk.service.catalog.RegenerateDashboardResponsedataclasses. - Added
databricks.sdk.service.jobs.QueueDetails,databricks.sdk.service.jobs.QueueDetailsCodeCode,databricks.sdk.service.jobs.RunLifecycleStateV2State,databricks.sdk.service.jobs.RunStatus,databricks.sdk.service.jobs.TerminationCodeCode,databricks.sdk.service.jobs.TerminationDetailsanddatabricks.sdk.service.jobs.TerminationTypeTypedataclasses. - Added
statusfield fordatabricks.sdk.service.jobs.BaseRun. - Added
statusfield fordatabricks.sdk.service.jobs.RepairHistoryItem. - Added
statusfield fordatabricks.sdk.service.jobs.Run. - Added
statusfield fordatabricks.sdk.service.jobs.RunTask. - Added
max_provisioned_throughputandmin_provisioned_throughputfields fordatabricks.sdk.service.serving.ServedModelInput. - Added
columns_to_syncfield fordatabricks.sdk.service.vectorsearch.DeltaSyncVectorIndexSpecRequest. - Changed
workload_sizefield fordatabricks.sdk.service.serving.ServedModelInputto no longer be required.
OpenAPI SHA: d05898328669a3f8ab0c2ecee37db2673d3ea3f7, Date: 2024-09-04
Release v0.31.1 (2024-08-28)
Bug Fixes
- Fix
DatabricksConfig.copywhen authenticated with OAuth (#723).
Internal Changes
- Fix get_workspace_client test to match Go SDK behavior (#738).
- Verify that
WorkspaceClientcreated fromAccountClientdoes actually work through integration tests (#736).
Release v0.31.0 (2024-08-21)
Bug Fixes
- Fixed regression introduced in v0.30.0 causing
ValueError: Invalid semantic version: 0.33.1+420240816190912(#729).
Internal Changes
- Escape single quotes in regex matchers (#727).
API Changes:
- Added w.policy_compliance_for_clusters workspace-level service.
- Added w.policy_compliance_for_jobs workspace-level service.
- Added w.resource_quotas workspace-level service.
- Added
databricks.sdk.service.catalog.GetQuotaRequest,databricks.sdk.service.catalog.GetQuotaResponse,databricks.sdk.service.catalog.ListQuotasRequest,databricks.sdk.service.catalog.ListQuotasResponseanddatabricks.sdk.service.catalog.QuotaInfodataclasses. - Added
databricks.sdk.service.compute.ClusterCompliance,databricks.sdk.service.compute.ClusterSettingsChange,databricks.sdk.service.compute.EnforceClusterComplianceRequest,databricks.sdk.service.compute.EnforceClusterComplianceResponse,databricks.sdk.service.compute.GetClusterComplianceRequest,databricks.sdk.service.compute.GetClusterComplianceResponse,databricks.sdk.service.compute.ListClusterCompliancesRequestanddatabricks.sdk.service.compute.ListClusterCompliancesResponsedataclasses. - Added
databricks.sdk.service.jobs.EnforcePolicyComplianceForJobResponseJobClusterSettingsChange,databricks.sdk.service.jobs.EnforcePolicyComplianceRequest,databricks.sdk.service.jobs.EnforcePolicyComplianceResponse,databricks.sdk.service.jobs.GetPolicyComplianceRequest,databricks.sdk.service.jobs.GetPolicyComplianceResponse,databricks.sdk.service.jobs.JobCompliance,databricks.sdk.service.jobs.ListJobComplianceForPolicyResponseanddatabricks.sdk.service.jobs.ListJobComplianceRequestdataclasses. - Added
fallbackfield fordatabricks.sdk.service.catalog.CreateExternalLocation. - Added
fallbackfield fordatabricks.sdk.service.catalog.ExternalLocationInfo. - Added
fallbackfield fordatabricks.sdk.service.catalog.UpdateExternalLocation. - Added
job_run_idfield fordatabricks.sdk.service.jobs.BaseRun. - Added
job_run_idfield fordatabricks.sdk.service.jobs.Run. - Added
include_metricsfield fordatabricks.sdk.service.sql.ListQueryHistoryRequest. - Added
statement_idsfield fordatabricks.sdk.service.sql.QueryFilter. - Removed
databricks.sdk.service.sql.ContextFilterdataclass. - Removed
context_filterfield fordatabricks.sdk.service.sql.QueryFilter. - Removed
pipeline_idandpipeline_update_idfields fordatabricks.sdk.service.sql.QuerySource.
OpenAPI SHA: 3eae49b444cac5a0118a3503e5b7ecef7f96527a, Date: 2024-08-21
Release v0.30.0 (2024-08-13)
New Features and Improvements
Bug Fixes
- Check trailing slash in host url (#681).
- Decrease runtime of recursive workspace listing test (#721).
- Fix test_get_workspace_client and test_runtime_auth_from_jobs (#719).
- Infer Azure tenant ID if not set (#638).
Internal Changes
- Add Release tag and Workflow fix (#704).
- Add apps package in docgen (#722).
- Fix processing of
quotedtitles (#712). - Improve Changelog by grouping changes (#703).
- Move PR message validation to a separate workflow (#707).
- Test that Jobs API endpoints are pinned to 2.1 (#714).
- Trigger the validate workflow in the merge queue (#709).
- Update OpenAPI spec (#715).
Other Changes
- Add Windows WorkFlow (#692).
- Fix auth tests for windows. (#697).
- Fix for cancelled workflow (#701).
- Fix test_core for windows (#702).
- Fix test_local_io for windows (#695).
- Remove duplicate ubuntu tests (#693).
- fix windows path (#660) (#673).
API Changes:
- Added
databricks.sdk.service.appspackage. - Added a.usage_dashboards account-level service.
- Added w.alerts_legacy workspace-level service, w.queries_legacy workspace-level service and w.query_visualizations_legacy workspace-level service.
- Added w.genie workspace-level service.
- Added w.notification_destinations workspace-level service.
- Added
update()method for w.clusters workspace-level service. - Added
list_visualizations()method for w.queries workspace-level service. - Added
databricks.sdk.service.catalog.GetBindingsSecurableTypeanddatabricks.sdk.service.catalog.UpdateBindingsSecurableTypedataclasses. - Added
databricks.sdk.service.billing.ActionConfiguration,databricks.sdk.service.billing.ActionConfigurationType,databricks.sdk.service.billing.AlertConfiguration,databricks.sdk.service.billing.AlertConfigurationQuantityType,databricks.sdk.service.billing.AlertConfigurationTimePeriod,databricks.sdk.service.billing.AlertConfigurationTriggerType,databricks.sdk.service.billing.BudgetConfiguration,databricks.sdk.service.billing.BudgetConfigurationFilter,databricks.sdk.service.billing.BudgetConfigurationFilterClause,databricks.sdk.service.billing.BudgetConfigurationFilterOperator,databricks.sdk.service.billing.BudgetConfigurationFilterTagClause,databricks.sdk.service.billing.BudgetConfigurationFilterWorkspaceIdClause,databricks.sdk.service.billing.CreateBillingUsageDashboardRequest,databricks.sdk.service.billing.CreateBillingUsageDashboardResponse,databricks.sdk.service.billing.CreateBudgetConfigurationBudget,databricks.sdk.service.billing.CreateBudgetConfigurationBudgetActionConfigurations,databricks.sdk.service.billing.CreateBudgetConfigurationBudgetAlertConfigurations,databricks.sdk.service.billing.CreateBudgetConfigurationRequest,databricks.sdk.service.billing.CreateBudgetConfigurationResponse,databricks.sdk.service.billing.DeleteBudgetConfigurationRequest,any,databricks.sdk.service.billing.GetBillingUsageDashboardRequest,databricks.sdk.service.billing.GetBillingUsageDashboardResponse,databricks.sdk.service.billing.GetBudgetConfigurationRequest,databricks.sdk.service.billing.GetBudgetConfigurationResponse,databricks.sdk.service.billing.ListBudgetConfigurationsRequest,databricks.sdk.service.billing.ListBudgetConfigurationsResponse,databricks.sdk.service.billing.UpdateBudgetConfigurationBudget,databricks.sdk.service.billing.UpdateBudgetConfigurationRequest,databricks.sdk.service.billing.UpdateBudgetConfigurationResponseanddatabricks.sdk.service.billing.UsageDashboardTypedataclasses. - Added
databricks.sdk.service.compute.ListClustersFilterBy,databricks.sdk.service.compute.ListClustersSortBy,databricks.sdk.service.compute.ListClustersSortByDirection,databricks.sdk.service.compute.ListClustersSortByField,databricks.sdk.service.compute.UpdateCluster,databricks.sdk.service.compute.UpdateClusterResourceandanydataclasses. - Added
databricks.sdk.service.dashboards.ExecuteMessageQueryRequest,databricks.sdk.service.dashboards.GenieAttachment,databricks.sdk.service.dashboards.GenieConversation,databricks.sdk.service.dashboards.GenieCreateConversationMessageRequest,databricks.sdk.service.dashboards.GenieGetConversationMessageRequest,databricks.sdk.service.dashboards.GenieGetMessageQueryResultRequest,databricks.sdk.service.dashboards.GenieGetMessageQueryResultResponse,databricks.sdk.service.dashboards.GenieMessage,databricks.sdk.service.dashboards.GenieStartConversationMessageRequest,databricks.sdk.service.dashboards.GenieStartConversationResponse,databricks.sdk.service.dashboards.MessageError,databricks.sdk.service.dashboards.MessageErrorType,databricks.sdk.service.dashboards.MessageStatus,databricks.sdk.service.dashboards.QueryAttachment,databricks.sdk.service.dashboards.Resultanddatabricks.sdk.service.dashboards.TextAttachmentdataclasses. - Added
any,databricks.sdk.service.iam.MigratePermissionsRequestanddatabricks.sdk.service.iam.MigratePermissionsResponsedataclasses. - Added
databricks.sdk.service.oauth2.ListCustomAppIntegrationsRequestanddatabricks.sdk.service.oauth2.ListPublishedAppIntegrationsRequestdataclasses. - Added
databricks.sdk.service.pipelines.IngestionPipelineDefinitionanddatabricks.sdk.service.pipelines.PipelineStateInfoHealthdataclasses. - Added
databricks.sdk.service.serving.GoogleCloudVertexAiConfigdataclass. - Added
databricks.sdk.service.settings.Config,databricks.sdk.service.settings.CreateNotificationDestinationRequest,databricks.sdk.service.settings.DeleteNotificationDestinationRequest,databricks.sdk.service.settings.DestinationType,databricks.sdk.service.settings.EmailConfig,any,databricks.sdk.service.settings.GenericWebhookConfig,databricks.sdk.service.settings.GetNotificationDestinationRequest,databricks.sdk.service.settings.ListNotificationDestinationsRequest,databricks.sdk.service.settings.ListNotificationDestinationsResponse,databricks.sdk.service.settings.ListNotificationDestinationsResult,databricks.sdk.service.settings.MicrosoftTeamsConfig,databricks.sdk.service.settings.NotificationDestination,databricks.sdk.service.settings.PagerdutyConfig,databricks.sdk.service.settings.SlackConfiganddatabricks.sdk.service.settings.UpdateNotificationDestinationRequestdataclasses. - Added
databricks.sdk.service.sql.AlertCondition,databricks.sdk.service.sql.AlertConditionOperand,databricks.sdk.service.sql.AlertConditionThreshold,databricks.sdk.service.sql.AlertOperandColumn,databricks.sdk.service.sql.AlertOperandValue,databricks.sdk.service.sql.AlertOperator,databricks.sdk.service.sql.ClientCallContext,databricks.sdk.service.sql.ContextFilter,databricks.sdk.service.sql.CreateAlertRequest,databricks.sdk.service.sql.CreateAlertRequestAlert,databricks.sdk.service.sql.CreateQueryRequest,databricks.sdk.service.sql.CreateQueryRequestQuery,databricks.sdk.service.sql.CreateQueryVisualizationsLegacyRequest,databricks.sdk.service.sql.CreateVisualizationRequest,databricks.sdk.service.sql.CreateVisualizationRequestVisualization,databricks.sdk.service.sql.DatePrecision,databricks.sdk.service.sql.DateRange,databricks.sdk.service.sql.DateRangeValue,databricks.sdk.service.sql.DateRangeValueDynamicDateRange,databricks.sdk.service.sql.DateValue,databricks.sdk.service.sql.DateValueDynamicDate,databricks.sdk.service.sql.DeleteAlertsLegacyRequest,databricks.sdk.service.sql.DeleteQueriesLegacyRequest,databricks.sdk.service.sql.DeleteQueryVisualizationsLegacyRequest,databricks.sdk.service.sql.DeleteVisualizationRequest,any,databricks.sdk.service.sql.EncodedText,databricks.sdk.service.sql.EncodedTextEncoding,databricks.sdk.service.sql.EnumValue,databricks.sdk.service.sql.GetAlertsLegacyRequest,databricks.sdk.service.sql.GetQueriesLegacyRequest,databricks.sdk.service.sql.LegacyAlert,databricks.sdk.service.sql.LegacyAlertState,databricks.sdk.service.sql.LegacyQuery,databricks.sdk.service.sql.LegacyVisualization,databricks.sdk.service.sql.LifecycleState,databricks.sdk.service.sql.ListAlertsRequest,databricks.sdk.service.sql.ListAlertsResponse,databricks.sdk.service.sql.ListAlertsResponseAlert,databricks.sdk.service.sql.ListQueriesLegacyRequest,databricks.sdk.service.sql.ListQueryObjectsResponse,databricks.sdk.service.sql.ListQueryObjectsResponseQuery,databricks.sdk.service.sql.ListVisualizationsForQueryRequest,databricks.sdk.service.sql.ListVisualizationsForQueryResponse,databricks.sdk.service.sql.NumericValue,databricks.sdk.service.sql.QueryBackedValue,databricks.sdk.service.sql.QueryParameter,databricks.sdk.service.sql.QuerySource,databricks.sdk.service.sql.QuerySourceDriverInfo,databricks.sdk.service.sql.QuerySourceEntryPoint,databricks.sdk.service.sql.QuerySourceJobManager,databricks.sdk.service.sql.QuerySourceTrigger,databricks.sdk.service.sql.RestoreQueriesLegacyRequest,databricks.sdk.service.sql.RunAsMode,databricks.sdk.service.sql.ServerlessChannelInfo,databricks.sdk.service.sql.StatementResponse,databricks.sdk.service.sql.TextValue,databricks.sdk.service.sql.TrashAlertRequest,databricks.sdk.service.sql.TrashQueryRequest,databricks.sdk.service.sql.UpdateAlertRequest,databricks.sdk.service.sql.UpdateAlertRequestAlert,databricks.sdk.service.sql.UpdateQueryRequest,databricks.sdk.service.sql.UpdateQueryRequestQuery,databricks.sdk.service.sql.UpdateVisualizationRequestanddatabricks.sdk.service.sql.UpdateVisualizationRequestVisualizationdataclasses. - Added
forcefield fordatabricks.sdk.service.catalog.DeleteSchemaRequest. - Added
max_resultsandpage_tokenfields fordatabricks.sdk.service.catalog.GetBindingsRequest. - Added
include_aliasesfield fordatabricks.sdk.service.catalog.GetByAliasRequest. - Added
include_aliasesfield fordatabricks.sdk.service.catalog.GetModelVersionRequest. - Added
include_aliasesfield fordatabricks.sdk.service.catalog.GetRegisteredModelRequest. - Added
max_resultsandpage_tokenfields fordatabricks.sdk.service.catalog.ListSystemSchemasRequest. - Added
next_page_tokenfield fordatabricks.sdk.service.catalog.ListSystemSchemasResponse. - Added
aliasesfield fordatabricks.sdk.service.catalog.ModelVersionInfo. - Added
next_page_tokenfield fordatabricks.sdk.service.catalog.WorkspaceBindingsResponse. - Added
versionfield fordatabricks.sdk.service.compute.GetPolicyFamilyRequest. - Added
filter_by,page_size,page_tokenandsort_byfields fordatabricks.sdk.service.compute.ListClustersRequest. - Added
next_page_tokenandprev_page_tokenfields fordatabricks.sdk.service.compute.ListClustersResponse. - Added
page_tokenfield fordatabricks.sdk.service.jobs.GetRunRequest. - Added
iterations,next_page_tokenandprev_page_tokenfields fordatabricks.sdk.service.jobs.Run. - Added
create_time,created_by,creator_usernameandscopesfields fordatabricks.sdk.service.oauth2.GetCustomAppIntegrationOutput. - Added
next_page_tokenfield fordatabricks.sdk.service.oauth2.GetCustomAppIntegrationsOutput. - Added
create_timeandcreated_byfields fordatabricks.sdk.service.oauth2.GetPublishedAppIntegrationOutput. - Added
next_page_tokenfield fordatabricks.sdk.service.oauth2.GetPublishedAppIntegrationsOutput. - Added
enable_local_disk_encryptionfield fordatabricks.sdk.service.pipelines.PipelineCluster. - Added
whlfield fordatabricks.sdk.service.pipelines.PipelineLibrary. - Added
healthfield fordatabricks.sdk.service.pipelines.PipelineStateInfo. - Added
ai21labs_api_key_plaintextfield fordatabricks.sdk.service.serving.Ai21LabsConfig. - Added
aws_access_key_id_plaintextandaws_secret_access_key_plaintextfields fordatabricks.sdk.service.serving.AmazonBedrockConfig. - Added
anthropic_api_key_plaintextfield fordatabricks.sdk.service.serving.AnthropicConfig. - Added
cohere_api_baseandcohere_api_key_plaintextfields fordatabricks.sdk.service.serving.CohereConfig. - Added
databricks_api_token_plaintextfield fordatabricks.sdk.service.serving.DatabricksModelServingConfig. - Added
google_cloud_vertex_ai_configfield fordatabricks.sdk.service.serving.ExternalModel. - Added
microsoft_entra_client_secret_plaintextandopenai_api_key_plaintextfields fordatabricks.sdk.service.serving.OpenAiConfig. - Added
palm_api_key_plaintextfield fordatabricks.sdk.service.serving.PaLmConfig. - Added
expiration_timefield fordatabricks.sdk.service.sharing.CreateRecipient. - Added
next_page_tokenfield fordatabricks.sdk.service.sharing.GetRecipientSharePermissionsResponse. - Added
next_page_tokenfield fordatabricks.sdk.service.sharing.ListProviderSharesResponse. - Added
max_resultsandpage_tokenfields fordatabricks.sdk.service.sharing.ListProvidersRequest. - Added
next_page_tokenfield fordatabricks.sdk.service.sharing.ListProvidersResponse. - Added
max_resultsandpage_tokenfields fordatabricks.sdk.service.sharing.ListRecipientsRequest. - Added
next_page_tokenfield fordatabricks.sdk.service.sharing.ListRecipientsResponse. - Added
max_resultsandpage_tokenfields fordatabricks.sdk.service.sharing.ListSharesRequest. - Added
next_page_tokenfield fordatabricks.sdk.service.sharing.ListSharesResponse. - Added
max_resultsandpage_tokenfields fordatabricks.sdk.service.sharing.SharePermissionsRequest. - Added
expiration_timefield fordatabricks.sdk.service.sharing.UpdateRecipient. - Added
max_resultsandpage_tokenfields fordatabricks.sdk.service.sharing.UpdateSharePermissions. - Added
condition,create_time,custom_body,custom_subject,display_name,lifecycle_state,owner_user_name,parent_path,query_id,seconds_to_retrigger,trigger_timeandupdate_timefields fordatabricks.sdk.service.sql.Alert. - Added
idfield fordatabricks.sdk.service.sql.GetAlertRequest. - Added
idfield fordatabricks.sdk.service.sql.GetQueryRequest. - Added
page_tokenfield fordatabricks.sdk.service.sql.ListQueriesRequest. - Added
apply_auto_limit,catalog,create_time,display_name,last_modifier_user_name,lifecycle_state,owner_user_name,parameters,parent_path,query_text,run_as_mode,schema,update_timeandwarehouse_idfields fordatabricks.sdk.service.sql.Query. - Added
context_filterfield fordatabricks.sdk.service.sql.QueryFilter. - Added
query_sourcefield fordatabricks.sdk.service.sql.QueryInfo. - Added
create_time,display_name,query_id,serialized_options,serialized_query_planandupdate_timefields fordatabricks.sdk.service.sql.Visualization. - Changed
create()method for a.budgets account-level service to returndatabricks.sdk.service.billing.CreateBudgetConfigurationResponsedataclass. - Changed
create()method for a.budgets account-level service . New request type isdatabricks.sdk.service.billing.CreateBudgetConfigurationRequestdataclass. - Changed
delete()method for a.budgets account-level service . New request type isdatabricks.sdk.service.billing.DeleteBudgetConfigurationRequestdataclass. - Changed
delete()method for a.budgets account-level service to returnanydataclass. - Changed
get()method for a.budgets account-level service . New request type isdatabricks.sdk.service.billing.GetBudgetConfigurationRequestdataclass. - Changed
get()method for a.budgets account-level service to returndatabricks.sdk.service.billing.GetBudgetConfigurationResponsedataclass. - Changed
list()method for a.budgets account-level service to returndatabricks.sdk.service.billing.ListBudgetConfigurationsResponsedataclass. - Changed
list()method for a.budgets account-level service to require request ofdatabricks.sdk.service.billing.ListBudgetConfigurationsRequestdataclass. - Changed
update()method for a.budgets account-level service to returndatabricks.sdk.service.billing.UpdateBudgetConfigurationResponsedataclass. - Changed
update()method for a.budgets account-level service . New request type isdatabricks.sdk.service.billing.UpdateBudgetConfigurationRequestdataclass. - Changed
create()method for a.custom_app_integration account-level service with new required argument order. - Changed
list()method for a.custom_app_integration account-level service to require request ofdatabricks.sdk.service.oauth2.ListCustomAppIntegrationsRequestdataclass. - Changed
list()method for a.published_app_integration account-level service to require request ofdatabricks.sdk.service.oauth2.ListPublishedAppIntegrationsRequestdataclass. - Changed
delete()method for a.workspace_assignment account-level service to returnanydataclass. - Changed
update()method for a.workspace_assignment account-level service with new required argument order. - Changed
create()method for w.alerts workspace-level service . New request type isdatabricks.sdk.service.sql.CreateAlertRequestdataclass. - Changed
delete()method for w.alerts workspace-level service to returnanydataclass. - Changed
delete()method for w.alerts workspace-level service . New request type isdatabricks.sdk.service.sql.TrashAlertRequestdataclass. - Changed
get()method for w.alerts workspace-level service with new required argument order. - Changed
list()method for w.alerts workspace-level service to returndatabricks.sdk.service.sql.ListAlertsResponsedataclass. - Changed
list()method for w.alerts workspace-level service to require request ofdatabricks.sdk.service.sql.ListAlertsRequestdataclass. - Changed
update()method for w.alerts workspace-level service to returndatabricks.sdk.service.sql.Alertdataclass. - Changed
update()method for w.alerts workspace-level service . New request type isdatabricks.sdk.service.sql.UpdateAlertRequestdataclass. - Changed
create()andedit()methods for w.cluster_policies workspace-level service with new required argument order. - Changed
get()method for w.model_versions workspace-level service to returndatabricks.sdk.service.catalog.ModelVersionInfodataclass. - Changed
migrate_permissions()method for w.permission_migration workspace-level service . New request type isdatabricks.sdk.service.iam.MigratePermissionsRequestdataclass. - Changed
migrate_permissions()method for w.permission_migration workspace-level service to returndatabricks.sdk.service.iam.MigratePermissionsResponsedataclass. - Changed
create()method for w.queries workspace-level service . New request type isdatabricks.sdk.service.sql.CreateQueryRequestdataclass. - Changed
delete()method for w.queries workspace-level service to returnanydataclass. - Changed
delete()method for w.queries workspace-level service . New request type isdatabricks.sdk.service.sql.TrashQueryRequestdataclass. - Changed
get()method for w.queries workspace-level service with new required argument order. - Changed
list()method for w.queries workspace-level service to returndatabricks.sdk.service.sql.ListQueryObjectsResponsedataclass. - Changed
update()method for w.queries workspace-level service . New request type isdatabricks.sdk.service.sql.UpdateQueryRequestdataclass. - Changed
create()method for w.query_visualizations workspace-level service . New request type isdatabricks.sdk.service.sql.CreateVisualizationRequestdataclass. - Changed
delete()method for w.query_visualizations workspace-level service to returnanydataclass. - Changed
delete()method for w.query_visualizations workspace-level service . New request type isdatabricks.sdk.service.sql.DeleteVisualizationRequestdataclass. - Changed
update()method for w.query_visualizations workspace-level service . New request type isdatabricks.sdk.service.sql.UpdateVisualizationRequestdataclass. - Changed
list()method for w.shares workspace-level service to require request ofdatabricks.sdk.service.sharing.ListSharesRequestdataclass. - Changed
execute_statement()andget_statement()methods for w.statement_execution workspace-level service to returndatabricks.sdk.service.sql.StatementResponsedataclass. - Changed
securable_typefield fordatabricks.sdk.service.catalog.GetBindingsRequesttodatabricks.sdk.service.catalog.GetBindingsSecurableTypedataclass. - Changed
securable_typefield fordatabricks.sdk.service.catalog.UpdateWorkspaceBindingsParameterstodatabricks.sdk.service.catalog.UpdateBindingsSecurableTypedataclass. - Changed
namefield fordatabricks.sdk.service.compute.CreatePolicyto no longer be required. - Changed
namefield fordatabricks.sdk.service.compute.EditPolicyto no longer be required. - Changed
policy_family_idfield fordatabricks.sdk.service.compute.GetPolicyFamilyRequesttostrdataclass. - Changed
policy_familiesfield fordatabricks.sdk.service.compute.ListPolicyFamiliesResponseto no longer be required. - Changed
definition,description,nameandpolicy_family_idfields fordatabricks.sdk.service.compute.PolicyFamilyto no longer be required. - Changed
permissionsfield fordatabricks.sdk.service.iam.UpdateWorkspaceAssignmentsto no longer be required. - Changed
access_control_listfield fordatabricks.sdk.service.jobs.CreateJobtodatabricks.sdk.service.jobs.JobAccessControlRequestListdataclass. - Changed
access_control_listfield fordatabricks.sdk.service.jobs.SubmitRuntodatabricks.sdk.service.jobs.JobAccessControlRequestListdataclass. - Changed
nameandredirect_urlsfields fordatabricks.sdk.service.oauth2.CreateCustomAppIntegrationto no longer be required. - Changed
ingestion_definitionfield fordatabricks.sdk.service.pipelines.CreatePipelinetodatabricks.sdk.service.pipelines.IngestionPipelineDefinitiondataclass. - Changed
ingestion_definitionfield fordatabricks.sdk.service.pipelines.EditPipelinetodatabricks.sdk.service.pipelines.IngestionPipelineDefinitiondataclass. - Changed
ingestion_definitionfield fordatabricks.sdk.service.pipelines.PipelineSpectodatabricks.sdk.service.pipelines.IngestionPipelineDefinitiondataclass. - Changed
ai21labs_api_keyfield fordatabricks.sdk.service.serving.Ai21LabsConfigto no longer be required. - Changed
aws_access_key_idandaws_secret_access_keyfields fordatabricks.sdk.service.serving.AmazonBedrockConfigto no longer be required. - Changed
anthropic_api_keyfield fordatabricks.sdk.service.serving.AnthropicConfigto no longer be required. - Changed
cohere_api_keyfield fordatabricks.sdk.service.serving.CohereConfigto no longer be required. - Changed
databricks_api_tokenfield fordatabricks.sdk.service.serving.DatabricksModelServingConfigto no longer be required. - Changed
palm_api_keyfield fordatabricks.sdk.service.serving.PaLmConfigto no longer be required. - Changed
tagsfield fordatabricks.sdk.service.sql.Querytodatabricks.sdk.service.sql.Listdataclass. - Changed
user_idsandwarehouse_idsfields fordatabricks.sdk.service.sql.QueryFiltertodatabricks.sdk.service.sql.Listdataclass. - Changed
resultsfield fordatabricks.sdk.service.sql.QueryListtodatabricks.sdk.service.sql.LegacyQueryListdataclass. - Changed
visualizationfield fordatabricks.sdk.service.sql.Widgettodatabricks.sdk.service.sql.LegacyVisualizationdataclass. - Removed w.apps workspace-level service.
- Removed
restore()method for w.queries workspace-level service. - Removed
databricks.sdk.service.marketplace.FilterType,databricks.sdk.service.marketplace.ProviderIconFile,databricks.sdk.service.marketplace.ProviderIconType,databricks.sdk.service.marketplace.ProviderListingSummaryInfo,databricks.sdk.service.marketplace.SortByanddatabricks.sdk.service.marketplace.VisibilityFilterdataclasses. - Removed
databricks.sdk.service.billing.Budget,databricks.sdk.service.billing.BudgetAlert,databricks.sdk.service.billing.BudgetList,databricks.sdk.service.billing.BudgetWithStatus,databricks.sdk.service.billing.BudgetWithStatusStatusDailyItem,databricks.sdk.service.billing.DeleteBudgetRequest,any,databricks.sdk.service.billing.GetBudgetRequest,any,databricks.sdk.service.billing.WrappedBudgetanddatabricks.sdk.service.billing.WrappedBudgetWithStatusdataclasses. - Removed
any,databricks.sdk.service.iam.PermissionMigrationRequestanddatabricks.sdk.service.iam.PermissionMigrationResponsedataclasses. - Removed
databricks.sdk.service.pipelines.ManagedIngestionPipelineDefinitiondataclass. - Removed
databricks.sdk.service.serving.App,databricks.sdk.service.serving.AppDeployment,databricks.sdk.service.serving.AppDeploymentArtifacts,databricks.sdk.service.serving.AppDeploymentMode,databricks.sdk.service.serving.AppDeploymentState,databricks.sdk.service.serving.AppDeploymentStatus,databricks.sdk.service.serving.AppEnvironment,databricks.sdk.service.serving.AppState,databricks.sdk.service.serving.AppStatus,databricks.sdk.service.serving.CreateAppDeploymentRequest,databricks.sdk.service.serving.CreateAppRequest,databricks.sdk.service.serving.DeleteAppRequest,databricks.sdk.service.serving.EnvVariable,databricks.sdk.service.serving.GetAppDeploymentRequest,databricks.sdk.service.serving.GetAppEnvironmentRequest,databricks.sdk.service.serving.GetAppRequest,databricks.sdk.service.serving.ListAppDeploymentsRequest,databricks.sdk.service.serving.ListAppDeploymentsResponse,databricks.sdk.service.serving.ListAppsRequest,databricks.sdk.service.serving.ListAppsResponse,databricks.sdk.service.serving.StartAppRequest,databricks.sdk.service.serving.StopAppRequest,anyanddatabricks.sdk.service.serving.UpdateAppRequestdataclasses. - Removed
databricks.sdk.service.sql.CreateQueryVisualizationRequest,databricks.sdk.service.sql.DeleteAlertRequest,databricks.sdk.service.sql.DeleteQueryRequest,databricks.sdk.service.sql.DeleteQueryVisualizationRequest,databricks.sdk.service.sql.ExecuteStatementResponse,databricks.sdk.service.sql.GetStatementResponse,databricks.sdk.service.sql.RestoreQueryRequest,databricks.sdk.service.sql.StatementId,databricks.sdk.service.sql.UserIdanddatabricks.sdk.service.sql.WarehouseIddataclasses. - Removed
databricks.sdk.service.compute.PolicyFamilyIddataclass. - Removed
can_use_clientfield fordatabricks.sdk.service.compute.ListClustersRequest. - Removed
is_ascendingandsort_byfields fordatabricks.sdk.service.marketplace.ListListingsRequest. - Removed
provider_summaryfield fordatabricks.sdk.service.marketplace.Listing. - Removed
filtersfield fordatabricks.sdk.service.marketplace.ListingSetting. - Removed
metastore_idfield fordatabricks.sdk.service.marketplace.ListingSummary. - Removed
is_ascendingandsort_byfields fordatabricks.sdk.service.marketplace.SearchListingsRequest. - Removed
created_at,last_triggered_at,name,options,parent,query,rearm,updated_atanduserfields fordatabricks.sdk.service.sql.Alert. - Removed
alert_idfield fordatabricks.sdk.service.sql.GetAlertRequest. - Removed
query_idfield fordatabricks.sdk.service.sql.GetQueryRequest. - Removed
order,pageandqfields fordatabricks.sdk.service.sql.ListQueriesRequest. - Removed
include_metricsfield fordatabricks.sdk.service.sql.ListQueryHistoryRequest. - Removed
can_edit,created_at,data_source_id,is_archived,is_draft,is_favorite,is_safe,last_modified_by,last_modified_by_id,latest_query_data_id,name,options,parent,permission_tier,query,query_hash,run_as_role,updated_at,user,user_idandvisualizationsfields fordatabricks.sdk.service.sql.Query. - Removed
statement_idsfield fordatabricks.sdk.service.sql.QueryFilter. - Removed
can_subscribe_to_live_queryfield fordatabricks.sdk.service.sql.QueryInfo. - Removed
metadata_time_ms,planning_time_msandquery_execution_time_msfields fordatabricks.sdk.service.sql.QueryMetrics. - Removed
created_at,description,name,options,queryandupdated_atfields fordatabricks.sdk.service.sql.Visualization.
OpenAPI SHA: f98c07f9c71f579de65d2587bb0292f83d10e55d, Date: 2024-08-12
Release v0.29.0 (2024-06-24)
Breaking Changes
- Create a method to generate OAuth tokens (#644)
NOTE: this change renames @credentials_provider/CredentialsProvider to @credentials_strategy/CredentialsStrategy.
Improvements and Bug Fixes
- Patch
dbutils.notebook.entry_point...to return current local notebook path from env var (#618). - Add
serverless_compute_idfield to the config (#685). - Added
with_product(...)andwith_user_agent_extra(...)public functions to improve telemetry for mid-stream libraries (#679). - Fixed Interactive OAuth on Azure & updated documentations (#669).
Documentation
- Fix documentation examples (#676).
Internal Changes
- Ignore DataPlane Services during generation (#663).
- Update OpenAPI spec (#667).
- Retry failed integration tests (#674).
API Changes
- Changed
list()method for a.account_storage_credentials account-level service to returndatabricks.sdk.service.catalog.ListAccountStorageCredentialsResponsedataclass. - Changed
isolation_modefield fordatabricks.sdk.service.catalog.CatalogInfotodatabricks.sdk.service.catalog.CatalogIsolationModedataclass. - Added
isolation_modefield fordatabricks.sdk.service.catalog.ExternalLocationInfo. - Added
max_resultsandpage_tokenfields fordatabricks.sdk.service.catalog.ListCatalogsRequest. - Added
next_page_tokenfield fordatabricks.sdk.service.catalog.ListCatalogsResponse. - Added
table_serving_urlfield fordatabricks.sdk.service.catalog.OnlineTable. - Added
isolation_modefield fordatabricks.sdk.service.catalog.StorageCredentialInfo. - Changed
isolation_modefield fordatabricks.sdk.service.catalog.UpdateCatalogtodatabricks.sdk.service.catalog.CatalogIsolationModedataclass. - Added
isolation_modefield fordatabricks.sdk.service.catalog.UpdateExternalLocation. - Added
isolation_modefield fordatabricks.sdk.service.catalog.UpdateStorageCredential. - Added
databricks.sdk.service.catalog.CatalogIsolationModeanddatabricks.sdk.service.catalog.ListAccountStorageCredentialsResponsedataclasses. - Added
create_schedule(),create_subscription(),delete_schedule(),delete_subscription(),get_schedule(),get_subscription(),list(),list_schedules(),list_subscriptions()andupdate_schedule()methods for w.lakeview workspace-level service. - Added
databricks.sdk.service.dashboards.CreateScheduleRequest,databricks.sdk.service.dashboards.CreateSubscriptionRequest,databricks.sdk.service.dashboards.CronSchedule,databricks.sdk.service.dashboards.DashboardView,databricks.sdk.service.dashboards.DeleteScheduleRequest,databricks.sdk.service.dashboards.DeleteSubscriptionRequestdataclass,databricks.sdk.service.dashboards.GetScheduleRequest,databricks.sdk.service.dashboards.GetSubscriptionRequest,databricks.sdk.service.dashboards.ListDashboardsRequest,databricks.sdk.service.dashboards.ListDashboardsResponse,databricks.sdk.service.dashboards.ListSchedulesRequest,databricks.sdk.service.dashboards.ListSchedulesResponse,databricks.sdk.service.dashboards.ListSubscriptionsRequest,databricks.sdk.service.dashboards.ListSubscriptionsResponse,databricks.sdk.service.dashboards.Schedule,databricks.sdk.service.dashboards.SchedulePauseStatus,databricks.sdk.service.dashboards.Subscriber,databricks.sdk.service.dashboards.Subscription,databricks.sdk.service.dashboards.SubscriptionSubscriberDestination,databricks.sdk.service.dashboards.SubscriptionSubscriberUseranddatabricks.sdk.service.dashboards.UpdateScheduleRequestdataclasses. - Added
termination_categoryfield fordatabricks.sdk.service.jobs.ForEachTaskErrorMessageStats. - Added
on_streaming_backlog_exceededfield fordatabricks.sdk.service.jobs.JobEmailNotifications. - Added
environment_keyfield fordatabricks.sdk.service.jobs.RunTask. - Removed
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
environmentsfield fordatabricks.sdk.service.jobs.SubmitRun. - Added
dbt_taskfield fordatabricks.sdk.service.jobs.SubmitTask. - Added
environment_keyfield fordatabricks.sdk.service.jobs.SubmitTask. - Added
on_streaming_backlog_exceededfield fordatabricks.sdk.service.jobs.TaskEmailNotifications. - Added
periodicfield fordatabricks.sdk.service.jobs.TriggerSettings. - Added
on_streaming_backlog_exceededfield fordatabricks.sdk.service.jobs.WebhookNotifications. - Added
databricks.sdk.service.jobs.PeriodicTriggerConfigurationdataclass. - Added
databricks.sdk.service.jobs.PeriodicTriggerConfigurationTimeUnitdataclass. - Added
batch_get()method for w.consumer_listings workspace-level service. - Added
batch_get()method for w.consumer_providers workspace-level service. - Added
provider_summaryfield fordatabricks.sdk.service.marketplace.Listing. - Added
databricks.sdk.service.marketplace.BatchGetListingsRequest,databricks.sdk.service.marketplace.BatchGetListingsResponse,databricks.sdk.service.marketplace.BatchGetProvidersRequest,databricks.sdk.service.marketplace.BatchGetProvidersResponse,databricks.sdk.service.marketplace.ProviderIconFile,databricks.sdk.service.marketplace.ProviderIconType,databricks.sdk.service.marketplace.ProviderListingSummaryInfoanddatabricks.sdk.service.oauth2.DataPlaneInfodataclasses. - Removed
create_deployment()method for w.apps workspace-level service. - Added
deploy()andstart()method1 for w.apps workspace-level service. - Added w.serving_endpoints_data_plane workspace-level service.
- Added
service_principal_idandservice_principal_namefields fordatabricks.sdk.service.serving.App. - Added
modefield fordatabricks.sdk.service.serving.AppDeployment. - Added
modefield fordatabricks.sdk.service.serving.CreateAppDeploymentRequest. - Added
data_plane_infofield fordatabricks.sdk.service.serving.ServingEndpointDetailed. - Added
databricks.sdk.service.serving.AppDeploymentMode,databricks.sdk.service.serving.ModelDataPlaneInfoanddatabricks.sdk.service.serving.StartAppRequestdataclasses. - Added
query_next_page()method for w.vector_search_indexes workspace-level service. - Added
query_typefield fordatabricks.sdk.service.vectorsearch.QueryVectorIndexRequest. - Added
next_page_tokenfield fordatabricks.sdk.service.vectorsearch.QueryVectorIndexResponse.
OpenAPI SHA: 7437dabb9dadee402c1fc060df4c1ce8cc5369f0, Date: 2024-06-24
Release v0.28.0 (2024-05-23)
Improvements and new features
- Better error message when private link enabled workspaces reject requests (#647).
API Changes:
- Renamed w.lakehouse_monitors workspace-level service to w.quality_monitors .
- Added
databricks.sdk.service.vectorsearch.ListValuedataclass. - Added
databricks.sdk.service.vectorsearch.MapStringValueEntrydataclass. - Added
databricks.sdk.service.vectorsearch.ScanVectorIndexRequestdataclass. - Added
databricks.sdk.service.vectorsearch.ScanVectorIndexResponsedataclass. - Added
databricks.sdk.service.vectorsearch.Structdataclass. - Added
databricks.sdk.service.vectorsearch.Valuedataclass. - Added
databricks.sdk.service.catalog.ListConnectionsRequestdataclass. - Added
databricks.sdk.service.catalog.MonitorRefreshListResponsedataclass. - Added
databricks.sdk.service.pipelines.IngestionGatewayPipelineDefinitiondataclass. - Added
databricks.sdk.service.pipelines.TableSpecificConfigdataclass. - Added
databricks.sdk.service.pipelines.TableSpecificConfigScdTypedataclass. - Added
databricks.sdk.service.serving.AppDeploymentArtifactsdataclass. - Removed
databricks.sdk.service.catalog.EnableSchemaNamedataclass. - Removed
databricks.sdk.service.catalog.DisableSchemaNamedataclass. - Removed
databricks.sdk.service.marketplace.SortBySpecdataclass. - Removed
databricks.sdk.service.marketplace.SortOrderdataclass. - Renamed
databricks.sdk.service.catalog.DeleteLakehouseMonitorRequestdataclass todatabricks.sdk.service.catalog.DeleteQualityMonitorRequest. - Renamed
databricks.sdk.service.catalog.GetLakehouseMonitorRequestdataclass todatabricks.sdk.service.catalog.GetQualityMonitorRequest. - Added
next_page_tokenfield fordatabricks.sdk.service.catalog.ListConnectionsResponse. - Added
dashboard_idfield fordatabricks.sdk.service.catalog.UpdateMonitor. - Added
is_ascendingandsort_byfields fordatabricks.sdk.service.marketplace.ListListingsRequest. - Added
is_ascendingfield fordatabricks.sdk.service.marketplace.SearchListingsRequest. - Added
gateway_definitionfield fordatabricks.sdk.service.pipelines.CreatePipeline. - Added
gateway_definitionfield fordatabricks.sdk.service.pipelines.EditPipeline. - Added
table_configurationfield fordatabricks.sdk.service.pipelines.ManagedIngestionPipelineDefinition. - Added
gateway_definitionfield fordatabricks.sdk.service.pipelines.PipelineSpec. - Added
table_configurationfield fordatabricks.sdk.service.pipelines.SchemaSpec. - Added
table_configurationfield fordatabricks.sdk.service.pipelines.TableSpec. - Added
deployment_artifactsfield fordatabricks.sdk.service.serving.AppDeployment. - Added
route_optimizedfield fordatabricks.sdk.service.serving.CreateServingEndpoint. - Added
contentsfield fordatabricks.sdk.service.serving.ExportMetricsResponse. - Added
microsoft_entra_client_id,microsoft_entra_client_secretandmicrosoft_entra_tenant_idfields fordatabricks.sdk.service.serving.OpenAiConfig. - Added
endpoint_urlandroute_optimizedfields fordatabricks.sdk.service.serving.ServingEndpointDetailed. - Added
storage_rootfield fordatabricks.sdk.service.sharing.CreateShare. - Added
storage_locationandstorage_rootfields fordatabricks.sdk.service.sharing.ShareInfo. - Added
storage_rootfield fordatabricks.sdk.service.sharing.UpdateShare. - Added
embedding_writeback_tablefield fordatabricks.sdk.service.vectorsearch.DeltaSyncVectorIndexSpecRequest. - Added
embedding_writeback_tablefield fordatabricks.sdk.service.vectorsearch.DeltaSyncVectorIndexSpecResponse. - Changed
schema_namefield fordatabricks.sdk.service.catalog.DisableRequesttostrdataclass. - Changed
schema_namefield fordatabricks.sdk.service.catalog.EnableRequesttostrdataclass. - Changed
cluster_status()method for w.libraries workspace-level service to returndatabricks.sdk.service.compute.ClusterLibraryStatusesdataclass. - Changed
specandcluster_sourcefields fordatabricks.sdk.service.compute.ClusterDetailstodatabricks.sdk.service.compute.ClusterSpecdataclass. - Changed
openai_api_keyfield fordatabricks.sdk.service.serving.OpenAiConfigto no longer be required. - Removed
cluster_sourcefield fordatabricks.sdk.service.compute.ClusterAttributes. - Removed
cluster_sourcefield fordatabricks.sdk.service.compute.ClusterSpec. - Removed
databricks.sdk.service.compute.ClusterStatusResponsedataclass. - Removed
cluster_sourcefield fordatabricks.sdk.service.compute.CreateCluster. - Removed
clone_fromandcluster_sourcefields fordatabricks.sdk.service.compute.EditCluster. - Removed
sort_by_specfield fordatabricks.sdk.service.marketplace.ListListingsRequest. - Added
scan_index()method for w.vector_search_indexes workspace-level service. - Changed
list()method for w.connections workspace-level service to require request ofdatabricks.sdk.service.catalog.ListConnectionsRequestdataclass.
OpenAPI SHA: 7eb5ad9a2ed3e3f1055968a2d1014ac92c06fe92, Date: 2024-05-21
Release v0.27.1 (2024-05-16)
Bug Fixes
- Fix null body response to empty in ApiClient (#579).
Release v0.27.0 (2024-05-03)
New Features
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
Release v0.26.0 (2024-04-24)
- 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
Release v0.25.1 (2024-04-12)
Bug fixes:
- Fixed
select_node_typeerror (#614).
Release v0.25.0 (2024-04-11)
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 a ResourceNotFoundException instead in this circumstance. To handle this change, modify error handling by updating your
exceptblocks from:
try:
w.jobs.get_by_id("123")
except e as InvalidParameterValue:
...
to
try:
w.jobs.get_by_id("123")
except e as 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.sdk.service.catalog.ValidationResultAwsOperationdataclass. - Added
databricks.sdk.service.catalog.ValidationResultAzureOperationdataclass. - Added
databricks.sdk.service.catalog.ValidationResultGcpOperationdataclass. - Added
clone_fromfield fordatabricks.sdk.service.compute.ClusterSpec. - Removed
databricks.sdk.service.compute.ComputeSpecdataclass. - Removed
databricks.sdk.service.compute.ComputeSpecKinddataclass. - Added
clone_fromfield fordatabricks.sdk.service.compute.CreateCluster. - Added
clone_fromfield fordatabricks.sdk.service.compute.EditCluster. - Added
databricks.sdk.service.compute.CloneClusterdataclass. - Added
databricks.sdk.service.compute.Environmentdataclass. - Changed
update()method for a.workspace_assignment account-level service to returndatabricks.sdk.service.iam.PermissionAssignmentdataclass. - Removed
anydataclass. - Removed
compute_keyfield fordatabricks.sdk.service.jobs.ClusterSpec. - Removed
computefield fordatabricks.sdk.service.jobs.CreateJob. - Added
environmentsfield fordatabricks.sdk.service.jobs.CreateJob. - Removed
databricks.sdk.service.jobs.JobComputedataclass. - Removed
computefield fordatabricks.sdk.service.jobs.JobSettings. - Added
environmentsfield fordatabricks.sdk.service.jobs.JobSettings. - Removed
compute_keyfield fordatabricks.sdk.service.jobs.RunTask. - Removed
databricks.sdk.service.jobs.TableTriggerConfigurationdataclass. - Removed
compute_keyfield fordatabricks.sdk.service.jobs.Task. - Added
environment_keyfield fordatabricks.sdk.service.jobs.Task. - Changed
tablefield fordatabricks.sdk.service.jobs.TriggerSettingstodatabricks.sdk.service.jobs.TableUpdateTriggerConfigurationdataclass. - Changed
table_updatefield fordatabricks.sdk.service.jobs.TriggerSettingstodatabricks.sdk.service.jobs.TableUpdateTriggerConfigurationdataclass. - Added
databricks.sdk.service.jobs.JobEnvironmentdataclass. - Added
databricks.sdk.service.jobs.TableUpdateTriggerConfigurationdataclass. - Added
databricks.sdk.service.marketplacepackage.
OpenAPI SHA: 94684175b8bd65f8701f89729351f8069e8309c9, Date: 2024-04-11
Release v0.24.0 (2024-04-02)
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
Release v0.23.0 (2024-03-20)
- Add CONTRIBUTING.md (#585).
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
Release v0.22.0 (2024-03-15)
- 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
Release v0.21.0 (2024-03-07)
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.databricks.sdk.service.settings.DeletePersonalComputeSettingRequestdataclass.databricks.sdk.service.settings.DeleteRestrictWorkspaceAdminsSettingRequestdataclass.databricks.sdk.service.settings.GetDefaultNamespaceSettingRequestdataclass.databricks.sdk.service.settings.GetPersonalComputeSettingRequestdataclass.databricks.sdk.service.settings.GetRestrictWorkspaceAdminsSettingRequestdataclass.databricks.sdk.service.vectorsearch.EmbeddingConfigdataclass.embedding_configfield fordatabricks.sdk.service.vectorsearch.EmbeddingSourceColumn.namefield fordatabricks.sdk.service.vectorsearch.DeleteDataVectorIndexRequest.namefield fordatabricks.sdk.service.vectorsearch.DeleteEndpointRequest.planning_phasesfield fordatabricks.sdk.service.sql.QueryMetrics.delta_sync_vector_index_specfield fordatabricks.sdk.service.vectorsearch.VectorIndex.direct_access_vector_index_specfield fordatabricks.sdk.service.vectorsearch.VectorIndex.
Internal Changes
- Added tokei.rs badge (#567).
- Update SDK to latest OpenAPI spec (#576).
- Add integration tests for Files API (#552).
- Fix integer deserialization for headers (#553).
- Support subservices (#559).
- Distinguish between empty types and fields that can take any value (#561).
OpenAPI SHA: 1026b998b14fba1b8317528f47778240dc4e9a5d, Date: 2024-03-06
Release v0.20.0 (2024-02-19)
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.GetCleanRoomRequestanddatabricks.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
Release v0.19.1 (2024-02-15)
New features:
- Add
get_workspace_id()to WorkspaceClient (#537).
Bugfix:
- Create a deepcopy of config when creating workspace client from account client (#542). This fixes an issue where
AccountClientinstances would stop working after callingget_workspace_client().
Release v0.19.0 (2024-02-09)
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.mappingtodatabricks.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.CancelRefreshRequestdatabricks.sdk.service.catalog.GetRefreshRequestdatabricks.sdk.service.catalog.ListRefreshesRequestdatabricks.sdk.service.catalog.MonitorRefreshInfodatabricks.sdk.service.catalog.MonitorRefreshInfoStatedatabricks.sdk.service.catalog.RunRefreshRequestdatabricks.sdk.service.compute.Adlsgen2Infodatabricks.sdk.service.compute.GcsStorageInfodatabricks.sdk.service.files.CreateDirectoryRequestdatabricks.sdk.service.files.DeleteDirectoryRequestdatabricks.sdk.service.files.DirectoryEntrydatabricks.sdk.service.files.ListDirectoryContentsRequestdatabricks.sdk.service.files.ListDirectoryResponsedatabricks.sdk.service.files.PageTokendatabricks.sdk.service.jobs.ForEachStatsdatabricks.sdk.service.jobs.ForEachTaskdatabricks.sdk.service.jobs.ForEachTaskErrorMessageStatsdatabricks.sdk.service.jobs.ForEachTaskTaskRunStatsdatabricks.sdk.service.jobs.RunForEachTaskdatabricks.sdk.service.pipelines.PipelineClusterAutoscaledatabricks.sdk.service.pipelines.PipelineClusterAutoscaleModedatabricks.sdk.service.settings.DeleteDefaultNamespaceSettingRequestdatabricks.sdk.service.settings.DeleteDefaultNamespaceSettingResponsedatabricks.sdk.service.settings.DeleteRestrictWorkspaceAdminsSettingRequestdatabricks.sdk.service.settings.DeleteRestrictWorkspaceAdminsSettingResponsedatabricks.sdk.service.settings.GetDefaultNamespaceSettingRequestdatabricks.sdk.service.settings.GetPersonalComputeSettingRequestdatabricks.sdk.service.settings.GetRestrictWorkspaceAdminsSettingRequestdatabricks.sdk.service.settings.RestrictWorkspaceAdminsMessagedatabricks.sdk.service.settings.RestrictWorkspaceAdminsMessageStatusdatabricks.sdk.service.settings.RestrictWorkspaceAdminsSettingdatabricks.sdk.service.settings.UpdateDefaultNamespaceSettingRequestdatabricks.sdk.service.settings.UpdateRestrictWorkspaceAdminsSettingRequest
- Added
cancel_refresh(),get_refresh(),list_refreshes()andrun_refresh()method for w.lakehouse_monitors workspace-level service. - Added
use_preemptible_executorsfield fordatabricks.sdk.service.compute.GcpAttributes. - Added
zone_idfield fordatabricks.sdk.service.compute.GcpAttributes. - Added
abfssandgcsfield fordatabricks.sdk.service.compute.InitScriptInfo. - Added
create_directory(),delete_directory()andlist_directory_contents()method for w.files workspace-level service. - Added
sourcefield fordatabricks.sdk.service.jobs.DbtTaskanddatabricks.sdk.service.jobs.SqlTaskFile. - Added
for_each_taskfield fordatabricks.sdk.service.jobs.RunTask,databricks.sdk.service.jobs.SubmitTaskanddatabricks.sdk.service.jobs.Task. - Added
field_maskfield fordatabricks.sdk.service.settings.UpdatePersonalComputeSettingRequest. - Added
delta_sync_index_specfield fordatabricks.sdk.service.vectorsearch.CreateVectorIndexRequest. - Added
file_typefield fordatabricks.sdk.service.workspace.ExportResponse. - Added
resource_idfield 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.ReadDefaultWorkspaceNamespaceRequestdatabricks.sdk.service.settings.ReadPersonalComputeSettingRequestdatabricks.sdk.service.settings.UpdateDefaultWorkspaceNamespaceRequestdatabricks.sdk.service.settings.DeleteDefaultWorkspaceNamespaceRequestdatabricks.sdk.service.settings.DeleteDefaultWorkspaceNamespaceResponsedatabricks.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
namefield fordatabricks.sdk.service.catalog.UpdateConnection,databricks.sdk.service.catalog.UpdateMetastore,databricks.sdk.service.catalog.UpdateRegisteredModelRequest.databricks.sdk.service.catalog.UpdateSchemaanddatabricks.sdk.service.catalog.UpdateVolumeRequestContent. - Removed
delta_sync_vector_index_specfield fordatabricks.sdk.service.vectorsearch.CreateVectorIndexRequest.
Changes:
- Changed
max_workersandmin_workersfield fordatabricks.sdk.service.compute.AutoScaleto no longer be required. - Changed
destinationfield fordatabricks.sdk.service.compute.DbfsStorageInfo,databricks.sdk.service.compute.LocalFileInfo,databricks.sdk.service.compute.S3StorageInfo,databricks.sdk.service.compute.VolumesStorageInfoanddatabricks.sdk.service.compute.WorkspaceStorageInfoto be required. - Changed
clientsfield fordatabricks.sdk.service.compute.WorkloadTypeto be required. - Changed
allow_missingandsettingfield fordatabricks.sdk.service.settings.UpdatePersonalComputeSettingRequestto be required. - Changed
etagfield fordatabricks.sdk.service.settings.DeletePersonalComputeSettingRequestto no longer be required. - Changed
autoscalefield fordatabricks.sdk.service.pipelines.PipelineClustertodatabricks.sdk.service.pipelines.PipelineClusterAutoscaledataclass. - 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
Release v0.18.0 (2024-01-23)
Bugfixes:
- Fix Databricks OAuth M2M on Azure (#513).
Other noteworthy changes:
- Use
[]instead ofNoneas 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.TableExistsResponseanddatabricks.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.GetTokenResponsedataclass. - Changed
lifetime_secondsfield fordatabricks.sdk.service.settings.CreateOboTokenRequestto no longer be required. - Added
databricks.sdk.service.settings.GetTokenResponsedataclass.
OpenAPI SHA: e05401ed5dd4974c5333d737ec308a7d451f749f, Date: 2024-01-23
Release v0.17.0 (2024-01-11)
- Use covariant type for
@retried(on=[...])(#486). - Configure request timeout using existing parameter from Config (#489).
- Make contents of
__init__.pyequal 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.ListPublicTokensResponsedataclass. - Changed
list()method for w.external_locations workspace-level service to require request ofdatabricks.sdk.service.catalog.ListExternalLocationsRequestdataclass and w.storage_credentials workspace-level service to require request ofdatabricks.sdk.service.catalog.ListStorageCredentialsRequestdataclass. - Added
next_page_tokenfield fordatabricks.sdk.service.catalog.ListExternalLocationsResponse,databricks.sdk.service.catalog.ListFunctionsResponse,databricks.sdk.service.catalog.ListSchemasResponseanddatabricks.sdk.service.catalog.ListStorageCredentialsResponse. - Added
max_resultsfield fordatabricks.sdk.service.catalog.ListFunctionsRequestanddatabricks.sdk.service.catalog.ListSchemasRequest. - Added
page_tokenfield fordatabricks.sdk.service.catalog.ListFunctionsRequestanddatabricks.sdk.service.catalog.ListSchemasRequest. - Added
omit_columnsfield fordatabricks.sdk.service.catalog.ListTablesRequest. - Added
omit_propertiesfield fordatabricks.sdk.service.catalog.ListTablesRequest. - Added
init_scriptsfield fordatabricks.sdk.service.pipelines.PipelineCluster. - Added
validate_onlyfield fordatabricks.sdk.service.pipelines.StartUpdateanddatabricks.sdk.service.pipelines.UpdateInfo. - Changed
create()method for w.dashboards workspace-level service . New request type isdatabricks.sdk.service.sql.DashboardPostContentdataclass. - Added
update()method for w.dashboards workspace-level service. - Added
http_headersfield fordatabricks.sdk.service.sql.ExternalLink. - Added
run_as_rolefield fordatabricks.sdk.service.sql.QueryEditContent. - Added package:
databricks.sdk.service.dashboardsanddatabricks.sdk.service.vectorsearch. - Added dataclass:
databricks.sdk.service.catalog.ListExternalLocationsRequest,databricks.sdk.service.catalog.ListStorageCredentialsRequest,databricks.sdk.service.settings.ListPublicTokensResponse,databricks.sdk.service.sql.DashboardEditContentanddatabricks.sdk.service.sql.DashboardPostContent. - Removed dataclass:
databricks.sdk.service.catalog.TableConstraintListanddatabricks.sdk.service.sql.CreateDashboardRequest.
OpenAPI SHA: 0e0d4cbe87193e36c73b8b2be3b0dd0f1b013e00, Date: 2024-01-10
Release v0.16.0 (2023-12-20)
- Sort imports in service template (#479).
- Add
py.typedto support PEP-561 (#483). - Fixed bug in
@retriedwhen exception subtypes were not respected (#484). - Make
WorkspaceClientandAccountClientmore friendly with autospeccing (#480).
API Changes:
- Added
azure_workspace_infofield fordatabricks.sdk.service.provisioning.Workspace. - Added
databricks.sdk.service.provisioning.AzureWorkspaceInfodataclass. - Changed
update_config()method for w.serving_endpoints workspace-level service with new required argument order. - Changed
served_entitiesfield fordatabricks.sdk.service.serving.EndpointCoreConfigInputto 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_addressesfield fordatabricks.sdk.service.settings.CreateIpAccessListto no longer be required. - Changed
ip_addressesfield fordatabricks.sdk.service.settings.ReplaceIpAccessListto no longer be required. - Removed
list_idfield fordatabricks.sdk.service.settings.ReplaceIpAccessList. - Changed
enabledfield fordatabricks.sdk.service.settings.UpdateIpAccessListto no longer be required. - Changed
ip_addressesfield fordatabricks.sdk.service.settings.UpdateIpAccessListto no longer be required. - Changed
labelfield fordatabricks.sdk.service.settings.UpdateIpAccessListto no longer be required. - Removed
list_idfield fordatabricks.sdk.service.settings.UpdateIpAccessList. - Changed
list_typefield fordatabricks.sdk.service.settings.UpdateIpAccessListto no longer be required.
OpenAPI SHA: d3853c8dee5806d04da2ae8910f273ffb35719a5, Date: 2023-12-14
Release v0.15.0 (2023-12-12)
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_tokenfield fordatabricks.sdk.service.catalog.CreateStorageCredential. - Added
cloudflare_api_tokenfield fordatabricks.sdk.service.catalog.StorageCredentialInfo. - Changed
namefield fordatabricks.sdk.service.catalog.UpdateCatalogto be required. - Added
new_namefield fordatabricks.sdk.service.catalog.UpdateCatalog. - Changed
namefield fordatabricks.sdk.service.catalog.UpdateConnectionto no longer be required. - Added
new_namefield fordatabricks.sdk.service.catalog.UpdateConnection. - Changed
namefield fordatabricks.sdk.service.catalog.UpdateExternalLocationto be required. - Added
new_namefield fordatabricks.sdk.service.catalog.UpdateExternalLocation. - Added
new_namefield fordatabricks.sdk.service.catalog.UpdateMetastore. - Added
new_namefield fordatabricks.sdk.service.catalog.UpdateRegisteredModelRequest. - Added
new_namefield fordatabricks.sdk.service.catalog.UpdateSchema. - Changed
namefield fordatabricks.sdk.service.catalog.UpdateStorageCredentialto be required. - Added
cloudflare_api_tokenfield fordatabricks.sdk.service.catalog.UpdateStorageCredential. - Added
new_namefield fordatabricks.sdk.service.catalog.UpdateStorageCredential. - Added
new_namefield fordatabricks.sdk.service.catalog.UpdateVolumeRequestContent. - Added
cloudflare_api_tokenfield fordatabricks.sdk.service.catalog.ValidateStorageCredential. - Added
databricks.sdk.service.catalog.CloudflareApiTokendataclass. - Removed
continuousfield fordatabricks.sdk.service.jobs.BaseRun. - Removed
continuousfield fordatabricks.sdk.service.jobs.Run. - Changed
job_parametersfield fordatabricks.sdk.service.jobs.RunJobTasktodatabricks.sdk.service.jobs.ParamPairsdataclass. - Added
run_iffield fordatabricks.sdk.service.jobs.SubmitTask. - Added
run_job_taskfield 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_limitsfield fordatabricks.sdk.service.serving.CreateServingEndpoint. - Changed
served_modelsfield fordatabricks.sdk.service.serving.EndpointCoreConfigInputto no longer be required. - Added
auto_capture_configfield fordatabricks.sdk.service.serving.EndpointCoreConfigInput. - Added
served_entitiesfield fordatabricks.sdk.service.serving.EndpointCoreConfigInput. - Added
auto_capture_configfield fordatabricks.sdk.service.serving.EndpointCoreConfigOutput. - Added
served_entitiesfield fordatabricks.sdk.service.serving.EndpointCoreConfigOutput. - Added
served_entitiesfield fordatabricks.sdk.service.serving.EndpointCoreConfigSummary. - Added
served_entitiesfield fordatabricks.sdk.service.serving.EndpointPendingConfig. - Added
extra_paramsfield fordatabricks.sdk.service.serving.QueryEndpointInput. - Added
inputfield fordatabricks.sdk.service.serving.QueryEndpointInput. - Added
max_tokensfield fordatabricks.sdk.service.serving.QueryEndpointInput. - Added
messagesfield fordatabricks.sdk.service.serving.QueryEndpointInput. - Added
nfield fordatabricks.sdk.service.serving.QueryEndpointInput. - Added
promptfield fordatabricks.sdk.service.serving.QueryEndpointInput. - Added
stopfield fordatabricks.sdk.service.serving.QueryEndpointInput. - Added
streamfield fordatabricks.sdk.service.serving.QueryEndpointInput. - Added
temperaturefield fordatabricks.sdk.service.serving.QueryEndpointInput. - Changed
predictionsfield fordatabricks.sdk.service.serving.QueryEndpointResponseto no longer be required. - Added
choicesfield fordatabricks.sdk.service.serving.QueryEndpointResponse. - Added
createdfield fordatabricks.sdk.service.serving.QueryEndpointResponse. - Added
datafield fordatabricks.sdk.service.serving.QueryEndpointResponse. - Added
idfield fordatabricks.sdk.service.serving.QueryEndpointResponse. - Added
modelfield fordatabricks.sdk.service.serving.QueryEndpointResponse. - Added
objectfield fordatabricks.sdk.service.serving.QueryEndpointResponse. - Added
usagefield fordatabricks.sdk.service.serving.QueryEndpointResponse. - Changed
workload_sizefield fordatabricks.sdk.service.serving.ServedModelInputtodatabricks.sdk.service.serving.ServedModelInputWorkloadSizedataclass. - Changed
workload_typefield fordatabricks.sdk.service.serving.ServedModelInputtodatabricks.sdk.service.serving.ServedModelInputWorkloadTypedataclass. - Added
taskfield fordatabricks.sdk.service.serving.ServingEndpoint. - Added
taskfield fordatabricks.sdk.service.serving.ServingEndpointDetailed. - Added
databricks.sdk.service.serving.Ai21LabsConfigdataclass. - Added
databricks.sdk.service.serving.AnthropicConfigdataclass. - Added
databricks.sdk.service.serving.AutoCaptureConfigInputdataclass. - Added
databricks.sdk.service.serving.AutoCaptureConfigOutputdataclass. - Added
databricks.sdk.service.serving.AutoCaptureStatedataclass. - Added
databricks.sdk.service.serving.AwsBedrockConfigdataclass. - Added
databricks.sdk.service.serving.AwsBedrockConfigBedrockProviderdataclass. - Added
databricks.sdk.service.serving.ChatMessagedataclass. - Added
databricks.sdk.service.serving.ChatMessageRoledataclass. - Added
databricks.sdk.service.serving.CohereConfigdataclass. - Added
databricks.sdk.service.serving.DatabricksModelServingConfigdataclass. - Added
databricks.sdk.service.serving.EmbeddingsV1ResponseEmbeddingElementdataclass. - Added
databricks.sdk.service.serving.EmbeddingsV1ResponseEmbeddingElementObjectdataclass. - Added
databricks.sdk.service.serving.ExternalModeldataclass. - Added
databricks.sdk.service.serving.ExternalModelConfigdataclass. - Added
databricks.sdk.service.serving.ExternalModelProviderdataclass. - Added
databricks.sdk.service.serving.ExternalModelUsageElementdataclass. - Added
databricks.sdk.service.serving.FoundationModeldataclass. - Added
databricks.sdk.service.serving.OpenAiConfigdataclass. - Added
databricks.sdk.service.serving.PaLmConfigdataclass. - Added
databricks.sdk.service.serving.PayloadTabledataclass. - Added
databricks.sdk.service.serving.PutRequestdataclass. - Added
databricks.sdk.service.serving.PutResponsedataclass. - Added
databricks.sdk.service.serving.QueryEndpointResponseObjectdataclass. - Added
databricks.sdk.service.serving.RateLimitdataclass. - Added
databricks.sdk.service.serving.RateLimitKeydataclass. - Added
databricks.sdk.service.serving.RateLimitRenewalPerioddataclass. - Added
databricks.sdk.service.serving.ServedEntityInputdataclass. - Added
databricks.sdk.service.serving.ServedEntityOutputdataclass. - Added
databricks.sdk.service.serving.ServedEntitySpecdataclass. - Added
databricks.sdk.service.serving.ServedModelInputWorkloadSizedataclass. - Added
databricks.sdk.service.serving.ServedModelInputWorkloadTypedataclass. - Added
databricks.sdk.service.serving.V1ResponseChoiceElementdataclass. - Removed a.account_network_policy account-level service.
- Removed
databricks.sdk.service.settings.AccountNetworkPolicyMessagedataclass. - Removed
databricks.sdk.service.settings.DeleteAccountNetworkPolicyRequestdataclass. - Removed
databricks.sdk.service.settings.DeleteAccountNetworkPolicyResponsedataclass. - Removed
databricks.sdk.service.settings.ReadAccountNetworkPolicyRequestdataclass. - Removed
databricks.sdk.service.settings.UpdateAccountNetworkPolicyRequestdataclass. - Removed
namefield fordatabricks.sdk.service.sharing.UpdateCleanRoom. - Changed
namefield fordatabricks.sdk.service.sharing.UpdateProviderto be required. - Added
new_namefield fordatabricks.sdk.service.sharing.UpdateProvider. - Changed
namefield fordatabricks.sdk.service.sharing.UpdateRecipientto be required. - Added
new_namefield fordatabricks.sdk.service.sharing.UpdateRecipient. - Changed
namefield fordatabricks.sdk.service.sharing.UpdateShareto be required. - Added
new_namefield fordatabricks.sdk.service.sharing.UpdateShare. - Added
statement_idsfield fordatabricks.sdk.service.sql.QueryFilter. - Added
databricks.sdk.service.sql.StatementIddataclass.
OpenAPI SHA: 63caa3cb0c05045e81d3dcf2451fa990d8670f36, Date: 2023-12-12
Release v0.14.0 (2023-11-29)
Major changes:
- GCP Auth is now supported in the Python SDK. To use Google credentials-based authentication, specify your Default Application Credentials in the
GOOGLE_CREDENTIALSenvironment variable or correspondinggoogle_credentialsparameter inConfigor the client constructors. You may provide either the path to the file containing your credentials or the credentials themselves serialized as JSON. To use Google impersonation, specify the service principal to impersonate in theDATABRICKS_GOOGLE_SERVICE_ACCOUNTenvironment variable or the correspondinggoogle_service_accountparameter inConfigor the client constructors. See #444 for the changes.
Bug fixes:
- Fix flask app example (#445).
- Fix deserialization of repeated enums (#450, #452).
- Capture stdout and stderr separately when calling Azure CLI (#460).
Other changes:
- Change the name of retries logger to
databricks.sdk.retries(#453).
API Changes:
- Added
pipeline_idfield fordatabricks.sdk.service.catalog.TableInfo. - Added
enable_predictive_optimizationfield fordatabricks.sdk.service.catalog.UpdateCataloganddatabricks.sdk.service.catalog.UpdateSchema. - Removed
databricks.sdk.service.catalog.UpdatePredictiveOptimizationanddatabricks.sdk.service.catalog.UpdatePredictiveOptimizationResponsedataclasses. - Removed
enable_optimization()method for w.metastores workspace-level service. - Added
descriptionfield fordatabricks.sdk.service.jobs.CreateJobanddatabricks.sdk.service.jobs.JobSettings. - Added
list_network_connectivity_configurations()andlist_private_endpoint_rules()methods for a.network_connectivity account-level service. - Added
databricks.sdk.service.settings.ListNccAzurePrivateEndpointRulesResponse,databricks.sdk.service.settings.ListNetworkConnectivityConfigurationsRequest,databricks.sdk.service.settings.ListNetworkConnectivityConfigurationsResponse, anddatabricks.sdk.service.settings.ListPrivateEndpointRulesRequestdataclasses.
Internal changes:
- Make ucws tests skipped when DATABRICKS_ACCOUNT_ID is present (#448).
OpenAPI SHA: 22f09783eb8a84d52026f856be3b2068f9498db3, Date: 2023-11-23 Dependency updates:
- Introduced "google-auth" dependency to support Google authentication.
Release v0.13.0 (2023-11-14)
- Introduce more specific exceptions, like
NotFound,AlreadyExists,BadRequest,PermissionDenied,InternalError, and others (#376). This makes it easier to handle errors thrown by the Databricks API. Instead of catchingDatabricksErrorand checking the error_code field, you can catch one of these subtypes ofDatabricksError, which is more ergonomic and removes the need to rethrow exceptions that you don't want to catch. For example:
try:
return (self._ws
.permissions
.get(object_type, object_id))
except DatabricksError as e:
if e.error_code in [
"RESOURCE_DOES_NOT_EXIST",
"RESOURCE_NOT_FOUND",
"PERMISSION_DENIED",
"FEATURE_DISABLED",
"BAD_REQUEST"]:
logger.warning(...)
return None
raise RetryableError(...) from e
can be replaced with
try:
return (self._ws
.permissions
.get(object_type, object_id))
except PermissionDenied, FeatureDisabled:
logger.warning(...)
return None
except NotFound:
raise RetryableError(...)
- Paginate all SCIM list requests in the SDK (#440). This change ensures that SCIM list() APIs use a default limit of 100 resources, leveraging SCIM's offset + limit pagination to batch requests to the Databricks API.
- Added taskValues support in remoteDbUtils (#406).
- Added more detailed error message on default credentials not found error (#419).
- Request management token via Azure CLI only for Service Principals and not human users (#408).
API Changes:
- Fixed
create()method for w.functions workspace-level service and correspondingdatabricks.sdk.service.catalog.CreateFunctionanddatabricks.sdk.service.catalog.FunctionInfodataclasses. - Changed
create()method for w.metastores workspace-level service with new required argument order. - Changed
storage_rootfield fordatabricks.sdk.service.catalog.CreateMetastoreto be optional. - Added
skip_validationfield fordatabricks.sdk.service.catalog.UpdateExternalLocation. - Added
librariesfield fordatabricks.sdk.service.compute.CreatePolicy,databricks.sdk.service.compute.EditPolicyanddatabricks.sdk.service.compute.Policy. - Added
init_scriptsfield fordatabricks.sdk.service.compute.EventDetails. - Added
filefield fordatabricks.sdk.service.compute.InitScriptInfo. - Added
zone_idfield fordatabricks.sdk.service.compute.InstancePoolGcpAttributes. - Added several dataclasses related to init scripts.
- Added
databricks.sdk.service.compute.LocalFileInfodataclass. - Replaced
ui_statefield withedit_modefordatabricks.sdk.service.jobs.CreateJobanddatabricks.sdk.service.jobs.JobSettings. - Replaced
databricks.sdk.service.jobs.CreateJobUiStatedataclass withdatabricks.sdk.service.jobs.CreateJobEditMode. - Added
include_resolved_valuesfield fordatabricks.sdk.service.jobs.GetRunRequest. - Replaced
databricks.sdk.service.jobs.JobSettingsUiStatedataclass withdatabricks.sdk.service.jobs.JobSettingsEditMode. - Removed a.o_auth_enrollment account-level service. This was only used to aid in OAuth enablement during the public preview of OAuth. OAuth is now enabled for all AWS E2 accounts, so usage of this API is no longer needed.
- Added
network_connectivity_config_idfield fordatabricks.sdk.service.provisioning.UpdateWorkspaceRequest. - Added a.network_connectivity account-level service.
- Added
string_shared_asfield fordatabricks.sdk.service.sharing.SharedDataObject.
Internal changes:
- Added regression question to issue template (#414).
- Made test_auth no longer fail if you have a default profile setup (#426).
OpenAPI SHA: d136ad0541f036372601bad9a4382db06c3c912d, Date: 2023-11-14
Release v0.12.0 (2023-10-24)
- Retry on all 429 and 503, even when missing Retry-After header (#402).
- Add support for tokenless authentication for GitHub Actions configured with OpenID Connect with Azure User Managed Identity (or Service Principal) (#385).
- Reduce redundant warning messages in azure-cli credential provider (#410).
API Changes:
- Added
attributes,count,excluded_attributes,filter,sort_by,sort_order, andstart_indexfields fordatabricks.sdk.service.iam.GetAccountUserRequestanddatabricks.sdk.service.iam.GetUserRequest. - Added
schemasfield fordatabricks.sdk.service.iam.Group,databricks.sdk.service.iam.ListGroupsResponse,databricks.sdk.service.iam.ListServicePrincipalResponse,databricks.sdk.service.iam.ListUsersResponse,databricks.sdk.service.iam.ServicePrincipal, anddatabricks.sdk.service.iam.User. - Added
databricks.sdk.service.iam.GetSortOrder,databricks.sdk.service.iam.GroupSchema,databricks.sdk.service.iam.ListResponseSchema,databricks.sdk.service.iam.ServicePrincipalSchema, anddatabricks.sdk.service.iam.UserSchemadataclasses. - Added
webhook_notificationsfield fordatabricks.sdk.service.jobs.SubmitTask. - Added w.apps workspace-level service and related dataclasses
- Added a.account_network_policy account-level service and related dataclasses.
OpenAPI SHA: 5903bb39137fd76ac384b2044e425f9c56840e00, Date: 2023-10-23
Release v0.11.0 (2023-10-12)
- Added Python 3.12 to project classifiers (#381).
- Fix serialization issues for generated resources (#382).
- Fix select spark version in staging (#388).
- Adjust token expiry window to 40 seconds because of Azure (#392).
- Add retries on
RPC token bucket limit has been exceeded(#395). - Regenerate to fix template drift (#398).
- Update OpenAPI spec to 12 Oct 2023 (#399).
Internal:
API Changes:
- Changed
download()method for a.billable_usage account-level service to start returningdatabricks.sdk.service.billing.DownloadResponsedataclass. - Added
databricks.sdk.service.billing.DownloadResponsedataclass. - Changed
delete()method for a.account_storage_credentials account-level service with new required argument order. - Changed
get()method for a.account_storage_credentials account-level service with new required argument order. - Changed
update()method for a.account_storage_credentials account-level service with new required argument order. - Added
get_bindings()method for w.workspace_bindings workspace-level service. - Added
update_bindings()method for w.workspace_bindings workspace-level service. - Removed
namefield fordatabricks.sdk.service.catalog.AccountsUpdateStorageCredential. - Added
storage_credential_namefield fordatabricks.sdk.service.catalog.AccountsUpdateStorageCredential. - Removed
namefield fordatabricks.sdk.service.catalog.DeleteAccountStorageCredentialRequest. - Added
storage_credential_namefield fordatabricks.sdk.service.catalog.DeleteAccountStorageCredentialRequest. - Removed
namefield fordatabricks.sdk.service.catalog.GetAccountStorageCredentialRequest. - Added
storage_credential_namefield fordatabricks.sdk.service.catalog.GetAccountStorageCredentialRequest. - Added
ownerfield fordatabricks.sdk.service.catalog.UpdateConnection. - Added
databricks.sdk.service.catalog.GetBindingsRequestdataclass. - Added
databricks.sdk.service.catalog.UpdateWorkspaceBindingsParametersdataclass. - Added
databricks.sdk.service.catalog.WorkspaceBindingdataclass. - Added
databricks.sdk.service.catalog.WorkspaceBindingBindingTypedataclass. - Added
databricks.sdk.service.catalog.WorkspaceBindingsResponsedataclass. - Added
specfield fordatabricks.sdk.service.compute.ClusterDetails. - Added
apply_policy_default_valuesfield fordatabricks.sdk.service.compute.ClusterSpec. - Removed
aws_attributesfield fordatabricks.sdk.service.compute.EditInstancePool. - Removed
azure_attributesfield fordatabricks.sdk.service.compute.EditInstancePool. - Removed
disk_specfield fordatabricks.sdk.service.compute.EditInstancePool. - Removed
enable_elastic_diskfield fordatabricks.sdk.service.compute.EditInstancePool. - Removed
gcp_attributesfield fordatabricks.sdk.service.compute.EditInstancePool. - Removed
preloaded_docker_imagesfield fordatabricks.sdk.service.compute.EditInstancePool. - Removed
preloaded_spark_versionsfield fordatabricks.sdk.service.compute.EditInstancePool. - Added
deploymentfield fordatabricks.sdk.service.jobs.CreateJob. - Added
ui_statefield fordatabricks.sdk.service.jobs.CreateJob. - Added
deploymentfield fordatabricks.sdk.service.jobs.JobSettings. - Added
ui_statefield fordatabricks.sdk.service.jobs.JobSettings. - Removed
condition_taskfield fordatabricks.sdk.service.jobs.RunOutput. - Added
webhook_notificationsfield fordatabricks.sdk.service.jobs.Task. - Added
databricks.sdk.service.jobs.CreateJobUiStatedataclass. - Added
databricks.sdk.service.jobs.JobDeploymentdataclass. - Added
databricks.sdk.service.jobs.JobDeploymentKinddataclass. - Added
databricks.sdk.service.jobs.JobSettingsUiStatedataclass. - Added
workload_typefield fordatabricks.sdk.service.serving.ServedModelInput. - Added
workload_typefield fordatabricks.sdk.service.serving.ServedModelOutput. - Removed a.account_network_policy account-level service.
- Changed
list()method for w.ip_access_lists workspace-level service to returndatabricks.sdk.service.settings.ListIpAccessListResponsedataclass. - Removed
databricks.sdk.service.settings.AccountNetworkPolicyMessagedataclass. - Removed
databricks.sdk.service.settings.DeleteAccountNetworkPolicyRequestdataclass. - Removed
databricks.sdk.service.settings.DeleteAccountNetworkPolicyResponsedataclass. - Removed
ip_access_listsfield fordatabricks.sdk.service.settings.GetIpAccessListResponse. - Added
ip_access_listfield fordatabricks.sdk.service.settings.GetIpAccessListResponse. - Removed
databricks.sdk.service.settings.ReadAccountNetworkPolicyRequestdataclass. - Removed
databricks.sdk.service.settings.UpdateAccountNetworkPolicyRequestdataclass. - Added
databricks.sdk.service.settings.ListIpAccessListResponsedataclass.
OpenAPI SHA: 493a76554afd3afdd15dc858773d01643f80352a, Date: 2023-10-12
Release v0.10.0 (2023-10-03)
- Respect
retry_timeout_secondsconfig setting and align retry implementation with Go SDK (#337).
Breaking API Changes:
- Changed
list()method for a.account_metastore_assignments account-level service to returndatabricks.sdk.service.catalog.ListAccountMetastoreAssignmentsResponsedataclass. - Removed
ownerfield fordatabricks.sdk.service.catalog.CreateConnection. Instead, use theownerfield ofUpdateConnection. - Removed
optionsfield fordatabricks.sdk.service.catalog.UpdateCatalog. - Changed
job_parametersfield fordatabricks.sdk.service.jobs.RunNowtodatabricks.sdk.service.jobs.ParamPairsdataclass. - Changed
query()method for w.serving_endpoints workspace-level service . New request type isdatabricks.sdk.service.serving.QueryEndpointInputdataclass. - Renamed
databricks.sdk.service.serving.QueryRequestdataclass toQueryEndpointInput. - Changed
list()method for w.clean_rooms workspace-level service to require request ofdatabricks.sdk.service.sharing.ListCleanRoomsRequestdataclass.
API Changes:
- Added
databricks.sdk.service.catalog.ListAccountMetastoreAssignmentsResponsedataclass. - Added
job_parametersfield fordatabricks.sdk.service.jobs.RepairRun. - Added
job_parametersfield fordatabricks.sdk.service.jobs.RunParameters. - Added
notificationsfield fordatabricks.sdk.service.pipelines.CreatePipeline. - Added
notificationsfield fordatabricks.sdk.service.pipelines.EditPipeline. - Added
notificationsfield fordatabricks.sdk.service.pipelines.PipelineSpec. - Added
databricks.sdk.service.pipelines.Notificationsdataclass. - Added
databricks.sdk.service.serving.DataframeSplitInputdataclass. - Added w.settings workspace-level service.
- Added
databricks.sdk.service.settings.DefaultNamespaceSettingdataclass. - Added
databricks.sdk.service.settings.DeleteDefaultWorkspaceNamespaceRequestdataclass. - Added
databricks.sdk.service.settings.DeleteDefaultWorkspaceNamespaceResponsedataclass. - Added
databricks.sdk.service.settings.ReadDefaultWorkspaceNamespaceRequestdataclass. - Added
databricks.sdk.service.settings.StringMessagedataclass. - Added
databricks.sdk.service.settings.UpdateDefaultWorkspaceNamespaceRequestdataclass. - Added
next_page_tokenfield fordatabricks.sdk.service.sharing.ListCleanRoomsResponse. - Added
databricks.sdk.service.sharing.ListCleanRoomsRequestdataclass.
OpenAPI SHA: bcbf6e851e3d82fd910940910dd31c10c059746c, Date: 2023-10-02
Release v0.9.0 (2023-09-20)
- Don't try to import runtime_auth when not in runtime (#327).
- Handled Azure authentication when WorkspaceResourceID is provided (#328).
- Added ErrorInfo to API errors (#347).
- Fixed eager default argument evaluation in
DatabricksError(#353). - Fixed code generation of primitive types (#354).
- Updated SDK to changes in OpenAPI specification (#355).
API Changes:
- Changed
list()method for a.account_metastore_assignments account-level service to returndatabricks.sdk.service.catalog.WorkspaceIdListdataclass. - Changed
artifact_matchersfield fordatabricks.sdk.service.catalog.ArtifactAllowlistInfotodatabricks.sdk.service.catalog.ArtifactMatcherListdataclass. - Changed
artifact_matchersfield fordatabricks.sdk.service.catalog.SetArtifactAllowlisttodatabricks.sdk.service.catalog.ArtifactMatcherListdataclass. - Added
databricks.sdk.service.catalog.WorkspaceIddataclass. - Changed
cancel_all_runs()method for w.jobs workspace-level service with new required argument order. - Changed
job_idfield fordatabricks.sdk.service.jobs.CancelAllRunsto no longer be required. - Added
all_queued_runsfield fordatabricks.sdk.service.jobs.CancelAllRuns. - Added
queuefield fordatabricks.sdk.service.jobs.CreateJob. - Added
queuefield fordatabricks.sdk.service.jobs.JobSettings. - Added
queuefield fordatabricks.sdk.service.jobs.RunNow. - Added
queue_reasonfield fordatabricks.sdk.service.jobs.RunState. - Added
queue_durationfield fordatabricks.sdk.service.jobs.RunTask. - Added
queuefield fordatabricks.sdk.service.jobs.SubmitRun. - Added
databricks.sdk.service.jobs.QueueSettingsdataclass. - Added a.o_auth_published_apps account-level service.
- Added
databricks.sdk.service.oauth2.GetPublishedAppsOutputdataclass. - Added
databricks.sdk.service.oauth2.ListOAuthPublishedAppsRequestdataclass. - Added
databricks.sdk.service.oauth2.PublishedAppOutputdataclass. - Added
patch()method for w.serving_endpoints workspace-level service. - Added
tagsfield fordatabricks.sdk.service.serving.CreateServingEndpoint. - Added
tagsfield fordatabricks.sdk.service.serving.ServingEndpoint. - Added
tagsfield fordatabricks.sdk.service.serving.ServingEndpointDetailed. - Added
databricks.sdk.service.serving.EndpointTagdataclass. - Added
databricks.sdk.service.serving.PatchServingEndpointTagsdataclass. - Added w.credentials_manager workspace-level service.
- Added
databricks.sdk.service.settings.ExchangeTokendataclass. - Added
databricks.sdk.service.settings.ExchangeTokenRequestdataclass. - Added
databricks.sdk.service.settings.ExchangeTokenResponsedataclass. - Added
databricks.sdk.service.settings.PartitionIddataclass. - Added
databricks.sdk.service.settings.TokenTypedataclass. - Changed
execute_statement()method for w.statement_execution workspace-level service with new required argument order. - Added
empty_result_statefield fordatabricks.sdk.service.sql.AlertOptions. - Removed
databricks.sdk.service.sql.ChunkInfodataclass. - Changed
on_wait_timeoutfield fordatabricks.sdk.service.sql.ExecuteStatementRequesttodatabricks.sdk.service.sql.ExecuteStatementRequestOnWaitTimeoutdataclass. - Changed
statementfield fordatabricks.sdk.service.sql.ExecuteStatementRequestto be required. - Changed
warehouse_idfield fordatabricks.sdk.service.sql.ExecuteStatementRequestto be required. - Changed
chunksfield fordatabricks.sdk.service.sql.ResultManifesttodatabricks.sdk.service.sql.BaseChunkInfoListdataclass. - Added
truncatedfield fordatabricks.sdk.service.sql.ResultManifest. - Removed
databricks.sdk.service.sql.TimeoutActiondataclass. - Added
databricks.sdk.service.sql.AlertOptionsEmptyResultStatedataclass. - Added
databricks.sdk.service.sql.BaseChunkInfodataclass. - Added
databricks.sdk.service.sql.ExecuteStatementRequestOnWaitTimeoutdataclass.
OpenAPI SHA: b52a3b410976501f08f76ca0b355fb2dca876953, Date: 2023-09-15
Release v0.8.0 (2023-09-04)
- Fixed redeclared
test_streaming_response_read_partialtest (#335). - Fixed
Incorrect typewarning (#336). - Add notebook installation instructions (#334).
API Changes:
- Renamed permissions APIs to no longer include the service name, for example:
get_job_permission_levels->get_permission_levelsget_job_permissions->get_permissionsset_job_permissions->set_permissionsupdate_job_permissions->update_permissions
- Changed
create()method for w.volumes workspace-level service with new required argument order. - Added
supports_elastic_diskfield fordatabricks.sdk.service.compute.NodeType. - Changed
create()method for w.dashboards workspace-level service with new required argument order. - Added w.dashboard_widgets workspace-level service.
- Added w.query_visualizations workspace-level service.
- Changed
namefield fordatabricks.sdk.service.sql.CreateDashboardRequestto be required. - Added
dashboard_filters_enabledfield fordatabricks.sdk.service.sql.CreateDashboardRequest. - Added
run_as_rolefield fordatabricks.sdk.service.sql.CreateDashboardRequest. - Added
run_as_rolefield fordatabricks.sdk.service.sql.Query. - Added
run_as_rolefield fordatabricks.sdk.service.sql.QueryPostContent. - Removed
dashboard_idfield fordatabricks.sdk.service.sql.WidgetOptions. - Changed
positionfield fordatabricks.sdk.service.sql.WidgetOptionstodatabricks.sdk.service.sql.WidgetPositiondataclass. - Removed
textfield fordatabricks.sdk.service.sql.WidgetOptions. - Added
descriptionfield fordatabricks.sdk.service.sql.WidgetOptions. - Added
titlefield fordatabricks.sdk.service.sql.WidgetOptions. - Added
databricks.sdk.service.sql.CreateQueryVisualizationRequestdataclass. - Added
databricks.sdk.service.sql.CreateWidgetdataclass. - Added
databricks.sdk.service.sql.DeleteDashboardWidgetRequestdataclass. - Added
databricks.sdk.service.sql.DeleteQueryVisualizationRequestdataclass. - Added
databricks.sdk.service.sql.RunAsRoledataclass. - Added
databricks.sdk.service.sql.WidgetPositiondataclass.
OpenAPI SHA: 09a7fa63d9ae243e5407941f200960ca14d48b07, Date: 2023-09-04
Release v0.7.1 (2023-08-31)
- Improve file download performance (#319).
Release v0.7.0 (2023-08-29)
- Added support for GZIP'ed streaming responses (#306).
- Added support for per-method request headers to ApiClient (#302).
- Added support for BinaryIO for streaming request and response bodies (#303).
- Added a link to the API reference (#311).
- Check workspaceUrl explicitly in runtime repl auth (#312).
Breaking Changes:
- Added support for the Files API (using application/octet-stream) in OpenAPI. The names of parameters have changed from
srctocontents, andw.files.download()now returns afiles.DownloadResponse, whosecontentsfield is aBinaryIOobject. When reading a download, the user must explicitly close this object to allow the connection to return to the connection pool.
Breaking API Changes:
- Changed
list()method for a.account_storage_credentials account-level service to returndatabricks.sdk.service.catalog.StorageCredentialInfoListdataclass. - Removed w.securable_tags workspace-level service and all associated classes.
- Removed w.subentity_tags workspace-level service and all associated classes.
- Removed
instance_pool_fleet_attributesfield fordatabricks.sdk.service.compute.CreateInstancePool. - Removed
instance_pool_fleet_attributesfield fordatabricks.sdk.service.compute.EditInstancePool. - Removed
databricks.sdk.service.compute.FleetLaunchTemplateOverridedataclass. - Removed
databricks.sdk.service.compute.FleetOnDemandOptiondataclass. - Removed
databricks.sdk.service.compute.FleetOnDemandOptionAllocationStrategydataclass. - Removed
databricks.sdk.service.compute.FleetSpotOptiondataclass. - Removed
databricks.sdk.service.compute.FleetSpotOptionAllocationStrategydataclass. - Removed
instance_pool_fleet_attributesfield fordatabricks.sdk.service.compute.GetInstancePool. - Removed
instance_pool_fleet_attributesfield fordatabricks.sdk.service.compute.InstancePoolAndStats. - Removed
databricks.sdk.service.compute.InstancePoolFleetAttributesdataclass. - Changed
get_by_name()method for w.experiments workspace-level service to returndatabricks.sdk.service.ml.GetExperimentResponsedataclass. - Changed
get_experiment()method for w.experiments workspace-level service to returndatabricks.sdk.service.ml.GetExperimentResponsedataclass. - Renamed
databricks.sdk.service.ml.GetExperimentByNameResponsedataclass todatabricks.sdk.service.ml.GetExperimentResponse. - Renamed
databricks.sdk.service.catalog.ProvisioningStatetodatabricks.sdk.service.catalog.ProvisioningInfoStatedataclass.
API Changes:
- Added w.model_versions workspace-level service.
- Added w.registered_models workspace-level service.
- Added
browse_onlyfield fordatabricks.sdk.service.catalog.CatalogInfo. - Added
full_namefield fordatabricks.sdk.service.catalog.CatalogInfo. - Added
provisioning_infofield fordatabricks.sdk.service.catalog.CatalogInfo. - Added
securable_kindfield fordatabricks.sdk.service.catalog.CatalogInfo. - Added
securable_typefield fordatabricks.sdk.service.catalog.CatalogInfo. - Added
provisioning_infofield fordatabricks.sdk.service.catalog.ConnectionInfo. - Added
optionsfield fordatabricks.sdk.service.catalog.CreateCatalog. - Added
optionsfield fordatabricks.sdk.service.catalog.UpdateCatalog. - Added
databricks.sdk.service.catalog.CatalogInfoSecurableKinddataclass. - Added
databricks.sdk.service.catalog.CreateRegisteredModelRequestdataclass. - Added
databricks.sdk.service.catalog.DeleteAliasRequestdataclass. - Added
databricks.sdk.service.catalog.DeleteModelVersionRequestdataclass. - Added
databricks.sdk.service.catalog.DeleteRegisteredModelRequestdataclass. - Added
databricks.sdk.service.catalog.GetByAliasRequestdataclass. - Added
databricks.sdk.service.catalog.GetModelVersionRequestdataclass. - Added
databricks.sdk.service.catalog.GetRegisteredModelRequestdataclass. - Added
databricks.sdk.service.catalog.ListModelVersionsRequestdataclass. - Added
databricks.sdk.service.catalog.ListModelVersionsResponsedataclass. - Added
databricks.sdk.service.catalog.ListRegisteredModelsRequestdataclass. - Added
databricks.sdk.service.catalog.ListRegisteredModelsResponsedataclass. - Added
databricks.sdk.service.catalog.ModelVersionInfodataclass. - Added
databricks.sdk.service.catalog.ModelVersionInfoStatusdataclass. - Added
databricks.sdk.service.catalog.ProvisioningInfodataclass. - Added
databricks.sdk.service.catalog.RegisteredModelAliasdataclass. - Added
databricks.sdk.service.catalog.RegisteredModelInfodataclass. - Added
databricks.sdk.service.catalog.SetRegisteredModelAliasRequestdataclass. - Added
databricks.sdk.service.catalog.UpdateModelVersionRequestdataclass. - Added
databricks.sdk.service.catalog.UpdateRegisteredModelRequestdataclass. - Added
volumesfield fordatabricks.sdk.service.compute.InitScriptInfo. - Added
databricks.sdk.service.compute.VolumesStorageInfodataclass. - Added w.files workspace-level service.
- Added
databricks.sdk.service.files.DeleteFileRequestdataclass. - Added
databricks.sdk.service.files.DownloadRequestdataclass. - Added
databricks.sdk.service.files.DownloadResponsedataclass. - Added
databricks.sdk.service.files.UploadRequestdataclass. - Added
custom_tagsfield fordatabricks.sdk.service.provisioning.CreateWorkspaceRequest. - Added
custom_tagsfield fordatabricks.sdk.service.provisioning.UpdateWorkspaceRequest. - Added
custom_tagsfield fordatabricks.sdk.service.provisioning.Workspace. - Added
databricks.sdk.service.provisioning.CustomTagsdataclass. - Added
parametersfield fordatabricks.sdk.service.sql.ExecuteStatementRequest. - Added
row_limitfield fordatabricks.sdk.service.sql.ExecuteStatementRequest. - Added
databricks.sdk.service.sql.StatementParameterListItemdataclass.
SDK Internal Changes:
- Skip Graviton runtimes for testing notebook native auth (#294).
- Fixed integration tests to not use beta DBR (#309).
OpenAPI SHA: 5d0ccbb790d341eae8e85321a685a9e9e2d5bf24, Date: 2023-08-29
Release v0.6.0 (2023-08-17)
- Added collection of Databricks Runtime versions used together with Python SDK (#287).
- Applied attribute transformer when reading in attributes from the environment (#293).
- Made notebook-native auth work with more configurations of the Databricks Runtime (#285).
- Added retry in
w.clusters.ensure_cluster_is_running(id)when cluster is simultaneously started by two different processes. (#283). - Set necessary headers when authenticating via Azure CLI (#290).
- Updated classifier to
Development Status :: 4 - Beta(#291). - Introduced Artifact Allowlist, Securable Tags, and Subentity Tags services.
- Introduced DeleteRuns and RestoreRuns methods in the Experiments API.
- Introduced the GetSecret method in the Secrets API.
- Renamed Auto Maintenance to Predictive Optimization.
New Services:
- Added w.artifact_allowlists workspace-level service.
- Added w.securable_tags workspace-level service.
- Added w.subentity_tags workspace-level service.
- Added
databricks.sdk.service.catalog.ArtifactAllowlistInfodataclass. - Added
databricks.sdk.service.catalog.ArtifactMatcherdataclass. - Added
databricks.sdk.service.catalog.ArtifactTypedataclass. - Added
databricks.sdk.service.catalog.GetArtifactAllowlistRequestdataclass. - Added
databricks.sdk.service.catalog.ListSecurableTagsRequestdataclass. - Added
databricks.sdk.service.catalog.ListSecurableTypedataclass. - Added
databricks.sdk.service.catalog.ListSubentityTagsRequestdataclass. - Added
databricks.sdk.service.catalog.MatchTypedataclass. - Added
databricks.sdk.service.catalog.SetArtifactAllowlistdataclass. - Added
databricks.sdk.service.catalog.TagChangesdataclass. - Added
databricks.sdk.service.catalog.TagKeyValuePairdataclass. - Added
databricks.sdk.service.catalog.TagSecurabledataclass. - Added
databricks.sdk.service.catalog.TagSecurableAssignmentdataclass. - Added
databricks.sdk.service.catalog.TagSecurableAssignmentsListdataclass. - Added
databricks.sdk.service.catalog.TagSubentitydataclass. - Added
databricks.sdk.service.catalog.TagSubentityAssignmentsListdataclass. - Added
databricks.sdk.service.catalog.TagsSubentityAssignmentdataclass. - Added
databricks.sdk.service.catalog.UpdateSecurableTypedataclass. - Added
databricks.sdk.service.catalog.UpdateTagsdataclass.
New APIs:
- Added
delete_runs()method for w.experiments workspace-level service. - Added
restore_runs()method for w.experiments workspace-level service. - Added
databricks.sdk.service.ml.DeleteRunsdataclass. - Added
databricks.sdk.service.ml.DeleteRunsResponsedataclass. - Added
databricks.sdk.service.ml.RestoreRunsdataclass. - Added
databricks.sdk.service.ml.RestoreRunsResponsedataclass. - Added
get_secret()method for w.secrets workspace-level service. - Added
databricks.sdk.service.workspace.GetSecretRequestdataclass. - Added
databricks.sdk.service.workspace.GetSecretResponsedataclass.
Service Renames:
- Removed
effective_auto_maintenance_flagfield fordatabricks.sdk.service.catalog.CatalogInfo. - Removed
enable_auto_maintenancefield fordatabricks.sdk.service.catalog.CatalogInfo. - Added
effective_predictive_optimization_flagfield fordatabricks.sdk.service.catalog.CatalogInfo. - Added
enable_predictive_optimizationfield fordatabricks.sdk.service.catalog.CatalogInfo. - Removed
databricks.sdk.service.catalog.EffectiveAutoMaintenanceFlagdataclass. - Removed
databricks.sdk.service.catalog.EffectiveAutoMaintenanceFlagInheritedFromTypedataclass. - Removed
databricks.sdk.service.catalog.EnableAutoMaintenancedataclass. - Removed
effective_auto_maintenance_flagfield fordatabricks.sdk.service.catalog.SchemaInfo. - Removed
enable_auto_maintenancefield fordatabricks.sdk.service.catalog.SchemaInfo. - Added
effective_predictive_optimization_flagfield fordatabricks.sdk.service.catalog.SchemaInfo. - Added
enable_predictive_optimizationfield fordatabricks.sdk.service.catalog.SchemaInfo. - Removed
effective_auto_maintenance_flagfield fordatabricks.sdk.service.catalog.TableInfo. - Removed
enable_auto_maintenancefield fordatabricks.sdk.service.catalog.TableInfo. - Added
effective_predictive_optimization_flagfield fordatabricks.sdk.service.catalog.TableInfo. - Added
enable_predictive_optimizationfield fordatabricks.sdk.service.catalog.TableInfo. - Added
databricks.sdk.service.catalog.EffectivePredictiveOptimizationFlagdataclass. - Added
databricks.sdk.service.catalog.EffectivePredictiveOptimizationFlagInheritedFromTypedataclass. - Added
databricks.sdk.service.catalog.EnablePredictiveOptimizationdataclass.
OpenAPI SHA: beff621d7b3e1d59244e2e34fc53a496f310e130, Date: 2023-08-17
Release v0.5.0 (2023-08-11)
- Added
connection_pool_sizeconfiguration property (preview) (#276). - Fixed OAuth M2M corner case in
WorkspaceClientwhereDATABRICKS_ACCOUNT_IDis present in the environment (#273).
API Changes:
- Changed
create()method for a.account_storage_credentials account-level service to returndatabricks.sdk.service.catalog.AccountsStorageCredentialInfodataclass. - Changed
get()method for a.account_storage_credentials account-level service to returndatabricks.sdk.service.catalog.AccountsStorageCredentialInfodataclass. - Changed
update()method for a.account_storage_credentials account-level service to returndatabricks.sdk.service.catalog.AccountsStorageCredentialInfodataclass. - Changed
create()method for w.connections workspace-level service with new required argument order. - Changed
update()method for w.connections workspace-level service with new required argument order. - Removed
options_kvpairsfield fordatabricks.sdk.service.catalog.ConnectionInfo. - Removed
properties_kvpairsfield fordatabricks.sdk.service.catalog.ConnectionInfo. - Added
optionsfield fordatabricks.sdk.service.catalog.ConnectionInfo. - Added
propertiesfield fordatabricks.sdk.service.catalog.ConnectionInfo. - Added
provisioning_statefield fordatabricks.sdk.service.catalog.ConnectionInfo. - Added
securable_kindfield fordatabricks.sdk.service.catalog.ConnectionInfo. - Added
securable_typefield fordatabricks.sdk.service.catalog.ConnectionInfo. - Removed
options_kvpairsfield fordatabricks.sdk.service.catalog.CreateConnection. - Removed
properties_kvpairsfield fordatabricks.sdk.service.catalog.CreateConnection. - Added
optionsfield fordatabricks.sdk.service.catalog.CreateConnection. - Added
propertiesfield fordatabricks.sdk.service.catalog.CreateConnection. - Changed
algorithmfield fordatabricks.sdk.service.catalog.SseEncryptionDetailsto no longer be required. - Removed
options_kvpairsfield fordatabricks.sdk.service.catalog.UpdateConnection. - Added
optionsfield fordatabricks.sdk.service.catalog.UpdateConnection. - Added
databricks.sdk.service.catalog.AccountsStorageCredentialInfodataclass. - Added
databricks.sdk.service.catalog.ConnectionInfoSecurableKinddataclass. - Added
databricks.sdk.service.catalog.ProvisioningStatedataclass. - Added
data_security_modefield fordatabricks.sdk.service.compute.CreateCluster. - Added
docker_imagefield fordatabricks.sdk.service.compute.CreateCluster. - Added
single_user_namefield fordatabricks.sdk.service.compute.CreateCluster. - Removed
schemafield fordatabricks.sdk.service.iam.PartialUpdate. - Added
schemasfield fordatabricks.sdk.service.iam.PartialUpdate.
OpenAPI SHA: 1e3533f94335f0e6c5d9262bc1fea95b3ddcb0e1, Date: 2023-08-11
Release v0.4.0 (2023-08-07)
To simplify documentation and management of object permissions, this release features a major reorganization of how permissions APIs are structured in the SDK. Rather than using a single permissions.get() API for all services, each service supporting permissions has its own permissions APIs. Follow these steps to migrate to the current SDK:
- Change
w.permissions.get()andw.permissions.get_by_request_object_id_and_request_object_type()tow.<Service>.get_<Service>_permissions() - Change
w.permissions.get_permission_levels()tow.<Service>.get_<Service>_permission_levels() - Change
w.permissions.set()tow.<Service>.set_<Service>_permissions() - Change
w.permissions.update()tow.<Service>.update_<Service>_permissions()
API Changes:
- Added
get_cluster_policy_permission_levels()method for w.cluster_policies workspace-level service. - Added
get_cluster_policy_permissions()method for w.cluster_policies workspace-level service. - Added
set_cluster_policy_permissions()method for w.cluster_policies workspace-level service. - Added
update_cluster_policy_permissions()method for w.cluster_policies workspace-level service. - Added
get_cluster_permission_levels()method for w.clusters workspace-level service. - Added
get_cluster_permissions()method for w.clusters workspace-level service. - Added
set_cluster_permissions()method for w.clusters workspace-level service. - Added
update_cluster_permissions()method for w.clusters workspace-level service. - Added
get_instance_pool_permission_levels()method for w.instance_pools workspace-level service. - Added
get_instance_pool_permissions()method for w.instance_pools workspace-level service. - Added
set_instance_pool_permissions()method for w.instance_pools workspace-level service. - Added
update_instance_pool_permissions()method for w.instance_pools workspace-level service. - Added
databricks.sdk.service.compute.ClusterAccessControlRequestdataclass. - Added
databricks.sdk.service.compute.ClusterAccessControlResponsedataclass. - Added
databricks.sdk.service.compute.ClusterPermissiondataclass. - Added
databricks.sdk.service.compute.ClusterPermissionLeveldataclass. - Added
databricks.sdk.service.compute.ClusterPermissionsdataclass. - Added
databricks.sdk.service.compute.ClusterPermissionsDescriptiondataclass. - Added
databricks.sdk.service.compute.ClusterPermissionsRequestdataclass. - Added
databricks.sdk.service.compute.ClusterPolicyAccessControlRequestdataclass. - Added
databricks.sdk.service.compute.ClusterPolicyAccessControlResponsedataclass. - Added
databricks.sdk.service.compute.ClusterPolicyPermissiondataclass. - Added
databricks.sdk.service.compute.ClusterPolicyPermissionLeveldataclass. - Added
databricks.sdk.service.compute.ClusterPolicyPermissionsdataclass. - Added
databricks.sdk.service.compute.ClusterPolicyPermissionsDescriptiondataclass. - Added
databricks.sdk.service.compute.ClusterPolicyPermissionsRequestdataclass. - Added
databricks.sdk.service.compute.GetClusterPermissionLevelsRequestdataclass. - Added
databricks.sdk.service.compute.GetClusterPermissionLevelsResponsedataclass. - Added
databricks.sdk.service.compute.GetClusterPermissionsRequestdataclass. - Added
databricks.sdk.service.compute.GetClusterPolicyPermissionLevelsRequestdataclass. - Added
databricks.sdk.service.compute.GetClusterPolicyPermissionLevelsResponsedataclass. - Added
databricks.sdk.service.compute.GetClusterPolicyPermissionsRequestdataclass. - Added
databricks.sdk.service.compute.GetInstancePoolPermissionLevelsRequestdataclass. - Added
databricks.sdk.service.compute.GetInstancePoolPermissionLevelsResponsedataclass. - Added
databricks.sdk.service.compute.GetInstancePoolPermissionsRequestdataclass. - Added
databricks.sdk.service.compute.InstancePoolAccessControlRequestdataclass. - Added
databricks.sdk.service.compute.InstancePoolAccessControlResponsedataclass. - Added
databricks.sdk.service.compute.InstancePoolPermissiondataclass. - Added
databricks.sdk.service.compute.InstancePoolPermissionLeveldataclass. - Added
databricks.sdk.service.compute.InstancePoolPermissionsdataclass. - Added
databricks.sdk.service.compute.InstancePoolPermissionsDescriptiondataclass. - Added
databricks.sdk.service.compute.InstancePoolPermissionsRequestdataclass. - Changed
set()method for w.permissions workspace-level service to start returningdatabricks.sdk.service.iam.ObjectPermissionsdataclass. - Changed
update()method for w.permissions workspace-level service to start returningdatabricks.sdk.service.iam.ObjectPermissionsdataclass. - Added
get_password_permission_levels()method for w.users workspace-level service. - Added
get_password_permissions()method for w.users workspace-level service. - Added
set_password_permissions()method for w.users workspace-level service. - Added
update_password_permissions()method for w.users workspace-level service. - Added
display_namefield fordatabricks.sdk.service.iam.AccessControlResponse. - Changed
rolesfield fordatabricks.sdk.service.iam.GetAssignableRolesForResourceResponsetodatabricks.sdk.service.iam.RoleListdataclass. - Added
databricks.sdk.service.iam.GetPasswordPermissionLevelsResponsedataclass. - Added
databricks.sdk.service.iam.PasswordAccessControlRequestdataclass. - Added
databricks.sdk.service.iam.PasswordAccessControlResponsedataclass. - Added
databricks.sdk.service.iam.PasswordPermissiondataclass. - Added
databricks.sdk.service.iam.PasswordPermissionLeveldataclass. - Added
databricks.sdk.service.iam.PasswordPermissionsdataclass. - Added
databricks.sdk.service.iam.PasswordPermissionsDescriptiondataclass. - Added
databricks.sdk.service.iam.PasswordPermissionsRequestdataclass. - Added
databricks.sdk.service.iam.Roledataclass. - Added
get_job_permission_levels()method for w.jobs workspace-level service. - Added
get_job_permissions()method for w.jobs workspace-level service. - Added
set_job_permissions()method for w.jobs workspace-level service. - Added
update_job_permissions()method for w.jobs workspace-level service. - Added
databricks.sdk.service.jobs.GetJobPermissionLevelsRequestdataclass. - Added
databricks.sdk.service.jobs.GetJobPermissionLevelsResponsedataclass. - Added
databricks.sdk.service.jobs.GetJobPermissionsRequestdataclass. - Added
databricks.sdk.service.jobs.JobAccessControlRequestdataclass. - Added
databricks.sdk.service.jobs.JobAccessControlResponsedataclass. - Added
databricks.sdk.service.jobs.JobPermissiondataclass. - Added
databricks.sdk.service.jobs.JobPermissionLeveldataclass. - Added
databricks.sdk.service.jobs.JobPermissionsdataclass. - Added
databricks.sdk.service.jobs.JobPermissionsDescriptiondataclass. - Added
databricks.sdk.service.jobs.JobPermissionsRequestdataclass. - Added
get_experiment_permission_levels()method for w.experiments workspace-level service. - Added
get_experiment_permissions()method for w.experiments workspace-level service. - Added
set_experiment_permissions()method for w.experiments workspace-level service. - Added
update_experiment_permissions()method for w.experiments workspace-level service. - Added
get_registered_model_permission_levels()method for w.model_registry workspace-level service. - Added
get_registered_model_permissions()method for w.model_registry workspace-level service. - Added
set_registered_model_permissions()method for w.model_registry workspace-level service. - Added
update_registered_model_permissions()method for w.model_registry workspace-level service. - Added
databricks.sdk.service.ml.ExperimentAccessControlRequestdataclass. - Added
databricks.sdk.service.ml.ExperimentAccessControlResponsedataclass. - Added
databricks.sdk.service.ml.ExperimentPermissiondataclass. - Added
databricks.sdk.service.ml.ExperimentPermissionLeveldataclass. - Added
databricks.sdk.service.ml.ExperimentPermissionsdataclass. - Added
databricks.sdk.service.ml.ExperimentPermissionsDescriptiondataclass. - Added
databricks.sdk.service.ml.ExperimentPermissionsRequestdataclass. - Added
databricks.sdk.service.ml.GetExperimentPermissionLevelsRequestdataclass. - Added
databricks.sdk.service.ml.GetExperimentPermissionLevelsResponsedataclass. - Added
databricks.sdk.service.ml.GetExperimentPermissionsRequestdataclass. - Added
databricks.sdk.service.ml.GetRegisteredModelPermissionLevelsRequestdataclass. - Added
databricks.sdk.service.ml.GetRegisteredModelPermissionLevelsResponsedataclass. - Added
databricks.sdk.service.ml.GetRegisteredModelPermissionsRequestdataclass. - Added
databricks.sdk.service.ml.RegisteredModelAccessControlRequestdataclass. - Added
databricks.sdk.service.ml.RegisteredModelAccessControlResponsedataclass. - Added
databricks.sdk.service.ml.RegisteredModelPermissiondataclass. - Added
databricks.sdk.service.ml.RegisteredModelPermissionLeveldataclass. - Added
databricks.sdk.service.ml.RegisteredModelPermissionsdataclass. - Added
databricks.sdk.service.ml.RegisteredModelPermissionsDescriptiondataclass. - Added
databricks.sdk.service.ml.RegisteredModelPermissionsRequestdataclass. - Added
scopesfield fordatabricks.sdk.service.oauth2.CreateCustomAppIntegration. - Added
get_pipeline_permission_levels()method for w.pipelines workspace-level service. - Added
get_pipeline_permissions()method for w.pipelines workspace-level service. - Added
set_pipeline_permissions()method for w.pipelines workspace-level service. - Added
update_pipeline_permissions()method for w.pipelines workspace-level service. - Added
databricks.sdk.service.pipelines.GetPipelinePermissionLevelsRequestdataclass. - Added
databricks.sdk.service.pipelines.GetPipelinePermissionLevelsResponsedataclass. - Added
databricks.sdk.service.pipelines.GetPipelinePermissionsRequestdataclass. - Added
databricks.sdk.service.pipelines.PipelineAccessControlRequestdataclass. - Added
databricks.sdk.service.pipelines.PipelineAccessControlResponsedataclass. - Added
databricks.sdk.service.pipelines.PipelinePermissiondataclass. - Added
databricks.sdk.service.pipelines.PipelinePermissionLeveldataclass. - Added
databricks.sdk.service.pipelines.PipelinePermissionsdataclass. - Added
databricks.sdk.service.pipelines.PipelinePermissionsDescriptiondataclass. - Added
databricks.sdk.service.pipelines.PipelinePermissionsRequestdataclass. - Added
gcp_managed_network_configfield fordatabricks.sdk.service.provisioning.CreateWorkspaceRequest. - Added
gke_configfield fordatabricks.sdk.service.provisioning.CreateWorkspaceRequest. - Added
get_serving_endpoint_permission_levels()method for w.serving_endpoints workspace-level service. - Added
get_serving_endpoint_permissions()method for w.serving_endpoints workspace-level service. - Added
set_serving_endpoint_permissions()method for w.serving_endpoints workspace-level service. - Added
update_serving_endpoint_permissions()method for w.serving_endpoints workspace-level service. - Added
instance_profile_arnfield fordatabricks.sdk.service.serving.ServedModelInput. - Added
instance_profile_arnfield fordatabricks.sdk.service.serving.ServedModelOutput. - Added
databricks.sdk.service.serving.GetServingEndpointPermissionLevelsRequestdataclass. - Added
databricks.sdk.service.serving.GetServingEndpointPermissionLevelsResponsedataclass. - Added
databricks.sdk.service.serving.GetServingEndpointPermissionsRequestdataclass. - Added
databricks.sdk.service.serving.ServingEndpointAccessControlRequestdataclass. - Added
databricks.sdk.service.serving.ServingEndpointAccessControlResponsedataclass. - Added
databricks.sdk.service.serving.ServingEndpointPermissiondataclass. - Added
databricks.sdk.service.serving.ServingEndpointPermissionLeveldataclass. - Added
databricks.sdk.service.serving.ServingEndpointPermissionsdataclass. - Added
databricks.sdk.service.serving.ServingEndpointPermissionsDescriptiondataclass. - Added
databricks.sdk.service.serving.ServingEndpointPermissionsRequestdataclass. - Added
get_token_permission_levels()method for w.token_management workspace-level service. - Added
get_token_permissions()method for w.token_management workspace-level service. - Added
set_token_permissions()method for w.token_management workspace-level service. - Added
update_token_permissions()method for w.token_management workspace-level service. - Added
databricks.sdk.service.settings.GetTokenPermissionLevelsResponsedataclass. - Added
databricks.sdk.service.settings.TokenAccessControlRequestdataclass. - Added
databricks.sdk.service.settings.TokenAccessControlResponsedataclass. - Added
databricks.sdk.service.settings.TokenPermissiondataclass. - Added
databricks.sdk.service.settings.TokenPermissionLeveldataclass. - Added
databricks.sdk.service.settings.TokenPermissionsdataclass. - Added
databricks.sdk.service.settings.TokenPermissionsDescriptiondataclass. - Added
databricks.sdk.service.settings.TokenPermissionsRequestdataclass. - Added
get_warehouse_permission_levels()method for w.warehouses workspace-level service. - Added
get_warehouse_permissions()method for w.warehouses workspace-level service. - Added
set_warehouse_permissions()method for w.warehouses workspace-level service. - Added
update_warehouse_permissions()method for w.warehouses workspace-level service. - Added
can_subscribe_to_live_queryfield fordatabricks.sdk.service.sql.QueryInfo. - Removed
queued_overload_time_msfield fordatabricks.sdk.service.sql.QueryMetrics. - Removed
queued_provisioning_time_msfield fordatabricks.sdk.service.sql.QueryMetrics. - Removed
total_files_countfield fordatabricks.sdk.service.sql.QueryMetrics. - Removed
total_partitions_countfield fordatabricks.sdk.service.sql.QueryMetrics. - Added
metadata_time_msfield fordatabricks.sdk.service.sql.QueryMetrics. - Added
overloading_queue_start_timestampfield fordatabricks.sdk.service.sql.QueryMetrics. - Added
planning_phasesfield fordatabricks.sdk.service.sql.QueryMetrics. - Added
planning_time_msfield fordatabricks.sdk.service.sql.QueryMetrics. - Added
provisioning_queue_start_timestampfield fordatabricks.sdk.service.sql.QueryMetrics. - Added
pruned_bytesfield fordatabricks.sdk.service.sql.QueryMetrics. - Added
pruned_files_countfield fordatabricks.sdk.service.sql.QueryMetrics. - Added
query_compilation_start_timestampfield fordatabricks.sdk.service.sql.QueryMetrics. - Added
query_execution_time_msfield fordatabricks.sdk.service.sql.QueryMetrics. - Added
databricks.sdk.service.sql.GetWarehousePermissionLevelsRequestdataclass. - Added
databricks.sdk.service.sql.GetWarehousePermissionLevelsResponsedataclass. - Added
databricks.sdk.service.sql.GetWarehousePermissionsRequestdataclass. - Added
databricks.sdk.service.sql.WarehouseAccessControlRequestdataclass. - Added
databricks.sdk.service.sql.WarehouseAccessControlResponsedataclass. - Added
databricks.sdk.service.sql.WarehousePermissiondataclass. - Added
databricks.sdk.service.sql.WarehousePermissionLeveldataclass. - Added
databricks.sdk.service.sql.WarehousePermissionsdataclass. - Added
databricks.sdk.service.sql.WarehousePermissionsDescriptiondataclass. - Added
databricks.sdk.service.sql.WarehousePermissionsRequestdataclass. - Added
get_repo_permission_levels()method for w.repos workspace-level service. - Added
get_repo_permissions()method for w.repos workspace-level service. - Added
set_repo_permissions()method for w.repos workspace-level service. - Added
update_repo_permissions()method for w.repos workspace-level service. - Added
get_workspace_object_permission_levels()method for w.workspace workspace-level service. - Added
get_workspace_object_permissions()method for w.workspace workspace-level service. - Added
set_workspace_object_permissions()method for w.workspace workspace-level service. - Added
update_workspace_object_permissions()method for w.workspace workspace-level service. - Added
databricks.sdk.service.workspace.GetRepoPermissionLevelsRequestdataclass. - Added
databricks.sdk.service.workspace.GetRepoPermissionLevelsResponsedataclass. - Added
databricks.sdk.service.workspace.GetRepoPermissionsRequestdataclass. - Added
databricks.sdk.service.workspace.GetWorkspaceObjectPermissionLevelsRequestdataclass. - Added
databricks.sdk.service.workspace.GetWorkspaceObjectPermissionLevelsResponsedataclass. - Added
databricks.sdk.service.workspace.GetWorkspaceObjectPermissionsRequestdataclass. - Added
databricks.sdk.service.workspace.RepoAccessControlRequestdataclass. - Added
databricks.sdk.service.workspace.RepoAccessControlResponsedataclass. - Added
databricks.sdk.service.workspace.RepoPermissiondataclass. - Added
databricks.sdk.service.workspace.RepoPermissionLeveldataclass. - Added
databricks.sdk.service.workspace.RepoPermissionsdataclass. - Added
databricks.sdk.service.workspace.RepoPermissionsDescriptiondataclass. - Added
databricks.sdk.service.workspace.RepoPermissionsRequestdataclass. - Added
databricks.sdk.service.workspace.WorkspaceObjectAccessControlRequestdataclass. - Added
databricks.sdk.service.workspace.WorkspaceObjectAccessControlResponsedataclass. - Added
databricks.sdk.service.workspace.WorkspaceObjectPermissiondataclass. - Added
databricks.sdk.service.workspace.WorkspaceObjectPermissionLeveldataclass. - Added
databricks.sdk.service.workspace.WorkspaceObjectPermissionsdataclass. - Added
databricks.sdk.service.workspace.WorkspaceObjectPermissionsDescriptiondataclass. - Added
databricks.sdk.service.workspace.WorkspaceObjectPermissionsRequestdataclass.
OpenAPI SHA: 386b65ecdc825b9c3ed4aa7ca88e2e5baf9d87df, Date: 2023-08-07
Release v0.3.1 (2023-08-02)
- Added timeout to
w.clusters.ensure_cluster_running()(#227). - Fixed
debug_headerstype hints forWorkspaceClientandAccountClient(#258). - Made dbutils typecast use a valid type variable (#259).
Release v0.3.0 (2023-07-27)
- Fixed serialization of lists of enum values (#248).
- Fixed examples that used incorrect keyword argument names. (https://github.com/databricks/databricks-sdk-go/pull/560)
- Handled nested query parameters in ApiClient.do() (#249).
- Improved access of
__annotations__(#239).
API Changes:
- Changed
create()method for a.account_metastore_assignments account-level service to no longer returndatabricks.sdk.service.catalog.CreateMetastoreAssignmentsResponseItemListdataclass. - Added
connection_namefield fordatabricks.sdk.service.catalog.CreateCatalog. - Added
access_pointfield fordatabricks.sdk.service.catalog.CreateExternalLocation. - Added
encryption_detailsfield fordatabricks.sdk.service.catalog.CreateExternalLocation. - Removed
databricks.sdk.service.catalog.CreateMetastoreAssignmentsResponseItemdataclass. - Added
access_pointfield fordatabricks.sdk.service.catalog.ExternalLocationInfo. - Added
encryption_detailsfield fordatabricks.sdk.service.catalog.ExternalLocationInfo. - Added
access_pointfield fordatabricks.sdk.service.catalog.TableInfo. - Added
encryption_detailsfield fordatabricks.sdk.service.catalog.TableInfo. - Added
access_pointfield fordatabricks.sdk.service.catalog.UpdateExternalLocation. - Added
encryption_detailsfield fordatabricks.sdk.service.catalog.UpdateExternalLocation. - Added
access_pointfield fordatabricks.sdk.service.catalog.VolumeInfo. - Added
encryption_detailsfield fordatabricks.sdk.service.catalog.VolumeInfo. - Added
databricks.sdk.service.catalog.EncryptionDetailsdataclass. - Added
databricks.sdk.service.catalog.SseEncryptionDetailsdataclass. - Added
databricks.sdk.service.catalog.SseEncryptionDetailsAlgorithmdataclass. - Added a.account_network_policy account-level service.
- Added
databricks.sdk.service.settings.AccountNetworkPolicyMessagedataclass. - Added
databricks.sdk.service.settings.DeleteAccountNetworkPolicyRequestdataclass. - Added
databricks.sdk.service.settings.DeleteAccountNetworkPolicyResponsedataclass. - Added
databricks.sdk.service.settings.ReadAccountNetworkPolicyRequestdataclass. - Added
databricks.sdk.service.settings.UpdateAccountNetworkPolicyRequestdataclass.
OpenAPI SHA: a1b6c1ecfaab6635911d3c060a8dd797ac6b2d4d, Date: 2023-07-27
Release v0.2.1 (2023-07-18)
- Support older versions of
urllib3and Databricks Runtime with regards toDEFAULT_METHOD_WHITELISTchange toDEFAULT_ALLOWED_METHODS(#240).
Release v0.2.0 (2023-07-18)
- Add Issue Templates (#208).
- Fixed notebook native auth for jobs (#209).
- Replace
datatime.timedelta()withdatetime.timedelta()in codebase (#207). - Support dod in python sdk (#212).
- [DECO-1115] Add local implementation for
dbutils.widgets(#93). - Fix error message, ExportFormat -> ImportFormat (#220).
- Regenerate Python SDK using recent OpenAPI Specification (#229).
- Make workspace client also return runtime dbutils when in dbr (#210).
- Use .ConstantName defining target enum states for waiters (#230).
- Fix enum deserialization (#234).
- Fix enum deserialization, take 2 (#235).
- Added toolchain configuration to
.codegen.json(#236). - Make OpenAPI spec location configurable (#237).
- Rearrange imports in
databricks.sdk.runtimeto improve local editor experience (#219). - Updated account-level and workspace-level user management examples (#241).
API Changes:
- Removed
maintenance()method for w.metastores workspace-level service. - Added
enable_optimization()method for w.metastores workspace-level service. - Added
update()method for w.tables workspace-level service. - Added
forcefield fordatabricks.sdk.service.catalog.DeleteAccountMetastoreRequest. - Added
forcefield fordatabricks.sdk.service.catalog.DeleteAccountStorageCredentialRequest. - Removed
databricks.sdk.service.catalog.UpdateAutoMaintenancedataclass. - Removed
databricks.sdk.service.catalog.UpdateAutoMaintenanceResponsedataclass. - Added
databricks.sdk.service.catalog.UpdatePredictiveOptimizationdataclass. - Added
databricks.sdk.service.catalog.UpdatePredictiveOptimizationResponsedataclass. - Added
databricks.sdk.service.catalog.UpdateTableRequestdataclass. - Added
schemafield fordatabricks.sdk.service.iam.PartialUpdate. - Added
databricks.sdk.service.iam.PatchSchemadataclass. - Added
trigger_infofield fordatabricks.sdk.service.jobs.BaseRun. - Added
healthfield fordatabricks.sdk.service.jobs.CreateJob. - Added
job_sourcefield fordatabricks.sdk.service.jobs.GitSource. - Added
on_duration_warning_threshold_exceededfield fordatabricks.sdk.service.jobs.JobEmailNotifications. - Added
healthfield fordatabricks.sdk.service.jobs.JobSettings. - Added
trigger_infofield fordatabricks.sdk.service.jobs.Run. - Added
run_job_outputfield fordatabricks.sdk.service.jobs.RunOutput. - Added
run_job_taskfield fordatabricks.sdk.service.jobs.RunTask. - Added
email_notificationsfield fordatabricks.sdk.service.jobs.SubmitRun. - Added
healthfield fordatabricks.sdk.service.jobs.SubmitRun. - Added
email_notificationsfield fordatabricks.sdk.service.jobs.SubmitTask. - Added
healthfield fordatabricks.sdk.service.jobs.SubmitTask. - Added
notification_settingsfield fordatabricks.sdk.service.jobs.SubmitTask. - Added
healthfield fordatabricks.sdk.service.jobs.Task. - Added
run_job_taskfield fordatabricks.sdk.service.jobs.Task. - Added
on_duration_warning_threshold_exceededfield fordatabricks.sdk.service.jobs.TaskEmailNotifications. - Added
on_duration_warning_threshold_exceededfield fordatabricks.sdk.service.jobs.WebhookNotifications. - Added
databricks.sdk.service.jobs.JobSourcedataclass. - Added
databricks.sdk.service.jobs.JobSourceDirtyStatedataclass. - Added
databricks.sdk.service.jobs.JobsHealthMetricdataclass. - Added
databricks.sdk.service.jobs.JobsHealthOperatordataclass. - Added
databricks.sdk.service.jobs.JobsHealthRuledataclass. - Added
databricks.sdk.service.jobs.JobsHealthRulesdataclass. - Added
databricks.sdk.service.jobs.RunJobOutputdataclass. - Added
databricks.sdk.service.jobs.RunJobTaskdataclass. - Added
databricks.sdk.service.jobs.TriggerInfodataclass. - Added
databricks.sdk.service.jobs.WebhookNotificationsOnDurationWarningThresholdExceededItemdataclass. - Removed
whlfield fordatabricks.sdk.service.pipelines.PipelineLibrary. - Changed
delete_personal_compute_setting()method for a.account_settings account-level service with new required argument order. - Changed
read_personal_compute_setting()method for a.account_settings account-level service with new required argument order. - Changed
etagfield fordatabricks.sdk.service.settings.DeletePersonalComputeSettingRequestto be required. - Changed
etagfield fordatabricks.sdk.service.settings.ReadPersonalComputeSettingRequestto be required. - Added w.clean_rooms workspace-level service.
- Added
databricks.sdk.service.sharing.CentralCleanRoomInfodataclass. - Added
databricks.sdk.service.sharing.CleanRoomAssetInfodataclass. - Added
databricks.sdk.service.sharing.CleanRoomCatalogdataclass. - Added
databricks.sdk.service.sharing.CleanRoomCatalogUpdatedataclass. - Added
databricks.sdk.service.sharing.CleanRoomCollaboratorInfodataclass. - Added
databricks.sdk.service.sharing.CleanRoomInfodataclass. - Added
databricks.sdk.service.sharing.CleanRoomNotebookInfodataclass. - Added
databricks.sdk.service.sharing.CleanRoomTableInfodataclass. - Added
databricks.sdk.service.sharing.ColumnInfodataclass. - Added
databricks.sdk.service.sharing.ColumnMaskdataclass. - Added
databricks.sdk.service.sharing.ColumnTypeNamedataclass. - Added
databricks.sdk.service.sharing.CreateCleanRoomdataclass. - Added
databricks.sdk.service.sharing.DeleteCleanRoomRequestdataclass. - Added
databricks.sdk.service.sharing.GetCleanRoomRequestdataclass. - Added
databricks.sdk.service.sharing.ListCleanRoomsResponsedataclass. - Added
databricks.sdk.service.sharing.UpdateCleanRoomdataclass. - Changed
queryfield fordatabricks.sdk.service.sql.Alerttodatabricks.sdk.service.sql.AlertQuerydataclass. - Changed
valuefield fordatabricks.sdk.service.sql.AlertOptionstoanydataclass. - Removed
is_db_adminfield fordatabricks.sdk.service.sql.User. - Removed
profile_image_urlfield fordatabricks.sdk.service.sql.User. - Added
databricks.sdk.service.sql.AlertQuerydataclass.
OpenAPI SHA: 0a1949ba96f71680dad30e06973eaae85b1307bb, Date: 2023-07-18
Release v0.1.12 (2023-06-28)
- Beta release (#198).
- Documentation improvements (#197).
- Make
dbutilstype stubs consistent with runtime implementation (#196). - Regenerated from OpenAPI spec (#199).
API changes:
- Renamed
compute.BaseClusterInfotocompute.ClusterSpec - Renamed
compute.ClusterInfotocompute.ClusterDetails - Renamed
jobs.JobTaskSettingstojobs.Task - Renamed
jobs.RunSubmitTaskSettingstojobs.SubmitTask - Renamed
jobs.JobWebhookNotificationstojobs.WebhookNotifications - Renamed
jobs.CreateJobFormattojobs.Format - Renamed
jobs.GitSourceGitProvidertojobs.GitProvider - Renamed
jobs.FileArrivalTriggerSettingstojobs.FileArrivalTriggerConfiguration
Release v0.1.11 (2023-06-21)
- Added Sphinx documentation (#184, #191, #183, #193).
- Integrated with ReadTheDocs service (#188, #189, #190).
- Create a deepcopy of config in api client (#172).
- Fix client/secret auth (#186).
- Increase DBFS copy buffer size (#185).
- Move classes to other repository (#192).
- Relax
requestsversion upper bound to <3 (#138).
Release v0.1.10 (2023-06-15)
- Regenerate from OpenAPI spec (#176).
- Added improved notebook-native authentication (#152).
- Added methods to provide extra user agent and upstream user agent to SDK config (#163).
- Added more missing
Optionaltype hints (#171, #177). - Correctly serialize external entities (#178).
- Correctly serialize external enum values in paths (#179).
- Mark non-required fields as
Optional(#170). - Synchronize auth permutation tests with Go SDK (#165).
Release v0.1.9 (2023-06-09)
- Added new services from OpenAPI spec (#145, #159).
- Added consistent usage of the
upload(path, IO)anddownload(path) -> IOacross file-related operations (#148). - Added Databricks Metadata Service credential provider (#139, #130).
- Added exposing runtime credential provider without changing user namespace (#140).
- Added a check for
is not Nonefor primitive fields inas_dict()(#147). - Fixed bug related to boolean flags and convert
Truetotruein query strings (#156). - Fixed generation of external entities (#146).
- Make u2m authentication work with new CLI (#150).
Release v0.1.8 (2023-05-22)
- Regenerated from OpenAPI spec (#124).
- Added
codecov.iobadge (#126). - Improved readme with links to examples (#125).
- Fixed
AttributeError: 'NoneType' object has no attribute 'debug_truncate_bytes' when instantiating an ApiClientwith empty config (#123).
Release v0.1.7 (2023-05-17)
- Added an extensive set of examples (#113).
- Fixed broken
dbutils.fs.mountanddbutils.fs.updateMount(#119). - Ignore
.netrcwhen sending unauthenticated requests for OAuth handshake (#108). - Make ApiClient more
pyodidefriendly (#114). - Persist token acquired through
external-browserauth type (#110). - Prototype for notebook-native auth (#115).
- Rename
RefreshableCredentialstoSessionCredentials(#116). - Use shell for opening
azcli on Windows (#117).
Release v0.1.6 (2023-05-10)
- Preserve original
databricks.sdk.runtimefor internal purposes (#96).
Release v0.1.5 (2023-05-08)
- Pin version of
requeststo>=2.28.1,<2.29.0, so that we don't getImportError: urllib3 v2.0 only supports OpenSSL 1.1.1+, currently the 'ssl' module is compiled with LibreSSL 2.8.3. See this issue for more information.
Release v0.1.4 (2023-05-05)
- Removed experimental redacting logger filter for
dbutils.secrets.get('scope', 'key'), that was causing Jupyter Kernels to hang (#92). - Fixed error handling for SCIM and CommandExecution APIs (#94).
- Created
dependabot.yml(#89).
Release v0.1.3 (2023-05-03)
- Added support for sdist (#86).
- Removed redundant newlines from AAD OAuth responses (#85).
- Update README.md with doc links (#83).
Release v0.1.2 (2023-05-03)
- Fix
dbutils.fs.put()utility (#82).
Release v0.1.1 (2023-04-28)
- Improve Azure AD auth (#80).
Release v0.1.0 (2023-04-20)
- Make code working with new OpenAPI packaging (#78).
- Added
bricksCLI authentication (#66). - Use
databricks.sdk.oauthlogger for single-request server (#74). - Support more Azure environments (#73).
- Added SECURITY.md (#64).
API changes:
- Moved
clusterpoliciesAPIs tocomputepackage. - Moved
clustersAPIs tocomputepackage. - Moved
commandsAPIs tocomputepackage. - Moved
globalinitscriptsAPIs tocomputepackage. - Moved
instancepoolsAPIs tocomputepackage. - Moved
scimAPIs toiampackage. - Moved
permissionsAPIs toiampackage. - Moved
ipaccesslistsAPIs tosettingspackage. - Moved
tokenmanagementAPIs tosettingspackage. - Moved
tokensAPIs tosettingspackage. - Moved
workspaceconfAPIs tosettingspackage. - Moved
gitcredentialsAPIs toworkspacepackage. - Moved
reposAPIs toworkspacepackage. - Moved
secretsAPIs toworkspacepackage. - Split
unitcatalogpackage tocatalogandsharing. - Renamed
mlflowpackage toml. - Renamed
dbfspackage tofiles. - Renamed
deploymentpackage toprovisioning. - Renamed
endpointspackage toserving. - Renamed
clusters.Listtype tocompute.ListClustersRequest. - Renamed
jobs.ListRunstype tojobs.ListRunsRequest. - Renamed
jobs.ExportRuntype tojobs.ExportRunRequest. - Renamed
clusterpolicies.Listtype tocompute.ListClusterPoliciesRequest. - Renamed
jobs.Listtype tojobs.ListJobsRequest. - Renamed
permissions.GetPermissionLevelstype toiam.GetPermissionLevelsRequest. - Renamed
pipelines.ListPipelineEventstype topipelines.ListPipelineEventsRequest. - Renamed
pipelines.ListPipelinestype topipelines.ListPipelinesRequest. - Renamed
workspaceconf.GetStatustype tosettings.GetStatusRequest. - Renamed
repos.Listtype toworkspace.ListReposRequest. - Renamed
tokenmanagement.Listtype tosettings.ListTokenManagementRequest. - Renamed
workspace.Exporttype toworkspace.ExportRequest. - Renamed
workspace.Listtype toworkspace.ListWorkspaceRequest.