Update SDK API to b7f0bdef8060a7daec78568f87fae44773f598c5 (#1181)

databricks-ci-ghec-1[bot] · web-flow · commit 1ea495601e9a · 2026-01-04T10:04:20.000Z
This PR updates the SDK to the latest API changes.

NO_CHANGELOG=true

Co-authored-by: databricks-ci-ghec-1[bot] &lt;184311507+databricks-ci-ghec-1[bot]@users.noreply.github.com&gt;
diff --git a/.codegen/_openapi_sha b/.codegen/_openapi_sha
@@ -1 +1 @@
-b5283a925ecf8929263b63f41b182246745d81a0
+b7f0bdef8060a7daec78568f87fae44773f598c5
diff --git a/NEXT_CHANGELOG.md b/NEXT_CHANGELOG.md
@@ -38,4 +38,4 @@
 * [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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/ml/feature_engineering.html) workspace-level service . Method path has changed.
+* [Breaking] Change `delete_kafka_config()` method for [w.feature_engineering](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/ml/feature_engineering.html) workspace-level service . Method path has changed.
diff --git a/docs/workspace/catalog/catalogs.rst b/docs/workspace/catalog/catalogs.rst
@@ -24,10 +24,10 @@
             
             w = WorkspaceClient()
             
-            created_catalog = w.catalogs.create(name=f"sdk-{time.time_ns()}")
+            created = w.catalogs.create(name=f"sdk-{time.time_ns()}")
             
             # cleanup
-            w.catalogs.delete(name=created_catalog.name, force=True)
+            w.catalogs.delete(name=created.name, force=True)
 
         Creates a new catalog instance in the parent metastore if the caller is a metastore admin or has the
         **CREATE_CATALOG** privilege.
diff --git a/docs/workspace/catalog/external_locations.rst b/docs/workspace/catalog/external_locations.rst
@@ -30,22 +30,20 @@
             
             w = WorkspaceClient()
             
-            storage_credential = w.storage_credentials.create(
+            credential = w.storage_credentials.create(
                 name=f"sdk-{time.time_ns()}",
-                aws_iam_role=catalog.AwsIamRoleRequest(role_arn=os.environ["TEST_METASTORE_DATA_ACCESS_ARN"]),
-                comment="created via SDK",
+                aws_iam_role=catalog.AwsIamRole(role_arn=os.environ["TEST_METASTORE_DATA_ACCESS_ARN"]),
             )
             
-            external_location = w.external_locations.create(
+            created = w.external_locations.create(
                 name=f"sdk-{time.time_ns()}",
-                credential_name=storage_credential.name,
-                comment="created via SDK",
-                url="s3://" + os.environ["TEST_BUCKET"] + "/" + f"sdk-{time.time_ns()}",
+                credential_name=credential.name,
+                url=f's3://{os.environ["TEST_BUCKET"]}/sdk-{time.time_ns()}',
             )
             
             # cleanup
-            w.storage_credentials.delete(name=storage_credential.name)
-            w.external_locations.delete(name=external_location.name)
+            w.storage_credentials.delete(delete=credential.name)
+            w.external_locations.delete(delete=created.name)
 
         Creates a new external location entry in the metastore. The caller must be a metastore admin or have
         the **CREATE_EXTERNAL_LOCATION** privilege on both the metastore and the associated storage
@@ -142,10 +140,11 @@
         .. code-block::
 
             from databricks.sdk import WorkspaceClient
+            from databricks.sdk.service import catalog
             
             w = WorkspaceClient()
             
-            all = w.external_locations.list()
+            all = w.external_locations.list(catalog.ListExternalLocationsRequest())
 
         Gets an array of external locations (__ExternalLocationInfo__ objects) from the metastore. The caller
         must be a metastore admin, the owner of the external location, or a user that has some privilege on
@@ -192,24 +191,24 @@
             
             credential = w.storage_credentials.create(
                 name=f"sdk-{time.time_ns()}",
-                aws_iam_role=catalog.AwsIamRole(role_arn=os.environ["TEST_METASTORE_DATA_ACCESS_ARN"]),
+                aws_iam_role=catalog.AwsIamRoleRequest(role_arn=os.environ["TEST_METASTORE_DATA_ACCESS_ARN"]),
             )
             
             created = w.external_locations.create(
                 name=f"sdk-{time.time_ns()}",
                 credential_name=credential.name,
-                url=f's3://{os.environ["TEST_BUCKET"]}/sdk-{time.time_ns()}',
+                url="s3://%s/%s" % (os.environ["TEST_BUCKET"], f"sdk-{time.time_ns()}"),
             )
             
             _ = w.external_locations.update(
                 name=created.name,
                 credential_name=credential.name,
-                url=f's3://{os.environ["TEST_BUCKET"]}/sdk-{time.time_ns()}',
+                url="s3://%s/%s" % (os.environ["TEST_BUCKET"], f"sdk-{time.time_ns()}"),
             )
             
             # cleanup
-            w.storage_credentials.delete(delete=credential.name)
-            w.external_locations.delete(delete=created.name)
+            w.storage_credentials.delete(name=credential.name)
+            w.external_locations.delete(name=created.name)
 
         Updates an external location in the metastore. The caller must be the owner of the external location,
         or be a metastore admin. In the second case, the admin can only update the name of the external
diff --git a/docs/workspace/catalog/storage_credentials.rst b/docs/workspace/catalog/storage_credentials.rst
@@ -32,11 +32,11 @@
             
             created = w.storage_credentials.create(
                 name=f"sdk-{time.time_ns()}",
-                aws_iam_role=catalog.AwsIamRoleRequest(role_arn=os.environ["TEST_METASTORE_DATA_ACCESS_ARN"]),
+                aws_iam_role=catalog.AwsIamRole(role_arn=os.environ["TEST_METASTORE_DATA_ACCESS_ARN"]),
             )
             
             # cleanup
-            w.storage_credentials.delete(name=created.name)
+            w.storage_credentials.delete(delete=created.name)
 
         Creates a new storage credential.
 
@@ -98,13 +98,13 @@
             
             created = w.storage_credentials.create(
                 name=f"sdk-{time.time_ns()}",
-                aws_iam_role=catalog.AwsIamRoleRequest(role_arn=os.environ["TEST_METASTORE_DATA_ACCESS_ARN"]),
+                aws_iam_role=catalog.AwsIamRole(role_arn=os.environ["TEST_METASTORE_DATA_ACCESS_ARN"]),
             )
             
-            by_name = w.storage_credentials.get(name=created.name)
+            by_name = w.storage_credentials.get(get=created.name)
             
             # cleanup
-            w.storage_credentials.delete(name=created.name)
+            w.storage_credentials.delete(delete=created.name)
 
         Gets a storage credential from the metastore. The caller must be a metastore admin, the owner of the
         storage credential, or have some permission on the storage credential.
@@ -172,17 +172,17 @@
             
             created = w.storage_credentials.create(
                 name=f"sdk-{time.time_ns()}",
-                aws_iam_role=catalog.AwsIamRoleRequest(role_arn=os.environ["TEST_METASTORE_DATA_ACCESS_ARN"]),
+                aws_iam_role=catalog.AwsIamRole(role_arn=os.environ["TEST_METASTORE_DATA_ACCESS_ARN"]),
             )
             
             _ = w.storage_credentials.update(
                 name=created.name,
                 comment=f"sdk-{time.time_ns()}",
-                aws_iam_role=catalog.AwsIamRoleRequest(role_arn=os.environ["TEST_METASTORE_DATA_ACCESS_ARN"]),
+                aws_iam_role=catalog.AwsIamRole(role_arn=os.environ["TEST_METASTORE_DATA_ACCESS_ARN"]),
             )
             
             # cleanup
-            w.storage_credentials.delete(name=created.name)
+            w.storage_credentials.delete(delete=created.name)
 
         Updates a storage credential on the metastore.
 
diff --git a/docs/workspace/catalog/tables.rst b/docs/workspace/catalog/tables.rst
@@ -156,7 +156,7 @@
             
             created_schema = w.schemas.create(name=f"sdk-{time.time_ns()}", catalog_name=created_catalog.name)
             
-            summaries = w.tables.list_summaries(catalog_name=created_catalog.name, schema_name_pattern=created_schema.name)
+            all_tables = w.tables.list(catalog_name=created_catalog.name, schema_name=created_schema.name)
             
             # cleanup
             w.schemas.delete(full_name=created_schema.full_name)
diff --git a/docs/workspace/iam/current_user.rst b/docs/workspace/iam/current_user.rst
@@ -17,7 +17,7 @@
             
             w = WorkspaceClient()
             
-            me2 = w.current_user.me()
+            me = w.current_user.me()
 
         Get details about the current method caller's identity.
 
diff --git a/docs/workspace/iam/permissions.rst b/docs/workspace/iam/permissions.rst
@@ -44,7 +44,7 @@
             
             obj = w.workspace.get_status(path=notebook_path)
             
-            _ = w.permissions.get(request_object_type="notebooks", request_object_id="%d" % (obj.object_id))
+            levels = w.permissions.get_permission_levels(request_object_type="notebooks", request_object_id="%d" % (obj.object_id))
 
         Gets the permissions of an object. Objects can inherit permissions from their parent objects or root
         object.
diff --git a/docs/workspace/jobs/jobs.rst b/docs/workspace/jobs/jobs.rst
@@ -359,21 +359,23 @@
                 w.clusters.ensure_cluster_is_running(os.environ["DATABRICKS_CLUSTER_ID"]) and os.environ["DATABRICKS_CLUSTER_ID"]
             )
             
-            run = w.jobs.submit(
-                run_name=f"sdk-{time.time_ns()}",
+            created_job = w.jobs.create(
+                name=f"sdk-{time.time_ns()}",
                 tasks=[
-                    jobs.SubmitTask(
+                    jobs.Task(
+                        description="test",
                         existing_cluster_id=cluster_id,
                         notebook_task=jobs.NotebookTask(notebook_path=notebook_path),
-                        task_key=f"sdk-{time.time_ns()}",
+                        task_key="test",
+                        timeout_seconds=0,
                     )
                 ],
-            ).result()
+            )
             
-            output = w.jobs.get_run_output(run_id=run.tasks[0].run_id)
+            by_id = w.jobs.get(job_id=created_job.job_id)
             
             # cleanup
-            w.jobs.delete_run(run_id=run.run_id)
+            w.jobs.delete(job_id=created_job.job_id)
 
         Get a single job.
 
diff --git a/docs/workspace/ml/model_registry.rst b/docs/workspace/ml/model_registry.rst
@@ -90,7 +90,7 @@
             
             w = WorkspaceClient()
             
-            model = w.model_registry.create_model(name=f"sdk-{time.time_ns()}")
+            created = w.model_registry.create_model(name=f"sdk-{time.time_ns()}")
 
         Creates a new registered model with the name specified in the request body. Throws
         `RESOURCE_ALREADY_EXISTS` if a registered model with the given name exists.
diff --git a/docs/workspace/sharing/providers.rst b/docs/workspace/sharing/providers.rst
@@ -101,25 +101,12 @@
 
         .. code-block::
 
-            import time
-            
             from databricks.sdk import WorkspaceClient
+            from databricks.sdk.service import sharing
             
             w = WorkspaceClient()
             
-            public_share_recipient = """{
-                    "shareCredentialsVersion":1,
-                    "bearerToken":"dapiabcdefghijklmonpqrstuvwxyz",
-                    "endpoint":"https://sharing.delta.io/delta-sharing/"
-                }
-            """
-            
-            created = w.providers.create(name=f"sdk-{time.time_ns()}", recipient_profile_str=public_share_recipient)
-            
-            shares = w.providers.list_shares(name=created.name)
-            
-            # cleanup
-            w.providers.delete(name=created.name)
+            all = w.providers.list(sharing.ListProvidersRequest())
 
         Gets an array of available authentication providers. The caller must either be a metastore admin or
         the owner of the providers. Providers not owned by the caller are not included in the response. There
diff --git a/docs/workspace/sql/queries.rst b/docs/workspace/sql/queries.rst
@@ -29,7 +29,7 @@
                     display_name=f"sdk-{time.time_ns()}",
                     warehouse_id=srcs[0].warehouse_id,
                     description="test query from Go SDK",
-                    query_text="SHOW TABLES",
+                    query_text="SELECT 1",
                 )
             )
             
diff --git a/docs/workspace/workspace/workspace.rst b/docs/workspace/workspace/workspace.rst
@@ -79,7 +79,7 @@
             
             notebook = f"/Users/{w.current_user.me().user_name}/sdk-{time.time_ns()}"
             
-            export_response = w.workspace.export(format=workspace.ExportFormat.SOURCE, path=notebook)
+            export_response = w.workspace.export_(format=workspace.ExportFormat.SOURCE, path=notebook)
 
         Exports an object or the contents of an entire directory.
 
@@ -148,9 +148,9 @@
             
             w = WorkspaceClient()
             
-            notebook = f"/Users/{w.current_user.me().user_name}/sdk-{time.time_ns()}"
+            notebook_path = f"/Users/{w.current_user.me().user_name}/sdk-{time.time_ns()}"
             
-            get_status_response = w.workspace.get_status(path=notebook)
+            obj = w.workspace.get_status(path=notebook_path)
 
         Gets the status of an object or a directory. If `path` does not exist, this call returns an error
         `RESOURCE_DOES_NOT_EXIST`.
@@ -185,7 +185,9 @@
                 language=workspace.Language.PYTHON,
                 content=base64.b64encode(
                     (
-                        """print(1)
+                        """import time
+            time.sleep(10)
+            dbutils.notebook.exit('hello')
             """
                     ).encode()
                 ).decode(),
@@ -232,16 +234,14 @@
 
         .. code-block::
 
-            import os
-            import time
-            
             from databricks.sdk import WorkspaceClient
             
             w = WorkspaceClient()
             
-            notebook = f"/Users/{w.current_user.me().user_name}/sdk-{time.time_ns()}"
-            
-            objects = w.workspace.list(path=os.path.dirname(notebook))
+            names = []
+            for i in w.workspace.list(f"/Users/{w.current_user.me().user_name}", recursive=True):
+                names.append(i.path)
+            assert len(names) > 0
 
         List workspace objects
 

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-b5283a925ecf8929263b63f41b182246745d81a0`
	`1`	`+b7f0bdef8060a7daec78568f87fae44773f598c5`