Version changelog

July 9, 2026 · View on GitHub

Release v0.121.0 (2026-07-09)

API Changes

  • Add list() and list_effective() methods for w.grants workspace-level service.
  • Add update_time field for databricks.sdk.service.bundledeployments.Resource.
  • Add stable_workspace_id field for databricks.sdk.service.disasterrecovery.StableUrl.
  • Add deployment_id and version_id fields for databricks.sdk.service.jobs.BaseRun.
  • Add parent_path field for databricks.sdk.service.jobs.CreateJob.
  • Add parent_path field for databricks.sdk.service.jobs.JobSettings.
  • Add deployment_id and version_id fields for databricks.sdk.service.jobs.Run.
  • Add first_distinct and last_distinct fields for databricks.sdk.service.ml.AggregationFunction.
  • Add trace_location field for databricks.sdk.service.ml.CreateExperiment.
  • Add trace_location field for databricks.sdk.service.ml.Experiment.
  • Add avro_schema and proto_schema fields for databricks.sdk.service.ml.SchemaConfig.
  • Add freshness_target field for databricks.sdk.service.ml.StreamingMode.
  • Add long_rolling field for databricks.sdk.service.ml.TimeWindow.
  • Add git_credential_id field for databricks.sdk.service.workspace.CreateRepoRequest.
  • Add git_credential_id field for databricks.sdk.service.workspace.UpdateRepoRequest.
  • Add cpu_large and cpu_medium enum values for databricks.sdk.service.serving.ServedModelInputWorkloadType.
  • Add cpu_large and cpu_medium enum values for databricks.sdk.service.serving.ServingModelWorkloadType.
  • [Breaking] Change role field for databricks.sdk.service.postgres.DatabaseDatabaseSpec to be required.
  • Change role field for databricks.sdk.service.postgres.DatabaseDatabaseSpec to be required.
  • [Breaking] Remove include_browse field for databricks.sdk.service.catalog.GetSecretRequest.
  • [Breaking] Remove include_browse field for databricks.sdk.service.catalog.ListSecretsRequest.
  • [Breaking] Remove browse_only and external_secret_id fields for databricks.sdk.service.catalog.Secret.
  • [Breaking] Remove first_distinct_n and last_distinct_n fields for databricks.sdk.service.ml.AggregationFunction.
  • [Breaking] Remove group_name field for databricks.sdk.service.postgres.GenerateDatabaseCredentialRequest.

Documentation

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_response field for databricks.sdk.service.catalog.UpdatePermissions.
  • Add viz field for databricks.sdk.service.dashboards.GenieAttachment.
  • Add enable_visualization field for databricks.sdk.service.dashboards.GenieCreateConversationMessageRequest.
  • Add enable_visualization field for databricks.sdk.service.dashboards.GenieStartConversationMessageRequest.
  • Add excluded_schemas field for databricks.sdk.service.dataclassification.CatalogConfig.
  • Add etag field for databricks.sdk.service.disasterrecovery.UpdateFailoverGroupRequest.
  • Add spec field for databricks.sdk.service.environments.WorkspaceBaseEnvironment.
  • Add full_name field for databricks.sdk.service.iamv2.User.
  • Add status_message field for databricks.sdk.service.jobs.AiRuntimeTaskOutput.
  • Add sql_condition field for databricks.sdk.service.jobs.CronSchedule.
  • Add sql_condition field for databricks.sdk.service.jobs.TriggerInfo.
  • Add sql_condition field for databricks.sdk.service.jobs.TriggerSettings.
  • Add sql_condition field for databricks.sdk.service.jobs.TriggerStateProto.
  • Add first_distinct_n, first_n, last_distinct_n and last_n fields for databricks.sdk.service.ml.AggregationFunction.
  • Add replace_existing field for databricks.sdk.service.postgres.CreateDatabaseRequest.
  • Add replace_existing field for databricks.sdk.service.postgres.CreateRoleRequest.
  • Add read_only_pooled_host and read_write_pooled_host fields for databricks.sdk.service.postgres.EndpointHosts.
  • Add last_active_time field for databricks.sdk.service.postgres.EndpointStatus.
  • Add expire_time, group_name and ttl fields for databricks.sdk.service.postgres.GenerateDatabaseCredentialRequest.
  • Add autoscaling_limit_max_cu, autoscaling_limit_min_cu, no_suspension and suspend_timeout_duration fields for databricks.sdk.service.postgres.InitialEndpointSpec.
  • Add initial_branch_spec field for databricks.sdk.service.postgres.Project.
  • Add compute_last_active_time field for databricks.sdk.service.postgres.ProjectStatus.
  • Add telemetry_config field for databricks.sdk.service.serving.CreateServingEndpoint.
  • Add telemetry_config field for databricks.sdk.service.serving.ServingEndpoint.
  • Add telemetry_config field for databricks.sdk.service.serving.ServingEndpointDetailed.
  • Add read_metadata enum value for databricks.sdk.service.catalog.Privilege.
  • [Breaking] Remove name field for databricks.sdk.service.iamv2.User.

Release v0.119.0 (2026-06-24)

New Features and Improvements

  • Added a meta-harness user-agent dimension that reports the omnigent meta-harness (detected via the OMNIGENT environment 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_path field for databricks.sdk.service.bundledeployments.WorkspaceInfo.
  • Add pending_enforcement field for databricks.sdk.service.compute.ClusterCompliance.
  • Add enforce_mode field for databricks.sdk.service.compute.EnforceClusterComplianceRequest.
  • Add enforce_result field for databricks.sdk.service.compute.EnforceClusterComplianceResponse.
  • Add pending_enforcement field for databricks.sdk.service.compute.GetClusterComplianceResponse.
  • Add ai_runtime_task field for databricks.sdk.service.jobs.ResolvedValues.
  • Add ai_runtime_task_output field for databricks.sdk.service.jobs.RunOutput.
  • Add ai_runtime_task field for databricks.sdk.service.jobs.RunTask.
  • Add ai_runtime_task field for databricks.sdk.service.jobs.SubmitTask.
  • Add ai_runtime_task field for databricks.sdk.service.jobs.Task.
  • Add xlarge enum value for databricks.sdk.service.apps.ComputeSize.
  • Add deferred_policy_enforcement_scheduled and deferred_policy_enforcement_failed enum values for databricks.sdk.service.compute.EventType.
  • [Breaking] Change replicate_workspace_assets field for databricks.sdk.service.disasterrecovery.WorkspaceSet to no longer be required.
  • Change replicate_workspace_assets field for databricks.sdk.service.disasterrecovery.WorkspaceSet to no longer be required.

Release v0.118.0 (2026-06-18)

API Changes

  • Add create_data_api(), delete_data_api(), get_data_api() and update_data_api() methods for w.postgres workspace-level service.
  • Add capacity_reservation_group field for databricks.sdk.service.compute.AzureAttributes.
  • Add serverless_compute_id field for databricks.sdk.service.pipelines.ClonePipelineRequest.
  • Add serverless_compute_id field for databricks.sdk.service.pipelines.CreatePipeline.
  • Add serverless_compute_id field for databricks.sdk.service.pipelines.EditPipeline.
  • Add serverless_compute_id field for databricks.sdk.service.pipelines.PipelineSpec.
  • Add endpoint_id field for databricks.sdk.service.vectorsearch.MiniVectorIndex.
  • Add endpoint_id field for databricks.sdk.service.vectorsearch.VectorIndex.
  • Add dynamics365 enum value for databricks.sdk.service.catalog.ConnectionType.

Release v0.117.0 (2026-06-11)

API Changes

  • Add type_overrides field for databricks.sdk.service.database.SyncedTableSpec.
  • Add type_overrides field for databricks.sdk.service.postgres.SyncedTableSyncedTableSpec.
  • Change resource_id field for databricks.sdk.service.bundledeployments.Operation to no longer be required.
  • [Breaking] Change resource_id field for databricks.sdk.service.bundledeployments.Operation to no longer be required.

Bug Fixes

  • Cache tokens minted by DatabricksOidcTokenSource (Workload Identity Federation / account-wide token federation). Previously a fresh /oidc/v1/token exchange 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.dbutils lazy (functools.cached_property). The constructor no longer imports databricks.sdk.runtime eagerly, so on Spark Connect (shared-access-mode) clusters, consumers that never read .dbutils — such as dbt-databricks Python models — no longer crash with CONTEXT_UNAVAILABLE_FOR_REMOTE_CLIENT during 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 a WorkspaceClient on such a cluster — tried to build a legacy SparkContext and raised CONTEXT_UNAVAILABLE_FOR_REMOTE_CLIENT at import time. It now logs a warning and falls back to the Spark Connect-compatible remote implementation instead of crashing.

Internal Changes

  • Declare urllib3 as an explicit dependency. The SDK imports it directly; previously it was only available transitively through requests. No resolution change for users.

Release v0.116.0 (2026-06-10)

API Changes

  • Add databricks.sdk.service.aisearch and databricks.sdk.service.bundledeployments packages.
  • Add w.ai_search workspace-level service.
  • Add w.bundle_deployments workspace-level service.
  • Add running_instances field for databricks.sdk.service.apps.ApplicationStatus.
  • Add custom_max_retention_hours field for databricks.sdk.service.catalog.CatalogInfo.
  • Add environment_settings field for databricks.sdk.service.catalog.ConnectionInfo.
  • Add custom_max_retention_hours field for databricks.sdk.service.catalog.CreateCatalog.
  • Add environment_settings field for databricks.sdk.service.catalog.CreateConnection.
  • Add custom_max_retention_hours field for databricks.sdk.service.catalog.CreateSchema.
  • Add custom_max_retention_hours field for databricks.sdk.service.catalog.SchemaInfo.
  • Add custom_max_retention_hours field for databricks.sdk.service.catalog.UpdateCatalog.
  • Add environment_settings field for databricks.sdk.service.catalog.UpdateConnection.
  • Add custom_max_retention_hours field for databricks.sdk.service.catalog.UpdateSchema.
  • Add stream_source field for databricks.sdk.service.ml.DataSource.
  • Add ingestion_config field for databricks.sdk.service.ml.KafkaConfig.
  • Add clustering_columns, enable_auto_clustering and table_properties fields for databricks.sdk.service.pipelines.TableSpecificConfig.
  • Add branch_id field for databricks.sdk.service.postgres.Branch.
  • Add catalog_id field for databricks.sdk.service.postgres.Catalog.
  • Add database_id field for databricks.sdk.service.postgres.Database.
  • Add endpoint_id field for databricks.sdk.service.postgres.Endpoint.
  • Add project_id field for databricks.sdk.service.postgres.Project.
  • Add role_id field for databricks.sdk.service.postgres.Role.
  • Add synced_table_id field for databricks.sdk.service.postgres.SyncedTable.
  • Add allowed_databricks_destinations field for databricks.sdk.service.settings.EgressNetworkPolicyNetworkAccessPolicy.
  • Add facets, query_columns and sort_columns fields for databricks.sdk.service.vectorsearch.QueryVectorIndexRequest.
  • Add facet_result field for databricks.sdk.service.vectorsearch.QueryVectorIndexResponse.
  • Add facet_column_count and facet_columns fields for databricks.sdk.service.vectorsearch.ResultManifest.
  • Add dangerously_force_discard_all field for databricks.sdk.service.workspace.UpdateRepoRequest.
  • [Breaking] Remove databricks.sdk.service.bundle package.
  • [Breaking] Remove w.bundle workspace-level service.
  • Add accelerated_sync field for databricks.sdk.service.database.SyncedTableSpec.
  • Add accelerated_sync field for databricks.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.md AGENT=<name> standard). Unrecognized fallback values now pass through the User-Agent sanitized and length-capped at 64 chars instead of being coerced to agent/unknown, so versioned variants such as claude-code_2-1-141_agent surface as-is.

Release v0.114.0 (2026-06-02)

API Changes

  • Add deployment_mode field for databricks.sdk.service.bundle.Deployment.
  • Add deployment_mode field for databricks.sdk.service.bundle.Version.
  • Add collaboration_platform_connectivity and effective_collaboration_platform_connectivity fields for databricks.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-Id to X-Databricks-Workspace-Id. The value continues to come from Config.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() and update_stream() methods for w.feature_engineering workspace-level service.
  • Add update_token_management() method for w.token_management workspace-level service.
  • Add deployment_id and version_id fields for databricks.sdk.service.jobs.JobDeployment.
  • Add parameters field for databricks.sdk.service.jobs.PipelineTask.
  • Add pipeline_task field for databricks.sdk.service.jobs.ResolvedValues.
  • Add parameters field for databricks.sdk.service.pipelines.CreatePipeline.
  • Add parameters field for databricks.sdk.service.pipelines.EditPipeline.
  • Add parameters field for databricks.sdk.service.pipelines.GetPipelineResponse.
  • Add deployment_id and version_id fields for databricks.sdk.service.pipelines.PipelineDeployment.
  • Add autoscope_enabled field for databricks.sdk.service.settings.CreateOboTokenRequest.
  • Add autoscope_enabled field for databricks.sdk.service.settings.CreateTokenRequest.
  • Add autoscope_state, backfill_scopes, inferred_scopes and scopes fields for databricks.sdk.service.settings.PublicTokenInfo.
  • Add autoscope_state, backfill_scopes, inferred_scopes and scopes fields for databricks.sdk.service.settings.TokenInfo.
  • [Breaking] Remove catalog_id field for databricks.sdk.service.postgres.CatalogCatalogStatus.
  • [Breaking] Remove synced_table_id field for databricks.sdk.service.postgres.SyncedTableSyncedTableStatus.
  • Add resource_type field for databricks.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 fmt now runs ruff format + ruff check --fix-only; make lint runs ruff check and ruff format --check across databricks and tests. No behavioral changes to the published SDK.

Release v0.111.0 (2026-05-25)

API Changes

  • Add databricks.sdk.service.bundle package.
  • 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_path field for databricks.sdk.service.dashboards.GenieUpdateSpaceRequest.
  • Add attributes and excluded_attributes fields for databricks.sdk.service.iam.MeRequest.
  • Add include_trigger_state field for databricks.sdk.service.jobs.GetJobRequest.
  • Add mtls_config field for databricks.sdk.service.ml.AuthConfig.
  • Add delete_time and purge_time fields for databricks.sdk.service.postgres.BranchStatus.
  • Add purge field for databricks.sdk.service.postgres.DeleteBranchRequest.
  • Add show_deleted field for databricks.sdk.service.postgres.ListBranchesRequest.
  • Add deleted enum value for databricks.sdk.service.postgres.BranchStatusState.
  • [Breaking] Change tags field for databricks.sdk.service.marketplace.ListListingsRequest to type databricks.sdk.service.marketplace.ListingTag dataclass.
  • [Breaking] Change pagination for ClustersAPI.events method.
  • Add compute_max_instances and compute_min_instances fields for databricks.sdk.service.apps.App.
  • Add compute_max_instances and compute_min_instances fields for databricks.sdk.service.apps.AppUpdate.
  • Add cron_schedule_trigger, streaming_mode and table_trigger fields for databricks.sdk.service.ml.MaterializedFeature.
  • Add synced_table_id field for databricks.sdk.service.postgres.SyncedTableSyncedTableStatus.

Release v0.110.0 (2026-05-19)

API Changes

  • Add full_refresh_selection, refresh_flow_selection, refresh_selection and reset_checkpoint_selection fields for databricks.sdk.service.jobs.PipelineParams.
  • Add full_refresh_selection, refresh_flow_selection, refresh_selection and reset_checkpoint_selection fields for databricks.sdk.service.jobs.PipelineTask.
  • Add effective_operational_email_custom_recipient and operational_email_custom_recipient fields for databricks.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() and update_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() and update_workspace_assignment_detail_proxy() methods for w.workspace_iam_v2 workspace-level service.
  • Add failover_group_name field for databricks.sdk.service.disasterrecovery.StableUrl.
  • Add catalog_name, created_at, created_by, name and schema_name fields for databricks.sdk.service.ml.Feature.
  • [Breaking] Add catalog_name and schema_name fields for databricks.sdk.service.ml.ListFeaturesRequest.
  • Add cross_workspace_access field for databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicy.
  • Add allowed_apps_user_api_scopes and effective_allowed_apps_user_api_scopes fields for databricks.sdk.service.settingsv2.Setting.
  • Add gpu_xlarge enum value for databricks.sdk.service.serving.ServedModelInputWorkloadType.
  • Add gpu_xlarge enum value for databricks.sdk.service.serving.ServingModelWorkloadType.
  • [Breaking] Change list_features() method for w.feature_engineering workspace-level service with new required argument order.
  • Add python_operator_task field for databricks.sdk.service.jobs.RunTask.
  • Add python_operator_task field for databricks.sdk.service.jobs.SubmitTask.
  • Add python_operator_task field for databricks.sdk.service.jobs.Task.
  • Add rolling field for databricks.sdk.service.ml.TimeWindow.

Release v0.108.0 (2026-05-12)

API Changes

  • Add disabled field for databricks.sdk.service.jobs.RunTask.
  • Add disabled field for databricks.sdk.service.jobs.SubmitTask.
  • Add hubspot, github, outlook and smartsheet enum values for databricks.sdk.service.catalog.ConnectionType.
  • [Breaking] Remove unspecified_resource_name field for databricks.sdk.service.postgres.RequestedResource.

Release v0.107.0 (2026-05-11)

Internal Changes

  • Pass --force-refresh to Databricks CLI auth token command 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() and update_permissions() methods for w.supervisor_agents workspace-level service.
  • Add meta_ads_options field for databricks.sdk.service.pipelines.ConnectorOptions.
  • Add meta_marketing and zendesk enum values for databricks.sdk.service.catalog.ConnectionType.
  • Add meta_marketing enum value for databricks.sdk.service.pipelines.IngestionSourceType.
  • Change guidelines field for databricks.sdk.service.knowledgeassistants.Example to no longer be required.
  • [Breaking] Change guidelines field for databricks.sdk.service.knowledgeassistants.Example to no longer be required.
  • Change description field for databricks.sdk.service.supervisoragents.Tool to no longer be required.
  • [Breaking] Change description field for databricks.sdk.service.supervisoragents.Tool to no longer be required.
  • Add r2_temp_credentials field for databricks.sdk.service.catalog.TemporaryCredentials.
  • Add zendesk_support_options field for databricks.sdk.service.pipelines.ConnectorOptions.
  • Add azure_key_info field for databricks.sdk.service.provisioning.CreateCustomerManagedKeyRequest.
  • Add target_qps field for databricks.sdk.service.vectorsearch.CreateEndpoint.
  • Add requested_target_qps field for databricks.sdk.service.vectorsearch.EndpointScalingInfo.
  • Add target_qps field for databricks.sdk.service.vectorsearch.PatchEndpointRequest.
  • Add jira and zendesk enum values for databricks.sdk.service.pipelines.IngestionSourceType.
  • [Breaking] Remove min_qps field for databricks.sdk.service.vectorsearch.CreateEndpoint.
  • [Breaking] Remove requested_min_qps field for databricks.sdk.service.vectorsearch.EndpointScalingInfo.
  • [Breaking] Remove min_qps field for databricks.sdk.service.vectorsearch.PatchEndpointRequest.
  • Add get_permission_levels(), get_permissions(), set_permissions() and update_permissions() methods for w.vector_search_endpoints workspace-level service.
  • Add kafka_options field for databricks.sdk.service.pipelines.ConnectorOptions.
  • Add private_access field for databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicy.
  • Add account_api, account_databricks_one and account_ui fields for databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyRequestDestination.
  • Add scope_qualifier field for databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyWorkspaceApiDestination.
  • Add display_name and preview_phase fields for databricks.sdk.service.settingsv2.SettingsMetadata.
  • Add columns_to_index field for databricks.sdk.service.vectorsearch.DeltaSyncVectorIndexSpecRequest.
  • Add columns_to_index field for databricks.sdk.service.vectorsearch.DeltaSyncVectorIndexSpecResponse.

Release v0.106.0 (2026-04-30)

Bug Fixes

  • Fixed Databricks CLI --profile fallback by detecting the CLI version at init time. The previous error-based detection was broken because --profile is 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 as IOError synchronously from construction rather than lazily from the first refresh() call. The exception type matches the previous refresh()-time behaviour, so callers who already catch IOError are unaffected.

API Changes

  • Add w.temporary_volume_credentials workspace-level service.
  • Add get_permission_levels(), get_permissions(), set_permissions() and update_permissions() methods for w.knowledge_assistants workspace-level service.
  • Add undelete_project() method for w.postgres workspace-level service.
  • Add thumbnail_url field for databricks.sdk.service.apps.App.
  • Add confidential_compute_type field for databricks.sdk.service.compute.GcpAttributes.
  • Add jira_options, outlook_options and smartsheet_options fields for databricks.sdk.service.pipelines.ConnectorOptions.
  • Add google_ads_config field for databricks.sdk.service.pipelines.SourceConfig.
  • Add replace_existing field for databricks.sdk.service.postgres.CreateBranchRequest.
  • Add replace_existing field for databricks.sdk.service.postgres.CreateEndpointRequest.
  • Add purge field for databricks.sdk.service.postgres.DeleteProjectRequest.
  • Add show_deleted field for databricks.sdk.service.postgres.ListProjectsRequest.
  • Add delete_time and purge_time fields for databricks.sdk.service.postgres.Project.
  • Add uc_connection field for databricks.sdk.service.supervisoragents.Tool.
  • Change name field for databricks.sdk.service.supervisoragents.Connection to no longer be required.
  • [Breaking] Change name field for databricks.sdk.service.supervisoragents.Connection to no longer be required.
  • Add databricks.sdk.service.disasterrecovery package.
  • Add a.disaster_recovery account-level service.
  • Add create_example(), delete_example(), get_example(), list_examples() and update_example() methods for w.knowledge_assistants workspace-level service.
  • Add delta_table_name field for databricks.sdk.service.ml.BackfillSource.
  • Add confluence_options field for databricks.sdk.service.pipelines.ConnectorOptions.
  • Add confluence enum value for databricks.sdk.service.catalog.ConnectionType.
  • Add confluence enum value for databricks.sdk.service.pipelines.IngestionSourceType.
  • Change description field for databricks.sdk.service.supervisoragents.SupervisorAgent to no longer be required.
  • [Breaking] Change description field for databricks.sdk.service.supervisoragents.SupervisorAgent to no longer be required.
  • [Breaking] Remove connection field for databricks.sdk.service.supervisoragents.Tool.

Release v0.105.0 (2026-04-23)

API Changes

  • Add databricks.sdk.service.supervisoragents package.
  • Add w.secrets_uc workspace-level service.
  • Add w.supervisor_agents workspace-level service.
  • Add update() method for w.tokens workspace-level service.
  • Add etag field for databricks.sdk.service.dashboards.GenieSpace.
  • Add etag field for databricks.sdk.service.dashboards.GenieUpdateSpaceRequest.
  • Add branch_id field for databricks.sdk.service.postgres.BranchStatus.
  • Add catalog_id field for databricks.sdk.service.postgres.CatalogCatalogStatus.
  • Add database_id field for databricks.sdk.service.postgres.DatabaseDatabaseStatus.
  • Add endpoint_id field for databricks.sdk.service.postgres.EndpointStatus.
  • Add project_id field for databricks.sdk.service.postgres.ProjectStatus.
  • Add role_id field for databricks.sdk.service.postgres.RoleRoleStatus.
  • Add project field for databricks.sdk.service.postgres.SyncedTableSyncedTableStatus.
  • Add manual field for databricks.sdk.service.provisioning.CreateGcpKeyInfo.
  • Add manual field for databricks.sdk.service.provisioning.GcpKeyInfo.
  • Add apps_runtime and lakebase_runtime fields for databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyRequestDestination.
  • Add blocked_internet_destinations field for databricks.sdk.service.settings.EgressNetworkPolicyNetworkAccessPolicy.
  • Add columns_to_sync field for databricks.sdk.service.vectorsearch.DeltaSyncVectorIndexSpecResponse.
  • Add breaking_change enum value for databricks.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() and update_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-Id header to WorkspaceExt.upload() and WorkspaceExt.download() for SPOG host compatibility.
  • WorkspaceClient.get_workspace_id() now returns Config.workspace_id directly 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 with Unable to load OAuth Config.
  • Add X-Databricks-Org-Id header to SharesExt.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, otherwise unknown). 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 generic AGENT=<name> signal. When multiple agent env vars are present (e.g. a Cursor CLI subagent invoked from Claude Code), the user-agent reports agent/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_id and workspace_id are available. The experimental_is_unified_host flag has been removed; unified host detection is now automatic.
  • Accept DATABRICKS_OIDC_TOKEN_FILEPATH environment variable for consistency with other Databricks SDKs (Go, CLI, Terraform). The previous DATABRICKS_OIDC_TOKEN_FILE is 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_profile to simplify config file loading and improve __settings__ error messages.
  • Resolve token_audience from the token_federation_default_oidc_audiences field 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() and get_synced_table() methods for w.postgres workspace-level service.
  • Add effective_file_event_queue field for databricks.sdk.service.catalog.CreateExternalLocation.
  • Add effective_file_event_queue field for databricks.sdk.service.catalog.ExternalLocationInfo.
  • Add effective_file_event_queue field for databricks.sdk.service.catalog.UpdateExternalLocation.
  • Add column_selection field for databricks.sdk.service.ml.Function.
  • Add cascade field for databricks.sdk.service.pipelines.DeletePipelineRequest.
  • Add default_branch field for databricks.sdk.service.postgres.ProjectSpec.
  • Add default_branch field for databricks.sdk.service.postgres.ProjectStatus.
  • Add ingress and ingress_dry_run fields for databricks.sdk.service.settings.AccountNetworkPolicy.
  • Add delete_app_thumbnail() and update_app_thumbnail() methods for w.apps workspace-level service.
  • Add create_message_comment(), list_conversation_comments() and list_message_comments() methods for w.genie workspace-level service.
  • Add apply_environment() method for w.pipelines workspace-level service.
  • Add name and permission fields for databricks.sdk.service.apps.AppResourceApp.
  • Add managed_encryption_settings field for databricks.sdk.service.catalog.CatalogInfo.
  • Add managed_encryption_settings field for databricks.sdk.service.catalog.CreateCatalog.
  • Add managed_encryption_settings field for databricks.sdk.service.catalog.UpdateCatalog.
  • Add comment field for databricks.sdk.service.dashboards.GenieFeedback.
  • Add thoughts field for databricks.sdk.service.dashboards.GenieQueryAttachment.
  • Add comment field for databricks.sdk.service.dashboards.GenieSendMessageFeedbackRequest.
  • Add request_source field for databricks.sdk.service.ml.DataSource.
  • Add is_online field for databricks.sdk.service.ml.MaterializedFeature.
  • Add connector_options field for databricks.sdk.service.pipelines.SchemaSpec.
  • Add connector_options field for databricks.sdk.service.pipelines.TableSpec.
  • Add scopes field for databricks.sdk.service.settings.CreateOboTokenRequest.
  • Add gcp_endpoint field for databricks.sdk.service.settings.CreatePrivateEndpointRule.
  • Add scopes field for databricks.sdk.service.settings.CreateTokenRequest.
  • Add gcp_endpoint field for databricks.sdk.service.settings.NccPrivateEndpointRule.
  • Add gcp_endpoint field for databricks.sdk.service.settings.UpdatePrivateEndpointRule.
  • Add sql_state field for databricks.sdk.service.sql.StatementStatus.
  • Add usage_policy_id field for databricks.sdk.service.vectorsearch.CreateEndpoint.
  • Add index_subtype field for databricks.sdk.service.vectorsearch.CreateVectorIndexRequest.
  • Add budget_policy_id field for databricks.sdk.service.vectorsearch.EndpointInfo.
  • Add index_subtype field for databricks.sdk.service.vectorsearch.MiniVectorIndex.
  • Add budget_policy_id field for databricks.sdk.service.vectorsearch.PatchEndpointBudgetPolicyResponse.
  • Add index_subtype field for databricks.sdk.service.vectorsearch.VectorIndex.
  • Add table_delta_uniform_iceberg_external_deltasharing enum value for databricks.sdk.service.catalog.SecurableKind.
  • Add google_drive enum value for databricks.sdk.service.pipelines.IngestionSourceType.
  • Add storage_optimized enum value for databricks.sdk.service.vectorsearch.EndpointType.
  • [Breaking] Remove project field for databricks.sdk.service.postgres.SyncedTableSyncedTableSpec.
  • [Breaking] Remove apps and lakebase fields for databricks.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_creation field for databricks.sdk.service.settings.RestrictWorkspaceAdminsMessage.
  • Add disable_gov_tag_creation field for databricks.sdk.service.settingsv2.RestrictWorkspaceAdminsMessage.

Release v0.101.0 (2026-03-18)

API Changes

  • Add databricks.sdk.service.environments package.
  • Add w.environments workspace-level service.
  • Add parent_path field for databricks.sdk.service.dashboards.GenieSpace.
  • Add can_create_app enum value for databricks.sdk.service.iam.PermissionLevel.

Release v0.100.0 (2026-03-16)

New Features and Improvements

  • Support default_profile in [__settings__] section of .databrickscfg for consistent default profile resolution across CLI and SDKs.

API Changes

  • Add alert_output field for databricks.sdk.service.jobs.RunOutput.
  • Add alert_task field for databricks.sdk.service.jobs.RunTask.
  • Add alert_task field for databricks.sdk.service.jobs.SubmitTask.
  • Add alert_task field for databricks.sdk.service.jobs.Task.

Release v0.99.0 (2026-03-12)

API Changes

  • Add connector_type and data_staging_options fields for databricks.sdk.service.pipelines.IngestionPipelineDefinition.
  • Add ingestion_source_catalog_name, ingestion_source_connection_name, ingestion_source_schema_name, ingestion_source_table_name and ingestion_source_table_version fields for databricks.sdk.service.pipelines.Origin.
  • Add sub_domain field for databricks.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() and genie_list_eval_runs() methods for w.genie workspace-level service.
  • Add update_role() method for w.postgres workspace-level service.
  • Add telemetry_export_destinations field for databricks.sdk.service.apps.App.
  • Add entities and timeseries_column fields for databricks.sdk.service.ml.Feature.
  • Add aggregation_function field for databricks.sdk.service.ml.Function.
  • Add filter_condition field for databricks.sdk.service.ml.KafkaSource.
  • Add attributes field for databricks.sdk.service.postgres.RoleRoleStatus.
  • [Breaking] Change entity_columns and timeseries_column fields for databricks.sdk.service.ml.DeltaTableSource to no longer be required.
  • Change entity_columns and timeseries_column fields for databricks.sdk.service.ml.DeltaTableSource to no longer be required.
  • Change inputs field for databricks.sdk.service.ml.Feature to no longer be required.
  • [Breaking] Change inputs field for databricks.sdk.service.ml.Feature to no longer be required.
  • [Breaking] Change function_type field for databricks.sdk.service.ml.Function to no longer be required.
  • Change function_type field for databricks.sdk.service.ml.Function to no longer be required.
  • Change entity_column_identifiers and timeseries_column_identifier fields for databricks.sdk.service.ml.KafkaSource to no longer be required.
  • [Breaking] Change entity_column_identifiers and timeseries_column_identifier fields for databricks.sdk.service.ml.KafkaSource to 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

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_url config field (DATABRICKS_DISCOVERY_URL env var). When set, OIDC endpoints are fetched directly from this URL instead of the default host-type-based logic. Mirrors discoveryUrl in 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_condition and transformation_sql fields for databricks.sdk.service.ml.DeltaTableSource.
  • Add environment_version field for databricks.sdk.service.pipelines.PipelinesEnvironment.
  • Add reset_checkpoint_selection field for databricks.sdk.service.pipelines.StartUpdate.
  • [Breaking] Remove oauth2_app_client_id and oauth2_app_integration_id fields for databricks.sdk.service.apps.Space.
  • Add create_database(), delete_database(), get_database(), list_databases() and update_database() methods for w.postgres workspace-level service.
  • Add postgres field for databricks.sdk.service.apps.AppResource.
  • Add enable_pg_native_login field for databricks.sdk.service.postgres.ProjectSpec.
  • Add enable_pg_native_login field for databricks.sdk.service.postgres.ProjectStatus.
  • [Breaking] Remove node_type_flexibility field for databricks.sdk.service.compute.EditInstancePool.

Release v0.94.0 (2026-02-26)

New Features and Improvements

  • Added Config.discovery_url config field (DATABRICKS_DISCOVERY_URL env var). When set, OIDC endpoints are fetched directly from this URL instead of the default host-type-based logic. Mirrors discoveryUrl in the Java SDK.

Bug Fixes

  • Pass --profile to 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_mode field for databricks.sdk.service.pipelines.GetPipelineResponse.
  • Add dbr_autoscale enum value for databricks.sdk.service.compute.EventDetailsCause.
  • Change output_catalog field for databricks.sdk.service.cleanrooms.CreateCleanRoomOutputCatalogResponse to be required.
  • [Breaking] Remove internal_attributes field for databricks.sdk.service.sharing.Table.
  • [Breaking] Remove internal_attributes field for databricks.sdk.service.sharing.Volume.

Release v0.93.0 (2026-02-25)

API Changes

  • Add parameters field for databricks.sdk.service.pipelines.StartUpdate.
  • Add parameters field for databricks.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 name field for databricks.sdk.service.apps.Space to be required.
  • Change name field for databricks.sdk.service.apps.Space to be required.
  • [Breaking] Change id and user_id fields for databricks.sdk.service.dashboards.GenieConversation to no longer be required.
  • [Breaking] Change created_timestamp and title fields for databricks.sdk.service.dashboards.GenieConversationSummary to no longer be required.
  • [Breaking] Change download_id_signature field for databricks.sdk.service.dashboards.GenieGetDownloadFullQueryResultRequest to be required.
  • [Breaking] Change id field for databricks.sdk.service.dashboards.GenieMessage to no longer be required.

Release v0.92.0 (2026-02-24)

Documentation

  • Added "Retries" section to README.

API Changes

  • Add read_only_host field for databricks.sdk.service.postgres.EndpointHosts.
  • Add group field for databricks.sdk.service.postgres.EndpointSpec.
  • Add group field for databricks.sdk.service.postgres.EndpointStatus.
  • Add initial_endpoint_spec field for databricks.sdk.service.postgres.Project.
  • Add degraded enum value for databricks.sdk.service.postgres.EndpointStatusState.
  • Add patch_endpoint() method for w.vector_search_endpoints workspace-level service.
  • Add app field for databricks.sdk.service.apps.AppResource.
  • Add securable_kind field for databricks.sdk.service.apps.AppResourceUcSecurable.
  • Add min_qps field for databricks.sdk.service.vectorsearch.CreateEndpoint.
  • Add scaling_info field for databricks.sdk.service.vectorsearch.EndpointInfo.
  • Add modify enum value for databricks.sdk.service.apps.AppResourceUcSecurableUcSecurablePermission.
  • Add could_not_get_dashboard_schema_exception enum value for databricks.sdk.service.dashboards.MessageErrorType.
  • Add replace_where_overrides field for databricks.sdk.service.pipelines.StartUpdate.
  • Add hivemetastore_connectivity_failure enum value for databricks.sdk.service.compute.TerminationReasonCode.
  • Add hivemetastore_connectivity_failure enum value for databricks.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 attributes and membership_roles fields for databricks.sdk.service.postgres.RoleRoleSpec.
  • Add membership_roles field for databricks.sdk.service.postgres.RoleRoleStatus.
  • Add general_access enum value for databricks.sdk.service.provisioning.EndpointUseCase.

Release v0.90.0 (2026-02-18)

API Changes

  • Add databricks.sdk.service.networking package.
  • Add a.endpoints account-level service.
  • Add create_space(), delete_space(), get_space(), get_space_operation(), list_spaces() and update_space() methods for w.apps workspace-level service.
  • Add space field for databricks.sdk.service.apps.App.
  • Add space field for databricks.sdk.service.apps.ListAppsRequest.
  • Add source_type, update_time and updated_by fields for databricks.sdk.service.catalog.EntityTagAssignment.
  • Add skip_notify field for databricks.sdk.service.dashboards.Subscription.
  • Add sparse_checkout field for databricks.sdk.service.jobs.GitSource.
  • Add disable_auto_optimization, max_retries, min_retry_interval_millis and retry_on_timeout fields for databricks.sdk.service.jobs.RunTask.
  • Add disable_auto_optimization, max_retries, min_retry_interval_millis and retry_on_timeout fields for databricks.sdk.service.jobs.SubmitTask.
  • Add budget_policy_id and custom_tags fields for databricks.sdk.service.postgres.ProjectSpec.
  • Add budget_policy_id and custom_tags fields for databricks.sdk.service.postgres.ProjectStatus.
  • Add edgegrid_akamai enum value for databricks.sdk.service.catalog.CredentialType.
  • Add using_arguments field for databricks.sdk.service.catalog.ColumnMask.
  • Add effective_enable_file_events field for databricks.sdk.service.catalog.CreateExternalLocation.
  • Add effective_enable_file_events field for databricks.sdk.service.catalog.ExternalLocationInfo.
  • Add input_arguments field for databricks.sdk.service.catalog.TableRowFilter.
  • Add effective_enable_file_events field for databricks.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() and WorkspaceClient.serving_endpoints.get_langchain_chat_open_ai_client() methods in favor of dedicated packages. Users should migrate to databricks-openai (using DatabricksOpenAI) and databricks-langchain (using ChatDatabricks) 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_ID is set. Added new databricks_oidc_endpoints property that returns only Databricks OIDC endpoints, and updated all Databricks OAuth flows to use it. The old oidc_endpoints property is deprecated but maintained for backward compatibility.

Release v0.86.0 (2026-02-10)

