v0.40.0

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

v0.39.0

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

v0.38.0

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

v0.37.0

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 prev_page_token field for databricks.sdk.service.jobs.Run.

The following fields are now nested in the request:

• 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.

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

v0.36.0

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).

v0.35.0

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

v0.34.0

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

v0.33.0

Release v0.33.0

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.Q...

v0.32.3

Release v0.32.3

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).

v0.32.2

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).