generate documentation

yuanjieding-db · yuanjieding-db · commit 770e0cd1d5f3 · 2025-10-17T13:57:30.000+02:00
diff --git a/NEXT_CHANGELOG.md b/NEXT_CHANGELOG.md
diff --git a/databricks/sdk/__init__.py b/databricks/sdk/__init__.py
diff --git a/databricks/sdk/config.py b/databricks/sdk/config.py
@@ -6,7 +6,7 @@
 import pathlib
 import sys
 import urllib.parse
-from typing import Dict, Iterable, Optional, List
+from typing import Dict, Iterable, List, Optional
 
 import requests
 
@@ -110,7 +110,9 @@ class Config:
 
     disable_async_token_refresh: bool = ConfigAttribute(env="DATABRICKS_DISABLE_ASYNC_TOKEN_REFRESH")
 
-    disable_experimental_files_api_client: bool = ConfigAttribute(env="DATABRICKS_DISABLE_EXPERIMENTAL_FILES_API_CLIENT")
+    disable_experimental_files_api_client: bool = ConfigAttribute(
+        env="DATABRICKS_DISABLE_EXPERIMENTAL_FILES_API_CLIENT"
+    )
 
     files_ext_client_download_streaming_chunk_size: int = 2 * 1024 * 1024  # 2 MiB
 
diff --git a/docs/account/iam/workspace_assignment.rst b/docs/account/iam/workspace_assignment.rst
@@ -74,9 +74,9 @@
             
             spn_id = spn.id
             
-            workspace_id = os.environ["TEST_WORKSPACE_ID"]
+            workspace_id = os.environ["DUMMY_WORKSPACE_ID"]
             