New Features and Improvements

  • Added custom_headers parameter to WorkspaceClient and AccountClient to support custom HTTP headers in all API requests (#1245).

API Changes

  • Add id field for databricks.sdk.service.sharing.CreateRecipient.
  • Add id field for databricks.sdk.service.sharing.RecipientInfo.
  • Add id field for databricks.sdk.service.sharing.UpdateRecipient.
  • Add query_tags field for databricks.sdk.service.sql.ExecuteStatementRequest.
  • Add query_tags field for databricks.sdk.service.sql.QueryInfo.
  • Add uc_volume_misconfigured enum value for databricks.sdk.service.compute.EventType.
  • Add filters field for databricks.sdk.service.jobs.DashboardTask.
  • Add ssws_token enum value for databricks.sdk.service.catalog.CredentialType.

Release v0.85.0 (2026-02-05)

API Changes

  • [Breaking] Change username field for databricks.sdk.service.iamv2.User to no longer be required.

Release v0.84.0 (2026-02-04)

API Changes

  • Add base_environment field for databricks.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() and get_download_full_query_result() methods for w.genie workspace-level service.
  • Add active_instances field for databricks.sdk.service.apps.ComputeStatus.
  • [Breaking] Change create_role() method for w.postgres workspace-level service. HTTP method/verb has changed.
  • Add compute field for databricks.sdk.service.jobs.RunTask.
  • Add compute field for databricks.sdk.service.jobs.SubmitTask.
  • Add compute field for databricks.sdk.service.jobs.Task.
  • Add mtls_port_connectivity_failure enum value for databricks.sdk.service.compute.TerminationReasonCode.
  • Add mtls_port_connectivity_failure enum value for databricks.sdk.service.sql.TerminationReasonCode.

Release v0.82.0 (2026-01-29)

API Changes

  • Add backfill_source field for databricks.sdk.service.ml.KafkaConfig.
  • Add clone_mode field for databricks.sdk.service.pipelines.ClonePipelineRequest.
  • Add burst_scaling_enabled field for databricks.sdk.service.serving.ServedEntityInput.
  • Add burst_scaling_enabled field for databricks.sdk.service.serving.ServedEntityOutput.
  • Add burst_scaling_enabled field for databricks.sdk.service.serving.ServedModelInput.
  • Add burst_scaling_enabled field for databricks.sdk.service.serving.ServedModelOutput.
  • [Breaking] Change create_role() method for w.postgres workspace-level service with new required argument order.
  • Change role_id field for databricks.sdk.service.postgres.CreateRoleRequest to no longer be required.

Release v0.81.0 (2026-01-27)

API Changes

  • Add postgres_role field for databricks.sdk.service.postgres.RoleRoleSpec.
  • Add postgres_role field for databricks.sdk.service.postgres.RoleRoleStatus.
  • Add purge field for databricks.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_window field for databricks.sdk.service.pipelines.IngestionPipelineDefinition.
  • Add auto_full_refresh_policy field for databricks.sdk.service.pipelines.TableSpecificConfig.
  • Add hosts field for databricks.sdk.service.postgres.EndpointStatus.
  • Add owner field for databricks.sdk.service.postgres.ProjectStatus.
  • Add validity_check_configurations field for databricks.sdk.service.qualitymonitorv2.QualityMonitor.
  • Add burst_scaling_enabled field for databricks.sdk.service.serving.PtServedModel.
  • Add system_managed enum value for databricks.sdk.service.jobs.JobDeploymentKind.
  • Add endpoint_type_read_write and endpoint_type_read_only enum values for databricks.sdk.service.postgres.EndpointType.
  • Add deleted enum value for databricks.sdk.service.vectorsearch.EndpointStatusState.
  • [Breaking] Remove host, last_active_time, start_time and suspend_time fields for databricks.sdk.service.postgres.EndpointStatus.
  • [Breaking] Remove compute_last_active_time field for databricks.sdk.service.postgres.ProjectStatus.
  • [Breaking] Remove read_write and read_only enum values for databricks.sdk.service.postgres.EndpointType.
  • Add create_default_warehouse_override(), delete_default_warehouse_override(), get_default_warehouse_override(), list_default_warehouse_overrides() and update_default_warehouse_override() methods for w.warehouses workspace-level service.
  • Add driver_node_type_flexibility and worker_node_type_flexibility fields for databricks.sdk.service.compute.ClusterAttributes.
  • Add driver_node_type_flexibility and worker_node_type_flexibility fields for databricks.sdk.service.compute.ClusterDetails.
  • Add driver_node_type_flexibility and worker_node_type_flexibility fields for databricks.sdk.service.compute.ClusterSpec.
  • Add driver_node_type_flexibility and worker_node_type_flexibility fields for databricks.sdk.service.compute.CreateCluster.
  • Add node_type_flexibility field for databricks.sdk.service.compute.CreateInstancePool.
  • Add driver_node_type_flexibility and worker_node_type_flexibility fields for databricks.sdk.service.compute.EditCluster.
  • Add node_type_flexibility field for databricks.sdk.service.compute.EditInstancePool.
  • Add node_type_flexibility field for databricks.sdk.service.compute.GetInstancePool.
  • Add node_type_flexibility field for databricks.sdk.service.compute.InstancePoolAndStats.
  • Add driver_node_type_flexibility and worker_node_type_flexibility fields for databricks.sdk.service.compute.UpdateClusterResource.
  • Add expire_time and ttl fields for databricks.sdk.service.postgres.BranchSpec.
  • Add expire_time field for databricks.sdk.service.postgres.BranchStatus.
  • [Breaking] Change create_branch(), create_endpoint() and create_project() methods for w.postgres workspace-level service with new required argument order.
  • [Breaking] Change branch_id field for databricks.sdk.service.postgres.CreateBranchRequest to be required.
  • [Breaking] Change endpoint_id field for databricks.sdk.service.postgres.CreateEndpointRequest to be required.
  • [Breaking] Change project_id field for databricks.sdk.service.postgres.CreateProjectRequest to be required.
  • [Breaking] Remove default field for databricks.sdk.service.postgres.BranchSpec.
  • [Breaking] Remove settings field for databricks.sdk.service.postgres.ProjectSpec.
  • [Breaking] Remove settings field for databricks.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() and patch_public_account_user_preference() methods for a.account_settings_v2 account-level service.
  • Add stderr field for databricks.sdk.service.compute.InitScriptInfoAndExecutionDetails.
  • Add no_expiry field for databricks.sdk.service.postgres.BranchSpec.
  • Add outputs field for databricks.sdk.service.serving.QueryEndpointResponse.
  • Add session_id field for databricks.sdk.service.sql.QueryInfo.
  • Add principal_id field for databricks.sdk.service.workspace.CreateCredentialsRequest.
  • Add principal_id field for databricks.sdk.service.workspace.DeleteCredentialsRequest.
  • Add principal_id field for databricks.sdk.service.workspace.GetCredentialsRequest.
  • Add principal_id field for databricks.sdk.service.workspace.ListCredentialsRequest.
  • Add principal_id field for databricks.sdk.service.workspace.UpdateCredentialsRequest.
  • Add force field for databricks.sdk.service.pipelines.DeletePipelineRequest.
  • Add no_suspension field for databricks.sdk.service.postgres.EndpointSpec.
  • Add no_suspension field for databricks.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_based enum value for databricks.sdk.service.catalog.SecurableKind.
  • Add creating and create_failed enum values for databricks.sdk.service.settings.NccPrivateEndpointRulePrivateLinkConnectionState.
  • [Breaking] Remove access_modes and storage_location fields for databricks.sdk.service.sharing.Table.
  • Add error_message field for databricks.sdk.service.settings.CreatePrivateEndpointRule.
  • Add error_message field for databricks.sdk.service.settings.NccPrivateEndpointRule.
  • Add error_message field for databricks.sdk.service.settings.UpdatePrivateEndpointRule.
  • Add rate_limited enum value for databricks.sdk.service.compute.TerminationReasonCode.
  • Add rate_limited enum value for databricks.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() and delete_project() methods for w.postgres workspace-level service to return databricks.sdk.service.postgres.Operation dataclass.
  • [Breaking] Remove pgbouncer_settings field for databricks.sdk.service.postgres.EndpointSettings.
  • [Breaking] Remove pooler_mode field for databricks.sdk.service.postgres.EndpointSpec.
  • [Breaking] Remove pooler_mode field for databricks.sdk.service.postgres.EndpointStatus.
  • [Breaking] Remove pgbouncer_settings field for databricks.sdk.service.postgres.ProjectDefaultEndpointSettings.

Release v0.77.0 (2026-01-06)

API Changes

  • Add git_repository field for databricks.sdk.service.apps.App.
  • Add git_source field for databricks.sdk.service.apps.AppDeployment.
  • Add experiment_spec field for databricks.sdk.service.apps.AppManifestAppResourceSpec.
  • Add experiment field for databricks.sdk.service.apps.AppResource.
  • Add git_repository field for databricks.sdk.service.apps.AppUpdate.
  • Add excluded_table_full_names field for databricks.sdk.service.dataquality.AnomalyDetectionConfig.
  • Add group_name field for databricks.sdk.service.jobs.JobRunAs.
  • Add row_filter field for databricks.sdk.service.pipelines.TableSpecificConfig.
  • Add spec and status fields for databricks.sdk.service.postgres.Endpoint.
  • Add excluded_table_full_names field for databricks.sdk.service.qualitymonitorv2.AnomalyDetectionConfig.
  • Add execute and use_connection enum values for databricks.sdk.service.apps.AppManifestAppResourceUcSecurableSpecUcSecurablePermission.
  • Add function and connection enum values for databricks.sdk.service.apps.AppManifestAppResourceUcSecurableSpecUcSecurableType.
  • Add select, execute and use_connection enum values for databricks.sdk.service.apps.AppResourceUcSecurableUcSecurablePermission.
  • Add table, function and connection enum values for databricks.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_time and suspend_timeout_duration fields for databricks.sdk.service.postgres.Endpoint.
  • Add create_role(), delete_role(), get_role() and list_roles() methods for w.postgres workspace-level service.
  • Add destination_source_securable field for databricks.sdk.service.catalog.AccessRequestDestinations.
  • Add spec and status fields for databricks.sdk.service.postgres.Branch.
  • Add spec and status fields for databricks.sdk.service.postgres.Project.
  • Add access_modes and storage_location fields for databricks.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_time and state_change_time fields for databricks.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, settings and synthetic_storage_size_bytes fields for databricks.sdk.service.postgres.Project.
  • Add command and env_vars fields for databricks.sdk.service.apps.AppDeployment.
  • Add full_name and securable_type fields for databricks.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 None dataclass.

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.postgres package.
  • Add w.postgres workspace-level service.
  • Add apply_environment() method for w.pipelines workspace-level service.
  • Add effective_usage_policy_id and usage_policy_id fields for databricks.sdk.service.apps.App.
  • Add external_access_enabled field for databricks.sdk.service.catalog.CreateAccountsMetastore.
  • Add external_access_enabled field for databricks.sdk.service.catalog.CreateMetastore.
  • Add external_access_enabled field for databricks.sdk.service.catalog.UpdateAccountsMetastore.
  • Add external_access_enabled field for databricks.sdk.service.catalog.UpdateMetastore.
  • Add usage_policy_id field for databricks.sdk.service.ml.OnlineStore.
  • Add error_message field for databricks.sdk.service.settings.CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule.
  • Add error_message field for databricks.sdk.service.settings.NccAzurePrivateEndpointRule.
  • Add control_plane_connection_failure and control_plane_connection_failure_due_to_misconfig enum values for databricks.sdk.service.compute.TerminationReasonCode.
  • Add control_plane_connection_failure and control_plane_connection_failure_due_to_misconfig enum values for databricks.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() and update_space() methods for w.genie workspace-level service.
  • Add create_kafka_config(), delete_kafka_config(), get_kafka_config(), list_kafka_configs() and update_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_version field for databricks.sdk.service.billing.CreateBillingUsageDashboardRequest.
  • Add include_serialized_space field for databricks.sdk.service.dashboards.GenieGetSpaceRequest.
  • Add serialized_space field for databricks.sdk.service.dashboards.GenieSpace.
  • Add purpose field for databricks.sdk.service.dashboards.TextAttachment.
  • Add budget_policy_id field for databricks.sdk.service.database.NewPipelineSpec.
  • Add model field for databricks.sdk.service.jobs.TriggerSettings.
  • Add kafka_source field for databricks.sdk.service.ml.DataSource.
  • Add connection_parameters field for databricks.sdk.service.pipelines.IngestionGatewayPipelineDefinition.
  • Add ingest_from_uc_foreign_catalog field for databricks.sdk.service.pipelines.IngestionPipelineDefinition.
  • Add rewind_spec field for databricks.sdk.service.pipelines.StartUpdate.
  • Add type_text field for databricks.sdk.service.vectorsearch.ColumnInfo.
  • Add foreign_catalog enum value for databricks.sdk.service.pipelines.IngestionSourceType.
  • Add creating and create_failed enum values for databricks.sdk.service.settings.CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState.
  • Add creating and create_failed enum values for databricks.sdk.service.settings.NccAzurePrivateEndpointRuleConnectionState.
  • [Breaking] Change destinations field for databricks.sdk.service.catalog.AccessRequestDestinations to no longer be required.
  • Change destinations field for databricks.sdk.service.catalog.AccessRequestDestinations to no longer be required.
  • [Breaking] Change online_store_config field for databricks.sdk.service.ml.MaterializedFeature to type databricks.sdk.service.ml.OnlineStoreConfig dataclass.
  • Add w.workspace_entity_tag_assignments workspace-level service.
  • Add clone() method for w.pipelines workspace-level service.
  • Add dataset_catalog and dataset_schema fields for databricks.sdk.service.dashboards.CreateDashboardRequest.
  • Add dataset_catalog and dataset_schema fields for databricks.sdk.service.dashboards.UpdateDashboardRequest.
  • Add purge_data field for databricks.sdk.service.database.DeleteSyncedDatabaseTableRequest.
  • Add cron_schedule field for databricks.sdk.service.ml.MaterializedFeature.
  • Add truncation field for databricks.sdk.service.pipelines.PipelineEvent.
  • Add gcp_service_account field for databricks.sdk.service.provisioning.CreateGcpKeyInfo.
  • Add gcp_service_account field for databricks.sdk.service.provisioning.GcpKeyInfo.
  • Add has_delta_uniform_iceberg field for databricks.sdk.service.sharing.TableInternalAttributes.
  • Add foreign_table and volume enum values for databricks.sdk.service.sharing.SharedDataObjectDataObjectType.
  • Change time_window field for databricks.sdk.service.ml.Feature to no longer be required.
  • [Breaking] Change time_window field for databricks.sdk.service.ml.Feature to no longer be required.

Release v0.73.0 (2025-11-05)

Security

  • Update protobuf dependency constraints to exclude known vulnerable versions (related to SNYK-PYTHON-PROTOBUF-10364902).

Release v0.72.0 (2025-11-04)

Bug Fixes

  • Fix FilesExt can fail to upload and download data when Presigned URLs are not available in certain environments (e.g. Serverless GPU clusters).

  • Fix FilesExt.upload and FilesExt.upload_from would fail when the source content is empty and use_parallel=True.

API Changes

  • Add google_ads, tiktok_ads, salesforce_marketing_cloud, hubspot, workday_hcm, guidewire and zendesk enum values for databricks.sdk.service.pipelines.IngestionSourceType.
  • Add batch_create_materialized_features() method for w.feature_engineering workspace-level service.
  • Add lineage_context field for databricks.sdk.service.ml.Feature.
  • Add autoscale_v2 enum value for databricks.sdk.service.compute.EventDetailsCause.
  • Add unsupported_conversation_type_exception enum value for databricks.sdk.service.dashboards.MessageErrorType.
  • Add red_state and yellow_state enum values for databricks.sdk.service.vectorsearch.EndpointStatusState.
  • [Breaking] Change table_names field for databricks.sdk.service.jobs.TableUpdateTriggerConfiguration to be required.
  • Change table_names field for databricks.sdk.service.jobs.TableUpdateTriggerConfiguration to be required.

Release v0.71.0 (2025-10-30)

Bug Fixes

  • Fix the issue where FilesExt.upload's second parameter was changed from contents to content unintentionally. Now the interface is backward compatible to versions previous than 0.69.0.

API Changes

  • Add instance_profile_arn field for databricks.sdk.service.compute.InstancePoolAwsAttributes.
  • Add continuous, sliding and tumbling fields for databricks.sdk.service.ml.TimeWindow.
  • Add usage_policy_id field for databricks.sdk.service.pipelines.CreatePipeline.
  • Add usage_policy_id field for databricks.sdk.service.pipelines.EditPipeline.
  • Add usage_policy_id field for databricks.sdk.service.pipelines.PipelineSpec.
  • Add read_files_bytes field for databricks.sdk.service.sql.QueryMetrics.
  • Add select enum value for databricks.sdk.service.apps.AppManifestAppResourceUcSecurableSpecUcSecurablePermission.
  • Add table enum value for databricks.sdk.service.apps.AppManifestAppResourceUcSecurableSpecUcSecurableType.
  • Add decommission_started and decommission_ended enum values for databricks.sdk.service.compute.EventType.
  • Add dbr_image_resolution_failure enum value for databricks.sdk.service.compute.TerminationReasonCode.
  • Add dbr_image_resolution_failure enum value for databricks.sdk.service.sql.TerminationReasonCode.
  • [Breaking] Change offline_store_config and online_store_config fields for databricks.sdk.service.ml.MaterializedFeature to no longer be required.
  • Change offline_store_config and online_store_config fields for databricks.sdk.service.ml.MaterializedFeature to no longer be required.
  • [Breaking] Change lifecycle_state field for databricks.sdk.service.sql.AlertV2 to type databricks.sdk.service.sql.AlertLifecycleState dataclass.
  • [Breaking] Remove table field for databricks.sdk.service.jobs.TriggerSettings.
  • [Breaking] Remove duration and offset fields for databricks.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.getServiceCredentialsProvider method 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() and update_materialized_feature() methods for w.feature_engineering workspace-level service.
  • Add filter_condition field for databricks.sdk.service.ml.Feature.
  • Add absolute_session_lifetime_in_minutes and enable_single_use_refresh_tokens fields for databricks.sdk.service.oauth2.TokenAccessPolicy.
  • Add network_connectivity_config_id field for databricks.sdk.service.provisioning.CreateWorkspaceRequest.
  • Add oauth_mtls enum value for databricks.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_misconfig and network_check_multiple_components_failure_due_to_misconfig enum values for databricks.sdk.service.compute.TerminationReasonCode.
  • Add creating and create_failed enum values for databricks.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_misconfig and network_check_multiple_components_failure_due_to_misconfig enum values for databricks.sdk.service.sql.TerminationReasonCode.
  • [Breaking] Change display_name, evaluation, query_text, schedule and warehouse_id fields for databricks.sdk.service.sql.AlertV2 to be required.
  • Change display_name, evaluation, query_text, schedule and warehouse_id fields for databricks.sdk.service.sql.AlertV2 to be required.
  • Change comparison_operator and source fields for databricks.sdk.service.sql.AlertV2Evaluation to be required.
  • [Breaking] Change comparison_operator and source fields for databricks.sdk.service.sql.AlertV2Evaluation to be required.
  • Change name field for databricks.sdk.service.sql.AlertV2OperandColumn to be required.
  • [Breaking] Change name field for databricks.sdk.service.sql.AlertV2OperandColumn to be required.
  • [Breaking] Change quartz_cron_schedule and timezone_id fields for databricks.sdk.service.sql.CronSchedule to be required.
  • Change quartz_cron_schedule and timezone_id fields for databricks.sdk.service.sql.CronSchedule to be required.
  • [Breaking] Remove update() method for w.recipient_federation_policies workspace-level service.
  • [Breaking] Remove results field for databricks.sdk.service.sql.ListAlertsV2Response.

Release v0.69.0 (2025-10-20)

New Features and Improvements

  • Add a new interface upload_from to databricks.sdk.mixins.FilesExt to support upload from a file in local filesystem.
  • Improve databricks.sdk.mixins.FilesExt upload throughput by uploading data in parallel by default.
  • Add a new interface download_to to databricks.sdk.mixins.FilesExt to 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.upload to 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 for databricks.sdk.mixins.FilesExt.
  • Add use_parallel, parallelism, part_size field for databricks.sdk.mixins.FilesExt.upload.
  • [Breaking] Change files_api_client_download_max_total_recovers to files_ext_client_download_max_total_recovers for databricks.sdk.Config
  • [Breaking] Change files_api_client_download_max_total_recovers_without_progressing to files_ext_client_download_max_total_recovers_without_progressing for databricks.sdk.Config
  • [Breaking] Change multipart_upload_min_stream_size to files_ext_multipart_upload_min_stream_size for databricks.sdk.Config
  • [Breaking] Change multipart_upload_batch_url_count to files_ext_multipart_upload_batch_url_count for databricks.sdk.Config
  • [Breaking] Change multipart_upload_chunk_size to files_ext_multipart_upload_default_part_size for databricks.sdk.Config
  • [Breaking] Change multipart_upload_url_expiration_duration to files_ext_multipart_upload_url_expiration_duration for databricks.sdk.Config
  • [Breaking] Change multipart_upload_max_retries to files_ext_multipart_upload_max_retries for databricks.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_retries for databricks.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.dataquality package.
  • Add w.data_quality workspace-level service.
  • Add create_update() and get_update() methods for w.apps workspace-level service.
  • Add compute_size field for databricks.sdk.service.apps.App.
  • Add genie_space field for databricks.sdk.service.apps.AppResource.
  • Add skip_validation field for databricks.sdk.service.catalog.AccountsCreateStorageCredential.
  • Add skip_validation field for databricks.sdk.service.catalog.AccountsUpdateStorageCredential.
  • Add aliases, browse_only, created_at, created_by, full_name, metastore_id, owner, updated_at and updated_by fields for databricks.sdk.service.catalog.CreateRegisteredModelRequest.
  • Add catalog_name, id, model_name and schema_name fields for databricks.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_at and updated_by fields for databricks.sdk.service.catalog.UpdateModelVersionRequest.
  • Add aliases, browse_only, catalog_name, created_at, created_by, metastore_id, name, schema_name, storage_location, updated_at and updated_by fields for databricks.sdk.service.catalog.UpdateRegisteredModelRequest.
  • Add key_region field for databricks.sdk.service.provisioning.CreateAwsKeyInfo.
  • Add role_arn field for databricks.sdk.service.provisioning.CreateStorageConfigurationRequest.
  • Add azure_key_info field for databricks.sdk.service.provisioning.CustomerManagedKey.
  • [Breaking] Add customer_facing_private_access_settings field for databricks.sdk.service.provisioning.ReplacePrivateAccessSettingsRequest.
  • Add role_arn field for databricks.sdk.service.provisioning.StorageConfiguration.
  • [Breaking] Add customer_facing_workspace field for databricks.sdk.service.provisioning.UpdateWorkspaceRequest.
  • Add update_mask field for databricks.sdk.service.provisioning.UpdateWorkspaceRequest.
  • Add compute_mode, network, network_connectivity_config_id and storage_mode fields for databricks.sdk.service.provisioning.Workspace.
  • Add enable_serverless_compute field for databricks.sdk.service.sql.GetWorkspaceWarehouseConfigResponse.
  • Add page_size and page_token fields for databricks.sdk.service.sql.ListWarehousesRequest.
  • Add next_page_token field for databricks.sdk.service.sql.ListWarehousesResponse.
  • Add enable_serverless_compute field for databricks.sdk.service.sql.SetWorkspaceWarehouseConfigRequest.
  • Add model_version_status_unknown enum value for databricks.sdk.service.catalog.ModelVersionInfoStatus.
  • Add k8s_active_pod_quota_exceeded and cloud_account_pod_quota_exceeded enum values for databricks.sdk.service.compute.TerminationReasonCode.
  • Add internal_catalog_asset_creation_ongoing_exception, internal_catalog_asset_creation_failed_exception and internal_catalog_asset_creation_unsupported_exception enum values for databricks.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_exceeded and cloud_account_pod_quota_exceeded enum values for databricks.sdk.service.sql.TerminationReasonCode.
  • [Breaking] Change create() method for a.account_metastore_assignments account-level service to start returning databricks.sdk.service.catalog.AccountsCreateMetastoreAssignmentResponse dataclass.
  • [Breaking] Change delete() method for a.account_metastore_assignments account-level service to start returning databricks.sdk.service.catalog.AccountsDeleteMetastoreAssignmentResponse dataclass.
  • [Breaking] Change update() method for a.account_metastore_assignments account-level service to start returning databricks.sdk.service.catalog.AccountsUpdateMetastoreAssignmentResponse dataclass.
  • [Breaking] Change create() method for a.account_metastores account-level service to return databricks.sdk.service.catalog.AccountsCreateMetastoreResponse dataclass.
  • [Breaking] Change delete() method for a.account_metastores account-level service to start returning databricks.sdk.service.catalog.AccountsDeleteMetastoreResponse dataclass.
  • [Breaking] Change get() method for a.account_metastores account-level service to return databricks.sdk.service.catalog.AccountsGetMetastoreResponse dataclass.
  • [Breaking] Change list() method for a.account_metastores account-level service to return databricks.sdk.service.catalog.AccountsListMetastoresResponse dataclass.
  • [Breaking] Change update() method for a.account_metastores account-level service to return databricks.sdk.service.catalog.AccountsUpdateMetastoreResponse dataclass.
  • [Breaking] Change create() method for a.account_storage_credentials account-level service to return databricks.sdk.service.catalog.AccountsCreateStorageCredentialInfo dataclass.
  • [Breaking] Change delete() method for a.account_storage_credentials account-level service to start returning databricks.sdk.service.catalog.AccountsDeleteStorageCredentialResponse dataclass.
  • [Breaking] Change update() method for a.account_storage_credentials account-level service to return databricks.sdk.service.catalog.AccountsUpdateStorageCredentialResponse dataclass.
  • [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 returning databricks.sdk.service.provisioning.Credential dataclass.
  • [Breaking] Change delete() method for a.encryption_keys account-level service to start returning databricks.sdk.service.provisioning.CustomerManagedKey dataclass.
  • [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 returning databricks.sdk.service.provisioning.Network dataclass.
  • [Breaking] Change create() and replace() methods for a.private_access account-level service with new required argument order.
  • [Breaking] Change delete() and replace() methods for a.private_access account-level service to start returning databricks.sdk.service.provisioning.PrivateAccessSettings dataclass.
  • [Breaking] Change delete() method for a.storage account-level service to start returning databricks.sdk.service.provisioning.StorageConfiguration dataclass.
  • [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 returning databricks.sdk.service.provisioning.VpcEndpoint dataclass.
  • [Breaking] Change create() and update() methods for a.workspaces account-level service with new required argument order.
  • [Breaking] Change delete() and update() methods for a.workspaces account-level service to start returning databricks.sdk.service.provisioning.Workspace dataclass.
  • [Breaking] Change execute_statement() method for w.statement_execution workspace-level service . Method path has changed.
  • [Breaking] Change metastore_info field for databricks.sdk.service.catalog.AccountsCreateMetastore to type databricks.sdk.service.catalog.CreateAccountsMetastore dataclass.
  • [Breaking] Change credential_info field for databricks.sdk.service.catalog.AccountsCreateStorageCredential to type databricks.sdk.service.catalog.CreateAccountsStorageCredential dataclass.
  • [Breaking] Change metastore_info field for databricks.sdk.service.catalog.AccountsUpdateMetastore to type databricks.sdk.service.catalog.UpdateAccountsMetastore dataclass.
  • [Breaking] Change credential_info field for databricks.sdk.service.catalog.AccountsUpdateStorageCredential to type databricks.sdk.service.catalog.UpdateAccountsStorageCredential dataclass.
  • Change catalog_name, name and schema_name fields for databricks.sdk.service.catalog.CreateRegisteredModelRequest to no longer be required.
  • Change network_name field for databricks.sdk.service.provisioning.CreateNetworkRequest to no longer be required.
  • Change private_access_settings_name and region fields for databricks.sdk.service.provisioning.CreatePrivateAccessSettingsRequest to no longer be required.
  • Change vpc_endpoint_name field for databricks.sdk.service.provisioning.CreateVpcEndpointRequest to no longer be required.
  • Change workspace_name field for databricks.sdk.service.provisioning.CreateWorkspaceRequest to no longer be required.
  • [Breaking] Change dataplane_relay and rest_api fields for databricks.sdk.service.provisioning.NetworkVpcEndpoints to no longer be required.
  • Change dataplane_relay and rest_api fields for databricks.sdk.service.provisioning.NetworkVpcEndpoints to no longer be required.
  • [Breaking] Change waiter for WorkspacesAPI.update method.
  • [Breaking] Remove browse_only field for databricks.sdk.service.catalog.ModelVersionInfo.
  • [Breaking] Remove jar_dependencies field for databricks.sdk.service.compute.Environment.
  • [Breaking] Remove is_no_public_ip_enabled field for databricks.sdk.service.provisioning.CreateWorkspaceRequest.
  • [Breaking] Remove allowed_vpc_endpoint_ids, private_access_level, private_access_settings_name, public_access_enabled and region fields for databricks.sdk.service.provisioning.ReplacePrivateAccessSettingsRequest.
  • [Breaking] Remove external_id field for databricks.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_id and storage_customer_managed_key_id fields for databricks.sdk.service.provisioning.UpdateWorkspaceRequest.
  • [Breaking] Remove external_customer_info and is_no_public_ip_enabled fields for databricks.sdk.service.provisioning.Workspace.
  • [Breaking] Remove status_unspecified enum value for databricks.sdk.service.sql.Status.
  • Add browse_only field for databricks.sdk.service.catalog.ModelVersionInfo.
  • Add jar_dependencies field for databricks.sdk.service.compute.Environment.
  • Add is_no_public_ip_enabled field for databricks.sdk.service.provisioning.CreateWorkspaceRequest.
  • Add allowed_vpc_endpoint_ids, private_access_level and public_access_enabled fields for databricks.sdk.service.provisioning.ReplacePrivateAccessSettingsRequest.
  • [Breaking] Add private_access_settings_name and region fields for databricks.sdk.service.provisioning.ReplacePrivateAccessSettingsRequest.
  • Add external_id field for databricks.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_id and storage_customer_managed_key_id fields for databricks.sdk.service.provisioning.UpdateWorkspaceRequest.
  • Add external_customer_info and is_no_public_ip_enabled fields for databricks.sdk.service.provisioning.Workspace.
  • Add status_unspecified enum value for databricks.sdk.service.sql.Status.
  • [Breaking] Change create() method for a.account_metastore_assignments account-level service to no longer return databricks.sdk.service.catalog.AccountsCreateMetastoreAssignmentResponse dataclass.
  • [Breaking] Change delete() method for a.account_metastore_assignments account-level service to no longer return databricks.sdk.service.catalog.AccountsDeleteMetastoreAssignmentResponse dataclass.
  • [Breaking] Change update() method for a.account_metastore_assignments account-level service to no longer return databricks.sdk.service.catalog.AccountsUpdateMetastoreAssignmentResponse dataclass.
  • [Breaking] Change create(), get() and update() methods for a.account_metastores account-level service to return databricks.sdk.service.catalog.AccountsMetastoreInfo dataclass.
  • [Breaking] Change delete() method for a.account_metastores account-level service to no longer return databricks.sdk.service.catalog.AccountsDeleteMetastoreResponse dataclass.
  • [Breaking] Change list() method for a.account_metastores account-level service to return databricks.sdk.service.catalog.ListMetastoresResponse dataclass.
  • [Breaking] Change create() and update() methods for a.account_storage_credentials account-level service to return databricks.sdk.service.catalog.AccountsStorageCredentialInfo dataclass.
  • [Breaking] Change delete() method for a.account_storage_credentials account-level service to no longer return databricks.sdk.service.catalog.AccountsDeleteStorageCredentialResponse dataclass.
  • [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 return databricks.sdk.service.provisioning.Credential dataclass.
  • [Breaking] Change delete() method for a.encryption_keys account-level service to no longer return databricks.sdk.service.provisioning.CustomerManagedKey dataclass.
  • [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 return databricks.sdk.service.provisioning.Network dataclass.
  • [Breaking] Change create() and replace() methods for a.private_access account-level service with new required argument order.
  • [Breaking] Change delete() and replace() methods for a.private_access account-level service to no longer return databricks.sdk.service.provisioning.PrivateAccessSettings dataclass.
  • [Breaking] Change delete() method for a.storage account-level service to no longer return databricks.sdk.service.provisioning.StorageConfiguration dataclass.
  • [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 return databricks.sdk.service.provisioning.VpcEndpoint dataclass.
  • [Breaking] Change create() and update() methods for a.workspaces account-level service with new required argument order.
  • [Breaking] Change delete() and update() methods for a.workspaces account-level service to no longer return databricks.sdk.service.provisioning.Workspace dataclass.
  • [Breaking] Change execute_statement() method for w.statement_execution workspace-level service . Method path has changed.
  • [Breaking] Change metastore_info field for databricks.sdk.service.catalog.AccountsCreateMetastore to type databricks.sdk.service.catalog.CreateMetastore dataclass.
  • [Breaking] Change credential_info field for databricks.sdk.service.catalog.AccountsCreateStorageCredential to type databricks.sdk.service.catalog.CreateStorageCredential dataclass.
  • [Breaking] Change metastore_info field for databricks.sdk.service.catalog.AccountsUpdateMetastore to type databricks.sdk.service.catalog.UpdateMetastore dataclass.
  • [Breaking] Change credential_info field for databricks.sdk.service.catalog.AccountsUpdateStorageCredential to type databricks.sdk.service.catalog.UpdateStorageCredential dataclass.
  • [Breaking] Change catalog_name, name and schema_name fields for databricks.sdk.service.catalog.CreateRegisteredModelRequest to be required.
  • [Breaking] Change name field for databricks.sdk.service.database.DatabaseInstanceRole to no longer be required.
  • Change name field for databricks.sdk.service.database.DatabaseInstanceRole to no longer be required.
  • [Breaking] Change network_name field for databricks.sdk.service.provisioning.CreateNetworkRequest to be required.
  • [Breaking] Change private_access_settings_name and region fields for databricks.sdk.service.provisioning.CreatePrivateAccessSettingsRequest to be required.
  • [Breaking] Change vpc_endpoint_name field for databricks.sdk.service.provisioning.CreateVpcEndpointRequest to be required.
  • [Breaking] Change workspace_name field for databricks.sdk.service.provisioning.CreateWorkspaceRequest to be required.
  • Change dataplane_relay and rest_api fields for databricks.sdk.service.provisioning.NetworkVpcEndpoints to be required.
  • [Breaking] Change dataplane_relay and rest_api fields for databricks.sdk.service.provisioning.NetworkVpcEndpoints to be required.
  • [Breaking] Change waiter for WorkspacesAPI.update method.
  • [Breaking] Remove databricks.sdk.service.dataquality package.
  • [Breaking] Remove create_update() and get_update() methods for w.apps workspace-level service.
  • [Breaking] Remove update_notifications() method for w.serving_endpoints workspace-level service.
  • [Breaking] Remove compute_size field for databricks.sdk.service.apps.App.
  • [Breaking] Remove genie_space field for databricks.sdk.service.apps.AppResource.
  • [Breaking] Remove skip_validation field for databricks.sdk.service.catalog.AccountsCreateStorageCredential.
  • [Breaking] Remove skip_validation field for databricks.sdk.service.catalog.AccountsUpdateStorageCredential.
  • [Breaking] Remove aliases, browse_only, created_at, created_by, full_name, metastore_id, owner, updated_at and updated_by fields for databricks.sdk.service.catalog.CreateRegisteredModelRequest.
  • [Breaking] Remove catalog_name, id, model_name and schema_name fields for databricks.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_at and updated_by fields for databricks.sdk.service.catalog.UpdateModelVersionRequest.
  • [Breaking] Remove aliases, browse_only, catalog_name, created_at, created_by, metastore_id, name, schema_name, storage_location, updated_at and updated_by fields for databricks.sdk.service.catalog.UpdateRegisteredModelRequest.
  • [Breaking] Remove parameters field for databricks.sdk.service.dashboards.GenieQueryAttachment.
  • [Breaking] Remove database_instance_name field for databricks.sdk.service.database.CreateDatabaseInstanceRoleRequest.
  • [Breaking] Remove custom_tags, effective_custom_tags, effective_usage_policy_id and usage_policy_id fields for databricks.sdk.service.database.DatabaseInstance.
  • [Breaking] Remove effective_attributes and instance_name fields for databricks.sdk.service.database.DatabaseInstanceRole.
  • [Breaking] Remove key_region field for databricks.sdk.service.provisioning.CreateAwsKeyInfo.
  • [Breaking] Remove role_arn field for databricks.sdk.service.provisioning.CreateStorageConfigurationRequest.
  • [Breaking] Remove azure_key_info field for databricks.sdk.service.provisioning.CustomerManagedKey.
  • [Breaking] Remove customer_facing_private_access_settings field for databricks.sdk.service.provisioning.ReplacePrivateAccessSettingsRequest.
  • [Breaking] Remove role_arn field for databricks.sdk.service.provisioning.StorageConfiguration.
  • [Breaking] Remove customer_facing_workspace and update_mask fields for databricks.sdk.service.provisioning.UpdateWorkspaceRequest.
  • [Breaking] Remove compute_mode, network, network_connectivity_config_id and storage_mode fields for databricks.sdk.service.provisioning.Workspace.
  • [Breaking] Remove enable_serverless_compute field for databricks.sdk.service.sql.GetWorkspaceWarehouseConfigResponse.
  • [Breaking] Remove page_size and page_token fields for databricks.sdk.service.sql.ListWarehousesRequest.
  • [Breaking] Remove next_page_token field for databricks.sdk.service.sql.ListWarehousesResponse.
  • [Breaking] Remove enable_serverless_compute field for databricks.sdk.service.sql.SetWorkspaceWarehouseConfigRequest.
  • [Breaking] Remove model_version_status_unknown enum value for databricks.sdk.service.catalog.ModelVersionInfoStatus.
  • [Breaking] Remove stream_native enum value for databricks.sdk.service.catalog.SystemType.
  • [Breaking] Remove k8s_active_pod_quota_exceeded and cloud_account_pod_quota_exceeded enum values for databricks.sdk.service.compute.TerminationReasonCode.
  • [Breaking] Remove exceeded_max_token_length_exception, internal_catalog_asset_creation_ongoing_exception, internal_catalog_asset_creation_failed_exception and internal_catalog_asset_creation_unsupported_exception enum values for databricks.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_exceeded and cloud_account_pod_quota_exceeded enum values for databricks.sdk.service.sql.TerminationReasonCode.
  • Add databricks.sdk.service.dataquality package.
  • Add w.data_quality workspace-level service.
  • Add create_update() and get_update() methods for w.apps workspace-level service.
  • Add update_notifications() method for w.serving_endpoints workspace-level service.
  • Add compute_size field for databricks.sdk.service.apps.App.
  • Add genie_space field for databricks.sdk.service.apps.AppResource.
  • Add skip_validation field for databricks.sdk.service.catalog.AccountsCreateStorageCredential.
  • Add skip_validation field for databricks.sdk.service.catalog.AccountsUpdateStorageCredential.
  • Add aliases, browse_only, created_at, created_by, full_name, metastore_id, owner, updated_at and updated_by fields for databricks.sdk.service.catalog.CreateRegisteredModelRequest.
  • Add include_unbound field for databricks.sdk.service.catalog.ListCatalogsRequest.
  • Add include_unbound field for databricks.sdk.service.catalog.ListCredentialsRequest.
  • Add include_unbound field for databricks.sdk.service.catalog.ListExternalLocationsRequest.
  • Add include_unbound field for databricks.sdk.service.catalog.ListStorageCredentialsRequest.
  • Add catalog_name, id, model_name and schema_name fields for databricks.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_at and updated_by fields for databricks.sdk.service.catalog.UpdateModelVersionRequest.
  • Add aliases, browse_only, catalog_name, created_at, created_by, metastore_id, name, schema_name, storage_location, updated_at and updated_by fields for databricks.sdk.service.catalog.UpdateRegisteredModelRequest.
  • Add parameters field for databricks.sdk.service.dashboards.GenieQueryAttachment.
  • Add database_instance_name field for databricks.sdk.service.database.CreateDatabaseInstanceRoleRequest.
  • Add custom_tags, effective_custom_tags, effective_usage_policy_id and usage_policy_id fields for databricks.sdk.service.database.DatabaseInstance.
  • Add effective_attributes and instance_name fields for databricks.sdk.service.database.DatabaseInstanceRole.
  • Add key_region field for databricks.sdk.service.provisioning.CreateAwsKeyInfo.
  • Add role_arn field for databricks.sdk.service.provisioning.CreateStorageConfigurationRequest.
  • Add azure_key_info field for databricks.sdk.service.provisioning.CustomerManagedKey.
  • [Breaking] Add customer_facing_private_access_settings field for databricks.sdk.service.provisioning.ReplacePrivateAccessSettingsRequest.
  • Add role_arn field for databricks.sdk.service.provisioning.StorageConfiguration.
  • [Breaking] Add customer_facing_workspace field for databricks.sdk.service.provisioning.UpdateWorkspaceRequest.
  • Add update_mask field for databricks.sdk.service.provisioning.UpdateWorkspaceRequest.
  • Add compute_mode, network, network_connectivity_config_id and storage_mode fields for databricks.sdk.service.provisioning.Workspace.
  • Add enable_serverless_compute field for databricks.sdk.service.sql.GetWorkspaceWarehouseConfigResponse.
  • Add page_size and page_token fields for databricks.sdk.service.sql.ListWarehousesRequest.
  • Add next_page_token field for databricks.sdk.service.sql.ListWarehousesResponse.
  • Add enable_serverless_compute field for databricks.sdk.service.sql.SetWorkspaceWarehouseConfigRequest.
  • Add model_version_status_unknown enum value for databricks.sdk.service.catalog.ModelVersionInfoStatus.
  • Add stream_native enum value for databricks.sdk.service.catalog.SystemType.
  • Add k8s_active_pod_quota_exceeded and cloud_account_pod_quota_exceeded enum values for databricks.sdk.service.compute.TerminationReasonCode.
  • Add exceeded_max_token_length_exception, internal_catalog_asset_creation_ongoing_exception, internal_catalog_asset_creation_failed_exception and internal_catalog_asset_creation_unsupported_exception enum values for databricks.sdk.service.dashboards.MessageErrorType.
  • Add asset_type_mcp enum value for databricks.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_exceeded and cloud_account_pod_quota_exceeded enum values for databricks.sdk.service.sql.TerminationReasonCode.
  • [Breaking] Change create() method for a.account_metastore_assignments account-level service to start returning databricks.sdk.service.catalog.AccountsCreateMetastoreAssignmentResponse dataclass.
  • [Breaking] Change delete() method for a.account_metastore_assignments account-level service to start returning databricks.sdk.service.catalog.AccountsDeleteMetastoreAssignmentResponse dataclass.
  • [Breaking] Change update() method for a.account_metastore_assignments account-level service to start returning databricks.sdk.service.catalog.AccountsUpdateMetastoreAssignmentResponse dataclass.
  • [Breaking] Change create() method for a.account_metastores account-level service to return databricks.sdk.service.catalog.AccountsCreateMetastoreResponse dataclass.
  • [Breaking] Change delete() method for a.account_metastores account-level service to start returning databricks.sdk.service.catalog.AccountsDeleteMetastoreResponse dataclass.
  • [Breaking] Change get() method for a.account_metastores account-level service to return databricks.sdk.service.catalog.AccountsGetMetastoreResponse dataclass.
  • [Breaking] Change list() method for a.account_metastores account-level service to return databricks.sdk.service.catalog.AccountsListMetastoresResponse dataclass.
  • [Breaking] Change update() method for a.account_metastores account-level service to return databricks.sdk.service.catalog.AccountsUpdateMetastoreResponse dataclass.
  • [Breaking] Change create() method for a.account_storage_credentials account-level service to return databricks.sdk.service.catalog.AccountsCreateStorageCredentialInfo dataclass.
  • [Breaking] Change delete() method for a.account_storage_credentials account-level service to start returning databricks.sdk.service.catalog.AccountsDeleteStorageCredentialResponse dataclass.
  • [Breaking] Change update() method for a.account_storage_credentials account-level service to return databricks.sdk.service.catalog.AccountsUpdateStorageCredentialResponse dataclass.
  • [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 returning databricks.sdk.service.provisioning.Credential dataclass.
  • [Breaking] Change delete() method for a.encryption_keys account-level service to start returning databricks.sdk.service.provisioning.CustomerManagedKey dataclass.
  • [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 returning databricks.sdk.service.provisioning.Network dataclass.
  • [Breaking] Change create() and replace() methods for a.private_access account-level service with new required argument order.
  • [Breaking] Change delete() and replace() methods for a.private_access account-level service to start returning databricks.sdk.service.provisioning.PrivateAccessSettings dataclass.
  • [Breaking] Change delete() method for a.storage account-level service to start returning databricks.sdk.service.provisioning.StorageConfiguration dataclass.
  • [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 returning databricks.sdk.service.provisioning.VpcEndpoint dataclass.
  • [Breaking] Change create() and update() methods for a.workspaces account-level service with new required argument order.
  • [Breaking] Change delete() and update() methods for a.workspaces account-level service to start returning databricks.sdk.service.provisioning.Workspace dataclass.
  • [Breaking] Change execute_statement() method for w.statement_execution workspace-level service . Method path has changed.
  • [Breaking] Change metastore_info field for databricks.sdk.service.catalog.AccountsCreateMetastore to type databricks.sdk.service.catalog.CreateAccountsMetastore dataclass.
  • [Breaking] Change credential_info field for databricks.sdk.service.catalog.AccountsCreateStorageCredential to type databricks.sdk.service.catalog.CreateAccountsStorageCredential dataclass.
  • [Breaking] Change metastore_info field for databricks.sdk.service.catalog.AccountsUpdateMetastore to type databricks.sdk.service.catalog.UpdateAccountsMetastore dataclass.
  • [Breaking] Change credential_info field for databricks.sdk.service.catalog.AccountsUpdateStorageCredential to type databricks.sdk.service.catalog.UpdateAccountsStorageCredential dataclass.
  • Change catalog_name, name and schema_name fields for databricks.sdk.service.catalog.CreateRegisteredModelRequest to no longer be required.
  • [Breaking] Change name field for databricks.sdk.service.database.DatabaseInstanceRole to be required.
  • Change name field for databricks.sdk.service.database.DatabaseInstanceRole to be required.
  • Change network_name field for databricks.sdk.service.provisioning.CreateNetworkRequest to no longer be required.
  • Change private_access_settings_name and region fields for databricks.sdk.service.provisioning.CreatePrivateAccessSettingsRequest to no longer be required.
  • Change vpc_endpoint_name field for databricks.sdk.service.provisioning.CreateVpcEndpointRequest to no longer be required.
  • Change workspace_name field for databricks.sdk.service.provisioning.CreateWorkspaceRequest to no longer be required.
  • Change dataplane_relay and rest_api fields for databricks.sdk.service.provisioning.NetworkVpcEndpoints to no longer be required.
  • [Breaking] Change dataplane_relay and rest_api fields for databricks.sdk.service.provisioning.NetworkVpcEndpoints to no longer be required.
  • [Breaking] Change waiter for WorkspacesAPI.update method.
  • [Breaking] Remove browse_only field for databricks.sdk.service.catalog.ModelVersionInfo.
  • [Breaking] Remove jar_dependencies field for databricks.sdk.service.compute.Environment.
  • [Breaking] Remove is_no_public_ip_enabled field for databricks.sdk.service.provisioning.CreateWorkspaceRequest.
  • [Breaking] Remove allowed_vpc_endpoint_ids, private_access_level, private_access_settings_name, public_access_enabled and region fields for databricks.sdk.service.provisioning.ReplacePrivateAccessSettingsRequest.
  • [Breaking] Remove external_id field for databricks.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_id and storage_customer_managed_key_id fields for databricks.sdk.service.provisioning.UpdateWorkspaceRequest.
  • [Breaking] Remove external_customer_info and is_no_public_ip_enabled fields for databricks.sdk.service.provisioning.Workspace.
  • [Breaking] Remove status_unspecified enum value for databricks.sdk.service.sql.Status.
  • Add compute_mode field for databricks.sdk.service.provisioning.CreateWorkspaceRequest.
  • Add expected_workspace_status field for databricks.sdk.service.provisioning.Workspace.
  • Add dependency_storage_locations field for databricks.sdk.service.sharing.TableInternalAttributes.
  • Add git_email field for databricks.sdk.service.workspace.CreateCredentialsRequest.
  • Add git_email field for databricks.sdk.service.workspace.CreateCredentialsResponse.
  • Add git_email field for databricks.sdk.service.workspace.CredentialInfo.
  • Add git_email field for databricks.sdk.service.workspace.GetCredentialsResponse.
  • Add git_email field for databricks.sdk.service.workspace.UpdateCredentialsRequest.
  • Add germany_tisax enum value for databricks.sdk.service.settings.ComplianceStandard.
  • [Breaking] Remove prediction_probability_column field for databricks.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 parameters field for databricks.sdk.service.dashboards.GenieQueryAttachment.
  • Add database_instance_name field for databricks.sdk.service.database.CreateDatabaseInstanceRoleRequest.
  • Add custom_tags, effective_custom_tags, effective_usage_policy_id and usage_policy_id fields for databricks.sdk.service.database.DatabaseInstance.
  • Add effective_attributes and instance_name fields for databricks.sdk.service.database.DatabaseInstanceRole.
  • Add external_use_schema enum value for databricks.sdk.service.catalog.Privilege.
  • Add stream_native enum value for databricks.sdk.service.catalog.SystemType.
  • Add exceeded_max_token_length_exception enum value for databricks.sdk.service.dashboards.MessageErrorType.
  • Change name field for databricks.sdk.service.database.DatabaseInstanceRole to be required.
  • [Breaking] Change name field for databricks.sdk.service.database.DatabaseInstanceRole to be required.

Release v0.66.0 (2025-09-22)

New Features and Improvements

  • Add a public helper function to build a CredentialsProvider directly from an IdTokenSource.

API Changes

  • Added databricks.sdk.service.iamv2 package.
  • 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_dependencies field for databricks.sdk.service.compute.Environment.
  • Added followup_questions field for databricks.sdk.service.dashboards.GenieAttachment.
  • Added feedback field for databricks.sdk.service.dashboards.GenieMessage.
  • Added effective_capacity field for databricks.sdk.service.database.DatabaseInstance.
  • Added disabled field for databricks.sdk.service.jobs.Task.
  • Added netsuite_jar_path field for databricks.sdk.service.pipelines.IngestionPipelineDefinition.
  • Added workday_report_parameters field for databricks.sdk.service.pipelines.TableSpecificConfig.
  • Added auxiliary_managed_location field for databricks.sdk.service.sharing.TableInternalAttributes.
  • Added alerts field for databricks.sdk.service.sql.ListAlertsV2Response.
  • Added create_time and update_time fields for databricks.sdk.service.tags.TagPolicy.
  • Added table_delta_uniform_iceberg_foreign_deltasharing enum value for databricks.sdk.service.catalog.SecurableKind.
  • Added no_activated_k8s and usage_policy_entitlement_denied enum values for databricks.sdk.service.compute.TerminationReasonCode.
  • Added internal_catalog_path_overlap_exception and internal_catalog_missing_uc_path_exception enum values for databricks.sdk.service.dashboards.MessageErrorType.
  • Added foreign_catalog enum value for databricks.sdk.service.pipelines.IngestionSourceType.
  • Added foreign_iceberg_table enum value for databricks.sdk.service.sharing.TableInternalAttributesSharedTableType.
  • [Breaking] Removed disabled field for databricks.sdk.service.jobs.RunTask.
  • [Breaking] Removed default_data_security_mode and effective_default_data_security_mode fields for databricks.sdk.service.settingsv2.Setting.
  • Added list_shares() method for w.shares workspace-level service.
  • Added suggested_questions field for databricks.sdk.service.dashboards.GenieAttachment.
  • Added warehouse_id field for databricks.sdk.service.dashboards.GenieSpace.
  • Added palantir enum value for databricks.sdk.service.catalog.ConnectionType.
  • Added table_metric_view_deltasharing and table_foreign_palantir enum values for databricks.sdk.service.catalog.SecurableKind.
  • Added no_activated_k8s_testing_tag enum value for databricks.sdk.service.compute.TerminationReasonCode.
  • Added metric_view enum value for databricks.sdk.service.sharing.TableInternalAttributesSharedTableType.
  • [Breaking] Removed followup_questions field for databricks.sdk.service.dashboards.GenieAttachment.
  • [Breaking] Removed comment field for databricks.sdk.service.dashboards.GenieFeedback.
  • [Breaking] Removed comment field for databricks.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 like timeout and max_retries when creating an OpenAI client for Databricks Model Serving.

API Changes

  • Added comment field for databricks.sdk.service.dashboards.GenieSendMessageFeedbackRequest.
  • [Breaking] Added rating field for databricks.sdk.service.dashboards.GenieSendMessageFeedbackRequest.
  • Added effective_enable_pg_native_login and enable_pg_native_login fields for databricks.sdk.service.database.DatabaseInstance.
  • Added task_retry_mode field for databricks.sdk.service.jobs.Continuous.
  • Added source_configurations field for databricks.sdk.service.pipelines.IngestionPipelineDefinition.
  • Added app_id, app_id_set, auth_secret, auth_secret_set, channel_url, channel_url_set, tenant_id and tenant_id_set fields for databricks.sdk.service.settings.MicrosoftTeamsConfig.
  • Added ensure_reranker_compatible field for databricks.sdk.service.vectorsearch.GetIndexRequest.
  • Added reranker field for databricks.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_review field for databricks.sdk.service.cleanrooms.CreateCleanRoomAssetReviewRequest to no longer be required.
  • [Breaking] Changed features field for databricks.sdk.service.ml.FeatureList to type list[databricks.sdk.service.ml.LinkedFeature] dataclass.
  • [Breaking] Removed feedback_rating and feedback_text fields for databricks.sdk.service.dashboards.GenieSendMessageFeedbackRequest.

Release v0.64.0 (2025-08-20)

API Changes

  • Added databricks.sdk.service.settingsv2 and databricks.sdk.service.tags packages.
  • 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() and send_message_feedback() methods for w.genie workspace-level service.
  • Added include_all field for databricks.sdk.service.dashboards.GenieListConversationsRequest.
  • Added effective_usage_policy_id field for databricks.sdk.service.jobs.BaseJob.
  • Added effective_usage_policy_id field for databricks.sdk.service.jobs.BaseRun.
  • Added effective_usage_policy_id field for databricks.sdk.service.jobs.Job.
  • Added effective_usage_policy_id field for databricks.sdk.service.jobs.Run.
  • Added tokens field for databricks.sdk.service.serving.AiGatewayRateLimit.
  • Added usage_policy_id field for databricks.sdk.service.serving.ServingEndpoint.
  • Added effective_run_as and run_as fields for databricks.sdk.service.sql.AlertV2.
  • Added cache_query_id field for databricks.sdk.service.sql.QueryInfo.
  • Added model_endpoint_name_for_query field for databricks.sdk.service.vectorsearch.EmbeddingSourceColumn.
  • [Breaking] Removed environment_settings field for databricks.sdk.service.catalog.ConnectionInfo.
  • [Breaking] Removed environment_settings field for databricks.sdk.service.catalog.CreateConnection.
  • [Breaking] Removed environment_settings field for databricks.sdk.service.catalog.UpdateConnection.
  • [Breaking] Removed comment, display_name and tags fields for databricks.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() and update_synced_database_table() methods for w.database workspace-level service.
  • Added first_on_demand field for databricks.sdk.service.compute.GcpAttributes.
  • Added usage_policy_id field for databricks.sdk.service.jobs.CreateJob.
  • Added usage_policy_id field for databricks.sdk.service.jobs.JobSettings.
  • Added usage_policy_id field for databricks.sdk.service.jobs.SubmitRun.
  • Added client_request_id and usage_context fields for databricks.sdk.service.serving.QueryEndpointInput.
  • Added channel_id, channel_id_set, oauth_token and oauth_token_set fields for databricks.sdk.service.settings.SlackConfig.
  • Added snapshot enum value for databricks.sdk.service.ml.PublishSpecPublishMode.
  • [Breaking] Changed publish_mode field for databricks.sdk.service.ml.PublishSpec to be required.

Release v0.62.0 (2025-08-06)

Bug Fixes

  • Fix Config.oauth_token() to avoid re-creating a new CredentialsProvider at each call. This fix indirectly makes oauth_token() benefit from the internal caching mechanism of some providers.

API Changes

  • Added statement_id_signature field for databricks.sdk.service.dashboards.Result.
  • Added effective_database_instance_name and effective_logical_database_name fields for databricks.sdk.service.database.SyncedDatabaseTable.
  • Added table field for databricks.sdk.service.jobs.TriggerStateProto.
  • Added email_notifications field for databricks.sdk.service.serving.CreatePtEndpointRequest.
  • Added email_notifications field for databricks.sdk.service.serving.CreateServingEndpoint.
  • Added email_notifications field for databricks.sdk.service.serving.ServingEndpointDetailed.
  • [Breaking] Changed list() method for w.consumer_providers workspace-level service . New request type is databricks.sdk.service.marketplace.ListConsumerProvidersRequest dataclass.
  • [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 is databricks.sdk.service.provisioning.CreatePrivateAccessSettingsRequest dataclass.
  • [Breaking] Changed replace() method for a.private_access account-level service . New request type is databricks.sdk.service.provisioning.ReplacePrivateAccessSettingsRequest dataclass.
  • [Breaking] Removed is_featured field for databricks.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_msg field for databricks.sdk.service.catalog.CreateMonitor.
  • Added latest_monitor_failure_msg field for databricks.sdk.service.catalog.UpdateMonitor.
  • Added share field for databricks.sdk.service.sharing.ListProviderShareAssetsResponse.
  • Added projected_remaining_wallclock_time_ms field for databricks.sdk.service.sql.QueryMetrics.
  • Added unspecified enum value for databricks.sdk.service.catalog.MonitorCronSchedulePauseStatus.
  • Added unknown enum value for databricks.sdk.service.catalog.MonitorRefreshInfoState.
  • Added unknown_trigger enum value for databricks.sdk.service.catalog.MonitorRefreshInfoTrigger.
  • Added message_attachment_too_long_error enum value for databricks.sdk.service.dashboards.MessageErrorType.
  • Added mask enum value for databricks.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 returning databricks.sdk.service.catalog.CancelRefreshResponse dataclass.
  • [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 returning databricks.sdk.service.catalog.DeleteMonitorResponse dataclass.
  • [Breaking] Changed refresh_id field for databricks.sdk.service.catalog.CancelRefreshRequest to type int dataclass.
  • [Breaking] Changed refresh_id field for databricks.sdk.service.catalog.GetRefreshRequest to type int dataclass.
  • [Breaking] Changed monitor_version field for databricks.sdk.service.catalog.MonitorInfo to type int dataclass.
  • Changed output_schema_name field for databricks.sdk.service.catalog.MonitorInfo to 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 FilesExt fails to retry if it receives certain status code from server.

Internal Changes

  • Refactor unit tests for FilesExt to improve its readability.

API Changes

  • Added databricks.sdk.service.agentbricks package.
  • Added provisioning_phase field for databricks.sdk.service.database.SyncedTablePipelineProgress.
  • Added redshift and sqldw enum values for databricks.sdk.service.pipelines.IngestionSourceType.
  • Added germany_c5 enum value for databricks.sdk.service.settings.ComplianceStandard.
  • Changed asset_type and name fields for databricks.sdk.service.cleanrooms.CleanRoomAsset to be required.
  • [Breaking] Changed asset_type and name fields for databricks.sdk.service.cleanrooms.CleanRoomAsset to be required.
  • [Breaking] Changed local_name field for databricks.sdk.service.cleanrooms.CleanRoomAssetForeignTableLocalDetails to be required.
  • Changed local_name field for databricks.sdk.service.cleanrooms.CleanRoomAssetForeignTableLocalDetails to be required.
  • Changed notebook_content field for databricks.sdk.service.cleanrooms.CleanRoomAssetNotebook to be required.
  • [Breaking] Changed notebook_content field for databricks.sdk.service.cleanrooms.CleanRoomAssetNotebook to be required.
  • Changed local_name field for databricks.sdk.service.cleanrooms.CleanRoomAssetTableLocalDetails to be required.
  • [Breaking] Changed local_name field for databricks.sdk.service.cleanrooms.CleanRoomAssetTableLocalDetails to be required.
  • [Breaking] Changed local_name field for databricks.sdk.service.cleanrooms.CleanRoomAssetViewLocalDetails to be required.
  • Changed local_name field for databricks.sdk.service.cleanrooms.CleanRoomAssetViewLocalDetails to be required.
  • [Breaking] Changed local_name field for databricks.sdk.service.cleanrooms.CleanRoomAssetVolumeLocalDetails to be required.
  • Changed local_name field for databricks.sdk.service.cleanrooms.CleanRoomAssetVolumeLocalDetails to be required.
  • [Breaking] Removed databricks.sdk.service.aibuilder package.

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 database field for databricks.sdk.service.apps.AppResource.
  • Added environment_settings field for databricks.sdk.service.catalog.ConnectionInfo.
  • Added environment_settings field for databricks.sdk.service.catalog.CreateConnection.
  • Added environment_settings field for databricks.sdk.service.catalog.UpdateConnection.
  • Added read_replica_count field for databricks.sdk.service.ml.OnlineStore.
  • Added page_size field for databricks.sdk.service.oauth2.ListServicePrincipalSecretsRequest.
  • Added query_based_connector_config field for databricks.sdk.service.pipelines.TableSpecificConfig.
  • Added projected_remaining_task_total_time_ms, remaining_task_count, runnable_tasks and work_to_be_done fields for databricks.sdk.service.sql.QueryMetrics.
  • Added is_default_for_provider and name fields for databricks.sdk.service.workspace.CreateCredentialsRequest.
  • Added is_default_for_provider and name fields for databricks.sdk.service.workspace.CreateCredentialsResponse.
  • Added is_default_for_provider and name fields for databricks.sdk.service.workspace.CredentialInfo.
  • Added is_default_for_provider and name fields for databricks.sdk.service.workspace.GetCredentialsResponse.
  • Added is_default_for_provider and name fields for databricks.sdk.service.workspace.UpdateCredentialsRequest.
  • Added databricks enum value for databricks.sdk.service.catalog.SystemType.
  • Added driver_dns_resolution_failure enum value for databricks.sdk.service.compute.TerminationReasonCode.
  • Added confluence and meta_marketing enum values for databricks.sdk.service.pipelines.IngestionSourceType.
  • Added delta_iceberg_table enum value for databricks.sdk.service.sharing.TableInternalAttributesSharedTableType.
  • [Breaking] Changed delete() method for w.table_constraints workspace-level service to start returning databricks.sdk.service.catalog.DeleteTableConstraintResponse dataclass.
  • [Breaking] Changed service_principal_id field for databricks.sdk.service.oauth2.CreateServicePrincipalSecretRequest to type str dataclass.
  • [Breaking] Changed service_principal_id field for databricks.sdk.service.oauth2.DeleteServicePrincipalSecretRequest to type str dataclass.
  • [Breaking] Changed service_principal_id field for databricks.sdk.service.oauth2.ListServicePrincipalSecretsRequest to type str dataclass.
  • [Breaking] Changed calls field for databricks.sdk.service.serving.AiGatewayRateLimit to no longer be required.
  • Changed calls field for databricks.sdk.service.serving.AiGatewayRateLimit to no longer be required.
  • [Breaking] Removed create() method for w.dashboards workspace-level service.
  • [Breaking] Removed range and if_unmodified_since fields for databricks.sdk.service.files.DownloadRequest.
  • [Breaking] Removed range and if_unmodified_since fields for databricks.sdk.service.files.GetMetadataRequest.

Release v0.58.0 (2025-07-09)

API Changes

  • Added remote_disk_throughput and total_initial_remote_disk_size fields for databricks.sdk.service.compute.ClusterAttributes.
  • Added remote_disk_throughput and total_initial_remote_disk_size fields for databricks.sdk.service.compute.ClusterDetails.
  • Added remote_disk_throughput and total_initial_remote_disk_size fields for databricks.sdk.service.compute.ClusterSpec.
  • Added remote_disk_throughput and total_initial_remote_disk_size fields for databricks.sdk.service.compute.CreateCluster.
  • Added remote_disk_throughput and total_initial_remote_disk_size fields for databricks.sdk.service.compute.CreateInstancePool.
  • Added remote_disk_throughput and total_initial_remote_disk_size fields for databricks.sdk.service.compute.EditCluster.
  • Added remote_disk_throughput and total_initial_remote_disk_size fields for databricks.sdk.service.compute.EditInstancePool.
  • Added remote_disk_throughput and total_initial_remote_disk_size fields for databricks.sdk.service.compute.GetInstancePool.
  • Added remote_disk_throughput and total_initial_remote_disk_size fields for databricks.sdk.service.compute.InstancePoolAndStats.
  • Added remote_disk_throughput and total_initial_remote_disk_size fields for databricks.sdk.service.compute.UpdateClusterResource.
  • Added r enum value for databricks.sdk.service.compute.Language.
  • Added continuous and continuous_restart enum values for databricks.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() and trash_space() methods for w.genie workspace-level service.
  • Added create_database_instance_role(), delete_database_instance_role(), get_database_instance_role() and list_database_instance_roles() methods for w.database workspace-level service.
  • Added connection and credential fields for databricks.sdk.service.catalog.Dependency.
  • Added rely field for databricks.sdk.service.catalog.ForeignKeyConstraint.
  • Added rely field for databricks.sdk.service.catalog.PrimaryKeyConstraint.
  • Added securable_kind_manifest field for databricks.sdk.service.catalog.TableInfo.
  • Added securable_kind_manifest field for databricks.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_dns and retention_window_in_days fields for databricks.sdk.service.database.DatabaseInstance.
  • Added claims field for databricks.sdk.service.database.GenerateDatabaseCredentialRequest.
  • Added last_sync field for databricks.sdk.service.database.SyncedTableStatus.
  • Added activity field for databricks.sdk.service.ml.DeleteTransitionRequestResponse.
  • Added max_results field for databricks.sdk.service.ml.ListWebhooksRequest.
  • Added body and status_code fields for databricks.sdk.service.ml.TestRegistryWebhookResponse.
  • Added model_version_databricks field for databricks.sdk.service.ml.TransitionStageResponse.
  • Added registered_model field for databricks.sdk.service.ml.UpdateModelResponse.
  • Added model_version field for databricks.sdk.service.ml.UpdateModelVersionResponse.
  • Added webhook field for databricks.sdk.service.ml.UpdateWebhookResponse.
  • Added run_as field for databricks.sdk.service.pipelines.GetPipelineResponse.
  • Added principal field for databricks.sdk.service.serving.AiGatewayRateLimit.
  • Added description field for databricks.sdk.service.serving.CreateServingEndpoint.
  • Added served_entity_name field for databricks.sdk.service.serving.Route.
  • Added any_static_credential enum value for databricks.sdk.service.catalog.CredentialType.
  • Added databricks_row_store_format, delta_uniform_hudi, delta_uniform_iceberg, hive, iceberg, mongodb_format, oracle_format, salesforce_data_cloud_format and teradata_format enum values for databricks.sdk.service.catalog.DataSourceFormat.
  • Added metric_view enum value for databricks.sdk.service.catalog.TableType.
  • Added security_agents_failed_initial_verification enum value for databricks.sdk.service.compute.TerminationReasonCode.
  • Added can_create_registered_model enum value for databricks.sdk.service.ml.PermissionLevel.
  • Added bigquery enum value for databricks.sdk.service.pipelines.IngestionSourceType.
  • Added append_only enum value for databricks.sdk.service.pipelines.TableSpecificConfigScdType.
  • Added service_principal and user_group enum values for databricks.sdk.service.serving.AiGatewayRateLimitKey.
  • [Breaking] Changed cancel_optimize() and delete_custom_llm() methods for w.ai_builder workspace-level service to return any dataclass.
  • [Breaking] Changed delete() method for a.budget_policy account-level service to return any dataclass.
  • [Breaking] Changed delete() method for w.online_tables workspace-level service to return any dataclass.
  • [Breaking] Changed delete() method for w.clean_rooms workspace-level service to return any dataclass.
  • [Breaking] Changed delete_schedule() and delete_subscription() methods for w.lakeview workspace-level service to return any dataclass.
  • [Breaking] Changed delete_database_catalog(), delete_database_instance(), delete_database_table() and delete_synced_database_table() methods for w.database workspace-level service to return any dataclass.
  • [Breaking] Changed delete_online_store() method for w.feature_store workspace-level service to return any dataclass.
  • [Breaking] Changed delete_transition_request(), update_model(), update_model_version() and update_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 return any dataclass.
  • [Breaking] Changed delete() method for a.service_principal_federation_policy account-level service to return any dataclass.
  • [Breaking] Changed delete_quality_monitor() method for w.quality_monitor_v2 workspace-level service to return any dataclass.
  • [Breaking] Changed delete_network_connectivity_configuration() method for a.network_connectivity account-level service to return any dataclass.
  • [Breaking] Changed delete_network_policy_rpc() method for a.network_policies account-level service to return any dataclass.
  • [Breaking] Changed delete() method for w.recipient_federation_policies workspace-level service to return any dataclass.
  • [Breaking] Changed list() method for w.alerts_legacy workspace-level service . New request type is any dataclass.
  • [Breaking] Changed update() method for w.dashboard_widgets workspace-level service . New request type is databricks.sdk.service.sql.UpdateWidgetRequest dataclass.
  • [Breaking] Changed list() method for w.data_sources workspace-level service . New request type is any dataclass.
  • [Breaking] Changed create() method for w.query_visualizations_legacy workspace-level service with new required argument order.
  • [Breaking] Changed from_stage and to_stage fields for databricks.sdk.service.ml.Activity to type str dataclass.
  • [Breaking] Changed stage field for databricks.sdk.service.ml.ApproveTransitionRequest to type str dataclass.
  • [Breaking] Changed stage field for databricks.sdk.service.ml.CreateTransitionRequest to type str dataclass.
  • [Breaking] Changed stage field for databricks.sdk.service.ml.DeleteTransitionRequestRequest to type str dataclass.
  • [Breaking] Changed id field for databricks.sdk.service.ml.DeleteWebhookRequest to be required.
  • [Breaking] Changed capacity field for databricks.sdk.service.ml.OnlineStore to be required.
  • Changed capacity field for databricks.sdk.service.ml.OnlineStore to be required.
  • [Breaking] Changed online_table_name field for databricks.sdk.service.ml.PublishSpec to be required.
  • [Breaking] Changed stage field for databricks.sdk.service.ml.RejectTransitionRequest to type str dataclass.
  • [Breaking] Changed stage field for databricks.sdk.service.ml.TransitionModelVersionStageDatabricks to type str dataclass.
  • [Breaking] Changed to_stage field for databricks.sdk.service.ml.TransitionRequest to type str dataclass.
  • Changed served_model_name field for databricks.sdk.service.serving.Route to no longer be required.
  • [Breaking] Changed served_model_name field for databricks.sdk.service.serving.Route to no longer be required.
  • Changed pagination for TablesAPI.list method.
  • Changed pagination for TablesAPI.list_summaries method.
  • [Breaking] Removed generate_download_full_query_result() and get_download_full_query_result() methods for w.genie workspace-level service.
  • [Breaking] Removed include_delta_metadata field for databricks.sdk.service.catalog.ListTablesRequest.
  • [Breaking] Removed webhook field for databricks.sdk.service.ml.TestRegistryWebhookResponse.
  • [Breaking] Removed model_version field for databricks.sdk.service.ml.TransitionStageResponse.
  • [Breaking] Removed unknown_catalog_type enum value for databricks.sdk.service.catalog.CatalogType.
  • [Breaking] Removed hive_custom and hive_serde enum values for databricks.sdk.service.catalog.DataSourceFormat.
  • [Breaking] Removed unknown_securable_type enum value for databricks.sdk.service.catalog.SecurableType.
  • [Breaking] Removed archived, none, production and staging enum values for databricks.sdk.service.ml.DeleteTransitionRequestStage.
  • [Breaking] Removed archived, none, production and staging enum values for databricks.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_time field for databricks.sdk.service.database.DatabaseCredential.
  • Added effective_stopped field for databricks.sdk.service.database.DatabaseInstance.
  • Added existing_pipeline_id field for databricks.sdk.service.database.SyncedTableSpec.
  • Added pipeline_id field for databricks.sdk.service.database.SyncedTableStatus.
  • Added dbt_platform_output field for databricks.sdk.service.jobs.RunOutput.
  • Added dbt_platform_task field for databricks.sdk.service.jobs.RunTask.
  • Added dbt_platform_task field for databricks.sdk.service.jobs.SubmitTask.
  • Added dbt_platform_task field for databricks.sdk.service.jobs.Task.
  • Added environment field for databricks.sdk.service.pipelines.CreatePipeline.
  • Added environment field for databricks.sdk.service.pipelines.EditPipeline.
  • Added environment field for databricks.sdk.service.pipelines.PipelineSpec.
  • Added description field for databricks.sdk.service.serving.ServingEndpoint.
  • Added description field for databricks.sdk.service.serving.ServingEndpointDetailed.
  • Added cancelled, error, queued, running, starting and success enum values for databricks.sdk.service.jobs.DbtPlatformRunStatus.
  • [Breaking] Changed status field for databricks.sdk.service.jobs.DbtCloudJobRunStep to type databricks.sdk.service.jobs.DbtPlatformRunStatus dataclass.
  • [Breaking] Removed w.custom_llms workspace-level service.
  • [Breaking] Removed table_serving_url field for databricks.sdk.service.database.DatabaseTable.
  • [Breaking] Removed table_serving_url field for databricks.sdk.service.database.SyncedDatabaseTable.
  • [Breaking] Removed pipeline_id field for databricks.sdk.service.database.SyncedTableSpec.
  • [Breaking] Removed cancelled, error, queued, running, starting and success enum values for databricks.sdk.service.jobs.DbtCloudRunStatus.

Release v0.56.0 (2025-06-05)

API Changes

  • Added databricks.sdk.service.aibuilder, databricks.sdk.service.database and databricks.sdk.service.qualitymonitorv2 packages.
  • 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_token field for databricks.sdk.service.billing.ListLogDeliveryRequest.
  • Added next_page_token field for databricks.sdk.service.billing.WrappedLogDeliveryConfigurations.
  • Added next_page_token field for databricks.sdk.service.catalog.EffectivePermissionsList.
  • Added max_results and page_token fields for databricks.sdk.service.catalog.GetEffectiveRequest.
  • Added max_results and page_token fields for databricks.sdk.service.catalog.GetGrantRequest.
  • Added next_page_token field for databricks.sdk.service.catalog.ListMetastoresResponse.
  • Added clean_room_name field for databricks.sdk.service.cleanrooms.CleanRoomAsset.
  • [Breaking] Added name field for databricks.sdk.service.cleanrooms.DeleteCleanRoomAssetRequest.
  • [Breaking] Added name field for databricks.sdk.service.cleanrooms.GetCleanRoomAssetRequest.
  • Added trigger_state field for databricks.sdk.service.jobs.BaseJob.
  • Added trigger_state field for databricks.sdk.service.jobs.Job.
  • Added dbt_cloud_output field for databricks.sdk.service.jobs.RunOutput.
  • Added dbt_cloud_task field for databricks.sdk.service.jobs.RunTask.
  • Added dbt_cloud_task field for databricks.sdk.service.jobs.SubmitTask.
  • Added dbt_cloud_task field for databricks.sdk.service.jobs.Task.
  • Added tags field for databricks.sdk.service.pipelines.CreatePipeline.
  • Added tags field for databricks.sdk.service.pipelines.EditPipeline.
  • Added tags field for databricks.sdk.service.pipelines.PipelineSpec.
  • Added max_provisioned_concurrency and min_provisioned_concurrency fields for databricks.sdk.service.serving.ServedEntityInput.
  • Added max_provisioned_concurrency and min_provisioned_concurrency fields for databricks.sdk.service.serving.ServedEntityOutput.
  • Added max_provisioned_concurrency and min_provisioned_concurrency fields for databricks.sdk.service.serving.ServedModelInput.
  • Added max_provisioned_concurrency and min_provisioned_concurrency fields for databricks.sdk.service.serving.ServedModelOutput.
  • Added endpoint_service and resource_names fields for databricks.sdk.service.settings.CreatePrivateEndpointRule.
  • Added aws_private_endpoint_rules field for databricks.sdk.service.settings.NccEgressTargetRules.
  • Added task_time_over_time_range field for databricks.sdk.service.sql.QueryMetrics.
  • Added deltasharing_catalog, foreign_catalog, internal_catalog, managed_catalog, managed_online_catalog, system_catalog and unknown_catalog_type enum values for databricks.sdk.service.catalog.CatalogType.
  • Added ga4_raw_data, power_bi, salesforce, salesforce_data_cloud, servicenow, unknown_connection_type and workday_raas enum values for databricks.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_credential and unknown_credential_type enum values for databricks.sdk.service.catalog.CredentialType.
  • Added internal and internal_and_external enum values for databricks.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_type and volume enum values for databricks.sdk.service.catalog.SecurableType.
  • Added cluster_migrated enum value for databricks.sdk.service.compute.EventType.
  • Added driver_unhealthy enum value for databricks.sdk.service.compute.TerminationReasonCode.
  • Added teradata enum value for databricks.sdk.service.pipelines.IngestionSourceType.
  • Added oidc_federation enum value for databricks.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 return databricks.sdk.service.billing.GetLogDeliveryConfigurationResponse dataclass.
  • [Breaking] Changed create_private_endpoint_rule(), delete_private_endpoint_rule() and get_private_endpoint_rule() methods for a.network_connectivity account-level service to return databricks.sdk.service.settings.NccPrivateEndpointRule dataclass.
  • [Breaking] Changed list_private_endpoint_rules() method for a.network_connectivity account-level service to return databricks.sdk.service.settings.ListPrivateEndpointRulesResponse dataclass.
  • [Breaking] Changed delete() and get() methods for w.clean_room_assets workspace-level service . Method path has changed.
  • [Breaking] Changed delete() and get() 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 return databricks.sdk.service.catalog.GetPermissionsResponse dataclass.
  • [Breaking] Changed update() method for w.grants workspace-level service to return databricks.sdk.service.catalog.UpdatePermissionsResponse dataclass.
  • [Breaking] Changed list() method for w.metastores workspace-level service to require request of databricks.sdk.service.catalog.ListMetastoresRequest dataclass.
  • Changed account_id, credentials_id, log_type, output_format and storage_configuration_id fields for databricks.sdk.service.billing.LogDeliveryConfiguration to be required.
  • Changed message and status fields for databricks.sdk.service.billing.LogDeliveryStatus to be required.
  • [Breaking] Changed log_delivery_configuration field for databricks.sdk.service.billing.WrappedCreateLogDeliveryConfiguration to be required.
  • [Breaking] Changed securable_type field for databricks.sdk.service.catalog.ConnectionInfo to type databricks.sdk.service.catalog.SecurableType dataclass.
  • [Breaking] Changed securable_type field for databricks.sdk.service.catalog.GetEffectiveRequest to type str dataclass.
  • [Breaking] Changed securable_type field for databricks.sdk.service.catalog.GetGrantRequest to type str dataclass.
  • [Breaking] Changed delta_sharing_scope field for databricks.sdk.service.catalog.GetMetastoreSummaryResponse to type databricks.sdk.service.catalog.DeltaSharingScopeEnum dataclass.
  • [Breaking] Changed delta_sharing_scope field for databricks.sdk.service.catalog.MetastoreInfo to type databricks.sdk.service.catalog.DeltaSharingScopeEnum dataclass.
  • [Breaking] Changed catalog_type field for databricks.sdk.service.catalog.SchemaInfo to type databricks.sdk.service.catalog.CatalogType dataclass.
  • [Breaking] Changed delta_sharing_scope field for databricks.sdk.service.catalog.UpdateMetastore to type databricks.sdk.service.catalog.DeltaSharingScopeEnum dataclass.
  • [Breaking] Changed securable_type field for databricks.sdk.service.catalog.UpdatePermissions to type str dataclass.
  • Changed resource_id field for databricks.sdk.service.settings.CreatePrivateEndpointRule to 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() and list_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_name field for databricks.sdk.service.cleanrooms.DeleteCleanRoomAssetRequest.
  • [Breaking] Removed asset_full_name field for databricks.sdk.service.cleanrooms.GetCleanRoomAssetRequest.
  • [Breaking] Removed internal and internal_and_external enum values for databricks.sdk.service.catalog.GetMetastoreSummaryResponseDeltaSharingScope.
  • [Breaking] Removed internal and internal_and_external enum values for databricks.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_type and volume enum values for databricks.sdk.service.catalog.SecurableType.
  • [Breaking] Removed internal and internal_and_external enum values for databricks.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() and set_logged_model_tags() methods for w.experiments workspace-level service.
  • Added create_provisioned_throughput_endpoint() and update_provisioned_throughput_endpoint_config() methods for w.serving_endpoints workspace-level service.
  • Added uc_securable field for databricks.sdk.service.apps.AppResource.
  • Added enable_file_events and file_event_queue fields for databricks.sdk.service.catalog.CreateExternalLocation.
  • Added catalog_name field for databricks.sdk.service.catalog.EnableRequest.
  • Added enable_file_events and file_event_queue fields for databricks.sdk.service.catalog.ExternalLocationInfo.
  • Added timeseries_columns field for databricks.sdk.service.catalog.PrimaryKeyConstraint.
  • Added enable_file_events and file_event_queue fields for databricks.sdk.service.catalog.UpdateExternalLocation.
  • Added review_state, reviews and runner_collaborator_aliases fields for databricks.sdk.service.cleanrooms.CleanRoomAssetNotebook.
  • Added notebook_etag and notebook_updated_at fields for databricks.sdk.service.cleanrooms.CleanRoomNotebookTaskRun.
  • Added policy_id and service_principal_id fields for databricks.sdk.service.oauth2.FederationPolicy.
  • Added root_path field for databricks.sdk.service.pipelines.CreatePipeline.
  • Added root_path field for databricks.sdk.service.pipelines.EditPipeline.
  • Added source_type field for databricks.sdk.service.pipelines.IngestionPipelineDefinition.
  • Added glob field for databricks.sdk.service.pipelines.PipelineLibrary.
  • Added root_path field for databricks.sdk.service.pipelines.PipelineSpec.
  • Added provisioned_model_units field for databricks.sdk.service.serving.ServedEntityInput.
  • Added provisioned_model_units field for databricks.sdk.service.serving.ServedEntityOutput.
  • Added provisioned_model_units field for databricks.sdk.service.serving.ServedModelInput.
  • Added provisioned_model_units field for databricks.sdk.service.serving.ServedModelOutput.
  • Added materialization_namespace field for databricks.sdk.service.sharing.Table.
  • Added omit_permissions_list field for databricks.sdk.service.sharing.UpdateSharePermissions.
  • Added auto_resolve_display_name field for databricks.sdk.service.sql.UpdateAlertRequest.
  • Added auto_resolve_display_name field for databricks.sdk.service.sql.UpdateQueryRequest.
  • Added internal_catalog, managed_online_catalog and unknown_catalog_type enum values for databricks.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_type and volume enum values for databricks.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_exception and invalid_sql_unknown_table_exception enum values for databricks.sdk.service.dashboards.MessageErrorType.
  • Added can_create and can_monitor_only enum values for databricks.sdk.service.iam.PermissionLevel.
  • Added success_with_failures enum value for databricks.sdk.service.jobs.TerminationCodeCode.
  • Added infrastructure_maintenance enum value for databricks.sdk.service.pipelines.StartUpdateCause.
  • Added infrastructure_maintenance enum value for databricks.sdk.service.pipelines.UpdateInfoCause.
  • [Breaking] Changed create_alert() and update_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 is databricks.sdk.service.iam.SetObjectPermissions dataclass.
  • [Breaking] Changed update() method for w.permissions workspace-level service . New request type is databricks.sdk.service.iam.UpdateObjectPermissions dataclass.
  • [Breaking] Changed get() method for w.workspace_bindings workspace-level service to return databricks.sdk.service.catalog.GetCatalogWorkspaceBindingsResponse dataclass.
  • [Breaking] Changed get_bindings() method for w.workspace_bindings workspace-level service to return databricks.sdk.service.catalog.GetWorkspaceBindingsResponse dataclass.
  • [Breaking] Changed update() method for w.workspace_bindings workspace-level service to return databricks.sdk.service.catalog.UpdateCatalogWorkspaceBindingsResponse dataclass.
  • [Breaking] Changed update_bindings() method for w.workspace_bindings workspace-level service to return databricks.sdk.service.catalog.UpdateWorkspaceBindingsResponse dataclass.
  • [Breaking] Changed securable_type field for databricks.sdk.service.catalog.CatalogInfo to type databricks.sdk.service.catalog.SecurableType dataclass.
  • [Breaking] Changed securable_type field for databricks.sdk.service.catalog.GetBindingsRequest to type str dataclass.
  • Changed schema and state fields for databricks.sdk.service.catalog.SystemSchemaInfo to be required.
  • [Breaking] Changed state field for databricks.sdk.service.catalog.SystemSchemaInfo to type str dataclass.
  • [Breaking] Changed securable_type field for databricks.sdk.service.catalog.UpdateWorkspaceBindingsParameters to type str dataclass.
  • [Breaking] Changed workspace_id field for databricks.sdk.service.catalog.WorkspaceBinding to be required.
  • Changed etag and name fields for databricks.sdk.service.iam.RuleSetResponse to be required.
  • Changed gpu_node_pool_id field for databricks.sdk.service.jobs.ComputeConfig to no longer be required.
  • [Breaking] Changed gpu_node_pool_id field for databricks.sdk.service.jobs.ComputeConfig to no longer be required.
  • [Breaking] Changed alert field for databricks.sdk.service.sql.CreateAlertV2Request to be required.
  • [Breaking] Changed alert field for databricks.sdk.service.sql.UpdateAlertV2Request to be required.
  • [Breaking] Removed access_point field for databricks.sdk.service.catalog.CreateExternalLocation.
  • [Breaking] Removed access_point field for databricks.sdk.service.catalog.ExternalLocationInfo.
  • [Breaking] Removed access_point field for databricks.sdk.service.catalog.UpdateExternalLocation.
  • [Breaking] Removed node_type_flexibility field for databricks.sdk.service.compute.EditInstancePool.
  • [Breaking] Removed node_type_flexibility field for databricks.sdk.service.compute.GetInstancePool.
  • [Breaking] Removed node_type_flexibility field for databricks.sdk.service.compute.InstancePoolAndStats.
  • [Breaking] Removed catalog, credential, external_location and storage_credential enum values for databricks.sdk.service.catalog.GetBindingsSecurableType.
  • [Breaking] Removed available, disable_initialized, enable_completed, enable_initialized and unavailable enum values for databricks.sdk.service.catalog.SystemSchemaInfoState.
  • [Breaking] Removed catalog, credential, external_location and storage_credential enum values for databricks.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_path field for databricks.sdk.service.ml.CreateForecastingExperimentRequest.
  • Added exclude_columns and include_columns fields for databricks.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_failure and secret_permission_denied enum values for databricks.sdk.service.compute.TerminationReasonCode.
  • [Breaking] Changed pipeline_id field for databricks.sdk.service.pipelines.EditPipeline to be required.
  • Changed connection_name, gateway_storage_catalog and gateway_storage_schema fields for databricks.sdk.service.pipelines.IngestionGatewayPipelineDefinition to be required.
  • [Breaking] Changed connection_name, gateway_storage_catalog and gateway_storage_schema fields for databricks.sdk.service.pipelines.IngestionGatewayPipelineDefinition to be required.
  • Changed kind field for databricks.sdk.service.pipelines.PipelineDeployment to be required.
  • [Breaking] Changed kind field for databricks.sdk.service.pipelines.PipelineDeployment to be required.
  • Changed destination_catalog, destination_schema and source_url fields for databricks.sdk.service.pipelines.ReportSpec to be required.
  • [Breaking] Changed destination_catalog, destination_schema and source_url fields for databricks.sdk.service.pipelines.ReportSpec to be required.
  • Changed destination_catalog, destination_schema and source_schema fields for databricks.sdk.service.pipelines.SchemaSpec to be required.
  • [Breaking] Changed destination_catalog, destination_schema and source_schema fields for databricks.sdk.service.pipelines.SchemaSpec to be required.
  • [Breaking] Changed destination_catalog, destination_schema and source_table fields for databricks.sdk.service.pipelines.TableSpec to be required.
  • Changed destination_catalog, destination_schema and source_table fields for databricks.sdk.service.pipelines.TableSpec to be required.
  • [Breaking] Changed results field for databricks.sdk.service.sql.ListAlertsV2Response to type databricks.sdk.service.sql.AlertV2List dataclass.
  • [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_refresh configuration option has been added to allow disabling this feature if necessary (#952). To disable asynchronous token refresh, set the environment variable DATABRICKS_DISABLE_ASYNC_TOKEN_REFRESH=true or configure it within your configuration object. The previous enable_experimental_async_token_refresh option 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_ID and DATABRICKS_HOST environment 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() and update_endpoint_custom_tags() methods for w.vector_search_endpoints workspace-level service.
  • Added created_at, created_by and metastore_id fields for databricks.sdk.service.catalog.SetArtifactAllowlist.
  • Added node_type_flexibility field for databricks.sdk.service.compute.EditInstancePool.
  • Added page_size and page_token fields for databricks.sdk.service.compute.GetEvents.
  • Added next_page_token and prev_page_token fields for databricks.sdk.service.compute.GetEventsResponse.
  • Added node_type_flexibility field for databricks.sdk.service.compute.GetInstancePool.
  • Added node_type_flexibility field for databricks.sdk.service.compute.InstancePoolAndStats.
  • Added effective_performance_target field for databricks.sdk.service.jobs.RepairHistoryItem.
  • Added performance_target field for databricks.sdk.service.jobs.RepairRun.
  • [Breaking] Added network_connectivity_config field for databricks.sdk.service.settings.CreateNetworkConnectivityConfigRequest.
  • [Breaking] Added private_endpoint_rule field for databricks.sdk.service.settings.CreatePrivateEndpointRuleRequest.
  • Added domain_names field for databricks.sdk.service.settings.NccAzurePrivateEndpointRule.
  • Added auto_resolve_display_name field for databricks.sdk.service.sql.CreateAlertRequest.
  • Added auto_resolve_display_name field for databricks.sdk.service.sql.CreateQueryRequest.
  • Added budget_policy_id field for databricks.sdk.service.vectorsearch.CreateEndpoint.
  • Added custom_tags and effective_budget_policy_id fields for databricks.sdk.service.vectorsearch.EndpointInfo.
  • Added create_clean_room, execute_clean_room_task and modify_clean_room enum values for databricks.sdk.service.catalog.Privilege.
  • Added dns_resolution_error and gcp_denied_by_org_policy enum values for databricks.sdk.service.compute.TerminationReasonCode.
  • Added disabled enum value for databricks.sdk.service.jobs.TerminationCodeCode.
  • Added expired enum value for databricks.sdk.service.settings.NccAzurePrivateEndpointRuleConnectionState.
  • [Breaking] Changed create_network_connectivity_configuration() and create_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 return databricks.sdk.service.vectorsearch.VectorIndex dataclass.
  • [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.List dataclass to.
  • [Breaking] Changed workload_size field for databricks.sdk.service.serving.ServedModelInput to type str dataclass.
  • [Breaking] Changed group_id field for databricks.sdk.service.settings.NccAzurePrivateEndpointRule to type str dataclass.
  • [Breaking] Changed target_services field for databricks.sdk.service.settings.NccAzureServiceEndpointRule to type databricks.sdk.service.settings.EgressResourceTypeList dataclass.
  • [Breaking] Changed data_array field for databricks.sdk.service.vectorsearch.ResultData to type databricks.sdk.service.vectorsearch.ListValueList dataclass.
  • [Breaking] Changed waiter for VectorSearchEndpointsAPI.create_endpoint method.
  • [Breaking] Removed name and region fields for databricks.sdk.service.settings.CreateNetworkConnectivityConfigRequest.
  • [Breaking] Removed group_id and resource_id fields for databricks.sdk.service.settings.CreatePrivateEndpointRuleRequest.
  • [Breaking] Removed null_value field for databricks.sdk.service.vectorsearch.Value.
  • [Breaking] Removed large, medium and small enum values for databricks.sdk.service.serving.ServedModelInputWorkloadSize.
  • [Breaking] Removed blob, dfs, mysql_server and sql_server enum values for databricks.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() and get_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_ids field for databricks.sdk.service.billing.BudgetPolicy.
  • Added download_id field for databricks.sdk.service.dashboards.GenieGenerateDownloadFullQueryResultResponse.
  • Added dashboard_output field for databricks.sdk.service.jobs.RunOutput.
  • Added dashboard_task and power_bi_task fields for databricks.sdk.service.jobs.RunTask.
  • Added dashboard_task and power_bi_task fields for databricks.sdk.service.jobs.SubmitTask.
  • Added dashboard_task and power_bi_task fields for databricks.sdk.service.jobs.Task.
  • Added include_features field for databricks.sdk.service.ml.CreateForecastingExperimentRequest.
  • Added models field for databricks.sdk.service.ml.LogInputs.
  • Added dataset_digest, dataset_name and model_id fields for databricks.sdk.service.ml.LogMetric.
  • Added dataset_digest, dataset_name, model_id and run_id fields for databricks.sdk.service.ml.Metric.
  • Added model_inputs field for databricks.sdk.service.ml.RunInputs.
  • Added client_application field for databricks.sdk.service.sql.QueryInfo.
  • Added geography and geometry enum values for databricks.sdk.service.catalog.ColumnTypeName.
  • Added allocation_timeout_no_healthy_and_warmed_up_clusters, docker_container_creation_exception, docker_image_too_large_for_instance_exception and docker_invalid_os_exception enum values for databricks.sdk.service.compute.TerminationReasonCode.
  • Added standard enum value for databricks.sdk.service.jobs.PerformanceTarget.
  • Added can_view enum value for databricks.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, status and transient_statement_id fields for databricks.sdk.service.dashboards.GenieGenerateDownloadFullQueryResultResponse.
  • [Breaking] Removed balanced and cost_optimized enum values for databricks.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_id and user_api_scopes fields for databricks.sdk.service.apps.App.
  • Added abfss, dbfs, error_message, execution_duration_seconds, file, gcs, s3, status, volumes and workspace fields for databricks.sdk.service.compute.InitScriptInfoAndExecutionDetails.
  • [Breaking] Added forecast_granularity field for databricks.sdk.service.ml.CreateForecastingExperimentRequest.
  • Added jwks_uri field for databricks.sdk.service.oauth2.OidcFederationPolicy.
  • Added event_log field for databricks.sdk.service.pipelines.CreatePipeline.
  • Added event_log field for databricks.sdk.service.pipelines.EditPipeline.
  • Added event_log field for databricks.sdk.service.pipelines.PipelineSpec.
  • Added fallback_config field for databricks.sdk.service.serving.AiGatewayConfig.
  • Added custom_provider_config field for databricks.sdk.service.serving.ExternalModel.
  • Added fallback_config field for databricks.sdk.service.serving.PutAiGatewayRequest.
  • Added fallback_config field for databricks.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_location and tags fields for databricks.sdk.service.sharing.DeltaSharingFunction.
  • Added query_source field for databricks.sdk.service.sql.QueryInfo.
  • Added foreign_catalog enum value for databricks.sdk.service.catalog.CatalogType.
  • Added browse enum value for databricks.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_termination and workspace_update enum values for databricks.sdk.service.compute.TerminationReasonCode.
  • Added generated_sql_query_too_long_exception and missing_sql_query_exception enum values for databricks.sdk.service.dashboards.MessageErrorType.
  • Added balanced enum value for databricks.sdk.service.jobs.PerformanceTarget.
  • Added listing_resource enum value for databricks.sdk.service.marketplace.FileParentType.
  • Added app enum value for databricks.sdk.service.marketplace.MarketplaceFileType.
  • Added custom enum value for databricks.sdk.service.serving.ExternalModelProvider.
  • Added arclight_multi_tenant_azure_exchange_token and arclight_multi_tenant_azure_exchange_token_with_user_delegation_key enum values for databricks.sdk.service.settings.TokenType.
  • [Breaking] Changed create_experiment() method for w.forecasting workspace-level service with new required argument order.
  • Changed instance_type_id field for databricks.sdk.service.compute.NodeInstanceType to be required.
  • Changed category field for databricks.sdk.service.compute.NodeType to be required.
  • [Breaking] Changed functions field for databricks.sdk.service.sharing.ListProviderShareAssetsResponse to type databricks.sdk.service.sharing.DeltaSharingFunctionList dataclass.
  • [Breaking] Removed execution_details and script fields for databricks.sdk.service.compute.InitScriptInfoAndExecutionDetails.
  • [Breaking] Removed supports_elastic_disk field for databricks.sdk.service.compute.NodeType.
  • [Breaking] Removed data_granularity_quantity and data_granularity_unit fields for databricks.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_location and tags fields for databricks.sdk.service.sharing.Function.

Release v0.48.0 (2025-03-27)

API Changes

  • Added execution_details and script fields for databricks.sdk.service.compute.InitScriptInfoAndExecutionDetails.
  • Added supports_elastic_disk field for databricks.sdk.service.compute.NodeType.
  • Added data_granularity_quantity field for databricks.sdk.service.ml.CreateForecastingExperimentRequest.
  • [Breaking] Added data_granularity_unit field for databricks.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_location and tags fields for databricks.sdk.service.sharing.Function.
  • [Breaking] Changed create_experiment() method for w.forecasting workspace-level service with new required argument order.
  • [Breaking] Changed instance_type_id field for databricks.sdk.service.compute.NodeInstanceType to no longer be required.
  • [Breaking] Changed category field for databricks.sdk.service.compute.NodeType to no longer be required.
  • [Breaking] Changed functions field for databricks.sdk.service.sharing.ListProviderShareAssetsResponse to type databricks.sdk.service.sharing.FunctionList dataclass.
  • [Breaking] Removed abfss, dbfs, error_message, execution_duration_seconds, file, gcs, s3, status, volumes and workspace fields for databricks.sdk.service.compute.InitScriptInfoAndExecutionDetails.
  • [Breaking] Removed forecast_granularity field for databricks.sdk.service.ml.CreateForecastingExperimentRequest.
  • [Breaking] Removed jwks_uri field for databricks.sdk.service.oauth2.OidcFederationPolicy.
  • [Breaking] Removed fallback_config field for databricks.sdk.service.serving.AiGatewayConfig.
  • [Breaking] Removed custom_provider_config field for databricks.sdk.service.serving.ExternalModel.
  • [Breaking] Removed fallback_config field for databricks.sdk.service.serving.PutAiGatewayRequest.
  • [Breaking] Removed fallback_config field for databricks.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_location and tags fields for databricks.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_termination and workspace_update enum values for databricks.sdk.service.compute.TerminationReasonCode.
  • [Breaking] Removed generated_sql_query_too_long_exception and missing_sql_query_exception enum values for databricks.sdk.service.dashboards.MessageErrorType.
  • [Breaking] Removed balanced enum value for databricks.sdk.service.jobs.PerformanceTarget.
  • [Breaking] Removed listing_resource enum value for databricks.sdk.service.marketplace.FileParentType.
  • [Breaking] Removed app enum value for databricks.sdk.service.marketplace.MarketplaceFileType.
  • [Breaking] Removed custom enum value for databricks.sdk.service.serving.ExternalModelProvider.

Release v0.47.0 (2025-03-21)

Bug Fixes

  • Ensure that refresh tokens are returned when using the external-browser credentials strategy.

API Changes

  • Added abfss, dbfs, error_message, execution_duration_seconds, file, gcs, s3, status, volumes and workspace fields for databricks.sdk.service.compute.InitScriptInfoAndExecutionDetails.
  • [Breaking] Added forecast_granularity field for databricks.sdk.service.ml.CreateForecastingExperimentRequest.
  • Added jwks_uri field for databricks.sdk.service.oauth2.OidcFederationPolicy.
  • Added fallback_config field for databricks.sdk.service.serving.AiGatewayConfig.
  • Added custom_provider_config field for databricks.sdk.service.serving.ExternalModel.
  • Added fallback_config field for databricks.sdk.service.serving.PutAiGatewayRequest.
  • Added fallback_config field for databricks.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_location and tags fields for databricks.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_termination and workspace_update enum values for databricks.sdk.service.compute.TerminationReasonCode.
  • Added generated_sql_query_too_long_exception and missing_sql_query_exception enum values for databricks.sdk.service.dashboards.MessageErrorType.
  • Added balanced enum value for databricks.sdk.service.jobs.PerformanceTarget.
  • Added listing_resource enum value for databricks.sdk.service.marketplace.FileParentType.
  • Added app enum value for databricks.sdk.service.marketplace.MarketplaceFileType.
  • Added custom enum value for databricks.sdk.service.serving.ExternalModelProvider.
  • [Breaking] Changed create_experiment() method for w.forecasting workspace-level service with new required argument order.
  • Changed instance_type_id field for databricks.sdk.service.compute.NodeInstanceType to be required.
  • Changed category field for databricks.sdk.service.compute.NodeType to be required.
  • [Breaking] Changed functions field for databricks.sdk.service.sharing.ListProviderShareAssetsResponse to type databricks.sdk.service.sharing.DeltaSharingFunctionList dataclass.
  • [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_details and script fields for databricks.sdk.service.compute.InitScriptInfoAndExecutionDetails.
  • [Breaking] Removed supports_elastic_disk field for databricks.sdk.service.compute.NodeType.
  • [Breaking] Removed data_granularity_quantity and data_granularity_unit fields for databricks.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_location and tags fields for databricks.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:
    export DATABRICKS_ENABLE_EXPERIMENTAL_ASYNC_TOKEN_REFRESH=1.
    
    This feature and its setting are experimental and may be removed in future releases.

API Changes

  • Added w.forecasting workspace-level service.
  • Added statement_id field for databricks.sdk.service.dashboards.GenieQueryAttachment.
  • Added could_not_get_model_deployments_exception enum value for databricks.sdk.service.dashboards.MessageErrorType.
  • [Breaking] Removed jwks_uri field for databricks.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 DatabricksError to 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() and get_space() methods for w.genie workspace-level service.
  • Added list_provider_share_assets() method for w.providers workspace-level service.
  • Added budget_policy_id and effective_budget_policy_id fields for databricks.sdk.service.apps.App.
  • Added policy field for databricks.sdk.service.billing.CreateBudgetPolicyRequest.
  • Added databricks_gcp_service_account field for databricks.sdk.service.catalog.ValidateCredentialRequest.
  • Added attachment_id field for databricks.sdk.service.dashboards.GenieAttachment.
  • Added conversation_id field for databricks.sdk.service.dashboards.GenieConversation.
  • Added message_id field for databricks.sdk.service.dashboards.GenieMessage.
  • Added description, id, last_updated_timestamp, query, query_result_metadata and title fields for databricks.sdk.service.dashboards.GenieQueryAttachment.
  • Added gen_ai_compute_task field for databricks.sdk.service.jobs.RunTask.
  • Added gen_ai_compute_task field for databricks.sdk.service.jobs.SubmitTask.
  • Added gen_ai_compute_task field for databricks.sdk.service.jobs.Task.
  • Added run_name field for databricks.sdk.service.ml.CreateRun.
  • Added run_name field for databricks.sdk.service.ml.RunInfo.
  • Added run_name field for databricks.sdk.service.ml.UpdateRun.
  • Added lifetime field for databricks.sdk.service.oauth2.CreateServicePrincipalSecretRequest.
  • Added expire_time field for databricks.sdk.service.oauth2.CreateServicePrincipalSecretResponse.
  • Added jwks_uri field for databricks.sdk.service.oauth2.OidcFederationPolicy.
  • Added expire_time field for databricks.sdk.service.oauth2.SecretInfo.
  • Added instance_profile_arn field for databricks.sdk.service.serving.AmazonBedrockConfig.
  • Added budget_policy_id field for databricks.sdk.service.serving.CreateServingEndpoint.
  • Added budget_policy_id field for databricks.sdk.service.serving.ServingEndpoint.
  • Added budget_policy_id field for databricks.sdk.service.serving.ServingEndpointDetailed.
  • Added add, principal and remove fields for databricks.sdk.service.sharing.PermissionsChange.
  • Added columns_to_rerank field for databricks.sdk.service.vectorsearch.QueryVectorIndexRequest.
  • Added oracle and teradata enum values for databricks.sdk.service.catalog.ConnectionType.
  • Added function_arguments_invalid_type_exception and message_cancelled_while_executing_exception enum values for databricks.sdk.service.dashboards.MessageErrorType.
  • Added waiting enum value for databricks.sdk.service.jobs.RunLifecycleStateV2State.
  • Added active_only, all and deleted_only enum values for databricks.sdk.service.ml.ViewType.
  • Added oauth_client_credentials enum value for databricks.sdk.service.sharing.AuthenticationType.
  • Added raw enum value for databricks.sdk.service.workspace.ExportFormat.
  • [Breaking] Changed get_by_name() method for w.experiments workspace-level service to return databricks.sdk.service.ml.GetExperimentByNameResponse dataclass.
  • [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 return databricks.sdk.service.sharing.GetSharePermissionsResponse dataclass.
  • [Breaking] Changed share_permissions() and update_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 return databricks.sdk.service.sharing.UpdateSharePermissionsResponse dataclass.
  • [Breaking] Changed policy_id field for databricks.sdk.service.billing.BudgetPolicy to no longer be required.
  • Changed policy_id field for databricks.sdk.service.billing.BudgetPolicy to no longer be required.
  • [Breaking] Changed partitions field for databricks.sdk.service.cleanrooms.CleanRoomAssetTableLocalDetails to type databricks.sdk.service.cleanrooms.PartitionList dataclass.
  • [Breaking] Changed query field for databricks.sdk.service.dashboards.GenieAttachment to type databricks.sdk.service.dashboards.GenieQueryAttachment dataclass.
  • [Breaking] Changed digest, name, source and source_type fields for databricks.sdk.service.ml.Dataset to be required.
  • Changed digest, name, source and source_type fields for databricks.sdk.service.ml.Dataset to be required.
  • [Breaking] Changed dataset field for databricks.sdk.service.ml.DatasetInput to be required.
  • Changed dataset field for databricks.sdk.service.ml.DatasetInput to be required.
  • Changed key and value fields for databricks.sdk.service.ml.InputTag to be required.
  • [Breaking] Changed key and value fields for databricks.sdk.service.ml.InputTag to be required.
  • [Breaking] Changed view_type field for databricks.sdk.service.ml.ListExperimentsRequest to type databricks.sdk.service.ml.ViewType dataclass.
  • [Breaking] Changed run_id field for databricks.sdk.service.ml.LogInputs to be required.
  • [Breaking] Changed view_type field for databricks.sdk.service.ml.SearchExperiments to type databricks.sdk.service.ml.ViewType dataclass.
  • [Breaking] Changed run_view_type field for databricks.sdk.service.ml.SearchRuns to type databricks.sdk.service.ml.ViewType dataclass.
  • [Breaking] Removed custom_tags and policy_name fields for databricks.sdk.service.billing.CreateBudgetPolicyRequest.
  • [Breaking] Removed cached_query_schema, description, id, instruction_id, instruction_title, last_updated_timestamp, query, statement_id and title fields for databricks.sdk.service.dashboards.QueryAttachment.
  • [Breaking] Removed max_results and page_token fields for databricks.sdk.service.sharing.UpdateSharePermissions.
  • [Breaking] Removed active_only, all and deleted_only enum values for databricks.sdk.service.ml.SearchExperimentsViewType.
  • [Breaking] Removed active_only, all and deleted_only enum values for databricks.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 id field for databricks.sdk.service.apps.App.
  • Added limit_config field for databricks.sdk.service.billing.UpdateBudgetPolicyRequest.
  • Added volumes field for databricks.sdk.service.compute.ClusterLogConf.
  • Removed review_state, reviews and runner_collaborators fields for databricks.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_token field for databricks.sdk.service.catalog.TemporaryCredentials.
  • Added options field for databricks.sdk.service.catalog.UpdateCatalog.
  • Added disabled field for databricks.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_request mixin 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 type http_request() method for w.serving_endpoints workspace-level service.
  • Changed http_request() method for w.serving_endpoints workspace-level service to return databricks.sdk.service.serving.HttpRequestResponse dataclass.
  • Changed config field for databricks.sdk.service.serving.CreateServingEndpoint to no longer be required.
  • Removed securable_kind field for databricks.sdk.service.catalog.CatalogInfo.
  • Removed securable_kind field for databricks.sdk.service.catalog.ConnectionInfo.
  • Removed status_code and text fields for databricks.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, reviews and runner_collaborators fields for databricks.sdk.service.cleanrooms.CleanRoomAssetNotebook.
  • Added statement_id field for databricks.sdk.service.dashboards.QueryAttachment.
  • Added effective_performance_target field for databricks.sdk.service.jobs.BaseRun.
  • Added performance_target field for databricks.sdk.service.jobs.CreateJob.
  • Added performance_target field for databricks.sdk.service.jobs.JobSettings.
  • Added effective_performance_target field for databricks.sdk.service.jobs.Run.
  • Added performance_target field for databricks.sdk.service.jobs.RunNow.
  • Added effective_performance_target field for databricks.sdk.service.jobs.RunTask.
  • Added run_as_repl field for databricks.sdk.service.jobs.SparkJarTask.
  • Added user_authorized_scopes field for databricks.sdk.service.oauth2.CreateCustomAppIntegration.
  • Added user_authorized_scopes field for databricks.sdk.service.oauth2.GetCustomAppIntegrationOutput.
  • Added user_authorized_scopes field for databricks.sdk.service.oauth2.UpdateCustomAppIntegration.
  • Added contents field for databricks.sdk.service.serving.HttpRequestResponse.
  • Added clean_room enum value for databricks.sdk.service.catalog.SecurableType.
  • Added budget_policy_limit_exceeded enum value for databricks.sdk.service.jobs.TerminationCodeCode.
  • Added arclight_azure_exchange_token_with_user_delegation_key enum value for databricks.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_request to 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_compute field for databricks.sdk.service.apps.CreateAppRequest.
  • Added has_more field for databricks.sdk.service.jobs.BaseJob.
  • Added has_more field for databricks.sdk.service.jobs.BaseRun.
  • Added page_token field for databricks.sdk.service.jobs.GetJobRequest.
  • Added has_more and next_page_token fields for databricks.sdk.service.jobs.Job.
  • Added has_more field for databricks.sdk.service.jobs.Run.
  • Added clean_rooms_notebook_output field for databricks.sdk.service.jobs.RunOutput.
  • Added scopes field for databricks.sdk.service.oauth2.UpdateCustomAppIntegration.
  • Added run_as field for databricks.sdk.service.pipelines.CreatePipeline.
  • Added run_as field for databricks.sdk.service.pipelines.EditPipeline.
  • Added authorization_details and endpoint_url fields for databricks.sdk.service.serving.DataPlaneInfo.
  • Added contents field for databricks.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_at and updated_by fields for databricks.sdk.service.sharing.RecipientInfo.
  • Added expiration_time field for databricks.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 return databricks.sdk.service.sharing.RecipientInfo dataclass.
  • 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 type update() 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 type patch() method for w.serving_endpoints workspace-level service.
  • Changed patch() method for w.serving_endpoints workspace-level service to return databricks.sdk.service.serving.EndpointTags dataclass.
  • Changed databricks.sdk.service.serving.EndpointTagList dataclass to.
  • Changed collaborator_alias field for databricks.sdk.service.cleanrooms.CleanRoomCollaborator to be required.
  • Changed collaborator_alias field for databricks.sdk.service.cleanrooms.CleanRoomCollaborator to be required.
  • Changed update_mask field for databricks.sdk.service.oauth2.UpdateAccountFederationPolicyRequest to no longer be required.
  • Changed update_mask field for databricks.sdk.service.oauth2.UpdateServicePrincipalFederationPolicyRequest to no longer be required.
  • Changed days_of_week field for databricks.sdk.service.pipelines.RestartWindow to type databricks.sdk.service.pipelines.DayOfWeekList dataclass.
  • Changed behavior field for databricks.sdk.service.serving.AiGatewayGuardrailPiiBehavior to no longer be required.
  • Changed behavior field for databricks.sdk.service.serving.AiGatewayGuardrailPiiBehavior to no longer be required.
  • Changed project_id and region fields for databricks.sdk.service.serving.GoogleCloudVertexAiConfig to be required.
  • Changed project_id and region fields for databricks.sdk.service.serving.GoogleCloudVertexAiConfig to be required.
  • Changed workload_type field for databricks.sdk.service.serving.ServedEntityInput to type databricks.sdk.service.serving.ServingModelWorkloadType dataclass.
  • Changed workload_type field for databricks.sdk.service.serving.ServedEntityOutput to type databricks.sdk.service.serving.ServingModelWorkloadType dataclass.
  • Changed workload_type field for databricks.sdk.service.serving.ServedModelOutput to type databricks.sdk.service.serving.ServingModelWorkloadType dataclass.

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, kind and use_ml_runtime fields for databricks.sdk.service.compute.ClusterAttributes.
  • Added is_single_node, kind and use_ml_runtime fields for databricks.sdk.service.compute.ClusterDetails.
  • Added is_single_node, kind and use_ml_runtime fields for databricks.sdk.service.compute.ClusterSpec.
  • Added is_single_node, kind and use_ml_runtime fields for databricks.sdk.service.compute.CreateCluster.
  • Added is_single_node, kind and use_ml_runtime fields for databricks.sdk.service.compute.EditCluster.
  • Added is_single_node, kind and use_ml_runtime fields for databricks.sdk.service.compute.UpdateClusterResource.
  • Added update_parameter_syntax field for databricks.sdk.service.dashboards.MigrateDashboardRequest.
  • Added clean_rooms_notebook_task field for databricks.sdk.service.jobs.RunTask.
  • Added clean_rooms_notebook_task field for databricks.sdk.service.jobs.SubmitTask.
  • Added clean_rooms_notebook_task field for databricks.sdk.service.jobs.Task.
  • Changed days_of_week field for databricks.sdk.service.pipelines.RestartWindow to type databricks.sdk.service.pipelines.RestartWindowDaysOfWeekList dataclass.

OpenAPI SHA: a6a317df8327c9b1e5cb59a03a42ffa2aabeef6d, Date: 2024-12-16

Release v0.39.0 (2024-12-11)

Bug Fixes

  • Update Changelog file (#830).

Internal Changes

  • Fix a couple of typos in open_ai_client.py (#829).
  • Update SDK to OpenAPI spec (#834).

API Changes:

  • Added databricks.sdk.service.cleanrooms package.
  • 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_account field for databricks.sdk.service.catalog.CreateCredentialRequest.
  • Added databricks_gcp_service_account field for databricks.sdk.service.catalog.CredentialInfo.
  • Added gcp_options field for databricks.sdk.service.catalog.GenerateTemporaryServiceCredentialRequest.
  • Added databricks_gcp_service_account field for databricks.sdk.service.catalog.UpdateCredentialRequest.
  • Added cached_query_schema field for databricks.sdk.service.dashboards.QueryAttachment.
  • Added .
  • Removed gcp_service_account_key field for databricks.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_id field for databricks.sdk.service.apps.App.
  • Added azure_service_principal, gcp_service_account_key and read_only fields for databricks.sdk.service.catalog.CreateCredentialRequest.
  • Added azure_service_principal, read_only and used_for_managed_storage fields for databricks.sdk.service.catalog.CredentialInfo.
  • Added omit_username field for databricks.sdk.service.catalog.ListTablesRequest.
  • Added azure_service_principal and read_only fields for databricks.sdk.service.catalog.UpdateCredentialRequest.
  • Added external_location_name, read_only and url fields for databricks.sdk.service.catalog.ValidateCredentialRequest.
  • Added is_dir field for databricks.sdk.service.catalog.ValidateCredentialResponse.
  • Added only field for databricks.sdk.service.jobs.RunNow.
  • Added restart_window field for databricks.sdk.service.pipelines.CreatePipeline.
  • Added restart_window field for databricks.sdk.service.pipelines.EditPipeline.
  • Added restart_window field for databricks.sdk.service.pipelines.PipelineSpec.
  • Added private_access_settings_id field for databricks.sdk.service.provisioning.UpdateWorkspaceRequest.
  • Changed create_credential() and generate_temporary_service_credential() methods for w.credentials workspace-level service with new required argument order.
  • Changed access_connector_id field for databricks.sdk.service.catalog.AzureManagedIdentity to be required.
  • Changed access_connector_id field for databricks.sdk.service.catalog.AzureManagedIdentity to be required.
  • Changed name field for databricks.sdk.service.catalog.CreateCredentialRequest to be required.
  • Changed credential_name field for databricks.sdk.service.catalog.GenerateTemporaryServiceCredentialRequest to 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 cleanrooms package (#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_deployment field for databricks.sdk.service.apps.CreateAppDeploymentRequest.
  • Added app field for databricks.sdk.service.apps.CreateAppRequest.
  • Added app field for databricks.sdk.service.apps.UpdateAppRequest.
  • Added table field for databricks.sdk.service.catalog.CreateOnlineTableRequest.
  • Added azure_aad field for databricks.sdk.service.catalog.GenerateTemporaryTableCredentialResponse.
  • Added full_name field for databricks.sdk.service.catalog.StorageCredentialInfo.
  • Added dashboard field for databricks.sdk.service.dashboards.CreateDashboardRequest.
  • Added schedule field for databricks.sdk.service.dashboards.CreateScheduleRequest.
  • Added subscription field for databricks.sdk.service.dashboards.CreateSubscriptionRequest.
  • Added warehouse_id field for databricks.sdk.service.dashboards.Schedule.
  • Added dashboard field for databricks.sdk.service.dashboards.UpdateDashboardRequest.
  • Added schedule field for databricks.sdk.service.dashboards.UpdateScheduleRequest.
  • Added page_token field for databricks.sdk.service.oauth2.ListServicePrincipalSecretsRequest.
  • Added next_page_token field for databricks.sdk.service.oauth2.ListServicePrincipalSecretsResponse.
  • Added connection_name field for databricks.sdk.service.pipelines.IngestionGatewayPipelineDefinition.
  • Added is_no_public_ip_enabled field for databricks.sdk.service.provisioning.CreateWorkspaceRequest.
  • Added external_customer_info and is_no_public_ip_enabled fields for databricks.sdk.service.provisioning.Workspace.
  • Added last_used_day field for databricks.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 is databricks.sdk.service.dashboards.GenieExecuteMessageQueryRequest dataclass.
  • Changed execute_message_query() method for w.genie workspace-level service to type execute_message_query() method for w.genie workspace-level service.
  • Changed create(), create_schedule(), create_subscription() and update_schedule() methods for w.lakeview workspace-level service with new required argument order.
  • Removed w.clean_rooms workspace-level service.
  • Removed deployment_id, mode and source_code_path fields for databricks.sdk.service.apps.CreateAppDeploymentRequest.
  • Removed description, name and resources fields for databricks.sdk.service.apps.CreateAppRequest.
  • Removed description and resources fields for databricks.sdk.service.apps.UpdateAppRequest.
  • Removed name and spec fields for databricks.sdk.service.catalog.CreateOnlineTableRequest.
  • Removed display_name, parent_path, serialized_dashboard and warehouse_id fields for databricks.sdk.service.dashboards.CreateDashboardRequest.
  • Removed cron_schedule, display_name and pause_status fields for databricks.sdk.service.dashboards.CreateScheduleRequest.
  • Removed subscriber field for databricks.sdk.service.dashboards.CreateSubscriptionRequest.
  • Removed display_name, etag, serialized_dashboard and warehouse_id fields for databricks.sdk.service.dashboards.UpdateDashboardRequest.
  • Removed cron_schedule, display_name, etag and pause_status fields for databricks.sdk.service.dashboards.UpdateScheduleRequest.
  • Removed prev_page_token field for databricks.sdk.service.jobs.Run.

OpenAPI SHA: 5285ce76f81314f342c1702d5c2ad4ef42488781, Date: 2024-11-04

Release v0.36.0 (2024-10-22)

Breaking Changes

  • external_browser now uses the databricks-cli app 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 to OAuthClient.from_host()
    • SessionCredentials() and SessionCredentials.from_dict(): now accepts token_endpoint, client_id, client_secret, and refresh_url as parameters, rather than accepting the OAuthClient.
    • TokenCache(): now accepts host, token_endpoint, client_id, client_secret, and refresh_url as parameters, rather than accepting the OAuthClient.

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.ReportSpec dataclass.
  • Added unity_catalog_provisioning_state field for databricks.sdk.service.catalog.OnlineTable.
  • Added is_truncated field for databricks.sdk.service.dashboards.Result.
  • Added effective_budget_policy_id field for databricks.sdk.service.jobs.BaseJob.
  • Added budget_policy_id field for databricks.sdk.service.jobs.CreateJob.
  • Added effective_budget_policy_id field for databricks.sdk.service.jobs.Job.
  • Added budget_policy_id field for databricks.sdk.service.jobs.JobSettings.
  • Added budget_policy_id field for databricks.sdk.service.jobs.SubmitRun.
  • Added report field for databricks.sdk.service.pipelines.IngestionConfig.
  • Added sequence_by field for databricks.sdk.service.pipelines.TableSpecificConfig.
  • Added notify_on_ok field for databricks.sdk.service.sql.Alert.
  • Added notify_on_ok field for databricks.sdk.service.sql.CreateAlertRequestAlert.
  • Added notify_on_ok field for databricks.sdk.service.sql.ListAlertsResponseAlert.
  • Added notify_on_ok field for databricks.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 _BaseClient and ApiClient (#785).
  • Update to latest OpenAPI spec (#787).
  • revert Support Models in dbutils.fs operations (#750) (#778).

API Changes:

  • Added w.disable_legacy_dbfs workspace-level service.
  • Added default_source_code_path and resources fields for databricks.sdk.service.apps.App.
  • Added resources field for databricks.sdk.service.apps.CreateAppRequest.
  • Added resources field for databricks.sdk.service.apps.UpdateAppRequest.

OpenAPI SHA: bc17b474818138f19b78a7bea0675707dead2b87, Date: 2024-10-07

Release v0.33.0 (2024-09-26)

Internal Changes

  • Add DCO guidelines (#773).
  • Update SDK to latest OpenAPI spec (#766).

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.ComputeState and databricks.sdk.service.apps.ComputeStatus dataclasses.
  • 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.R2Credentials and databricks.sdk.service.catalog.TableOperation dataclasses.
  • 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.PutAiGatewayRequest and databricks.sdk.service.serving.PutAiGatewayResponse dataclasses.
  • 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.UpdateDisableLegacyAccessRequest and databricks.sdk.service.settings.UpdateDisableLegacyFeaturesRequest dataclasses.
  • 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.UpdateRepoRequest and any dataclasses.
  • Added app_status and compute_status fields for databricks.sdk.service.apps.App.
  • Added deployment_id field for databricks.sdk.service.apps.CreateAppDeploymentRequest.
  • Added external_access_enabled field for databricks.sdk.service.catalog.GetMetastoreSummaryResponse.
  • Added include_manifest_capabilities field for databricks.sdk.service.catalog.GetTableRequest.
  • Added include_manifest_capabilities field for databricks.sdk.service.catalog.ListSummariesRequest.
  • Added include_manifest_capabilities field for databricks.sdk.service.catalog.ListTablesRequest.
  • Added external_access_enabled field for databricks.sdk.service.catalog.MetastoreInfo.
  • Added budget_policy_id and schema fields for databricks.sdk.service.pipelines.CreatePipeline.
  • Added budget_policy_id and schema fields for databricks.sdk.service.pipelines.EditPipeline.
  • Added effective_budget_policy_id field for databricks.sdk.service.pipelines.GetPipelineResponse.
  • Added budget_policy_id and schema fields for databricks.sdk.service.pipelines.PipelineSpec.
  • Added ai_gateway field for databricks.sdk.service.serving.CreateServingEndpoint.
  • Added ai_gateway field for databricks.sdk.service.serving.ServingEndpoint.
  • Added ai_gateway field for databricks.sdk.service.serving.ServingEndpointDetailed.
  • Added workspace_id field for databricks.sdk.service.settings.TokenInfo.
  • Added credential_id, git_provider and git_username fields for databricks.sdk.service.workspace.GetCredentialsResponse.
  • Changed delete(), start() and stop() methods for w.apps workspace-level service to return databricks.sdk.service.apps.App dataclass.
  • 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 is databricks.sdk.service.workspace.CreateCredentialsRequest dataclass.
  • Changed delete() method for w.git_credentials workspace-level service . New request type is databricks.sdk.service.workspace.DeleteCredentialsRequest dataclass.
  • Changed delete() method for w.git_credentials workspace-level service to return any dataclass.
  • Changed get() method for w.git_credentials workspace-level service . New request type is databricks.sdk.service.workspace.GetCredentialsRequest dataclass.
  • Changed get() method for w.git_credentials workspace-level service to return databricks.sdk.service.workspace.GetCredentialsResponse dataclass.
  • Changed list() method for w.git_credentials workspace-level service to return databricks.sdk.service.workspace.ListCredentialsResponse dataclass.
  • Changed update() method for w.git_credentials workspace-level service . New request type is databricks.sdk.service.workspace.UpdateCredentialsRequest dataclass.
  • Changed update() method for w.git_credentials workspace-level service to return any dataclass.
  • Changed create() method for w.repos workspace-level service to return databricks.sdk.service.workspace.CreateRepoResponse dataclass.
  • Changed create() method for w.repos workspace-level service . New request type is databricks.sdk.service.workspace.CreateRepoRequest dataclass.
  • Changed delete() method for w.repos workspace-level service to return any dataclass.
  • Changed get() method for w.repos workspace-level service to return databricks.sdk.service.workspace.GetRepoResponse dataclass.
  • Changed update() method for w.repos workspace-level service to return any dataclass.
  • Changed update() method for w.repos workspace-level service . New request type is databricks.sdk.service.workspace.UpdateRepoRequest dataclass.
  • Changed source_code_path field for databricks.sdk.service.apps.AppDeployment to no longer be required.
  • Changed source_code_path field for databricks.sdk.service.apps.CreateAppDeploymentRequest to no longer be required.
  • Changed return_params and routine_dependencies fields for databricks.sdk.service.catalog.CreateFunction to no longer be required.
  • Changed credential_id and git_provider fields for databricks.sdk.service.workspace.CreateCredentialsResponse to be required.
  • Changed credential_id field for databricks.sdk.service.workspace.CredentialInfo to be required.
  • Changed patterns field for databricks.sdk.service.workspace.SparseCheckout to databricks.sdk.service.workspace.List dataclass.
  • Changed patterns field for databricks.sdk.service.workspace.SparseCheckoutUpdate to databricks.sdk.service.workspace.List dataclass.
  • Removed databricks.sdk.service.apps.AppState, databricks.sdk.service.apps.AppStatus, any and any dataclasses.
  • 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.QuerySourceTrigger and databricks.sdk.service.sql.ServerlessChannelInfo dataclasses.
  • 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.UpdateRepo and any dataclasses.
  • Removed status field for databricks.sdk.service.apps.App.
  • Removed query_source field for databricks.sdk.service.sql.QueryInfo.
  • Removed credentials field for databricks.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).
  • mypy error: 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.fs operations (#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 WorkspaceClient for mypy (#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.RegenerateDashboardRequest and databricks.sdk.service.catalog.RegenerateDashboardResponse dataclasses.
  • 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.TerminationDetails and databricks.sdk.service.jobs.TerminationTypeType dataclasses.
  • Added status field for databricks.sdk.service.jobs.BaseRun.
  • Added status field for databricks.sdk.service.jobs.RepairHistoryItem.
  • Added status field for databricks.sdk.service.jobs.Run.
  • Added status field for databricks.sdk.service.jobs.RunTask.
  • Added max_provisioned_throughput and min_provisioned_throughput fields for databricks.sdk.service.serving.ServedModelInput.
  • Added columns_to_sync field for databricks.sdk.service.vectorsearch.DeltaSyncVectorIndexSpecRequest.
  • Changed workload_size field for databricks.sdk.service.serving.ServedModelInput to no longer be required.

OpenAPI SHA: d05898328669a3f8ab0c2ecee37db2673d3ea3f7, Date: 2024-09-04

Release v0.31.1 (2024-08-28)

Bug Fixes

  • Fix DatabricksConfig.copy when authenticated with OAuth (#723).

Internal Changes

  • Fix get_workspace_client test to match Go SDK behavior (#738).
  • Verify that WorkspaceClient created from AccountClient does 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.ListQuotasResponse and databricks.sdk.service.catalog.QuotaInfo dataclasses.
  • 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.ListClusterCompliancesRequest and databricks.sdk.service.compute.ListClusterCompliancesResponse dataclasses.
  • 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.ListJobComplianceForPolicyResponse and databricks.sdk.service.jobs.ListJobComplianceRequest dataclasses.
  • Added fallback field for databricks.sdk.service.catalog.CreateExternalLocation.
  • Added fallback field for databricks.sdk.service.catalog.ExternalLocationInfo.
  • Added fallback field for databricks.sdk.service.catalog.UpdateExternalLocation.
  • Added job_run_id field for databricks.sdk.service.jobs.BaseRun.
  • Added job_run_id field for databricks.sdk.service.jobs.Run.
  • Added include_metrics field for databricks.sdk.service.sql.ListQueryHistoryRequest.
  • Added statement_ids field for databricks.sdk.service.sql.QueryFilter.
  • Removed databricks.sdk.service.sql.ContextFilter dataclass.
  • Removed context_filter field for databricks.sdk.service.sql.QueryFilter.
  • Removed pipeline_id and pipeline_update_id fields for databricks.sdk.service.sql.QuerySource.

OpenAPI SHA: 3eae49b444cac5a0118a3503e5b7ecef7f96527a, Date: 2024-08-21

Release v0.30.0 (2024-08-13)

New Features and Improvements

  • Add DataPlane support (#700).
  • Support partners in SDK (#648).

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 quoted titles (#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.apps package.
  • 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.GetBindingsSecurableType and databricks.sdk.service.catalog.UpdateBindingsSecurableType dataclasses.
  • 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.UpdateBudgetConfigurationResponse and databricks.sdk.service.billing.UsageDashboardType dataclasses.
  • 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.UpdateClusterResource and any dataclasses.
  • 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.Result and databricks.sdk.service.dashboards.TextAttachment dataclasses.
  • Added any, databricks.sdk.service.iam.MigratePermissionsRequest and databricks.sdk.service.iam.MigratePermissionsResponse dataclasses.
  • Added databricks.sdk.service.oauth2.ListCustomAppIntegrationsRequest and databricks.sdk.service.oauth2.ListPublishedAppIntegrationsRequest dataclasses.
  • Added databricks.sdk.service.pipelines.IngestionPipelineDefinition and databricks.sdk.service.pipelines.PipelineStateInfoHealth dataclasses.
  • Added databricks.sdk.service.serving.GoogleCloudVertexAiConfig dataclass.
  • 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.SlackConfig and databricks.sdk.service.settings.UpdateNotificationDestinationRequest dataclasses.
  • 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.UpdateVisualizationRequest and databricks.sdk.service.sql.UpdateVisualizationRequestVisualization dataclasses.
  • Added force field for databricks.sdk.service.catalog.DeleteSchemaRequest.
  • Added max_results and page_token fields for databricks.sdk.service.catalog.GetBindingsRequest.
  • Added include_aliases field for databricks.sdk.service.catalog.GetByAliasRequest.
  • Added include_aliases field for databricks.sdk.service.catalog.GetModelVersionRequest.
  • Added include_aliases field for databricks.sdk.service.catalog.GetRegisteredModelRequest.
  • Added max_results and page_token fields for databricks.sdk.service.catalog.ListSystemSchemasRequest.
  • Added next_page_token field for databricks.sdk.service.catalog.ListSystemSchemasResponse.
  • Added aliases field for databricks.sdk.service.catalog.ModelVersionInfo.
  • Added next_page_token field for databricks.sdk.service.catalog.WorkspaceBindingsResponse.
  • Added version field for databricks.sdk.service.compute.GetPolicyFamilyRequest.
  • Added filter_by, page_size, page_token and sort_by fields for databricks.sdk.service.compute.ListClustersRequest.
  • Added next_page_token and prev_page_token fields for databricks.sdk.service.compute.ListClustersResponse.
  • Added page_token field for databricks.sdk.service.jobs.GetRunRequest.
  • Added iterations, next_page_token and prev_page_token fields for databricks.sdk.service.jobs.Run.
  • Added create_time, created_by, creator_username and scopes fields for databricks.sdk.service.oauth2.GetCustomAppIntegrationOutput.
  • Added next_page_token field for databricks.sdk.service.oauth2.GetCustomAppIntegrationsOutput.
  • Added create_time and created_by fields for databricks.sdk.service.oauth2.GetPublishedAppIntegrationOutput.
  • Added next_page_token field for databricks.sdk.service.oauth2.GetPublishedAppIntegrationsOutput.
  • Added enable_local_disk_encryption field for databricks.sdk.service.pipelines.PipelineCluster.
  • Added whl field for databricks.sdk.service.pipelines.PipelineLibrary.
  • Added health field for databricks.sdk.service.pipelines.PipelineStateInfo.
  • Added ai21labs_api_key_plaintext field for databricks.sdk.service.serving.Ai21LabsConfig.
  • Added aws_access_key_id_plaintext and aws_secret_access_key_plaintext fields for databricks.sdk.service.serving.AmazonBedrockConfig.
  • Added anthropic_api_key_plaintext field for databricks.sdk.service.serving.AnthropicConfig.
  • Added cohere_api_base and cohere_api_key_plaintext fields for databricks.sdk.service.serving.CohereConfig.
  • Added databricks_api_token_plaintext field for databricks.sdk.service.serving.DatabricksModelServingConfig.
  • Added google_cloud_vertex_ai_config field for databricks.sdk.service.serving.ExternalModel.
  • Added microsoft_entra_client_secret_plaintext and openai_api_key_plaintext fields for databricks.sdk.service.serving.OpenAiConfig.
  • Added palm_api_key_plaintext field for databricks.sdk.service.serving.PaLmConfig.
  • Added expiration_time field for databricks.sdk.service.sharing.CreateRecipient.
  • Added next_page_token field for databricks.sdk.service.sharing.GetRecipientSharePermissionsResponse.
  • Added next_page_token field for databricks.sdk.service.sharing.ListProviderSharesResponse.
  • Added max_results and page_token fields for databricks.sdk.service.sharing.ListProvidersRequest.
  • Added next_page_token field for databricks.sdk.service.sharing.ListProvidersResponse.
  • Added max_results and page_token fields for databricks.sdk.service.sharing.ListRecipientsRequest.
  • Added next_page_token field for databricks.sdk.service.sharing.ListRecipientsResponse.
  • Added max_results and page_token fields for databricks.sdk.service.sharing.ListSharesRequest.
  • Added next_page_token field for databricks.sdk.service.sharing.ListSharesResponse.
  • Added max_results and page_token fields for databricks.sdk.service.sharing.SharePermissionsRequest.
  • Added expiration_time field for databricks.sdk.service.sharing.UpdateRecipient.
  • Added max_results and page_token fields for databricks.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_time and update_time fields for databricks.sdk.service.sql.Alert.
  • Added id field for databricks.sdk.service.sql.GetAlertRequest.
  • Added id field for databricks.sdk.service.sql.GetQueryRequest.
  • Added page_token field for databricks.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_time and warehouse_id fields for databricks.sdk.service.sql.Query.
  • Added context_filter field for databricks.sdk.service.sql.QueryFilter.
  • Added query_source field for databricks.sdk.service.sql.QueryInfo.
  • Added create_time, display_name, query_id, serialized_options, serialized_query_plan and update_time fields for databricks.sdk.service.sql.Visualization.
  • Changed create() method for a.budgets account-level service to return databricks.sdk.service.billing.CreateBudgetConfigurationResponse dataclass.
  • Changed create() method for a.budgets account-level service . New request type is databricks.sdk.service.billing.CreateBudgetConfigurationRequest dataclass.
  • Changed delete() method for a.budgets account-level service . New request type is databricks.sdk.service.billing.DeleteBudgetConfigurationRequest dataclass.
  • Changed delete() method for a.budgets account-level service to return any dataclass.
  • Changed get() method for a.budgets account-level service . New request type is databricks.sdk.service.billing.GetBudgetConfigurationRequest dataclass.
  • Changed get() method for a.budgets account-level service to return databricks.sdk.service.billing.GetBudgetConfigurationResponse dataclass.
  • Changed list() method for a.budgets account-level service to return databricks.sdk.service.billing.ListBudgetConfigurationsResponse dataclass.
  • Changed list() method for a.budgets account-level service to require request of databricks.sdk.service.billing.ListBudgetConfigurationsRequest dataclass.
  • Changed update() method for a.budgets account-level service to return databricks.sdk.service.billing.UpdateBudgetConfigurationResponse dataclass.
  • Changed update() method for a.budgets account-level service . New request type is databricks.sdk.service.billing.UpdateBudgetConfigurationRequest dataclass.
  • 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 of databricks.sdk.service.oauth2.ListCustomAppIntegrationsRequest dataclass.
  • Changed list() method for a.published_app_integration account-level service to require request of databricks.sdk.service.oauth2.ListPublishedAppIntegrationsRequest dataclass.
  • Changed delete() method for a.workspace_assignment account-level service to return any dataclass.
  • 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 is databricks.sdk.service.sql.CreateAlertRequest dataclass.
  • Changed delete() method for w.alerts workspace-level service to return any dataclass.
  • Changed delete() method for w.alerts workspace-level service . New request type is databricks.sdk.service.sql.TrashAlertRequest dataclass.
  • Changed get() method for w.alerts workspace-level service with new required argument order.
  • Changed list() method for w.alerts workspace-level service to return databricks.sdk.service.sql.ListAlertsResponse dataclass.
  • Changed list() method for w.alerts workspace-level service to require request of databricks.sdk.service.sql.ListAlertsRequest dataclass.
  • Changed update() method for w.alerts workspace-level service to return databricks.sdk.service.sql.Alert dataclass.
  • Changed update() method for w.alerts workspace-level service . New request type is databricks.sdk.service.sql.UpdateAlertRequest dataclass.
  • Changed create() and edit() methods for w.cluster_policies workspace-level service with new required argument order.
  • Changed get() method for w.model_versions workspace-level service to return databricks.sdk.service.catalog.ModelVersionInfo dataclass.
  • Changed migrate_permissions() method for w.permission_migration workspace-level service . New request type is databricks.sdk.service.iam.MigratePermissionsRequest dataclass.
  • Changed migrate_permissions() method for w.permission_migration workspace-level service to return databricks.sdk.service.iam.MigratePermissionsResponse dataclass.
  • Changed create() method for w.queries workspace-level service . New request type is databricks.sdk.service.sql.CreateQueryRequest dataclass.
  • Changed delete() method for w.queries workspace-level service to return any dataclass.
  • Changed delete() method for w.queries workspace-level service . New request type is databricks.sdk.service.sql.TrashQueryRequest dataclass.
  • Changed get() method for w.queries workspace-level service with new required argument order.
  • Changed list() method for w.queries workspace-level service to return databricks.sdk.service.sql.ListQueryObjectsResponse dataclass.
  • Changed update() method for w.queries workspace-level service . New request type is databricks.sdk.service.sql.UpdateQueryRequest dataclass.
  • Changed create() method for w.query_visualizations workspace-level service . New request type is databricks.sdk.service.sql.CreateVisualizationRequest dataclass.
  • Changed delete() method for w.query_visualizations workspace-level service to return any dataclass.
  • Changed delete() method for w.query_visualizations workspace-level service . New request type is databricks.sdk.service.sql.DeleteVisualizationRequest dataclass.
  • Changed update() method for w.query_visualizations workspace-level service . New request type is databricks.sdk.service.sql.UpdateVisualizationRequest dataclass.
  • Changed list() method for w.shares workspace-level service to require request of databricks.sdk.service.sharing.ListSharesRequest dataclass.
  • Changed execute_statement() and get_statement() methods for w.statement_execution workspace-level service to return databricks.sdk.service.sql.StatementResponse dataclass.
  • Changed securable_type field for databricks.sdk.service.catalog.GetBindingsRequest to databricks.sdk.service.catalog.GetBindingsSecurableType dataclass.
  • Changed securable_type field for databricks.sdk.service.catalog.UpdateWorkspaceBindingsParameters to databricks.sdk.service.catalog.UpdateBindingsSecurableType dataclass.
  • Changed name field for databricks.sdk.service.compute.CreatePolicy to no longer be required.
  • Changed name field for databricks.sdk.service.compute.EditPolicy to no longer be required.
  • Changed policy_family_id field for databricks.sdk.service.compute.GetPolicyFamilyRequest to str dataclass.
  • Changed policy_families field for databricks.sdk.service.compute.ListPolicyFamiliesResponse to no longer be required.
  • Changed definition, description, name and policy_family_id fields for databricks.sdk.service.compute.PolicyFamily to no longer be required.
  • Changed permissions field for databricks.sdk.service.iam.UpdateWorkspaceAssignments to no longer be required.
  • Changed access_control_list field for databricks.sdk.service.jobs.CreateJob to databricks.sdk.service.jobs.JobAccessControlRequestList dataclass.
  • Changed access_control_list field for databricks.sdk.service.jobs.SubmitRun to databricks.sdk.service.jobs.JobAccessControlRequestList dataclass.
  • Changed name and redirect_urls fields for databricks.sdk.service.oauth2.CreateCustomAppIntegration to no longer be required.
  • Changed ingestion_definition field for databricks.sdk.service.pipelines.CreatePipeline to databricks.sdk.service.pipelines.IngestionPipelineDefinition dataclass.
  • Changed ingestion_definition field for databricks.sdk.service.pipelines.EditPipeline to databricks.sdk.service.pipelines.IngestionPipelineDefinition dataclass.
  • Changed ingestion_definition field for databricks.sdk.service.pipelines.PipelineSpec to databricks.sdk.service.pipelines.IngestionPipelineDefinition dataclass.
  • Changed ai21labs_api_key field for databricks.sdk.service.serving.Ai21LabsConfig to no longer be required.
  • Changed aws_access_key_id and aws_secret_access_key fields for databricks.sdk.service.serving.AmazonBedrockConfig to no longer be required.
  • Changed anthropic_api_key field for databricks.sdk.service.serving.AnthropicConfig to no longer be required.
  • Changed cohere_api_key field for databricks.sdk.service.serving.CohereConfig to no longer be required.
  • Changed databricks_api_token field for databricks.sdk.service.serving.DatabricksModelServingConfig to no longer be required.
  • Changed palm_api_key field for databricks.sdk.service.serving.PaLmConfig to no longer be required.
  • Changed tags field for databricks.sdk.service.sql.Query to databricks.sdk.service.sql.List dataclass.
  • Changed user_ids and warehouse_ids fields for databricks.sdk.service.sql.QueryFilter to databricks.sdk.service.sql.List dataclass.
  • Changed results field for databricks.sdk.service.sql.QueryList to databricks.sdk.service.sql.LegacyQueryList dataclass.
  • Changed visualization field for databricks.sdk.service.sql.Widget to databricks.sdk.service.sql.LegacyVisualization dataclass.
  • 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.SortBy and databricks.sdk.service.marketplace.VisibilityFilter dataclasses.
  • 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.WrappedBudget and databricks.sdk.service.billing.WrappedBudgetWithStatus dataclasses.
  • Removed any, databricks.sdk.service.iam.PermissionMigrationRequest and databricks.sdk.service.iam.PermissionMigrationResponse dataclasses.
  • Removed databricks.sdk.service.pipelines.ManagedIngestionPipelineDefinition dataclass.
  • 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, any and databricks.sdk.service.serving.UpdateAppRequest dataclasses.
  • 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.UserId and databricks.sdk.service.sql.WarehouseId dataclasses.
  • Removed databricks.sdk.service.compute.PolicyFamilyId dataclass.
  • Removed can_use_client field for databricks.sdk.service.compute.ListClustersRequest.
  • Removed is_ascending and sort_by fields for databricks.sdk.service.marketplace.ListListingsRequest.
  • Removed provider_summary field for databricks.sdk.service.marketplace.Listing.
  • Removed filters field for databricks.sdk.service.marketplace.ListingSetting.
  • Removed metastore_id field for databricks.sdk.service.marketplace.ListingSummary.
  • Removed is_ascending and sort_by fields for databricks.sdk.service.marketplace.SearchListingsRequest.
  • Removed created_at, last_triggered_at, name, options, parent, query, rearm, updated_at and user fields for databricks.sdk.service.sql.Alert.
  • Removed alert_id field for databricks.sdk.service.sql.GetAlertRequest.
  • Removed query_id field for databricks.sdk.service.sql.GetQueryRequest.
  • Removed order, page and q fields for databricks.sdk.service.sql.ListQueriesRequest.
  • Removed include_metrics field for databricks.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_id and visualizations fields for databricks.sdk.service.sql.Query.
  • Removed statement_ids field for databricks.sdk.service.sql.QueryFilter.
  • Removed can_subscribe_to_live_query field for databricks.sdk.service.sql.QueryInfo.
  • Removed metadata_time_ms, planning_time_ms and query_execution_time_ms fields for databricks.sdk.service.sql.QueryMetrics.
  • Removed created_at, description, name, options, query and updated_at fields for databricks.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_id field to the config (#685).
  • Added with_product(...) and with_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 return databricks.sdk.service.catalog.ListAccountStorageCredentialsResponse dataclass.
  • Changed isolation_mode field for databricks.sdk.service.catalog.CatalogInfo to databricks.sdk.service.catalog.CatalogIsolationMode dataclass.
  • Added isolation_mode field for databricks.sdk.service.catalog.ExternalLocationInfo.
  • Added max_results and page_token fields for databricks.sdk.service.catalog.ListCatalogsRequest.
  • Added next_page_token field for databricks.sdk.service.catalog.ListCatalogsResponse.
  • Added table_serving_url field for databricks.sdk.service.catalog.OnlineTable.
  • Added isolation_mode field for databricks.sdk.service.catalog.StorageCredentialInfo.
  • Changed isolation_mode field for databricks.sdk.service.catalog.UpdateCatalog to databricks.sdk.service.catalog.CatalogIsolationMode dataclass.
  • Added isolation_mode field for databricks.sdk.service.catalog.UpdateExternalLocation.
  • Added isolation_mode field for databricks.sdk.service.catalog.UpdateStorageCredential.
  • Added databricks.sdk.service.catalog.CatalogIsolationMode and databricks.sdk.service.catalog.ListAccountStorageCredentialsResponse dataclasses.
  • Added create_schedule(), create_subscription(), delete_schedule(), delete_subscription(), get_schedule(), get_subscription(), list(), list_schedules(), list_subscriptions() and update_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.DeleteSubscriptionRequest dataclass, 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.SubscriptionSubscriberUser and databricks.sdk.service.dashboards.UpdateScheduleRequest dataclasses.
  • Added termination_category field for databricks.sdk.service.jobs.ForEachTaskErrorMessageStats.
  • Added on_streaming_backlog_exceeded field for databricks.sdk.service.jobs.JobEmailNotifications.
  • Added environment_key field for databricks.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_task and sql_task fields for databricks.sdk.service.jobs.SubmitRun.
  • Added environments field for databricks.sdk.service.jobs.SubmitRun.
  • Added dbt_task field for databricks.sdk.service.jobs.SubmitTask.
  • Added environment_key field for databricks.sdk.service.jobs.SubmitTask.
  • Added on_streaming_backlog_exceeded field for databricks.sdk.service.jobs.TaskEmailNotifications.
  • Added periodic field for databricks.sdk.service.jobs.TriggerSettings.
  • Added on_streaming_backlog_exceeded field for databricks.sdk.service.jobs.WebhookNotifications.
  • Added databricks.sdk.service.jobs.PeriodicTriggerConfiguration dataclass.
  • Added databricks.sdk.service.jobs.PeriodicTriggerConfigurationTimeUnit dataclass.
  • Added batch_get() method for w.consumer_listings workspace-level service.
  • Added batch_get() method for w.consumer_providers workspace-level service.
  • Added provider_summary field for databricks.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.ProviderListingSummaryInfo and databricks.sdk.service.oauth2.DataPlaneInfo dataclasses.
  • Removed create_deployment() method for w.apps workspace-level service.
  • Added deploy() and start() method1 for w.apps workspace-level service.
  • Added w.serving_endpoints_data_plane workspace-level service.
  • Added service_principal_id and service_principal_name fields for databricks.sdk.service.serving.App.
  • Added mode field for databricks.sdk.service.serving.AppDeployment.
  • Added mode field for databricks.sdk.service.serving.CreateAppDeploymentRequest.
  • Added data_plane_info field for databricks.sdk.service.serving.ServingEndpointDetailed.
  • Added databricks.sdk.service.serving.AppDeploymentMode, databricks.sdk.service.serving.ModelDataPlaneInfo and databricks.sdk.service.serving.StartAppRequest dataclasses.
  • Added query_next_page() method for w.vector_search_indexes workspace-level service.
  • Added query_type field for databricks.sdk.service.vectorsearch.QueryVectorIndexRequest.
  • Added next_page_token field for databricks.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.ListValue dataclass.
  • Added databricks.sdk.service.vectorsearch.MapStringValueEntry dataclass.
  • Added databricks.sdk.service.vectorsearch.ScanVectorIndexRequest dataclass.
  • Added databricks.sdk.service.vectorsearch.ScanVectorIndexResponse dataclass.
  • Added databricks.sdk.service.vectorsearch.Struct dataclass.
  • Added databricks.sdk.service.vectorsearch.Value dataclass.
  • Added databricks.sdk.service.catalog.ListConnectionsRequest dataclass.
  • Added databricks.sdk.service.catalog.MonitorRefreshListResponse dataclass.
  • Added databricks.sdk.service.pipelines.IngestionGatewayPipelineDefinition dataclass.
  • Added databricks.sdk.service.pipelines.TableSpecificConfig dataclass.
  • Added databricks.sdk.service.pipelines.TableSpecificConfigScdType dataclass.
  • Added databricks.sdk.service.serving.AppDeploymentArtifacts dataclass.
  • Removed databricks.sdk.service.catalog.EnableSchemaName dataclass.
  • Removed databricks.sdk.service.catalog.DisableSchemaName dataclass.
  • Removed databricks.sdk.service.marketplace.SortBySpec dataclass.
  • Removed databricks.sdk.service.marketplace.SortOrder dataclass.
  • Renamed databricks.sdk.service.catalog.DeleteLakehouseMonitorRequest dataclass to databricks.sdk.service.catalog.DeleteQualityMonitorRequest.
  • Renamed databricks.sdk.service.catalog.GetLakehouseMonitorRequest dataclass to databricks.sdk.service.catalog.GetQualityMonitorRequest.
  • Added next_page_token field for databricks.sdk.service.catalog.ListConnectionsResponse.
  • Added dashboard_id field for databricks.sdk.service.catalog.UpdateMonitor.
  • Added is_ascending and sort_by fields for databricks.sdk.service.marketplace.ListListingsRequest.
  • Added is_ascending field for databricks.sdk.service.marketplace.SearchListingsRequest.
  • Added gateway_definition field for databricks.sdk.service.pipelines.CreatePipeline.
  • Added gateway_definition field for databricks.sdk.service.pipelines.EditPipeline.
  • Added table_configuration field for databricks.sdk.service.pipelines.ManagedIngestionPipelineDefinition.
  • Added gateway_definition field for databricks.sdk.service.pipelines.PipelineSpec.
  • Added table_configuration field for databricks.sdk.service.pipelines.SchemaSpec.
  • Added table_configuration field for databricks.sdk.service.pipelines.TableSpec.
  • Added deployment_artifacts field for databricks.sdk.service.serving.AppDeployment.
  • Added route_optimized field for databricks.sdk.service.serving.CreateServingEndpoint.
  • Added contents field for databricks.sdk.service.serving.ExportMetricsResponse.
  • Added microsoft_entra_client_id, microsoft_entra_client_secret and microsoft_entra_tenant_id fields for databricks.sdk.service.serving.OpenAiConfig.
  • Added endpoint_url and route_optimized fields for databricks.sdk.service.serving.ServingEndpointDetailed.
  • Added storage_root field for databricks.sdk.service.sharing.CreateShare.
  • Added storage_location and storage_root fields for databricks.sdk.service.sharing.ShareInfo.
  • Added storage_root field for databricks.sdk.service.sharing.UpdateShare.
  • Added embedding_writeback_table field for databricks.sdk.service.vectorsearch.DeltaSyncVectorIndexSpecRequest.
  • Added embedding_writeback_table field for databricks.sdk.service.vectorsearch.DeltaSyncVectorIndexSpecResponse.
  • Changed schema_name field for databricks.sdk.service.catalog.DisableRequest to str dataclass.
  • Changed schema_name field for databricks.sdk.service.catalog.EnableRequest to str dataclass.
  • Changed cluster_status() method for w.libraries workspace-level service to return databricks.sdk.service.compute.ClusterLibraryStatuses dataclass.
  • Changed spec and cluster_source fields for databricks.sdk.service.compute.ClusterDetails to databricks.sdk.service.compute.ClusterSpec dataclass.
  • Changed openai_api_key field for databricks.sdk.service.serving.OpenAiConfig to no longer be required.
  • Removed cluster_source field for databricks.sdk.service.compute.ClusterAttributes.
  • Removed cluster_source field for databricks.sdk.service.compute.ClusterSpec.
  • Removed databricks.sdk.service.compute.ClusterStatusResponse dataclass.
  • Removed cluster_source field for databricks.sdk.service.compute.CreateCluster.
  • Removed clone_from and cluster_source fields for databricks.sdk.service.compute.EditCluster.
  • Removed sort_by_spec field for databricks.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 of databricks.sdk.service.catalog.ListConnectionsRequest dataclass.

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_definition field for databricks.sdk.service.pipelines.CreatePipeline.
  • Added ingestion_definition field for databricks.sdk.service.pipelines.EditPipeline.
  • Added ingestion_definition field for databricks.sdk.service.pipelines.PipelineSpec.
  • Added databricks.sdk.service.pipelines.IngestionConfig dataclass.
  • Added databricks.sdk.service.pipelines.ManagedIngestionPipelineDefinition dataclass.
  • Added databricks.sdk.service.pipelines.SchemaSpec dataclass.
  • Added databricks.sdk.service.pipelines.TableSpec dataclass.
  • Changed create() method for w.apps workspace-level service . New request type is databricks.sdk.service.serving.CreateAppRequest dataclass.
  • Changed create() method for w.apps workspace-level service to return databricks.sdk.service.serving.App dataclass.
  • Removed delete_app() method for w.apps workspace-level service.
  • Removed get_app() method for w.apps workspace-level service.
  • Removed get_app_deployment_status() method for w.apps workspace-level service.
  • Removed get_apps() method for w.apps workspace-level service.
  • Removed get_events() method for w.apps workspace-level service.
  • Added create_deployment() method for w.apps workspace-level service.
  • Added delete() method for w.apps workspace-level service.
  • Added get() method for w.apps workspace-level service.
  • Added get_deployment() method for w.apps workspace-level service.
  • Added get_environment() method for w.apps workspace-level service.
  • Added list() method for w.apps workspace-level service.
  • Added list_deployments() method for w.apps workspace-level service.
  • Added stop() method for w.apps workspace-level service.
  • Added update() method for w.apps workspace-level service.
  • Added get_open_api() method for w.serving_endpoints workspace-level service.
  • Removed databricks.sdk.service.serving.AppEvents dataclass.
  • Removed databricks.sdk.service.serving.AppManifest dataclass.
  • Removed databricks.sdk.service.serving.AppServiceStatus dataclass.
  • Removed databricks.sdk.service.serving.DeleteAppResponse dataclass.
  • Removed databricks.sdk.service.serving.DeployAppRequest dataclass.
  • Removed databricks.sdk.service.serving.DeploymentStatus dataclass.
  • Removed databricks.sdk.service.serving.DeploymentStatusState dataclass.
  • Removed databricks.sdk.service.serving.GetAppDeploymentStatusRequest dataclass.
  • Removed databricks.sdk.service.serving.GetAppResponse dataclass.
  • Removed databricks.sdk.service.serving.GetEventsRequest dataclass.
  • Removed databricks.sdk.service.serving.ListAppEventsResponse dataclass.
  • Changed apps field for databricks.sdk.service.serving.ListAppsResponse to databricks.sdk.service.serving.AppList dataclass.
  • Added databricks.sdk.service.serving.App dataclass.
  • Added databricks.sdk.service.serving.AppDeployment dataclass.
  • Added databricks.sdk.service.serving.AppDeploymentState dataclass.
  • Added databricks.sdk.service.serving.AppDeploymentStatus dataclass.
  • Added databricks.sdk.service.serving.AppEnvironment dataclass.
  • Added databricks.sdk.service.serving.AppState dataclass.
  • Added databricks.sdk.service.serving.AppStatus dataclass.
  • Added databricks.sdk.service.serving.CreateAppDeploymentRequest dataclass.
  • Added databricks.sdk.service.serving.CreateAppRequest dataclass.
  • Added databricks.sdk.service.serving.EnvVariable dataclass.
  • Added databricks.sdk.service.serving.GetAppDeploymentRequest dataclass.
  • Added databricks.sdk.service.serving.GetAppEnvironmentRequest dataclass.
  • Added databricks.sdk.service.serving.GetOpenApiRequest dataclass.
  • Added any dataclass.
  • Added databricks.sdk.service.serving.ListAppDeploymentsRequest dataclass.
  • Added databricks.sdk.service.serving.ListAppDeploymentsResponse dataclass.
  • Added databricks.sdk.service.serving.ListAppsRequest dataclass.
  • Added databricks.sdk.service.serving.StopAppRequest dataclass.
  • Added any dataclass.
  • Added databricks.sdk.service.serving.UpdateAppRequest dataclass.
  • Removed w.csp_enablement workspace-level service.
  • Removed w.esm_enablement workspace-level service.
  • Added w.compliance_security_profile workspace-level service.
  • Added w.enhanced_security_monitoring workspace-level service.
  • Removed databricks.sdk.service.settings.CspEnablement dataclass.
  • Removed databricks.sdk.service.settings.CspEnablementSetting dataclass.
  • Removed databricks.sdk.service.settings.EsmEnablement dataclass.
  • Removed databricks.sdk.service.settings.EsmEnablementSetting dataclass.
  • Removed databricks.sdk.service.settings.GetCspEnablementSettingRequest dataclass.
  • Removed databricks.sdk.service.settings.GetEsmEnablementSettingRequest dataclass.
  • Removed databricks.sdk.service.settings.UpdateCspEnablementSettingRequest dataclass.
  • Removed databricks.sdk.service.settings.UpdateEsmEnablementSettingRequest dataclass.
  • Added databricks.sdk.service.settings.ComplianceSecurityProfile dataclass.
  • Added databricks.sdk.service.settings.ComplianceSecurityProfileSetting dataclass.
  • Added databricks.sdk.service.settings.EnhancedSecurityMonitoring dataclass.
  • Added databricks.sdk.service.settings.EnhancedSecurityMonitoringSetting dataclass.
  • Added databricks.sdk.service.settings.GetComplianceSecurityProfileSettingRequest dataclass.
  • Added databricks.sdk.service.settings.GetEnhancedSecurityMonitoringSettingRequest dataclass.
  • Added databricks.sdk.service.settings.UpdateComplianceSecurityProfileSettingRequest dataclass.
  • Added databricks.sdk.service.settings.UpdateEnhancedSecurityMonitoringSettingRequest dataclass.
  • Added tags field for databricks.sdk.service.sql.DashboardEditContent.
  • Added tags field for databricks.sdk.service.sql.QueryEditContent.
  • Added catalog field for databricks.sdk.service.sql.QueryOptions.
  • Added schema field for databricks.sdk.service.sql.QueryOptions.
  • Added tags field for databricks.sdk.service.sql.QueryPostContent.
  • Added query field for databricks.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 deployment field for databricks.sdk.service.pipelines.CreatePipeline, databricks.sdk.service.pipelines.EditPipeline and databricks.sdk.service.pipelines.PipelineSpec.
  • Added schema_id field for databricks.sdk.service.catalog.SchemaInfo.
  • Added operation field for databricks.sdk.service.catalog.ValidationResult.
  • Added requirements field for databricks.sdk.service.compute.Library.
  • Added warehouse_id field for databricks.sdk.service.jobs.NotebookTask.
  • Added run_as field for databricks.sdk.service.jobs.SubmitRun.
  • Added databricks.sdk.service.catalog.ValidationResultOperation dataclass.
  • Added databricks.sdk.service.compute.ClusterStatus dataclass.
  • Added databricks.sdk.service.compute.ClusterStatusResponse dataclass.
  • Added databricks.sdk.service.compute.LibraryInstallStatus dataclass.
  • Added databricks.sdk.service.pipelines.DeploymentKind dataclass.
  • Added databricks.sdk.service.pipelines.PipelineDeployment dataclass.
  • Removed aws_operation field for databricks.sdk.service.catalog.ValidationResult.
  • Removed azure_operation field for databricks.sdk.service.catalog.ValidationResult.
  • Removed gcp_operation field for databricks.sdk.service.catalog.ValidationResult.
  • Removed databricks.sdk.service.catalog.ValidationResultAwsOperation dataclass.
  • Removed databricks.sdk.service.catalog.ValidationResultAzureOperation dataclass.
  • Removed databricks.sdk.service.catalog.ValidationResultGcpOperation dataclass.
  • Removed databricks.sdk.service.compute.LibraryFullStatusStatus dataclass.
  • Removed databricks.sdk.service.compute.ClusterStatusRequest dataclass.
  • Changed cluster_status() method for w.libraries workspace-level service . New request type is databricks.sdk.service.compute.ClusterStatus dataclass.
  • Changed cluster_status() method for w.libraries workspace-level service to return databricks.sdk.service.compute.ClusterStatusResponse dataclass.
  • Changed status field for databricks.sdk.service.compute.LibraryFullStatus to databricks.sdk.service.compute.LibraryInstallStatus dataclass.

OpenAPI SHA: 06d330f43d92c1be864d4638c672cd0723e20a51, Date: 2024-04-22

Release v0.25.1 (2024-04-12)

Bug fixes:

  • Fixed select_node_type error (#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 except blocks 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.AzureManagedIdentity dataclass.
  • Removed full_name field for databricks.sdk.service.catalog.CancelRefreshRequest.
  • Added table_name field for databricks.sdk.service.catalog.CancelRefreshRequest.
  • Changed custom_metrics field for databricks.sdk.service.catalog.CreateMonitor to databricks.sdk.service.catalog.MonitorMetricList dataclass.
  • Removed full_name field for databricks.sdk.service.catalog.CreateMonitor.
  • Changed inference_log field for databricks.sdk.service.catalog.CreateMonitor to databricks.sdk.service.catalog.MonitorInferenceLog dataclass.
  • Changed notifications field for databricks.sdk.service.catalog.CreateMonitor to databricks.sdk.service.catalog.MonitorNotifications dataclass.
  • Changed snapshot field for databricks.sdk.service.catalog.CreateMonitor to any dataclass.
  • Changed time_series field for databricks.sdk.service.catalog.CreateMonitor to databricks.sdk.service.catalog.MonitorTimeSeries dataclass.
  • Added table_name field for databricks.sdk.service.catalog.CreateMonitor.
  • Changed azure_managed_identity field for databricks.sdk.service.catalog.CreateStorageCredential to databricks.sdk.service.catalog.AzureManagedIdentityRequest dataclass.
  • Removed full_name field for databricks.sdk.service.catalog.DeleteLakehouseMonitorRequest.
  • Added table_name field for databricks.sdk.service.catalog.DeleteLakehouseMonitorRequest.
  • Removed full_name field for databricks.sdk.service.catalog.GetLakehouseMonitorRequest.
  • Added table_name field for databricks.sdk.service.catalog.GetLakehouseMonitorRequest.
  • Removed full_name field for databricks.sdk.service.catalog.GetRefreshRequest.
  • Added table_name field for databricks.sdk.service.catalog.GetRefreshRequest.
  • Removed full_name field for databricks.sdk.service.catalog.ListRefreshesRequest.
  • Added table_name field for databricks.sdk.service.catalog.ListRefreshesRequest.
  • Changed quartz_cron_expression field for databricks.sdk.service.catalog.MonitorCronSchedule to be required.
  • Changed timezone_id field for databricks.sdk.service.catalog.MonitorCronSchedule to be required.
  • Removed databricks.sdk.service.catalog.MonitorCustomMetric dataclass.
  • Removed databricks.sdk.service.catalog.MonitorCustomMetricType dataclass.
  • Removed databricks.sdk.service.catalog.MonitorDestinations dataclass.
  • Removed databricks.sdk.service.catalog.MonitorInferenceLogProfileType dataclass.
  • Removed databricks.sdk.service.catalog.MonitorInferenceLogProfileTypeProblemType dataclass.
  • Changed custom_metrics field for databricks.sdk.service.catalog.MonitorInfo to databricks.sdk.service.catalog.MonitorMetricList dataclass.
  • Changed drift_metrics_table_name field for databricks.sdk.service.catalog.MonitorInfo to be required.
  • Changed inference_log field for databricks.sdk.service.catalog.MonitorInfo to databricks.sdk.service.catalog.MonitorInferenceLog dataclass.
  • Changed monitor_version field for databricks.sdk.service.catalog.MonitorInfo to be required.
  • Changed notifications field for databricks.sdk.service.catalog.MonitorInfo to databricks.sdk.service.catalog.MonitorNotifications dataclass.
  • Changed profile_metrics_table_name field for databricks.sdk.service.catalog.MonitorInfo to be required.
  • Changed snapshot field for databricks.sdk.service.catalog.MonitorInfo to any dataclass.
  • Changed status field for databricks.sdk.service.catalog.MonitorInfo to be required.
  • Changed table_name field for databricks.sdk.service.catalog.MonitorInfo to be required.
  • Changed time_series field for databricks.sdk.service.catalog.MonitorInfo to databricks.sdk.service.catalog.MonitorTimeSeries dataclass.
  • Removed databricks.sdk.service.catalog.MonitorNotificationsConfig dataclass.
  • Changed refresh_id field for databricks.sdk.service.catalog.MonitorRefreshInfo to be required.
  • Changed start_time_ms field for databricks.sdk.service.catalog.MonitorRefreshInfo to be required.
  • Changed state field for databricks.sdk.service.catalog.MonitorRefreshInfo to be required.
  • Added trigger field for databricks.sdk.service.catalog.MonitorRefreshInfo.
  • Removed any dataclass.
  • Removed databricks.sdk.service.catalog.MonitorTimeSeriesProfileType dataclass.
  • Removed full_name field for databricks.sdk.service.catalog.RunRefreshRequest.
  • Added table_name field for databricks.sdk.service.catalog.RunRefreshRequest.
  • Changed azure_managed_identity field for databricks.sdk.service.catalog.StorageCredentialInfo to databricks.sdk.service.catalog.AzureManagedIdentityResponse dataclass.
  • Removed name field for databricks.sdk.service.catalog.TableRowFilter.
  • Added function_name field for databricks.sdk.service.catalog.TableRowFilter.
  • Changed custom_metrics field for databricks.sdk.service.catalog.UpdateMonitor to databricks.sdk.service.catalog.MonitorMetricList dataclass.
  • Removed full_name field for databricks.sdk.service.catalog.UpdateMonitor.
  • Changed inference_log field for databricks.sdk.service.catalog.UpdateMonitor to databricks.sdk.service.catalog.MonitorInferenceLog dataclass.
  • Changed notifications field for databricks.sdk.service.catalog.UpdateMonitor to databricks.sdk.service.catalog.MonitorNotifications dataclass.
  • Changed snapshot field for databricks.sdk.service.catalog.UpdateMonitor to any dataclass.
  • Changed time_series field for databricks.sdk.service.catalog.UpdateMonitor to databricks.sdk.service.catalog.MonitorTimeSeries dataclass.
  • Added table_name field for databricks.sdk.service.catalog.UpdateMonitor.
  • Changed azure_managed_identity field for databricks.sdk.service.catalog.UpdateStorageCredential to databricks.sdk.service.catalog.AzureManagedIdentityResponse dataclass.
  • Changed azure_managed_identity field for databricks.sdk.service.catalog.ValidateStorageCredential to databricks.sdk.service.catalog.AzureManagedIdentityRequest dataclass.
  • Removed operation field for databricks.sdk.service.catalog.ValidationResult.
  • Added aws_operation field for databricks.sdk.service.catalog.ValidationResult.
  • Added azure_operation field for databricks.sdk.service.catalog.ValidationResult.
  • Added gcp_operation field for databricks.sdk.service.catalog.ValidationResult.
  • Removed databricks.sdk.service.catalog.ValidationResultOperation dataclass.
  • Added databricks.sdk.service.catalog.AzureManagedIdentityRequest dataclass.
  • Added databricks.sdk.service.catalog.AzureManagedIdentityResponse dataclass.
  • Added databricks.sdk.service.catalog.MonitorDestination dataclass.
  • Added databricks.sdk.service.catalog.MonitorInferenceLog dataclass.
  • Added databricks.sdk.service.catalog.MonitorInferenceLogProblemType dataclass.
  • Added databricks.sdk.service.catalog.MonitorMetric dataclass.
  • Added databricks.sdk.service.catalog.MonitorMetricType dataclass.
  • Added databricks.sdk.service.catalog.MonitorNotifications dataclass.
  • Added databricks.sdk.service.catalog.MonitorRefreshInfoTrigger dataclass.
  • Added any dataclass.
  • Added databricks.sdk.service.catalog.MonitorTimeSeries dataclass.
  • Added databricks.sdk.service.catalog.ValidationResultAwsOperation dataclass.
  • Added databricks.sdk.service.catalog.ValidationResultAzureOperation dataclass.
  • Added databricks.sdk.service.catalog.ValidationResultGcpOperation dataclass.
  • Added clone_from field for databricks.sdk.service.compute.ClusterSpec.
  • Removed databricks.sdk.service.compute.ComputeSpec dataclass.
  • Removed databricks.sdk.service.compute.ComputeSpecKind dataclass.
  • Added clone_from field for databricks.sdk.service.compute.CreateCluster.
  • Added clone_from field for databricks.sdk.service.compute.EditCluster.
  • Added databricks.sdk.service.compute.CloneCluster dataclass.
  • Added databricks.sdk.service.compute.Environment dataclass.
  • Changed update() method for a.workspace_assignment account-level service to return databricks.sdk.service.iam.PermissionAssignment dataclass.
  • Removed any dataclass.
  • Removed compute_key field for databricks.sdk.service.jobs.ClusterSpec.
  • Removed compute field for databricks.sdk.service.jobs.CreateJob.
  • Added environments field for databricks.sdk.service.jobs.CreateJob.
  • Removed databricks.sdk.service.jobs.JobCompute dataclass.
  • Removed compute field for databricks.sdk.service.jobs.JobSettings.
  • Added environments field for databricks.sdk.service.jobs.JobSettings.
  • Removed compute_key field for databricks.sdk.service.jobs.RunTask.
  • Removed databricks.sdk.service.jobs.TableTriggerConfiguration dataclass.
  • Removed compute_key field for databricks.sdk.service.jobs.Task.
  • Added environment_key field for databricks.sdk.service.jobs.Task.
  • Changed table field for databricks.sdk.service.jobs.TriggerSettings to databricks.sdk.service.jobs.TableUpdateTriggerConfiguration dataclass.
  • Changed table_update field for databricks.sdk.service.jobs.TriggerSettings to databricks.sdk.service.jobs.TableUpdateTriggerConfiguration dataclass.
  • Added databricks.sdk.service.jobs.JobEnvironment dataclass.
  • Added databricks.sdk.service.jobs.TableUpdateTriggerConfiguration dataclass.
  • Added databricks.sdk.service.marketplace package.

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() and unpublish() method fors w.lakeview workspace-level service.
  • Added databricks.sdk.service.dashboards.MigrateDashboardRequest and databricks.sdk.service.dashboards.UnpublishDashboardRequest dataclasses.
  • Added description, queue_duration and repair_history fields for databricks.sdk.service.jobs.BaseRun.
  • Added compute_key and job_cluster_key fields for databricks.sdk.service.jobs.ClusterSpec.
  • Changed left, op and right fields for databricks.sdk.service.jobs.ConditionTask to be required.
  • Changed edit_mode field for databricks.sdk.service.jobs.CreateJob to databricks.sdk.service.jobs.JobEditMode dataclass.
  • Replaced databricks.sdk.service.jobs.CreateJobEditMode dataclass by databricks.sdk.service.jobs.JobEditMode.
  • Changed url field for databricks.sdk.service.jobs.FileArrivalTriggerConfiguration to be required.
  • Changed error_message_stats field for databricks.sdk.service.jobs.ForEachStats to databricks.sdk.service.jobs.ForEachTaskErrorMessageStatsList dataclass.
  • Changed new_cluster field for databricks.sdk.service.jobs.JobCluster to be required.
  • Changed edit_mode field for databricks.sdk.service.jobs.JobSettings to databricks.sdk.service.jobs.JobEditMode dataclass.
  • Replaced databricks.sdk.service.jobs.JobsSettingsEditMode dataclass by databricks.sdk.service.jobs.JobEditMode.
  • Changed metric, op and value fields for databricks.sdk.service.jobs.JobsHealthRule to be required.
  • Changed run_type field for databricks.sdk.service.jobs.ListRunsRequest to databricks.sdk.service.jobs.RunType dataclass.
  • Repplaced databricks.sdk.service.jobs.ListRunsRunType dataclass by databricks.sdk.service.jobs.RunType dataclass.
  • Changed pipeline_id field for databricks.sdk.service.jobs.PipelineTask to be required.
  • Changed entry_point and package_name fields for databricks.sdk.service.jobs.PythonWheelTask to be required.
  • Changed job_parameters field for databricks.sdk.service.jobs.RepairRun to dict[str,str] dataclass.
  • Changed base_parameters field for databricks.sdk.service.jobs.ResolvedNotebookTaskValues to dict[str,str] dataclass.
  • Changed parameters field for databricks.sdk.service.jobs.ResolvedParamPairValues to dict[str,str] dataclass.
  • Changed named_parameters field for databricks.sdk.service.jobs.ResolvedPythonWheelTaskValues to dict[str,str] dataclass.
  • Removed named_parameters field for databricks.sdk.service.jobs.ResolvedRunJobTaskValues.
  • Changed parameters field for databricks.sdk.service.jobs.ResolvedRunJobTaskValues to dict[str,str] dataclass.
  • Added job_parameters field for databricks.sdk.service.jobs.ResolvedRunJobTaskValues.
  • Added description and queue_duration fields for databricks.sdk.service.jobs.Run.
  • Changed op field for databricks.sdk.service.jobs.RunConditionTask to databricks.sdk.service.jobs.ConditionTaskOp dataclass.
  • Replaced databricks.sdk.service.jobs.RunConditionTaskOp dataclass by databricks.sdk.service.jobs.ConditionTaskOp dataclass.
  • Changed inputs and task fields for databricks.sdk.service.jobs.RunForEachTask to be required.
  • Changed job_parameters field for databricks.sdk.service.jobs.RunJobTask to dict[str,str] dataclass.
  • Added dbt_commands, jar_params, notebook_params, pipeline_params, python_named_params, python_params, spark_submit_params and sql_params fields for databricks.sdk.service.jobs.RunJobTask.
  • Changed job_parameters field for databricks.sdk.service.jobs.RunNow to dict[str,str] dataclass.
  • Added info field for databricks.sdk.service.jobs.RunOutput.
  • Removed job_parameters field for databricks.sdk.service.jobs.RunParameters.
  • Changed task_key field for databricks.sdk.service.jobs.RunTask to be required.
  • Added compute_key, email_notifications, job_cluster_key, notification_settings, run_duration, run_page_url, timeout_seconds and webhook_notifications fields for databricks.sdk.service.jobs.RunTask.
  • Added endpoint_id field for databricks.sdk.service.jobs.SqlQueryOutput.
  • Added condition_task, dbt_task, notebook_task, pipeline_task, python_wheel_task, run_job_task, spark_jar_task, spark_python_task, spark_submit_task and sql_task fields for databricks.sdk.service.jobs.SubmitRun.
  • Added description field for databricks.sdk.service.jobs.SubmitTask.
  • Added disable_auto_optimization field for databricks.sdk.service.jobs.Task.
  • Added no_alert_for_skipped_runs field for databricks.sdk.service.jobs.TaskEmailNotifications.
  • Added table_update field for databricks.sdk.service.jobs.TriggerSettings.
  • Changed id field for databricks.sdk.service.jobs.Webhook to be required.
  • Changed on_duration_warning_threshold_exceeded field for databricks.sdk.service.jobs.WebhookNotifications to databricks.sdk.service.jobs.WebhookList dataclass.
  • Removed databricks.sdk.service.jobs.WebhookNotificationsOnDurationWarningThresholdExceededItem dataclass.
  • Added databricks.sdk.service.jobs.JobEditMode dataclass.
  • Replaced databricks.sdk.service.serving.AwsBedrockConfig dataclass by databricks.sdk.service.serving.AmazonBedrockConfig dataclass.
  • Replaced databricks.sdk.service.serving.AwsBedrockConfigBedrockProvider dataclass by databricks.sdk.service.serving.AmazonBedrockConfigBedrockProvider dataclass.
  • Renamed aws_bedrock_config field for databricks.sdk.service.serving.ExternalModel to amazon_bedrock_config.
  • Changed get() method for w.ip_access_lists workspace-level service . New request type is databricks.sdk.service.settings.GetIpAccessListRequest dataclass.
  • Replaced databricks.sdk.service.settings.GetIpAccessList dataclass by databricks.sdk.service.settings.GetIpAccessListRequest dataclass.

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.AwsIamRoleResponse dataclass.
  • Added databricks.sdk.service.catalog.AwsIamRoleRequest dataclass.
  • Removed databricks.sdk.service.catalog.AwsIamRole dataclass.
  • Changed aws_iam_role field for databricks.sdk.service.catalog.CreateStorageCredential to databricks.sdk.service.catalog.AwsIamRoleRequest dataclass.
  • Changed aws_iam_role field for databricks.sdk.service.catalog.StorageCredentialInfo to databricks.sdk.service.catalog.AwsIamRoleResponse dataclass.
  • Changed aws_iam_role field for databricks.sdk.service.catalog.UpdateStorageCredential to databricks.sdk.service.catalog.AwsIamRoleRequest dataclass.
  • Changed aws_iam_role field for databricks.sdk.service.catalog.ValidateStorageCredential to databricks.sdk.service.catalog.AwsIamRoleRequest dataclass.
  • Added auto_capture_config field for databricks.sdk.service.serving.EndpointPendingConfig.
  • Added databricks.sdk.service.sharing.SharedDataObjectDataObjectType dataclass.
  • Changed data_object_type field for databricks.sdk.service.sharing.SharedDataObject to databricks.sdk.service.sharing.SharedDataObjectDataObjectType dataclass.
  • Added content field for databricks.sdk.service.sharing.SharedDataObject.
  • Added embedding_source_columns field for databricks.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 notifications field for databricks.sdk.service.catalog.CreateMonitor, databricks.sdk.service.catalog.MonitorInfo, and databricks.sdk.service.catalog.UpdateMonitor to databricks.sdk.service.catalog.MonitorNotificationsConfig dataclass.
  • Added browse_only field for databricks.sdk.service.catalog.ExternalLocationInfo, databricks.sdk.service.catalog.FunctionInfo, databricks.sdk.service.catalog.ModelVersionInfo, databricks.sdk.service.catalog.RegisteredModelInfo, databricks.sdk.service.catalog.SchemaInfo, databricks.sdk.service.catalog.TableInfo, and databricks.sdk.service.catalog.VolumeInfo.
  • Added include_browse field for databricks.sdk.service.catalog.GetCatalogRequest, databricks.sdk.service.catalog.GetExternalLocationRequest, databricks.sdk.service.catalog.GetFunctionRequest, databricks.sdk.service.catalog.GetModelVersionRequest, databricks.sdk.service.catalog.GetRegisteredModelRequest, databricks.sdk.service.catalog.GetSchemaRequest, databricks.sdk.service.catalog.GetTableRequest, databricks.sdk.service.catalog.ListExternalLocationsRequest, databricks.sdk.service.catalog.ListFunctionsRequest, databricks.sdk.service.catalog.ListModelVersionsRequest, databricks.sdk.service.catalog.ListRegisteredModelsRequest, databricks.sdk.service.catalog.ListSchemasRequest, databricks.sdk.service.catalog.ListTablesRequest, databricks.sdk.service.catalog.ListVolumesRequest, and databricks.sdk.service.catalog.ReadVolumeRequest.
  • Changed publish() method for w.lakeview workspace-level service to return databricks.sdk.service.dashboards.PublishedDashboard dataclass.
  • Added create(), get(), get_published(), trash(), and update() 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, and databricks.sdk.service.dashboards.UpdateDashboardRequest dataclasses.

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:

Dataclasses:

  • databricks.sdk.service.settings.AutomaticClusterUpdateSetting
  • databricks.sdk.service.settings.ClusterAutoRestartMessage
  • databricks.sdk.service.settings.ClusterAutoRestartMessageEnablementDetails
  • databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindow
  • databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowDayOfWeek
  • databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule
  • databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency
  • databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime
  • databricks.sdk.service.settings.ComplianceStandard
  • databricks.sdk.service.settings.CspEnablement
  • databricks.sdk.service.settings.CspEnablementAccount
  • databricks.sdk.service.settings.CspEnablementAccountSetting
  • databricks.sdk.service.settings.CspEnablementSetting
  • databricks.sdk.service.settings.DeleteDefaultNamespaceRequest
  • databricks.sdk.service.settings.DeletePersonalComputeRequest
  • databricks.sdk.service.settings.DeleteRestrictWorkspaceAdminRequest
  • databricks.sdk.service.settings.EsmEnablement
  • databricks.sdk.service.settings.EsmEnablementAccount
  • databricks.sdk.service.settings.EsmEnablementAccountSetting
  • databricks.sdk.service.settings.EsmEnablementSetting
  • databricks.sdk.service.settings.GetAutomaticClusterUpdateRequest
  • databricks.sdk.service.settings.GetCspEnablementAccountRequest
  • databricks.sdk.service.settings.GetCspEnablementRequest
  • databricks.sdk.service.settings.GetDefaultNamespaceRequest
  • databricks.sdk.service.settings.GetEsmEnablementAccountRequest
  • databricks.sdk.service.settings.GetEsmEnablementRequest
  • databricks.sdk.service.settings.GetPersonalComputeRequest
  • databricks.sdk.service.settings.GetRestrictWorkspaceAdminRequest
  • databricks.sdk.service.settings.NccAwsStableIpRule
  • databricks.sdk.service.settings.UpdateAutomaticClusterUpdateSettingRequest
  • databricks.sdk.service.settings.UpdateCspEnablementAccountSettingRequest
  • databricks.sdk.service.settings.UpdateCspEnablementSettingRequest
  • databricks.sdk.service.settings.UpdateEsmEnablementAccountSettingRequest
  • databricks.sdk.service.settings.UpdateEsmEnablementSettingRequest
  • databricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindow
  • databricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindowDayOfWeek
  • databricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule
  • databricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency
  • databricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime
  • databricks.sdk.service.vectorsearch.ComplianceStandard
  • databricks.sdk.service.vectorsearch.CspEnablement
  • databricks.sdk.service.vectorsearch.CspEnablementAccount
  • databricks.sdk.service.vectorsearch.CspEnablementAccountSetting
  • databricks.sdk.service.vectorsearch.CspEnablementSetting
  • databricks.sdk.service.vectorsearch.DeleteDefaultNamespaceRequest
  • databricks.sdk.service.vectorsearch.DeletePersonalComputeRequest
  • databricks.sdk.service.vectorsearch.DeleteRestrictWorkspaceAdminRequest
  • databricks.sdk.service.vectorsearch.EsmEnablement
  • databricks.sdk.service.vectorsearch.EsmEnablementAccount
  • databricks.sdk.service.vectorsearch.EsmEnablementAccountSetting
  • databricks.sdk.service.vectorsearch.EsmEnablementSetting
  • databricks.sdk.service.vectorsearch.GetAutomaticClusterUpdateRequest
  • databricks.sdk.service.vectorsearch.GetCspEnablementAccountRequest
  • databricks.sdk.service.vectorsearch.GetCspEnablementRequest
  • databricks.sdk.service.vectorsearch.GetDefaultNamespaceRequest
  • databricks.sdk.service.vectorsearch.GetEsmEnablementAccountRequest
  • databricks.sdk.service.vectorsearch.GetEsmEnablementRequest
  • databricks.sdk.service.vectorsearch.GetPersonalComputeRequest
  • databricks.sdk.service.vectorsearch.GetRestrictWorkspaceAdminRequest
  • databricks.sdk.service.vectorsearch.NccAwsStableIpRule
  • databricks.sdk.service.vectorsearch.UpdateAutomaticClusterUpdateSettingRequest
  • databricks.sdk.service.vectorsearch.UpdateCspEnablementAccountSettingRequest
  • databricks.sdk.service.vectorsearch.UpdateCspEnablementSettingRequest
  • databricks.sdk.service.vectorsearch.UpdateEsmEnablementAccountSettingRequest
  • databricks.sdk.service.vectorsearch.UpdateEsmEnablementSettingRequest
  • databricks.sdk.service.iam.PermissionMigrationRequest
  • databricks.sdk.service.iam.PermissionMigrationResponse

Changed

  • version field for databricks.sdk.service.serving.AppManifest to databricks.sdk.service.serving.AnyValue dataclass.
  • delete_endpoint() method for w.vector_search_endpoints workspace-level service with new required argument order.
  • create_index() method for w.vector_search_indexes workspace-level service with new required argument order.
  • delete_data_vector_index() method for w.vector_search_indexes workspace-level service with new required argument order.
  • upsert_data_vector_index() method for w.vector_search_indexes workspace-level service with new required argument order.
  • endpoint_name field for databricks.sdk.service.vectorsearch.CreateVectorIndexRequest to be required.

Removed

  • delete_personal_compute_setting() method for a.account_settings account-level service.
  • get_personal_compute_setting() method for a.account_settings account-level service.
  • update_personal_compute_setting() method for a.account_settings account-level service.
  • delete_default_namespace_setting() method for w.settings workspace-level service.
  • delete_restrict_workspace_admins_setting() method for w.settings workspace-level service.
  • get_default_namespace_setting() method for w.settings workspace-level service.
  • get_restrict_workspace_admins_setting() method for w.settings workspace-level service.
  • update_default_namespace_setting() method for w.settings workspace-level service.
  • update_restrict_workspace_admins_setting() method for w.settings workspace-level service.
  • databricks.sdk.service.settings.DeleteDefaultNamespaceSettingRequest dataclass.
  • databricks.sdk.service.settings.DeletePersonalComputeSettingRequest dataclass.
  • databricks.sdk.service.settings.DeleteRestrictWorkspaceAdminsSettingRequest dataclass.
  • databricks.sdk.service.settings.GetDefaultNamespaceSettingRequest dataclass.
  • databricks.sdk.service.settings.GetPersonalComputeSettingRequest dataclass.
  • databricks.sdk.service.settings.GetRestrictWorkspaceAdminsSettingRequest dataclass.
  • databricks.sdk.service.vectorsearch.EmbeddingConfig dataclass.
  • embedding_config field for databricks.sdk.service.vectorsearch.EmbeddingSourceColumn.
  • name field for databricks.sdk.service.vectorsearch.DeleteDataVectorIndexRequest.
  • name field for databricks.sdk.service.vectorsearch.DeleteEndpointRequest.
  • planning_phases field for databricks.sdk.service.sql.QueryMetrics.
  • delta_sync_vector_index_spec field for databricks.sdk.service.vectorsearch.VectorIndex.
  • direct_access_vector_index_spec field for databricks.sdk.service.vectorsearch.VectorIndex.

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 the contents key. This dict will also contain response headers if returned by the API.

Internal Changes:

  • Add get_workspace_id to docgen blocklist (#549).
  • Support HEAD operation and response Headers (#547).

API Changes:

  • Changed delete(), get() and update() 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() and update() methods for w.volumes workspace-level service with new required argument order.
  • Added w.online_tables workspace-level service.
  • Renamed name_arg field to name for the following dataclasses: databricks.sdk.service.catalog.DeleteConnectionRequest, databricks.sdk.service.catalog.GetConnectionRequest, databricks.sdk.service.catalog.UpdateConnection, databricks.sdk.service.sharing.DeleteCleanRoomRequest, databricks.sdk.service.sharing.GetCleanRoomRequest and databricks.sdk.service.sharing.UpdateCleanRoom.
  • Removed full_name_arg field for databricks.sdk.service.catalog.DeleteVolumeRequest.
  • Added name field for databricks.sdk.service.catalog.DeleteVolumeRequest.
  • Added max_results field for databricks.sdk.service.catalog.ListVolumesRequest.
  • Added page_token field for databricks.sdk.service.catalog.ListVolumesRequest.
  • Added next_page_token field for databricks.sdk.service.catalog.ListVolumesResponseContent.
  • Removed full_name_arg field for databricks.sdk.service.catalog.ReadVolumeRequest.
  • Added name field for databricks.sdk.service.catalog.ReadVolumeRequest.
  • Removed assets_dir field for databricks.sdk.service.catalog.UpdateMonitor.
  • Removed full_name_arg field for databricks.sdk.service.catalog.UpdateVolumeRequestContent.
  • Added name field for databricks.sdk.service.catalog.UpdateVolumeRequestContent.
  • Added the following catalog dataclasses: ContinuousUpdateStatus, DeleteOnlineTableRequest, FailedStatus, GetOnlineTableRequest, OnlineTable, OnlineTableSpec, OnlineTableState, OnlineTableStatus, PipelineProgress, ProvisioningStatus, TriggeredUpdateStatus and ViewData.
  • Added get_directory_metadata() method for w.files workspace-level service.
  • Added get_metadata() method for w.files workspace-level service.
  • Added content_length, content_type and last_modified fields for databricks.sdk.service.files.DownloadResponse.
  • Added the following files dataclasses: FileSize, GetDirectoryMetadataRequest, GetMetadataRequest, GetMetadataResponse and LastModifiedHttpDate.
  • Removed trigger_history field for databricks.sdk.service.jobs.Job.
  • Removed databricks.sdk.service.jobs.TriggerEvaluation dataclass.
  • Removed databricks.sdk.service.jobs.TriggerHistory dataclass.
  • Added table field for databricks.sdk.service.jobs.TriggerSettings.
  • Added databricks.sdk.service.jobs.Condition dataclass.
  • Added databricks.sdk.service.jobs.TableTriggerConfiguration dataclass.
  • Removed config field for databricks.sdk.service.serving.ExternalModel.
  • Removed databricks.sdk.service.serving.ExternalModelConfig dataclass. Fields moved to databricks.sdk.service.serving.ExternalModel.
  • Added max_provisioned_throughput and min_provisioned_throughput fields for databricks.sdk.service.serving.ServedEntityInput.
  • Added max_provisioned_throughput and min_provisioned_throughput fields for databricks.sdk.service.serving.ServedEntityOutput.
  • Changed delete() method for w.clean_rooms workspace-level service with new required argument order.
  • Changed get() method for w.clean_rooms workspace-level service with new required argument order.
  • Changed update() method for w.clean_rooms workspace-level service with new required argument order.
  • Added enum_options field for databricks.sdk.service.sql.Parameter.
  • Added multi_values_options field for databricks.sdk.service.sql.Parameter.
  • Added query_id field for databricks.sdk.service.sql.Parameter.
  • Added databricks.sdk.service.sql.MultiValuesOptions dataclass.

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 AccountClient instances would stop working after calling get_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.mapping to databricks.sdk.errors.platform (#522).
  • Added Union to content (2nd) parameter in upload function (#493).
  • Fixed WorkspaceConf.get_status and WorkspaceConf.set_status (#525).

Documentation

  • Make docs useful again (#519).
  • Show undocumented fields in dataclasses (#520).

API Changes

Additions:

  • Added the following dataclasses:
    • databricks.sdk.service.catalog.CancelRefreshRequest
    • databricks.sdk.service.catalog.GetRefreshRequest
    • databricks.sdk.service.catalog.ListRefreshesRequest
    • databricks.sdk.service.catalog.MonitorRefreshInfo
    • databricks.sdk.service.catalog.MonitorRefreshInfoState
    • databricks.sdk.service.catalog.RunRefreshRequest
    • databricks.sdk.service.compute.Adlsgen2Info
    • databricks.sdk.service.compute.GcsStorageInfo
    • databricks.sdk.service.files.CreateDirectoryRequest
    • databricks.sdk.service.files.DeleteDirectoryRequest
    • databricks.sdk.service.files.DirectoryEntry
    • databricks.sdk.service.files.ListDirectoryContentsRequest
    • databricks.sdk.service.files.ListDirectoryResponse
    • databricks.sdk.service.files.PageToken
    • databricks.sdk.service.jobs.ForEachStats
    • databricks.sdk.service.jobs.ForEachTask
    • databricks.sdk.service.jobs.ForEachTaskErrorMessageStats
    • databricks.sdk.service.jobs.ForEachTaskTaskRunStats
    • databricks.sdk.service.jobs.RunForEachTask
    • databricks.sdk.service.pipelines.PipelineClusterAutoscale
    • databricks.sdk.service.pipelines.PipelineClusterAutoscaleMode
    • databricks.sdk.service.settings.DeleteDefaultNamespaceSettingRequest
    • databricks.sdk.service.settings.DeleteDefaultNamespaceSettingResponse
    • databricks.sdk.service.settings.DeleteRestrictWorkspaceAdminsSettingRequest
    • databricks.sdk.service.settings.DeleteRestrictWorkspaceAdminsSettingResponse
    • databricks.sdk.service.settings.GetDefaultNamespaceSettingRequest
    • databricks.sdk.service.settings.GetPersonalComputeSettingRequest
    • databricks.sdk.service.settings.GetRestrictWorkspaceAdminsSettingRequest
    • databricks.sdk.service.settings.RestrictWorkspaceAdminsMessage
    • databricks.sdk.service.settings.RestrictWorkspaceAdminsMessageStatus
    • databricks.sdk.service.settings.RestrictWorkspaceAdminsSetting
    • databricks.sdk.service.settings.UpdateDefaultNamespaceSettingRequest
    • databricks.sdk.service.settings.UpdateRestrictWorkspaceAdminsSettingRequest
  • Added cancel_refresh(), get_refresh(), list_refreshes() and run_refresh() method for w.lakehouse_monitors workspace-level service.
  • Added use_preemptible_executors field for databricks.sdk.service.compute.GcpAttributes.
  • Added zone_id field for databricks.sdk.service.compute.GcpAttributes.
  • Added abfss and gcs field for databricks.sdk.service.compute.InitScriptInfo.
  • Added create_directory(), delete_directory() and list_directory_contents() method for w.files workspace-level service.
  • Added source field for databricks.sdk.service.jobs.DbtTask and databricks.sdk.service.jobs.SqlTaskFile.
  • Added for_each_task field for databricks.sdk.service.jobs.RunTask, databricks.sdk.service.jobs.SubmitTask and databricks.sdk.service.jobs.Task.
  • Added field_mask field for databricks.sdk.service.settings.UpdatePersonalComputeSettingRequest.
  • Added delta_sync_index_spec field for databricks.sdk.service.vectorsearch.CreateVectorIndexRequest.
  • Added file_type field for databricks.sdk.service.workspace.ExportResponse.
  • Added resource_id field for databricks.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() and update_restrict_workspace_admins_setting() method for w.settings workspace-level service.
  • Added get_personal_compute_setting() method for a.account_settings account-level service.

Removals:

  • Removed the following dataclasses:
    • databricks.sdk.service.settings.ReadDefaultWorkspaceNamespaceRequest
    • databricks.sdk.service.settings.ReadPersonalComputeSettingRequest
    • databricks.sdk.service.settings.UpdateDefaultWorkspaceNamespaceRequest
    • databricks.sdk.service.settings.DeleteDefaultWorkspaceNamespaceRequest
    • databricks.sdk.service.settings.DeleteDefaultWorkspaceNamespaceResponse
    • databricks.sdk.service.pipelines.ResetRequest
  • Removed the following methods:
    • get_status() for w.files workspace-level service.
    • reset() for w.pipelines workspace-level service.
    • delete_default_workspace_namespace() for w.settings workspace-level service.
    • read_default_workspace_namespace() for w.settings workspace-level service.
    • update_default_workspace_namespace() for w.settings workspace-level service.
    • read_personal_compute_setting() for a.account_settings account-level service.
  • Removed name field for databricks.sdk.service.catalog.UpdateConnection, databricks.sdk.service.catalog.UpdateMetastore, databricks.sdk.service.catalog.UpdateRegisteredModelRequest. databricks.sdk.service.catalog.UpdateSchemaand databricks.sdk.service.catalog.UpdateVolumeRequestContent.
  • Removed delta_sync_vector_index_spec field for databricks.sdk.service.vectorsearch.CreateVectorIndexRequest.

Changes:

  • Changed max_workers and min_workers field for databricks.sdk.service.compute.AutoScale to no longer be required.
  • Changed destination field for databricks.sdk.service.compute.DbfsStorageInfo, databricks.sdk.service.compute.LocalFileInfo, databricks.sdk.service.compute.S3StorageInfo, databricks.sdk.service.compute.VolumesStorageInfo and databricks.sdk.service.compute.WorkspaceStorageInfo to be required.
  • Changed clients field for databricks.sdk.service.compute.WorkloadType to be required.
  • Changed allow_missing and setting field for databricks.sdk.service.settings.UpdatePersonalComputeSettingRequest to be required.
  • Changed etag field for databricks.sdk.service.settings.DeletePersonalComputeSettingRequest to no longer be required.
  • Changed autoscale field for databricks.sdk.service.pipelines.PipelineCluster to databricks.sdk.service.pipelines.PipelineClusterAutoscale dataclass.
  • Changed delete_personal_compute_setting() and update_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 of None as default list value for deserialising responses (#361).
  • Support dev and staging workspaces (#514).

API Changes:

  • Added exists() method for w.tables workspace-level service.
  • Added w.lakehouse_monitors workspace-level service.
  • Added the following dataclasses: databricks.sdk.service.catalog.CreateMonitor, databricks.sdk.service.catalog.DeleteLakehouseMonitorRequest, databricks.sdk.service.catalog.ExistsRequest, databricks.sdk.service.catalog.GetLakehouseMonitorRequest, databricks.sdk.service.catalog.MonitorCronSchedule, databricks.sdk.service.catalog.MonitorCronSchedulePauseStatus, databricks.sdk.service.catalog.MonitorCustomMetric, databricks.sdk.service.catalog.MonitorCustomMetricType, databricks.sdk.service.catalog.MonitorDataClassificationConfig, databricks.sdk.service.catalog.MonitorDestinations, databricks.sdk.service.catalog.MonitorInferenceLogProfileType, databricks.sdk.service.catalog.MonitorInferenceLogProfileTypeProblemType, databricks.sdk.service.catalog.MonitorInfo, databricks.sdk.service.catalog.MonitorInfoStatus, databricks.sdk.service.catalog.MonitorNotificationsConfig, databricks.sdk.service.catalog.MonitorTimeSeriesProfileType, databricks.sdk.service.catalog.TableExistsResponse and databricks.sdk.service.catalog.UpdateMonitor.
  • Changed create_obo_token() method for w.token_management workspace-level service with new required argument order.
  • Changed get() method for w.token_management workspace-level service to return databricks.sdk.service.settings.GetTokenResponse dataclass.
  • Changed lifetime_seconds field for databricks.sdk.service.settings.CreateOboTokenRequest to no longer be required.
  • Added databricks.sdk.service.settings.GetTokenResponse dataclass.

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__.py equal across projects (#488).
  • Update SDK to Latest OpenAPI Specification (#501).

Note: This release contains breaking changes, please see below for more details.

API Changes:

  • [Breaking] Changed list() method for w.tokens workspace-level service to return databricks.sdk.service.settings.ListPublicTokensResponse dataclass.
  • Changed list() method for w.external_locations workspace-level service to require request of databricks.sdk.service.catalog.ListExternalLocationsRequest dataclass and w.storage_credentials workspace-level service to require request of databricks.sdk.service.catalog.ListStorageCredentialsRequest dataclass.
  • Added next_page_token field for databricks.sdk.service.catalog.ListExternalLocationsResponse, databricks.sdk.service.catalog.ListFunctionsResponse, databricks.sdk.service.catalog.ListSchemasResponse and databricks.sdk.service.catalog.ListStorageCredentialsResponse.
  • Added max_results field for databricks.sdk.service.catalog.ListFunctionsRequest and databricks.sdk.service.catalog.ListSchemasRequest.
  • Added page_token field for databricks.sdk.service.catalog.ListFunctionsRequest and databricks.sdk.service.catalog.ListSchemasRequest.
  • Added omit_columns field for databricks.sdk.service.catalog.ListTablesRequest.
  • Added omit_properties field for databricks.sdk.service.catalog.ListTablesRequest.
  • Added init_scripts field for databricks.sdk.service.pipelines.PipelineCluster.
  • Added validate_only field for databricks.sdk.service.pipelines.StartUpdate and databricks.sdk.service.pipelines.UpdateInfo.
  • Changed create() method for w.dashboards workspace-level service . New request type is databricks.sdk.service.sql.DashboardPostContent dataclass.
  • Added update() method for w.dashboards workspace-level service.
  • Added http_headers field for databricks.sdk.service.sql.ExternalLink.
  • Added run_as_role field for databricks.sdk.service.sql.QueryEditContent.
  • Added package: databricks.sdk.service.dashboards and databricks.sdk.service.vectorsearch.
  • Added dataclass: databricks.sdk.service.catalog.ListExternalLocationsRequest, databricks.sdk.service.catalog.ListStorageCredentialsRequest, databricks.sdk.service.settings.ListPublicTokensResponse, databricks.sdk.service.sql.DashboardEditContent and databricks.sdk.service.sql.DashboardPostContent.
  • Removed dataclass: databricks.sdk.service.catalog.TableConstraintList and databricks.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.typed to support PEP-561 (#483).
  • Fixed bug in @retried when exception subtypes were not respected (#484).
  • Make WorkspaceClient and AccountClient more friendly with autospeccing (#480).

API Changes:

  • Added azure_workspace_info field for databricks.sdk.service.provisioning.Workspace.
  • Added databricks.sdk.service.provisioning.AzureWorkspaceInfo dataclass.
  • Changed update_config() method for w.serving_endpoints workspace-level service with new required argument order.
  • Changed served_entities field for databricks.sdk.service.serving.EndpointCoreConfigInput to no longer be required.
  • Changed create() method for a.account_ip_access_lists account-level service with new required argument order.
  • Changed replace() method for a.account_ip_access_lists account-level service with new required argument order.
  • Changed update() method for a.account_ip_access_lists account-level service with new required argument order.
  • Changed create() method for w.ip_access_lists workspace-level service with new required argument order.
  • Changed replace() method for w.ip_access_lists workspace-level service with new required argument order.
  • Changed update() method for w.ip_access_lists workspace-level service with new required argument order.
  • Changed ip_addresses field for databricks.sdk.service.settings.CreateIpAccessList to no longer be required.
  • Changed ip_addresses field for databricks.sdk.service.settings.ReplaceIpAccessList to no longer be required.
  • Removed list_id field for databricks.sdk.service.settings.ReplaceIpAccessList.
  • Changed enabled field for databricks.sdk.service.settings.UpdateIpAccessList to no longer be required.
  • Changed ip_addresses field for databricks.sdk.service.settings.UpdateIpAccessList to no longer be required.
  • Changed label field for databricks.sdk.service.settings.UpdateIpAccessList to no longer be required.
  • Removed list_id field for databricks.sdk.service.settings.UpdateIpAccessList.
  • Changed list_type field for databricks.sdk.service.settings.UpdateIpAccessList to no longer be required.

OpenAPI SHA: d3853c8dee5806d04da2ae8910f273ffb35719a5, Date: 2023-12-14

Release v0.15.0 (2023-12-12)

Bugfixes:

  • Fixed accidental rename (#471).
  • Fixed parsing of ISO date strings (#473).

Other changes:

  • Updated GCP OAuth Readme (#464).
  • Reference Documentation Refactoring (#467).
  • Installed local library when generating docs (#469).
  • Fixed readme links in pypi (#472).
  • Updated a note for installing Python SDK on Databricks Runtime 13.1+ (#474).
  • Updated GCP auth readme (#470).

API Changes:

  • Changed update() method for w.connections workspace-level service with new required argument order.
  • Added cloudflare_api_token field for databricks.sdk.service.catalog.CreateStorageCredential.
  • Added cloudflare_api_token field for databricks.sdk.service.catalog.StorageCredentialInfo.
  • Changed name field for databricks.sdk.service.catalog.UpdateCatalog to be required.
  • Added new_name field for databricks.sdk.service.catalog.UpdateCatalog.
  • Changed name field for databricks.sdk.service.catalog.UpdateConnection to no longer be required.
  • Added new_name field for databricks.sdk.service.catalog.UpdateConnection.
  • Changed name field for databricks.sdk.service.catalog.UpdateExternalLocation to be required.
  • Added new_name field for databricks.sdk.service.catalog.UpdateExternalLocation.
  • Added new_name field for databricks.sdk.service.catalog.UpdateMetastore.
  • Added new_name field for databricks.sdk.service.catalog.UpdateRegisteredModelRequest.
  • Added new_name field for databricks.sdk.service.catalog.UpdateSchema.
  • Changed name field for databricks.sdk.service.catalog.UpdateStorageCredential to be required.
  • Added cloudflare_api_token field for databricks.sdk.service.catalog.UpdateStorageCredential.
  • Added new_name field for databricks.sdk.service.catalog.UpdateStorageCredential.
  • Added new_name field for databricks.sdk.service.catalog.UpdateVolumeRequestContent.
  • Added cloudflare_api_token field for databricks.sdk.service.catalog.ValidateStorageCredential.
  • Added databricks.sdk.service.catalog.CloudflareApiToken dataclass.
  • Removed continuous field for databricks.sdk.service.jobs.BaseRun.
  • Removed continuous field for databricks.sdk.service.jobs.Run.
  • Changed job_parameters field for databricks.sdk.service.jobs.RunJobTask to databricks.sdk.service.jobs.ParamPairs dataclass.
  • Added run_if field for databricks.sdk.service.jobs.SubmitTask.
  • Added run_job_task field for databricks.sdk.service.jobs.SubmitTask.
  • Changed update_config() method for w.serving_endpoints workspace-level service with new required argument order.
  • Added put() method for w.serving_endpoints workspace-level service.
  • Added rate_limits field for databricks.sdk.service.serving.CreateServingEndpoint.
  • Changed served_models field for databricks.sdk.service.serving.EndpointCoreConfigInput to no longer be required.
  • Added auto_capture_config field for databricks.sdk.service.serving.EndpointCoreConfigInput.
  • Added served_entities field for databricks.sdk.service.serving.EndpointCoreConfigInput.
  • Added auto_capture_config field for databricks.sdk.service.serving.EndpointCoreConfigOutput.
  • Added served_entities field for databricks.sdk.service.serving.EndpointCoreConfigOutput.
  • Added served_entities field for databricks.sdk.service.serving.EndpointCoreConfigSummary.
  • Added served_entities field for databricks.sdk.service.serving.EndpointPendingConfig.
  • Added extra_params field for databricks.sdk.service.serving.QueryEndpointInput.
  • Added input field for databricks.sdk.service.serving.QueryEndpointInput.
  • Added max_tokens field for databricks.sdk.service.serving.QueryEndpointInput.
  • Added messages field for databricks.sdk.service.serving.QueryEndpointInput.
  • Added n field for databricks.sdk.service.serving.QueryEndpointInput.
  • Added prompt field for databricks.sdk.service.serving.QueryEndpointInput.
  • Added stop field for databricks.sdk.service.serving.QueryEndpointInput.
  • Added stream field for databricks.sdk.service.serving.QueryEndpointInput.
  • Added temperature field for databricks.sdk.service.serving.QueryEndpointInput.
  • Changed predictions field for databricks.sdk.service.serving.QueryEndpointResponse to no longer be required.
  • Added choices field for databricks.sdk.service.serving.QueryEndpointResponse.
  • Added created field for databricks.sdk.service.serving.QueryEndpointResponse.
  • Added data field for databricks.sdk.service.serving.QueryEndpointResponse.
  • Added id field for databricks.sdk.service.serving.QueryEndpointResponse.
  • Added model field for databricks.sdk.service.serving.QueryEndpointResponse.
  • Added object field for databricks.sdk.service.serving.QueryEndpointResponse.
  • Added usage field for databricks.sdk.service.serving.QueryEndpointResponse.
  • Changed workload_size field for databricks.sdk.service.serving.ServedModelInput to databricks.sdk.service.serving.ServedModelInputWorkloadSize dataclass.
  • Changed workload_type field for databricks.sdk.service.serving.ServedModelInput to databricks.sdk.service.serving.ServedModelInputWorkloadType dataclass.
  • Added task field for databricks.sdk.service.serving.ServingEndpoint.
  • Added task field for databricks.sdk.service.serving.ServingEndpointDetailed.
  • Added databricks.sdk.service.serving.Ai21LabsConfig dataclass.
  • Added databricks.sdk.service.serving.AnthropicConfig dataclass.
  • Added databricks.sdk.service.serving.AutoCaptureConfigInput dataclass.
  • Added databricks.sdk.service.serving.AutoCaptureConfigOutput dataclass.
  • Added databricks.sdk.service.serving.AutoCaptureState dataclass.
  • Added databricks.sdk.service.serving.AwsBedrockConfig dataclass.
  • Added databricks.sdk.service.serving.AwsBedrockConfigBedrockProvider dataclass.
  • Added databricks.sdk.service.serving.ChatMessage dataclass.
  • Added databricks.sdk.service.serving.ChatMessageRole dataclass.
  • Added databricks.sdk.service.serving.CohereConfig dataclass.
  • Added databricks.sdk.service.serving.DatabricksModelServingConfig dataclass.
  • Added databricks.sdk.service.serving.EmbeddingsV1ResponseEmbeddingElement dataclass.
  • Added databricks.sdk.service.serving.EmbeddingsV1ResponseEmbeddingElementObject dataclass.
  • Added databricks.sdk.service.serving.ExternalModel dataclass.
  • Added databricks.sdk.service.serving.ExternalModelConfig dataclass.
  • Added databricks.sdk.service.serving.ExternalModelProvider dataclass.
  • Added databricks.sdk.service.serving.ExternalModelUsageElement dataclass.
  • Added databricks.sdk.service.serving.FoundationModel dataclass.
  • Added databricks.sdk.service.serving.OpenAiConfig dataclass.
  • Added databricks.sdk.service.serving.PaLmConfig dataclass.
  • Added databricks.sdk.service.serving.PayloadTable dataclass.
  • Added databricks.sdk.service.serving.PutRequest dataclass.
  • Added databricks.sdk.service.serving.PutResponse dataclass.
  • Added databricks.sdk.service.serving.QueryEndpointResponseObject dataclass.
  • Added databricks.sdk.service.serving.RateLimit dataclass.
  • Added databricks.sdk.service.serving.RateLimitKey dataclass.
  • Added databricks.sdk.service.serving.RateLimitRenewalPeriod dataclass.
  • Added databricks.sdk.service.serving.ServedEntityInput dataclass.
  • Added databricks.sdk.service.serving.ServedEntityOutput dataclass.
  • Added databricks.sdk.service.serving.ServedEntitySpec dataclass.
  • Added databricks.sdk.service.serving.ServedModelInputWorkloadSize dataclass.
  • Added databricks.sdk.service.serving.ServedModelInputWorkloadType dataclass.
  • Added databricks.sdk.service.serving.V1ResponseChoiceElement dataclass.
  • Removed a.account_network_policy account-level service.
  • Removed databricks.sdk.service.settings.AccountNetworkPolicyMessage dataclass.
  • Removed databricks.sdk.service.settings.DeleteAccountNetworkPolicyRequest dataclass.
  • Removed databricks.sdk.service.settings.DeleteAccountNetworkPolicyResponse dataclass.
  • Removed databricks.sdk.service.settings.ReadAccountNetworkPolicyRequest dataclass.
  • Removed databricks.sdk.service.settings.UpdateAccountNetworkPolicyRequest dataclass.
  • Removed name field for databricks.sdk.service.sharing.UpdateCleanRoom.
  • Changed name field for databricks.sdk.service.sharing.UpdateProvider to be required.
  • Added new_name field for databricks.sdk.service.sharing.UpdateProvider.
  • Changed name field for databricks.sdk.service.sharing.UpdateRecipient to be required.
  • Added new_name field for databricks.sdk.service.sharing.UpdateRecipient.
  • Changed name field for databricks.sdk.service.sharing.UpdateShare to be required.
  • Added new_name field for databricks.sdk.service.sharing.UpdateShare.
  • Added statement_ids field for databricks.sdk.service.sql.QueryFilter.
  • Added databricks.sdk.service.sql.StatementId dataclass.

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_CREDENTIALS environment variable or corresponding google_credentials parameter in Config or the client constructors. You may provide either the path to the file containing your credentials or the credentials themselves serialized as JSON. To use Google impersonation, specify the service principal to impersonate in the DATABRICKS_GOOGLE_SERVICE_ACCOUNT environment variable or the corresponding google_service_account parameter in Config or the client constructors. See #444 for the changes.

Bug fixes:

  • 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_id field for databricks.sdk.service.catalog.TableInfo.
  • Added enable_predictive_optimization field for databricks.sdk.service.catalog.UpdateCatalog and databricks.sdk.service.catalog.UpdateSchema.
  • Removed databricks.sdk.service.catalog.UpdatePredictiveOptimization and databricks.sdk.service.catalog.UpdatePredictiveOptimizationResponse dataclasses.
  • Removed enable_optimization() method for w.metastores workspace-level service.
  • Added description field for databricks.sdk.service.jobs.CreateJob and databricks.sdk.service.jobs.JobSettings.
  • Added list_network_connectivity_configurations() and list_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, and databricks.sdk.service.settings.ListPrivateEndpointRulesRequest dataclasses.

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 catching DatabricksError and checking the error_code field, you can catch one of these subtypes of DatabricksError, which is more ergonomic and removes the need to rethrow exceptions that you don't want to catch. For example:
try:
  return (self._ws
    .permissions
    .get(object_type, object_id))
except DatabricksError as e:
  if e.error_code in [
    "RESOURCE_DOES_NOT_EXIST",
    "RESOURCE_NOT_FOUND",
    "PERMISSION_DENIED",
    "FEATURE_DISABLED",
    "BAD_REQUEST"]:
    logger.warning(...)
    return None
  raise RetryableError(...) from e

can be replaced with

try:
  return (self._ws
    .permissions
    .get(object_type, object_id))
except PermissionDenied, FeatureDisabled:
  logger.warning(...)
  return None
except NotFound:
  raise RetryableError(...)
  • 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 corresponding databricks.sdk.service.catalog.CreateFunction and databricks.sdk.service.catalog.FunctionInfo dataclasses.
  • Changed create() method for w.metastores workspace-level service with new required argument order.
  • Changed storage_root field for databricks.sdk.service.catalog.CreateMetastore to be optional.
  • Added skip_validation field for databricks.sdk.service.catalog.UpdateExternalLocation.
  • Added libraries field for databricks.sdk.service.compute.CreatePolicy, databricks.sdk.service.compute.EditPolicy and databricks.sdk.service.compute.Policy.
  • Added init_scripts field for databricks.sdk.service.compute.EventDetails.
  • Added file field for databricks.sdk.service.compute.InitScriptInfo.
  • Added zone_id field for databricks.sdk.service.compute.InstancePoolGcpAttributes.
  • Added several dataclasses related to init scripts.
  • Added databricks.sdk.service.compute.LocalFileInfo dataclass.
  • Replaced ui_state field with edit_mode for databricks.sdk.service.jobs.CreateJob and databricks.sdk.service.jobs.JobSettings.
  • Replaced databricks.sdk.service.jobs.CreateJobUiState dataclass with databricks.sdk.service.jobs.CreateJobEditMode.
  • Added include_resolved_values field for databricks.sdk.service.jobs.GetRunRequest.
  • Replaced databricks.sdk.service.jobs.JobSettingsUiState dataclass with databricks.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_id field for databricks.sdk.service.provisioning.UpdateWorkspaceRequest.
  • Added a.network_connectivity account-level service.
  • Added string_shared_as field for databricks.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, and start_index fields for databricks.sdk.service.iam.GetAccountUserRequest and databricks.sdk.service.iam.GetUserRequest.
  • Added schemas field for databricks.sdk.service.iam.Group, databricks.sdk.service.iam.ListGroupsResponse, databricks.sdk.service.iam.ListServicePrincipalResponse, databricks.sdk.service.iam.ListUsersResponse, databricks.sdk.service.iam.ServicePrincipal, and databricks.sdk.service.iam.User.
  • Added databricks.sdk.service.iam.GetSortOrder, databricks.sdk.service.iam.GroupSchema, databricks.sdk.service.iam.ListResponseSchema, databricks.sdk.service.iam.ServicePrincipalSchema, and databricks.sdk.service.iam.UserSchema dataclasses.
  • Added webhook_notifications field for databricks.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:

  • GitHub OIDC publishing (#386).
  • Move Release Pipeline to OIDC (#387).

API Changes:

  • Changed download() method for a.billable_usage account-level service to start returning databricks.sdk.service.billing.DownloadResponse dataclass.
  • Added databricks.sdk.service.billing.DownloadResponse dataclass.
  • 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 name field for databricks.sdk.service.catalog.AccountsUpdateStorageCredential.
  • Added storage_credential_name field for databricks.sdk.service.catalog.AccountsUpdateStorageCredential.
  • Removed name field for databricks.sdk.service.catalog.DeleteAccountStorageCredentialRequest.
  • Added storage_credential_name field for databricks.sdk.service.catalog.DeleteAccountStorageCredentialRequest.
  • Removed name field for databricks.sdk.service.catalog.GetAccountStorageCredentialRequest.
  • Added storage_credential_name field for databricks.sdk.service.catalog.GetAccountStorageCredentialRequest.
  • Added owner field for databricks.sdk.service.catalog.UpdateConnection.
  • Added databricks.sdk.service.catalog.GetBindingsRequest dataclass.
  • Added databricks.sdk.service.catalog.UpdateWorkspaceBindingsParameters dataclass.
  • Added databricks.sdk.service.catalog.WorkspaceBinding dataclass.
  • Added databricks.sdk.service.catalog.WorkspaceBindingBindingType dataclass.
  • Added databricks.sdk.service.catalog.WorkspaceBindingsResponse dataclass.
  • Added spec field for databricks.sdk.service.compute.ClusterDetails.
  • Added apply_policy_default_values field for databricks.sdk.service.compute.ClusterSpec.
  • Removed aws_attributes field for databricks.sdk.service.compute.EditInstancePool.
  • Removed azure_attributes field for databricks.sdk.service.compute.EditInstancePool.
  • Removed disk_spec field for databricks.sdk.service.compute.EditInstancePool.
  • Removed enable_elastic_disk field for databricks.sdk.service.compute.EditInstancePool.
  • Removed gcp_attributes field for databricks.sdk.service.compute.EditInstancePool.
  • Removed preloaded_docker_images field for databricks.sdk.service.compute.EditInstancePool.
  • Removed preloaded_spark_versions field for databricks.sdk.service.compute.EditInstancePool.
  • Added deployment field for databricks.sdk.service.jobs.CreateJob.
  • Added ui_state field for databricks.sdk.service.jobs.CreateJob.
  • Added deployment field for databricks.sdk.service.jobs.JobSettings.
  • Added ui_state field for databricks.sdk.service.jobs.JobSettings.
  • Removed condition_task field for databricks.sdk.service.jobs.RunOutput.
  • Added webhook_notifications field for databricks.sdk.service.jobs.Task.
  • Added databricks.sdk.service.jobs.CreateJobUiState dataclass.
  • Added databricks.sdk.service.jobs.JobDeployment dataclass.
  • Added databricks.sdk.service.jobs.JobDeploymentKind dataclass.
  • Added databricks.sdk.service.jobs.JobSettingsUiState dataclass.
  • Added workload_type field for databricks.sdk.service.serving.ServedModelInput.
  • Added workload_type field for databricks.sdk.service.serving.ServedModelOutput.
  • Removed a.account_network_policy account-level service.
  • Changed list() method for w.ip_access_lists workspace-level service to return databricks.sdk.service.settings.ListIpAccessListResponse dataclass.
  • Removed databricks.sdk.service.settings.AccountNetworkPolicyMessage dataclass.
  • Removed databricks.sdk.service.settings.DeleteAccountNetworkPolicyRequest dataclass.
  • Removed databricks.sdk.service.settings.DeleteAccountNetworkPolicyResponse dataclass.
  • Removed ip_access_lists field for databricks.sdk.service.settings.GetIpAccessListResponse.
  • Added ip_access_list field for databricks.sdk.service.settings.GetIpAccessListResponse.
  • Removed databricks.sdk.service.settings.ReadAccountNetworkPolicyRequest dataclass.
  • Removed databricks.sdk.service.settings.UpdateAccountNetworkPolicyRequest dataclass.
  • Added databricks.sdk.service.settings.ListIpAccessListResponse dataclass.

OpenAPI SHA: 493a76554afd3afdd15dc858773d01643f80352a, Date: 2023-10-12

Release v0.10.0 (2023-10-03)

  • Respect retry_timeout_seconds config setting and align retry implementation with Go SDK (#337).

Breaking API Changes:

  • Changed list() method for a.account_metastore_assignments account-level service to return databricks.sdk.service.catalog.ListAccountMetastoreAssignmentsResponse dataclass.
  • Removed owner field for databricks.sdk.service.catalog.CreateConnection. Instead, use the owner field of UpdateConnection.
  • Removed options field for databricks.sdk.service.catalog.UpdateCatalog.
  • Changed job_parameters field for databricks.sdk.service.jobs.RunNow to databricks.sdk.service.jobs.ParamPairs dataclass.
  • Changed query() method for w.serving_endpoints workspace-level service . New request type is databricks.sdk.service.serving.QueryEndpointInput dataclass.
  • Renamed databricks.sdk.service.serving.QueryRequest dataclass to QueryEndpointInput.
  • Changed list() method for w.clean_rooms workspace-level service to require request of databricks.sdk.service.sharing.ListCleanRoomsRequest dataclass.

API Changes:

  • Added databricks.sdk.service.catalog.ListAccountMetastoreAssignmentsResponse dataclass.
  • Added job_parameters field for databricks.sdk.service.jobs.RepairRun.
  • Added job_parameters field for databricks.sdk.service.jobs.RunParameters.
  • Added notifications field for databricks.sdk.service.pipelines.CreatePipeline.
  • Added notifications field for databricks.sdk.service.pipelines.EditPipeline.
  • Added notifications field for databricks.sdk.service.pipelines.PipelineSpec.
  • Added databricks.sdk.service.pipelines.Notifications dataclass.
  • Added databricks.sdk.service.serving.DataframeSplitInput dataclass.
  • Added w.settings workspace-level service.
  • Added databricks.sdk.service.settings.DefaultNamespaceSetting dataclass.
  • Added databricks.sdk.service.settings.DeleteDefaultWorkspaceNamespaceRequest dataclass.
  • Added databricks.sdk.service.settings.DeleteDefaultWorkspaceNamespaceResponse dataclass.
  • Added databricks.sdk.service.settings.ReadDefaultWorkspaceNamespaceRequest dataclass.
  • Added databricks.sdk.service.settings.StringMessage dataclass.
  • Added databricks.sdk.service.settings.UpdateDefaultWorkspaceNamespaceRequest dataclass.
  • Added next_page_token field for databricks.sdk.service.sharing.ListCleanRoomsResponse.
  • Added databricks.sdk.service.sharing.ListCleanRoomsRequest dataclass.

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 return databricks.sdk.service.catalog.WorkspaceIdList dataclass.
  • Changed artifact_matchers field for databricks.sdk.service.catalog.ArtifactAllowlistInfo to databricks.sdk.service.catalog.ArtifactMatcherList dataclass.
  • Changed artifact_matchers field for databricks.sdk.service.catalog.SetArtifactAllowlist to databricks.sdk.service.catalog.ArtifactMatcherList dataclass.
  • Added databricks.sdk.service.catalog.WorkspaceId dataclass.
  • Changed cancel_all_runs() method for w.jobs workspace-level service with new required argument order.
  • Changed job_id field for databricks.sdk.service.jobs.CancelAllRuns to no longer be required.
  • Added all_queued_runs field for databricks.sdk.service.jobs.CancelAllRuns.
  • Added queue field for databricks.sdk.service.jobs.CreateJob.
  • Added queue field for databricks.sdk.service.jobs.JobSettings.
  • Added queue field for databricks.sdk.service.jobs.RunNow.
  • Added queue_reason field for databricks.sdk.service.jobs.RunState.
  • Added queue_duration field for databricks.sdk.service.jobs.RunTask.
  • Added queue field for databricks.sdk.service.jobs.SubmitRun.
  • Added databricks.sdk.service.jobs.QueueSettings dataclass.
  • Added a.o_auth_published_apps account-level service.
  • Added databricks.sdk.service.oauth2.GetPublishedAppsOutput dataclass.
  • Added databricks.sdk.service.oauth2.ListOAuthPublishedAppsRequest dataclass.
  • Added databricks.sdk.service.oauth2.PublishedAppOutput dataclass.
  • Added patch() method for w.serving_endpoints workspace-level service.
  • Added tags field for databricks.sdk.service.serving.CreateServingEndpoint.
  • Added tags field for databricks.sdk.service.serving.ServingEndpoint.
  • Added tags field for databricks.sdk.service.serving.ServingEndpointDetailed.
  • Added databricks.sdk.service.serving.EndpointTag dataclass.
  • Added databricks.sdk.service.serving.PatchServingEndpointTags dataclass.
  • Added w.credentials_manager workspace-level service.
  • Added databricks.sdk.service.settings.ExchangeToken dataclass.
  • Added databricks.sdk.service.settings.ExchangeTokenRequest dataclass.
  • Added databricks.sdk.service.settings.ExchangeTokenResponse dataclass.
  • Added databricks.sdk.service.settings.PartitionId dataclass.
  • Added databricks.sdk.service.settings.TokenType dataclass.
  • Changed execute_statement() method for w.statement_execution workspace-level service with new required argument order.
  • Added empty_result_state field for databricks.sdk.service.sql.AlertOptions.
  • Removed databricks.sdk.service.sql.ChunkInfo dataclass.
  • Changed on_wait_timeout field for databricks.sdk.service.sql.ExecuteStatementRequest to databricks.sdk.service.sql.ExecuteStatementRequestOnWaitTimeout dataclass.
  • Changed statement field for databricks.sdk.service.sql.ExecuteStatementRequest to be required.
  • Changed warehouse_id field for databricks.sdk.service.sql.ExecuteStatementRequest to be required.
  • Changed chunks field for databricks.sdk.service.sql.ResultManifest to databricks.sdk.service.sql.BaseChunkInfoList dataclass.
  • Added truncated field for databricks.sdk.service.sql.ResultManifest.
  • Removed databricks.sdk.service.sql.TimeoutAction dataclass.
  • Added databricks.sdk.service.sql.AlertOptionsEmptyResultState dataclass.
  • Added databricks.sdk.service.sql.BaseChunkInfo dataclass.
  • Added databricks.sdk.service.sql.ExecuteStatementRequestOnWaitTimeout dataclass.

OpenAPI SHA: b52a3b410976501f08f76ca0b355fb2dca876953, Date: 2023-09-15

Release v0.8.0 (2023-09-04)

  • Fixed redeclared test_streaming_response_read_partial test (#335).
  • Fixed Incorrect type warning (#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_levels
    • get_job_permissions -> get_permissions
    • set_job_permissions -> set_permissions
    • update_job_permissions -> update_permissions
  • Changed create() method for w.volumes workspace-level service with new required argument order.
  • Added supports_elastic_disk field for databricks.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 name field for databricks.sdk.service.sql.CreateDashboardRequest to be required.
  • Added dashboard_filters_enabled field for databricks.sdk.service.sql.CreateDashboardRequest.
  • Added run_as_role field for databricks.sdk.service.sql.CreateDashboardRequest.
  • Added run_as_role field for databricks.sdk.service.sql.Query.
  • Added run_as_role field for databricks.sdk.service.sql.QueryPostContent.
  • Removed dashboard_id field for databricks.sdk.service.sql.WidgetOptions.
  • Changed position field for databricks.sdk.service.sql.WidgetOptions to databricks.sdk.service.sql.WidgetPosition dataclass.
  • Removed text field for databricks.sdk.service.sql.WidgetOptions.
  • Added description field for databricks.sdk.service.sql.WidgetOptions.
  • Added title field for databricks.sdk.service.sql.WidgetOptions.
  • Added databricks.sdk.service.sql.CreateQueryVisualizationRequest dataclass.
  • Added databricks.sdk.service.sql.CreateWidget dataclass.
  • Added databricks.sdk.service.sql.DeleteDashboardWidgetRequest dataclass.
  • Added databricks.sdk.service.sql.DeleteQueryVisualizationRequest dataclass.
  • Added databricks.sdk.service.sql.RunAsRole dataclass.
  • Added databricks.sdk.service.sql.WidgetPosition dataclass.

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 src to contents, and w.files.download() now returns a files.DownloadResponse, whose contents field is a BinaryIO object. When reading a download, the user must explicitly close this object to allow the connection to return to the connection pool.

Breaking API Changes:

  • Changed list() method for a.account_storage_credentials account-level service to return databricks.sdk.service.catalog.StorageCredentialInfoList dataclass.
  • 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_attributes field for databricks.sdk.service.compute.CreateInstancePool.
  • Removed instance_pool_fleet_attributes field for databricks.sdk.service.compute.EditInstancePool.
  • Removed databricks.sdk.service.compute.FleetLaunchTemplateOverride dataclass.
  • Removed databricks.sdk.service.compute.FleetOnDemandOption dataclass.
  • Removed databricks.sdk.service.compute.FleetOnDemandOptionAllocationStrategy dataclass.
  • Removed databricks.sdk.service.compute.FleetSpotOption dataclass.
  • Removed databricks.sdk.service.compute.FleetSpotOptionAllocationStrategy dataclass.
  • Removed instance_pool_fleet_attributes field for databricks.sdk.service.compute.GetInstancePool.
  • Removed instance_pool_fleet_attributes field for databricks.sdk.service.compute.InstancePoolAndStats.
  • Removed databricks.sdk.service.compute.InstancePoolFleetAttributes dataclass.
  • Changed get_by_name() method for w.experiments workspace-level service to return databricks.sdk.service.ml.GetExperimentResponse dataclass.
  • Changed get_experiment() method for w.experiments workspace-level service to return databricks.sdk.service.ml.GetExperimentResponse dataclass.
  • Renamed databricks.sdk.service.ml.GetExperimentByNameResponse dataclass to databricks.sdk.service.ml.GetExperimentResponse.
  • Renamed databricks.sdk.service.catalog.ProvisioningState to databricks.sdk.service.catalog.ProvisioningInfoState dataclass.

API Changes:

  • Added w.model_versions workspace-level service.
  • Added w.registered_models workspace-level service.
  • Added browse_only field for databricks.sdk.service.catalog.CatalogInfo.
  • Added full_name field for databricks.sdk.service.catalog.CatalogInfo.
  • Added provisioning_info field for databricks.sdk.service.catalog.CatalogInfo.
  • Added securable_kind field for databricks.sdk.service.catalog.CatalogInfo.
  • Added securable_type field for databricks.sdk.service.catalog.CatalogInfo.
  • Added provisioning_info field for databricks.sdk.service.catalog.ConnectionInfo.
  • Added options field for databricks.sdk.service.catalog.CreateCatalog.
  • Added options field for databricks.sdk.service.catalog.UpdateCatalog.
  • Added databricks.sdk.service.catalog.CatalogInfoSecurableKind dataclass.
  • Added databricks.sdk.service.catalog.CreateRegisteredModelRequest dataclass.
  • Added databricks.sdk.service.catalog.DeleteAliasRequest dataclass.
  • Added databricks.sdk.service.catalog.DeleteModelVersionRequest dataclass.
  • Added databricks.sdk.service.catalog.DeleteRegisteredModelRequest dataclass.
  • Added databricks.sdk.service.catalog.GetByAliasRequest dataclass.
  • Added databricks.sdk.service.catalog.GetModelVersionRequest dataclass.
  • Added databricks.sdk.service.catalog.GetRegisteredModelRequest dataclass.
  • Added databricks.sdk.service.catalog.ListModelVersionsRequest dataclass.
  • Added databricks.sdk.service.catalog.ListModelVersionsResponse dataclass.
  • Added databricks.sdk.service.catalog.ListRegisteredModelsRequest dataclass.
  • Added databricks.sdk.service.catalog.ListRegisteredModelsResponse dataclass.
  • Added databricks.sdk.service.catalog.ModelVersionInfo dataclass.
  • Added databricks.sdk.service.catalog.ModelVersionInfoStatus dataclass.
  • Added databricks.sdk.service.catalog.ProvisioningInfo dataclass.
  • Added databricks.sdk.service.catalog.RegisteredModelAlias dataclass.
  • Added databricks.sdk.service.catalog.RegisteredModelInfo dataclass.
  • Added databricks.sdk.service.catalog.SetRegisteredModelAliasRequest dataclass.
  • Added databricks.sdk.service.catalog.UpdateModelVersionRequest dataclass.
  • Added databricks.sdk.service.catalog.UpdateRegisteredModelRequest dataclass.
  • Added volumes field for databricks.sdk.service.compute.InitScriptInfo.
  • Added databricks.sdk.service.compute.VolumesStorageInfo dataclass.
  • Added w.files workspace-level service.
  • Added databricks.sdk.service.files.DeleteFileRequest dataclass.
  • Added databricks.sdk.service.files.DownloadRequest dataclass.
  • Added databricks.sdk.service.files.DownloadResponse dataclass.
  • Added databricks.sdk.service.files.UploadRequest dataclass.
  • Added custom_tags field for databricks.sdk.service.provisioning.CreateWorkspaceRequest.
  • Added custom_tags field for databricks.sdk.service.provisioning.UpdateWorkspaceRequest.
  • Added custom_tags field for databricks.sdk.service.provisioning.Workspace.
  • Added databricks.sdk.service.provisioning.CustomTags dataclass.
  • Added parameters field for databricks.sdk.service.sql.ExecuteStatementRequest.
  • Added row_limit field for databricks.sdk.service.sql.ExecuteStatementRequest.
  • Added databricks.sdk.service.sql.StatementParameterListItem dataclass.

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.ArtifactAllowlistInfo dataclass.
  • Added databricks.sdk.service.catalog.ArtifactMatcher dataclass.
  • Added databricks.sdk.service.catalog.ArtifactType dataclass.
  • Added databricks.sdk.service.catalog.GetArtifactAllowlistRequest dataclass.
  • Added databricks.sdk.service.catalog.ListSecurableTagsRequest dataclass.
  • Added databricks.sdk.service.catalog.ListSecurableType dataclass.
  • Added databricks.sdk.service.catalog.ListSubentityTagsRequest dataclass.
  • Added databricks.sdk.service.catalog.MatchType dataclass.
  • Added databricks.sdk.service.catalog.SetArtifactAllowlist dataclass.
  • Added databricks.sdk.service.catalog.TagChanges dataclass.
  • Added databricks.sdk.service.catalog.TagKeyValuePair dataclass.
  • Added databricks.sdk.service.catalog.TagSecurable dataclass.
  • Added databricks.sdk.service.catalog.TagSecurableAssignment dataclass.
  • Added databricks.sdk.service.catalog.TagSecurableAssignmentsList dataclass.
  • Added databricks.sdk.service.catalog.TagSubentity dataclass.
  • Added databricks.sdk.service.catalog.TagSubentityAssignmentsList dataclass.
  • Added databricks.sdk.service.catalog.TagsSubentityAssignment dataclass.
  • Added databricks.sdk.service.catalog.UpdateSecurableType dataclass.
  • Added databricks.sdk.service.catalog.UpdateTags dataclass.

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.DeleteRuns dataclass.
  • Added databricks.sdk.service.ml.DeleteRunsResponse dataclass.
  • Added databricks.sdk.service.ml.RestoreRuns dataclass.
  • Added databricks.sdk.service.ml.RestoreRunsResponse dataclass.
  • Added get_secret() method for w.secrets workspace-level service.
  • Added databricks.sdk.service.workspace.GetSecretRequest dataclass.
  • Added databricks.sdk.service.workspace.GetSecretResponse dataclass.

Service Renames:

  • Removed effective_auto_maintenance_flag field for databricks.sdk.service.catalog.CatalogInfo.
  • Removed enable_auto_maintenance field for databricks.sdk.service.catalog.CatalogInfo.
  • Added effective_predictive_optimization_flag field for databricks.sdk.service.catalog.CatalogInfo.
  • Added enable_predictive_optimization field for databricks.sdk.service.catalog.CatalogInfo.
  • Removed databricks.sdk.service.catalog.EffectiveAutoMaintenanceFlag dataclass.
  • Removed databricks.sdk.service.catalog.EffectiveAutoMaintenanceFlagInheritedFromType dataclass.
  • Removed databricks.sdk.service.catalog.EnableAutoMaintenance dataclass.
  • Removed effective_auto_maintenance_flag field for databricks.sdk.service.catalog.SchemaInfo.
  • Removed enable_auto_maintenance field for databricks.sdk.service.catalog.SchemaInfo.
  • Added effective_predictive_optimization_flag field for databricks.sdk.service.catalog.SchemaInfo.
  • Added enable_predictive_optimization field for databricks.sdk.service.catalog.SchemaInfo.
  • Removed effective_auto_maintenance_flag field for databricks.sdk.service.catalog.TableInfo.
  • Removed enable_auto_maintenance field for databricks.sdk.service.catalog.TableInfo.
  • Added effective_predictive_optimization_flag field for databricks.sdk.service.catalog.TableInfo.
  • Added enable_predictive_optimization field for databricks.sdk.service.catalog.TableInfo.
  • Added databricks.sdk.service.catalog.EffectivePredictiveOptimizationFlag dataclass.
  • Added databricks.sdk.service.catalog.EffectivePredictiveOptimizationFlagInheritedFromType dataclass.
  • Added databricks.sdk.service.catalog.EnablePredictiveOptimization dataclass.

OpenAPI SHA: beff621d7b3e1d59244e2e34fc53a496f310e130, Date: 2023-08-17

Release v0.5.0 (2023-08-11)

  • Added connection_pool_size configuration property (preview) (#276).
  • Fixed OAuth M2M corner case in WorkspaceClient where DATABRICKS_ACCOUNT_ID is present in the environment (#273).

API Changes:

  • Changed create() method for a.account_storage_credentials account-level service to return databricks.sdk.service.catalog.AccountsStorageCredentialInfo dataclass.
  • Changed get() method for a.account_storage_credentials account-level service to return databricks.sdk.service.catalog.AccountsStorageCredentialInfo dataclass.
  • Changed update() method for a.account_storage_credentials account-level service to return databricks.sdk.service.catalog.AccountsStorageCredentialInfo dataclass.
  • 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_kvpairs field for databricks.sdk.service.catalog.ConnectionInfo.
  • Removed properties_kvpairs field for databricks.sdk.service.catalog.ConnectionInfo.
  • Added options field for databricks.sdk.service.catalog.ConnectionInfo.
  • Added properties field for databricks.sdk.service.catalog.ConnectionInfo.
  • Added provisioning_state field for databricks.sdk.service.catalog.ConnectionInfo.
  • Added securable_kind field for databricks.sdk.service.catalog.ConnectionInfo.
  • Added securable_type field for databricks.sdk.service.catalog.ConnectionInfo.
  • Removed options_kvpairs field for databricks.sdk.service.catalog.CreateConnection.
  • Removed properties_kvpairs field for databricks.sdk.service.catalog.CreateConnection.
  • Added options field for databricks.sdk.service.catalog.CreateConnection.
  • Added properties field for databricks.sdk.service.catalog.CreateConnection.
  • Changed algorithm field for databricks.sdk.service.catalog.SseEncryptionDetails to no longer be required.
  • Removed options_kvpairs field for databricks.sdk.service.catalog.UpdateConnection.
  • Added options field for databricks.sdk.service.catalog.UpdateConnection.
  • Added databricks.sdk.service.catalog.AccountsStorageCredentialInfo dataclass.
  • Added databricks.sdk.service.catalog.ConnectionInfoSecurableKind dataclass.
  • Added databricks.sdk.service.catalog.ProvisioningState dataclass.
  • Added data_security_mode field for databricks.sdk.service.compute.CreateCluster.
  • Added docker_image field for databricks.sdk.service.compute.CreateCluster.
  • Added single_user_name field for databricks.sdk.service.compute.CreateCluster.
  • Removed schema field for databricks.sdk.service.iam.PartialUpdate.
  • Added schemas field for databricks.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() and w.permissions.get_by_request_object_id_and_request_object_type() to w.<Service>.get_<Service>_permissions()
  • Change w.permissions.get_permission_levels() to w.<Service>.get_<Service>_permission_levels()
  • Change w.permissions.set() to w.<Service>.set_<Service>_permissions()
  • Change w.permissions.update() to w.<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.ClusterAccessControlRequest dataclass.
  • Added databricks.sdk.service.compute.ClusterAccessControlResponse dataclass.
  • Added databricks.sdk.service.compute.ClusterPermission dataclass.
  • Added databricks.sdk.service.compute.ClusterPermissionLevel dataclass.
  • Added databricks.sdk.service.compute.ClusterPermissions dataclass.
  • Added databricks.sdk.service.compute.ClusterPermissionsDescription dataclass.
  • Added databricks.sdk.service.compute.ClusterPermissionsRequest dataclass.
  • Added databricks.sdk.service.compute.ClusterPolicyAccessControlRequest dataclass.
  • Added databricks.sdk.service.compute.ClusterPolicyAccessControlResponse dataclass.
  • Added databricks.sdk.service.compute.ClusterPolicyPermission dataclass.
  • Added databricks.sdk.service.compute.ClusterPolicyPermissionLevel dataclass.
  • Added databricks.sdk.service.compute.ClusterPolicyPermissions dataclass.
  • Added databricks.sdk.service.compute.ClusterPolicyPermissionsDescription dataclass.
  • Added databricks.sdk.service.compute.ClusterPolicyPermissionsRequest dataclass.
  • Added databricks.sdk.service.compute.GetClusterPermissionLevelsRequest dataclass.
  • Added databricks.sdk.service.compute.GetClusterPermissionLevelsResponse dataclass.
  • Added databricks.sdk.service.compute.GetClusterPermissionsRequest dataclass.
  • Added databricks.sdk.service.compute.GetClusterPolicyPermissionLevelsRequest dataclass.
  • Added databricks.sdk.service.compute.GetClusterPolicyPermissionLevelsResponse dataclass.
  • Added databricks.sdk.service.compute.GetClusterPolicyPermissionsRequest dataclass.
  • Added databricks.sdk.service.compute.GetInstancePoolPermissionLevelsRequest dataclass.
  • Added databricks.sdk.service.compute.GetInstancePoolPermissionLevelsResponse dataclass.
  • Added databricks.sdk.service.compute.GetInstancePoolPermissionsRequest dataclass.
  • Added databricks.sdk.service.compute.InstancePoolAccessControlRequest dataclass.
  • Added databricks.sdk.service.compute.InstancePoolAccessControlResponse dataclass.
  • Added databricks.sdk.service.compute.InstancePoolPermission dataclass.
  • Added databricks.sdk.service.compute.InstancePoolPermissionLevel dataclass.
  • Added databricks.sdk.service.compute.InstancePoolPermissions dataclass.
  • Added databricks.sdk.service.compute.InstancePoolPermissionsDescription dataclass.
  • Added databricks.sdk.service.compute.InstancePoolPermissionsRequest dataclass.
  • Changed set() method for w.permissions workspace-level service to start returning databricks.sdk.service.iam.ObjectPermissions dataclass.
  • Changed update() method for w.permissions workspace-level service to start returning databricks.sdk.service.iam.ObjectPermissions dataclass.
  • 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_name field for databricks.sdk.service.iam.AccessControlResponse.
  • Changed roles field for databricks.sdk.service.iam.GetAssignableRolesForResourceResponse to databricks.sdk.service.iam.RoleList dataclass.
  • Added databricks.sdk.service.iam.GetPasswordPermissionLevelsResponse dataclass.
  • Added databricks.sdk.service.iam.PasswordAccessControlRequest dataclass.
  • Added databricks.sdk.service.iam.PasswordAccessControlResponse dataclass.
  • Added databricks.sdk.service.iam.PasswordPermission dataclass.
  • Added databricks.sdk.service.iam.PasswordPermissionLevel dataclass.
  • Added databricks.sdk.service.iam.PasswordPermissions dataclass.
  • Added databricks.sdk.service.iam.PasswordPermissionsDescription dataclass.
  • Added databricks.sdk.service.iam.PasswordPermissionsRequest dataclass.
  • Added databricks.sdk.service.iam.Role dataclass.
  • 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.GetJobPermissionLevelsRequest dataclass.
  • Added databricks.sdk.service.jobs.GetJobPermissionLevelsResponse dataclass.
  • Added databricks.sdk.service.jobs.GetJobPermissionsRequest dataclass.
  • Added databricks.sdk.service.jobs.JobAccessControlRequest dataclass.
  • Added databricks.sdk.service.jobs.JobAccessControlResponse dataclass.
  • Added databricks.sdk.service.jobs.JobPermission dataclass.
  • Added databricks.sdk.service.jobs.JobPermissionLevel dataclass.
  • Added databricks.sdk.service.jobs.JobPermissions dataclass.
  • Added databricks.sdk.service.jobs.JobPermissionsDescription dataclass.
  • Added databricks.sdk.service.jobs.JobPermissionsRequest dataclass.
  • 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.ExperimentAccessControlRequest dataclass.
  • Added databricks.sdk.service.ml.ExperimentAccessControlResponse dataclass.
  • Added databricks.sdk.service.ml.ExperimentPermission dataclass.
  • Added databricks.sdk.service.ml.ExperimentPermissionLevel dataclass.
  • Added databricks.sdk.service.ml.ExperimentPermissions dataclass.
  • Added databricks.sdk.service.ml.ExperimentPermissionsDescription dataclass.
  • Added databricks.sdk.service.ml.ExperimentPermissionsRequest dataclass.
  • Added databricks.sdk.service.ml.GetExperimentPermissionLevelsRequest dataclass.
  • Added databricks.sdk.service.ml.GetExperimentPermissionLevelsResponse dataclass.
  • Added databricks.sdk.service.ml.GetExperimentPermissionsRequest dataclass.
  • Added databricks.sdk.service.ml.GetRegisteredModelPermissionLevelsRequest dataclass.
  • Added databricks.sdk.service.ml.GetRegisteredModelPermissionLevelsResponse dataclass.
  • Added databricks.sdk.service.ml.GetRegisteredModelPermissionsRequest dataclass.
  • Added databricks.sdk.service.ml.RegisteredModelAccessControlRequest dataclass.
  • Added databricks.sdk.service.ml.RegisteredModelAccessControlResponse dataclass.
  • Added databricks.sdk.service.ml.RegisteredModelPermission dataclass.
  • Added databricks.sdk.service.ml.RegisteredModelPermissionLevel dataclass.
  • Added databricks.sdk.service.ml.RegisteredModelPermissions dataclass.
  • Added databricks.sdk.service.ml.RegisteredModelPermissionsDescription dataclass.
  • Added databricks.sdk.service.ml.RegisteredModelPermissionsRequest dataclass.
  • Added scopes field for databricks.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.GetPipelinePermissionLevelsRequest dataclass.
  • Added databricks.sdk.service.pipelines.GetPipelinePermissionLevelsResponse dataclass.
  • Added databricks.sdk.service.pipelines.GetPipelinePermissionsRequest dataclass.
  • Added databricks.sdk.service.pipelines.PipelineAccessControlRequest dataclass.
  • Added databricks.sdk.service.pipelines.PipelineAccessControlResponse dataclass.
  • Added databricks.sdk.service.pipelines.PipelinePermission dataclass.
  • Added databricks.sdk.service.pipelines.PipelinePermissionLevel dataclass.
  • Added databricks.sdk.service.pipelines.PipelinePermissions dataclass.
  • Added databricks.sdk.service.pipelines.PipelinePermissionsDescription dataclass.
  • Added databricks.sdk.service.pipelines.PipelinePermissionsRequest dataclass.
  • Added gcp_managed_network_config field for databricks.sdk.service.provisioning.CreateWorkspaceRequest.
  • Added gke_config field for databricks.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_arn field for databricks.sdk.service.serving.ServedModelInput.
  • Added instance_profile_arn field for databricks.sdk.service.serving.ServedModelOutput.
  • Added databricks.sdk.service.serving.GetServingEndpointPermissionLevelsRequest dataclass.
  • Added databricks.sdk.service.serving.GetServingEndpointPermissionLevelsResponse dataclass.
  • Added databricks.sdk.service.serving.GetServingEndpointPermissionsRequest dataclass.
  • Added databricks.sdk.service.serving.ServingEndpointAccessControlRequest dataclass.
  • Added databricks.sdk.service.serving.ServingEndpointAccessControlResponse dataclass.
  • Added databricks.sdk.service.serving.ServingEndpointPermission dataclass.
  • Added databricks.sdk.service.serving.ServingEndpointPermissionLevel dataclass.
  • Added databricks.sdk.service.serving.ServingEndpointPermissions dataclass.
  • Added databricks.sdk.service.serving.ServingEndpointPermissionsDescription dataclass.
  • Added databricks.sdk.service.serving.ServingEndpointPermissionsRequest dataclass.
  • 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.GetTokenPermissionLevelsResponse dataclass.
  • Added databricks.sdk.service.settings.TokenAccessControlRequest dataclass.
  • Added databricks.sdk.service.settings.TokenAccessControlResponse dataclass.
  • Added databricks.sdk.service.settings.TokenPermission dataclass.
  • Added databricks.sdk.service.settings.TokenPermissionLevel dataclass.
  • Added databricks.sdk.service.settings.TokenPermissions dataclass.
  • Added databricks.sdk.service.settings.TokenPermissionsDescription dataclass.
  • Added databricks.sdk.service.settings.TokenPermissionsRequest dataclass.
  • 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_query field for databricks.sdk.service.sql.QueryInfo.
  • Removed queued_overload_time_ms field for databricks.sdk.service.sql.QueryMetrics.
  • Removed queued_provisioning_time_ms field for databricks.sdk.service.sql.QueryMetrics.
  • Removed total_files_count field for databricks.sdk.service.sql.QueryMetrics.
  • Removed total_partitions_count field for databricks.sdk.service.sql.QueryMetrics.
  • Added metadata_time_ms field for databricks.sdk.service.sql.QueryMetrics.
  • Added overloading_queue_start_timestamp field for databricks.sdk.service.sql.QueryMetrics.
  • Added planning_phases field for databricks.sdk.service.sql.QueryMetrics.
  • Added planning_time_ms field for databricks.sdk.service.sql.QueryMetrics.
  • Added provisioning_queue_start_timestamp field for databricks.sdk.service.sql.QueryMetrics.
  • Added pruned_bytes field for databricks.sdk.service.sql.QueryMetrics.
  • Added pruned_files_count field for databricks.sdk.service.sql.QueryMetrics.
  • Added query_compilation_start_timestamp field for databricks.sdk.service.sql.QueryMetrics.
  • Added query_execution_time_ms field for databricks.sdk.service.sql.QueryMetrics.
  • Added databricks.sdk.service.sql.GetWarehousePermissionLevelsRequest dataclass.
  • Added databricks.sdk.service.sql.GetWarehousePermissionLevelsResponse dataclass.
  • Added databricks.sdk.service.sql.GetWarehousePermissionsRequest dataclass.
  • Added databricks.sdk.service.sql.WarehouseAccessControlRequest dataclass.
  • Added databricks.sdk.service.sql.WarehouseAccessControlResponse dataclass.
  • Added databricks.sdk.service.sql.WarehousePermission dataclass.
  • Added databricks.sdk.service.sql.WarehousePermissionLevel dataclass.
  • Added databricks.sdk.service.sql.WarehousePermissions dataclass.
  • Added databricks.sdk.service.sql.WarehousePermissionsDescription dataclass.
  • Added databricks.sdk.service.sql.WarehousePermissionsRequest dataclass.
  • 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.GetRepoPermissionLevelsRequest dataclass.
  • Added databricks.sdk.service.workspace.GetRepoPermissionLevelsResponse dataclass.
  • Added databricks.sdk.service.workspace.GetRepoPermissionsRequest dataclass.
  • Added databricks.sdk.service.workspace.GetWorkspaceObjectPermissionLevelsRequest dataclass.
  • Added databricks.sdk.service.workspace.GetWorkspaceObjectPermissionLevelsResponse dataclass.
  • Added databricks.sdk.service.workspace.GetWorkspaceObjectPermissionsRequest dataclass.
  • Added databricks.sdk.service.workspace.RepoAccessControlRequest dataclass.
  • Added databricks.sdk.service.workspace.RepoAccessControlResponse dataclass.
  • Added databricks.sdk.service.workspace.RepoPermission dataclass.
  • Added databricks.sdk.service.workspace.RepoPermissionLevel dataclass.
  • Added databricks.sdk.service.workspace.RepoPermissions dataclass.
  • Added databricks.sdk.service.workspace.RepoPermissionsDescription dataclass.
  • Added databricks.sdk.service.workspace.RepoPermissionsRequest dataclass.
  • Added databricks.sdk.service.workspace.WorkspaceObjectAccessControlRequest dataclass.
  • Added databricks.sdk.service.workspace.WorkspaceObjectAccessControlResponse dataclass.
  • Added databricks.sdk.service.workspace.WorkspaceObjectPermission dataclass.
  • Added databricks.sdk.service.workspace.WorkspaceObjectPermissionLevel dataclass.
  • Added databricks.sdk.service.workspace.WorkspaceObjectPermissions dataclass.
  • Added databricks.sdk.service.workspace.WorkspaceObjectPermissionsDescription dataclass.
  • Added databricks.sdk.service.workspace.WorkspaceObjectPermissionsRequest dataclass.

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_headers type hints for WorkspaceClient and AccountClient (#258).
  • Made dbutils typecast use a valid type variable (#259).

Release v0.3.0 (2023-07-27)

API Changes:

  • Changed create() method for a.account_metastore_assignments account-level service to no longer return databricks.sdk.service.catalog.CreateMetastoreAssignmentsResponseItemList dataclass.
  • Added connection_name field for databricks.sdk.service.catalog.CreateCatalog.
  • Added access_point field for databricks.sdk.service.catalog.CreateExternalLocation.
  • Added encryption_details field for databricks.sdk.service.catalog.CreateExternalLocation.
  • Removed databricks.sdk.service.catalog.CreateMetastoreAssignmentsResponseItem dataclass.
  • Added access_point field for databricks.sdk.service.catalog.ExternalLocationInfo.
  • Added encryption_details field for databricks.sdk.service.catalog.ExternalLocationInfo.
  • Added access_point field for databricks.sdk.service.catalog.TableInfo.
  • Added encryption_details field for databricks.sdk.service.catalog.TableInfo.
  • Added access_point field for databricks.sdk.service.catalog.UpdateExternalLocation.
  • Added encryption_details field for databricks.sdk.service.catalog.UpdateExternalLocation.
  • Added access_point field for databricks.sdk.service.catalog.VolumeInfo.
  • Added encryption_details field for databricks.sdk.service.catalog.VolumeInfo.
  • Added databricks.sdk.service.catalog.EncryptionDetails dataclass.
  • Added databricks.sdk.service.catalog.SseEncryptionDetails dataclass.
  • Added databricks.sdk.service.catalog.SseEncryptionDetailsAlgorithm dataclass.
  • Added a.account_network_policy account-level service.
  • Added databricks.sdk.service.settings.AccountNetworkPolicyMessage dataclass.
  • Added databricks.sdk.service.settings.DeleteAccountNetworkPolicyRequest dataclass.
  • Added databricks.sdk.service.settings.DeleteAccountNetworkPolicyResponse dataclass.
  • Added databricks.sdk.service.settings.ReadAccountNetworkPolicyRequest dataclass.
  • Added databricks.sdk.service.settings.UpdateAccountNetworkPolicyRequest dataclass.

OpenAPI SHA: a1b6c1ecfaab6635911d3c060a8dd797ac6b2d4d, Date: 2023-07-27

Release v0.2.1 (2023-07-18)

  • Support older versions of urllib3 and Databricks Runtime with regards to DEFAULT_METHOD_WHITELIST change to DEFAULT_ALLOWED_METHODS (#240).

Release v0.2.0 (2023-07-18)

  • Add Issue Templates (#208).
  • Fixed notebook native auth for jobs (#209).
  • Replace datatime.timedelta() with datetime.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.runtime to 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 force field for databricks.sdk.service.catalog.DeleteAccountMetastoreRequest.
  • Added force field for databricks.sdk.service.catalog.DeleteAccountStorageCredentialRequest.
  • Removed databricks.sdk.service.catalog.UpdateAutoMaintenance dataclass.
  • Removed databricks.sdk.service.catalog.UpdateAutoMaintenanceResponse dataclass.
  • Added databricks.sdk.service.catalog.UpdatePredictiveOptimization dataclass.
  • Added databricks.sdk.service.catalog.UpdatePredictiveOptimizationResponse dataclass.
  • Added databricks.sdk.service.catalog.UpdateTableRequest dataclass.
  • Added schema field for databricks.sdk.service.iam.PartialUpdate.
  • Added databricks.sdk.service.iam.PatchSchema dataclass.
  • Added trigger_info field for databricks.sdk.service.jobs.BaseRun.
  • Added health field for databricks.sdk.service.jobs.CreateJob.
  • Added job_source field for databricks.sdk.service.jobs.GitSource.
  • Added on_duration_warning_threshold_exceeded field for databricks.sdk.service.jobs.JobEmailNotifications.
  • Added health field for databricks.sdk.service.jobs.JobSettings.
  • Added trigger_info field for databricks.sdk.service.jobs.Run.
  • Added run_job_output field for databricks.sdk.service.jobs.RunOutput.
  • Added run_job_task field for databricks.sdk.service.jobs.RunTask.
  • Added email_notifications field for databricks.sdk.service.jobs.SubmitRun.
  • Added health field for databricks.sdk.service.jobs.SubmitRun.
  • Added email_notifications field for databricks.sdk.service.jobs.SubmitTask.
  • Added health field for databricks.sdk.service.jobs.SubmitTask.
  • Added notification_settings field for databricks.sdk.service.jobs.SubmitTask.
  • Added health field for databricks.sdk.service.jobs.Task.
  • Added run_job_task field for databricks.sdk.service.jobs.Task.
  • Added on_duration_warning_threshold_exceeded field for databricks.sdk.service.jobs.TaskEmailNotifications.
  • Added on_duration_warning_threshold_exceeded field for databricks.sdk.service.jobs.WebhookNotifications.
  • Added databricks.sdk.service.jobs.JobSource dataclass.
  • Added databricks.sdk.service.jobs.JobSourceDirtyState dataclass.
  • Added databricks.sdk.service.jobs.JobsHealthMetric dataclass.
  • Added databricks.sdk.service.jobs.JobsHealthOperator dataclass.
  • Added databricks.sdk.service.jobs.JobsHealthRule dataclass.
  • Added databricks.sdk.service.jobs.JobsHealthRules dataclass.
  • Added databricks.sdk.service.jobs.RunJobOutput dataclass.
  • Added databricks.sdk.service.jobs.RunJobTask dataclass.
  • Added databricks.sdk.service.jobs.TriggerInfo dataclass.
  • Added databricks.sdk.service.jobs.WebhookNotificationsOnDurationWarningThresholdExceededItem dataclass.
  • Removed whl field for databricks.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 etag field for databricks.sdk.service.settings.DeletePersonalComputeSettingRequest to be required.
  • Changed etag field for databricks.sdk.service.settings.ReadPersonalComputeSettingRequest to be required.
  • Added w.clean_rooms workspace-level service.
  • Added databricks.sdk.service.sharing.CentralCleanRoomInfo dataclass.
  • Added databricks.sdk.service.sharing.CleanRoomAssetInfo dataclass.
  • Added databricks.sdk.service.sharing.CleanRoomCatalog dataclass.
  • Added databricks.sdk.service.sharing.CleanRoomCatalogUpdate dataclass.
  • Added databricks.sdk.service.sharing.CleanRoomCollaboratorInfo dataclass.
  • Added databricks.sdk.service.sharing.CleanRoomInfo dataclass.
  • Added databricks.sdk.service.sharing.CleanRoomNotebookInfo dataclass.
  • Added databricks.sdk.service.sharing.CleanRoomTableInfo dataclass.
  • Added databricks.sdk.service.sharing.ColumnInfo dataclass.
  • Added databricks.sdk.service.sharing.ColumnMask dataclass.
  • Added databricks.sdk.service.sharing.ColumnTypeName dataclass.
  • Added databricks.sdk.service.sharing.CreateCleanRoom dataclass.
  • Added databricks.sdk.service.sharing.DeleteCleanRoomRequest dataclass.
  • Added databricks.sdk.service.sharing.GetCleanRoomRequest dataclass.
  • Added databricks.sdk.service.sharing.ListCleanRoomsResponse dataclass.
  • Added databricks.sdk.service.sharing.UpdateCleanRoom dataclass.
  • Changed query field for databricks.sdk.service.sql.Alert to databricks.sdk.service.sql.AlertQuery dataclass.
  • Changed value field for databricks.sdk.service.sql.AlertOptions to any dataclass.
  • Removed is_db_admin field for databricks.sdk.service.sql.User.
  • Removed profile_image_url field for databricks.sdk.service.sql.User.
  • Added databricks.sdk.service.sql.AlertQuery dataclass.

OpenAPI SHA: 0a1949ba96f71680dad30e06973eaae85b1307bb, Date: 2023-07-18

Release v0.1.12 (2023-06-28)

  • Beta release (#198).
  • Documentation improvements (#197).
  • Make dbutils type stubs consistent with runtime implementation (#196).
  • Regenerated from OpenAPI spec (#199).

API changes:

  • Renamed compute.BaseClusterInfo to compute.ClusterSpec
  • Renamed compute.ClusterInfo to compute.ClusterDetails
  • Renamed jobs.JobTaskSettings to jobs.Task
  • Renamed jobs.RunSubmitTaskSettings to jobs.SubmitTask
  • Renamed jobs.JobWebhookNotifications to jobs.WebhookNotifications
  • Renamed jobs.CreateJobFormat to jobs.Format
  • Renamed jobs.GitSourceGitProvider to jobs.GitProvider
  • Renamed jobs.FileArrivalTriggerSettings to jobs.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 requests version 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 Optional type 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) and download(path) -> IO across 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 None for primitive fields in as_dict() (#147).
  • Fixed bug related to boolean flags and convert True to true in 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.io badge (#126).
  • Improved readme with links to examples (#125).
  • Fixed AttributeError: 'NoneType' object has no attribute 'debug_truncate_bytes' when instantiating an ApiClient with empty config (#123).

Release v0.1.7 (2023-05-17)

  • Added an extensive set of examples (#113).
  • Fixed broken dbutils.fs.mount and dbutils.fs.updateMount (#119).
  • Ignore .netrc when sending unauthenticated requests for OAuth handshake (#108).
  • Make ApiClient more pyodide friendly (#114).
  • Persist token acquired through external-browser auth type (#110).
  • Prototype for notebook-native auth (#115).
  • Rename RefreshableCredentials to SessionCredentials (#116).
  • Use shell for opening az cli on Windows (#117).

Release v0.1.6 (2023-05-10)

  • Preserve original databricks.sdk.runtime for internal purposes (#96).

Release v0.1.5 (2023-05-08)

  • Pin version of requests to >=2.28.1,<2.29.0, so that we don't get ImportError: urllib3 v2.0 only supports OpenSSL 1.1.1+, currently the 'ssl' module 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 bricks CLI authentication (#66).
  • Use databricks.sdk.oauth logger for single-request server (#74).
  • Support more Azure environments (#73).
  • Added SECURITY.md (#64).

API changes:

  • Moved clusterpolicies APIs to compute package.
  • Moved clusters APIs to compute package.
  • Moved commands APIs to compute package.
  • Moved globalinitscripts APIs to compute package.
  • Moved instancepools APIs to compute package.
  • Moved scim APIs to iam package.
  • Moved permissions APIs to iam package.
  • Moved ipaccesslists APIs to settings package.
  • Moved tokenmanagement APIs to settings package.
  • Moved tokens APIs to settings package.
  • Moved workspaceconf APIs to settings package.
  • Moved gitcredentials APIs to workspace package.
  • Moved repos APIs to workspace package.
  • Moved secrets APIs to workspace package.
  • Split unitcatalog package to catalog and sharing.
  • Renamed mlflow package to ml.
  • Renamed dbfs package to files.
  • Renamed deployment package to provisioning.
  • Renamed endpoints package to serving.
  • Renamed clusters.List type to compute.ListClustersRequest.
  • Renamed jobs.ListRuns type to jobs.ListRunsRequest.
  • Renamed jobs.ExportRun type to jobs.ExportRunRequest.
  • Renamed clusterpolicies.List type to compute.ListClusterPoliciesRequest.
  • Renamed jobs.List type to jobs.ListJobsRequest.
  • Renamed permissions.GetPermissionLevels type to iam.GetPermissionLevelsRequest.
  • Renamed pipelines.ListPipelineEvents type to pipelines.ListPipelineEventsRequest.
  • Renamed pipelines.ListPipelines type to pipelines.ListPipelinesRequest.
  • Renamed workspaceconf.GetStatus type to settings.GetStatusRequest.
  • Renamed repos.List type to workspace.ListReposRequest.
  • Renamed tokenmanagement.List type to settings.ListTokenManagementRequest.
  • Renamed workspace.Export type to workspace.ExportRequest.
  • Renamed workspace.List type to workspace.ListWorkspaceRequest.