-            a.workspace_assignment.update(
+            _ = a.workspace_assignment.update(
                 workspace_id=workspace_id,
                 principal_id=spn_id,
                 permissions=[iam.WorkspacePermission.USER],
diff --git a/docs/account/provisioning/storage.rst b/docs/account/provisioning/storage.rst
@@ -16,6 +16,7 @@
 
         .. code-block::
 
+            import os
             import time
             
             from databricks.sdk import AccountClient
@@ -25,8 +26,11 @@
             
             storage = a.storage.create(
                 storage_configuration_name=f"sdk-{time.time_ns()}",
-                root_bucket_info=provisioning.RootBucketInfo(bucket_name=f"sdk-{time.time_ns()}"),
+                root_bucket_info=provisioning.RootBucketInfo(bucket_name=os.environ["TEST_ROOT_BUCKET"]),
             )
+            
+            # cleanup
+            a.storage.delete(storage_configuration_id=storage.storage_configuration_id)
 
         Creates a Databricks storage configuration for an account.
 
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.
 
@@ -123,11 +123,10 @@
         .. code-block::
 
             from databricks.sdk import WorkspaceClient
-            from databricks.sdk.service import catalog
             
             w = WorkspaceClient()
             
-            all = w.storage_credentials.list(catalog.ListStorageCredentialsRequest())
+            all = w.storage_credentials.list()
 
         Gets an array of storage credentials (as __StorageCredentialInfo__ objects). The array is limited to
         only those storage credentials the caller has permission to access. If the caller is a 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/files/files.rst b/docs/workspace/files/files.rst
@@ -2,7 +2,7 @@
 ==================
 .. currentmodule:: databricks.sdk.service.files
 
-.. py:class:: FilesAPI
+.. py:class:: FilesExt
 
     The Files API is a standard HTTP API that allows you to read, write, list, and delete files and
     directories by referring to their URI. The API makes working with file content as raw bytes easier and
@@ -61,15 +61,39 @@
 
     .. py:method:: download(file_path: str) -> DownloadResponse
 
-        Downloads a file. The file contents are the response body. This is a standard HTTP file download, not
-        a JSON RPC. It supports the Range and If-Unmodified-Since HTTP headers.
+        Download a file.
+
+        Downloads a file of any size. The file contents are the response body.
+        This is a standard HTTP file download, not a JSON RPC.
+
+        It is strongly recommended, for fault tolerance reasons,
+        to iteratively consume from the stream with a maximum read(size)
+        defined instead of using indefinite-size reads.
 
         :param file_path: str
-          The absolute path of the file.
+          The remote path of the file, e.g. /Volumes/path/to/your/file
 
         :returns: :class:`DownloadResponse`
         
 
+    .. py:method:: download_to(file_path: str, destination: str [, overwrite: bool = True, use_parallel: bool = False, parallelism: Optional[int]]) -> DownloadFileResult
+
+        Download a file to a local path. There would be no responses returned if the download is successful.
+
+        :param file_path: str
+          The remote path of the file, e.g. /Volumes/path/to/your/file
+        :param destination: str
+          The local path where the file will be saved.
+        :param overwrite: bool
+          If true, an existing file will be overwritten. When not specified, assumed True.
+        :param use_parallel: bool
+          If true, the download will be performed using multiple threads.
+        :param parallelism: int
+          The number of parallel threads to use for downloading. If not specified, defaults to the number of CPU cores.
+
+        :returns: :class:`DownloadFileResult`
+        
+
     .. py:method:: get_directory_metadata(directory_path: str)
 
         Get the metadata of a directory. The response HTTP headers contain the metadata. There is no response
@@ -124,19 +148,48 @@
         :returns: Iterator over :class:`DirectoryEntry`
         
 
-    .. py:method:: upload(file_path: str, contents: BinaryIO [, overwrite: Optional[bool]])
+    .. py:method:: upload(file_path: str, content: BinaryIO [, overwrite: Optional[bool], part_size: Optional[int], use_parallel: bool = True, parallelism: Optional[int]]) -> UploadStreamResult
 
-        Uploads a file of up to 5 GiB. The file contents should be sent as the request body as raw bytes (an
-        octet stream); do not encode or otherwise modify the bytes before sending. The contents of the
-        resulting file will be exactly the bytes sent in the request body. If the request is successful, there
-        is no response body.
+        
+        Upload a file with stream interface.
 
         :param file_path: str
-          The absolute path of the file.
-        :param contents: BinaryIO
+            The absolute remote path of the target file, e.g. /Volumes/path/to/your/file
+        :param content: BinaryIO
+            The contents of the file to upload. This must be a BinaryIO stream.
         :param overwrite: bool (optional)
-          If true or unspecified, an existing file will be overwritten. If false, an error will be returned if
-          the path points to an existing file.
+            If true, an existing file will be overwritten. When not specified, assumed True.
+        :param part_size: int (optional)
+            If set, multipart upload will use the value as its size per uploading part.
+        :param use_parallel: bool (optional)
+            If true, the upload will be performed using multiple threads. Be aware that this will consume more memory
+            because multiple parts will be buffered in memory before being uploaded. The amount of memory used is proportional
+            to `parallelism * part_size`.
+            If false, the upload will be performed in a single thread.
+            Default is True.
+        :param parallelism: int (optional)
+            The number of threads to use for parallel uploads. This is only used if `use_parallel` is True.
+
+        :returns: :class:`UploadStreamResult`
+        
 
+    .. py:method:: upload_from(file_path: str, source_path: str [, overwrite: Optional[bool], part_size: Optional[int], use_parallel: bool = True, parallelism: Optional[int]]) -> UploadFileResult
 
+        Upload a file directly from a local path.
+
+        :param file_path: str
+          The absolute remote path of the target file.
+        :param source_path: str
+          The local path of the file to upload. This must be a path to a local file.
+        :param part_size: int
+          The size of each part in bytes for multipart upload. This is a required parameter for multipart uploads.
+        :param overwrite: bool (optional)
+          If true, an existing file will be overwritten. When not specified, assumed True.
+        :param use_parallel: bool (optional)
+          If true, the upload will be performed using multiple threads. Default is True.
+        :param parallelism: int (optional)
+          The number of threads to use for parallel uploads. This is only used if `use_parallel` is True.
+          If not specified, the default parallelism will be set to config.multipart_upload_default_parallelism
+
+        :returns: :class:`UploadFileResult`
         
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/ml/model_registry.rst b/docs/workspace/ml/model_registry.rst
@@ -120,7 +120,7 @@
             
             model = w.model_registry.create_model(name=f"sdk-{time.time_ns()}")
             
-            created = w.model_registry.create_model_version(name=model.registered_model.name, source="dbfs:/tmp")
+            mv = w.model_registry.create_model_version(name=model.registered_model.name, source="dbfs:/tmp")
 
         Creates a model version.
 
@@ -734,13 +734,14 @@
             
             w = WorkspaceClient()
             
-            created = w.model_registry.create_model(name=f"sdk-{time.time_ns()}")
+            model = w.model_registry.create_model(name=f"sdk-{time.time_ns()}")
             
-            model = w.model_registry.get_model(name=created.registered_model.name)
+            created = w.model_registry.create_model_version(name=model.registered_model.name, source="dbfs:/tmp")
             
-            w.model_registry.update_model(
-                name=model.registered_model_databricks.name,
+            w.model_registry.update_model_version(
                 description=f"sdk-{time.time_ns()}",
+                name=created.model_version.name,
+                version=created.model_version.version,
             )
 
         Updates a registered model.
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="SELECT 1",
+                    query_text="SHOW TABLES",
                 )
             )
             
diff --git a/docs/workspace/workspace/workspace.rst b/docs/workspace/workspace/workspace.rst
@@ -175,18 +175,11 @@
             notebook_path = f"/Users/{w.current_user.me().user_name}/sdk-{time.time_ns()}"
             
             w.workspace.import_(
-                path=notebook_path,
-                overwrite=True,
+                content=base64.b64encode(("CREATE LIVE TABLE dlt_sample AS SELECT 1").encode()).decode(),
                 format=workspace.ImportFormat.SOURCE,
-                language=workspace.Language.PYTHON,
-                content=base64.b64encode(
-                    (
-                        """import time
-            time.sleep(10)
-            dbutils.notebook.exit('hello')
-            """
-                    ).encode()
-                ).decode(),
+                language=workspace.Language.SQL,
+                overwrite=True,
+                path=notebook_path,
             )
 
         Imports a workspace object (for example, a notebook or file) or the contents of an entire directory.
diff --git a/tests/test_files.py b/tests/test_files.py
@@ -13,7 +13,7 @@
 from enum import Enum
 from tempfile import NamedTemporaryFile
 from threading import Lock
-from typing import Any, Callable, List, Optional, Type, Union, Dict
+from typing import Any, Callable, Dict, List, Optional, Type, Union
 from urllib.parse import parse_qs, urlparse
 
 import pytest
diff --git a/tests/test_files_utils.py b/tests/test_files_utils.py
@@ -2,7 +2,7 @@
 import os
 from abc import ABC, abstractmethod
 from io import BytesIO, RawIOBase, UnsupportedOperation
-from typing import BinaryIO, Callable, Optional, Tuple, List
+from typing import BinaryIO, Callable, List, Optional, Tuple
 
 import pytest
 
