databricks-sdk 0.23.0__py3-none-any.whl → 0.24.0__py3-none-any.whl

databricks/sdk/service/_internal.py

@@ -1,4 +1,5 @@
 import datetime
+import urllib.parse
 from typing import Callable, Dict, Generic, Optional, Type, TypeVar
 
 
@@ -38,6 +39,10 @@ def _repeated_enum(d: Dict[str, any], field: str, cls: Type) -> any:
     return res
 
 
+def _escape_multi_segment_path_parameter(param: str) -> str:
+    return urllib.parse.quote(param)
+
+
 ReturnType = TypeVar('ReturnType')
 
 

databricks/sdk/service/dashboards.py

@@ -117,6 +117,33 @@ class LifecycleState(Enum):
     TRASHED = 'TRASHED'
 
 
+@dataclass
+class MigrateDashboardRequest:
+    source_dashboard_id: str
+    """UUID of the dashboard to be migrated."""
+
+    display_name: Optional[str] = None
+    """Display name for the new Lakeview dashboard."""
+
+    parent_path: Optional[str] = None
+    """The workspace path of the folder to contain the migrated Lakeview dashboard."""
+
+    def as_dict(self) -> dict:
+        """Serializes the MigrateDashboardRequest into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.display_name is not None: body['display_name'] = self.display_name
+        if self.parent_path is not None: body['parent_path'] = self.parent_path
+        if self.source_dashboard_id is not None: body['source_dashboard_id'] = self.source_dashboard_id
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> MigrateDashboardRequest:
+        """Deserializes the MigrateDashboardRequest from a dictionary."""
+        return cls(display_name=d.get('display_name', None),
+                   parent_path=d.get('parent_path', None),
+                   source_dashboard_id=d.get('source_dashboard_id', None))
+
+
 @dataclass
 class PublishRequest:
     dashboard_id: Optional[str] = None
@@ -191,6 +218,20 @@ class TrashDashboardResponse:
         return cls()
 
 
+@dataclass
+class UnpublishDashboardResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the UnpublishDashboardResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> UnpublishDashboardResponse:
+        """Deserializes the UnpublishDashboardResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class UpdateDashboardRequest:
     dashboard_id: Optional[str] = None
@@ -300,6 +341,33 @@ class LakeviewAPI:
         res = self._api.do('GET', f'/api/2.0/lakeview/dashboards/{dashboard_id}/published', headers=headers)
         return PublishedDashboard.from_dict(res)
 
+    def migrate(self,
+                source_dashboard_id: str,
+                *,
+                display_name: Optional[str] = None,
+                parent_path: Optional[str] = None) -> Dashboard:
+        """Migrate dashboard.
+        
+        Migrates a classic SQL dashboard to Lakeview.
+        
+        :param source_dashboard_id: str
+          UUID of the dashboard to be migrated.
+        :param display_name: str (optional)
+          Display name for the new Lakeview dashboard.
+        :param parent_path: str (optional)
+          The workspace path of the folder to contain the migrated Lakeview dashboard.
+        
+        :returns: :class:`Dashboard`
+        """
+        body = {}
+        if display_name is not None: body['display_name'] = display_name
+        if parent_path is not None: body['parent_path'] = parent_path
+        if source_dashboard_id is not None: body['source_dashboard_id'] = source_dashboard_id
+        headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
+        res = self._api.do('POST', '/api/2.0/lakeview/dashboards/migrate', body=body, headers=headers)
+        return Dashboard.from_dict(res)
+
     def publish(self,
                 dashboard_id: str,
                 *,
@@ -345,6 +413,21 @@ class LakeviewAPI:
 
         self._api.do('DELETE', f'/api/2.0/lakeview/dashboards/{dashboard_id}', headers=headers)
 
+    def unpublish(self, dashboard_id: str):
+        """Unpublish dashboard.
+        
+        Unpublish the dashboard.
+        
+        :param dashboard_id: str
+          UUID identifying the dashboard to be published.
+        
+        
+        """
+
+        headers = {'Accept': 'application/json', }
+
+        self._api.do('DELETE', f'/api/2.0/lakeview/dashboards/{dashboard_id}/published', headers=headers)
+
     def update(self,
                dashboard_id: str,
                *,

databricks/sdk/service/files.py

@@ -6,7 +6,7 @@ import logging
 from dataclasses import dataclass
 from typing import BinaryIO, Dict, Iterator, List, Optional
 
-from ._internal import _repeated_dict
+from ._internal import _escape_multi_segment_path_parameter, _repeated_dict
 
 _LOG = logging.getLogger('databricks.sdk')
 
@@ -789,7 +789,9 @@ class FilesAPI:
 
         headers = {}
 
-        self._api.do('PUT', f'/api/2.0/fs/directories{directory_path}', headers=headers)
+        self._api.do('PUT',
+                     f'/api/2.0/fs/directories{_escape_multi_segment_path_parameter(directory_path)}',
+                     headers=headers)
 
     def delete(self, file_path: str):
         """Delete a file.
@@ -804,7 +806,9 @@ class FilesAPI:
 
         headers = {}
 
-        self._api.do('DELETE', f'/api/2.0/fs/files{file_path}', headers=headers)
+        self._api.do('DELETE',
+                     f'/api/2.0/fs/files{_escape_multi_segment_path_parameter(file_path)}',
+                     headers=headers)
 
     def delete_directory(self, directory_path: str):
         """Delete a directory.
@@ -822,7 +826,9 @@ class FilesAPI:
 
         headers = {}
 
-        self._api.do('DELETE', f'/api/2.0/fs/directories{directory_path}', headers=headers)
+        self._api.do('DELETE',
+                     f'/api/2.0/fs/directories{_escape_multi_segment_path_parameter(directory_path)}',
+                     headers=headers)
 
     def download(self, file_path: str) -> DownloadResponse:
         """Download a file.
@@ -839,7 +845,7 @@ class FilesAPI:
         headers = {'Accept': 'application/octet-stream', }
         response_headers = ['content-length', 'content-type', 'last-modified', ]
         res = self._api.do('GET',
-                           f'/api/2.0/fs/files{file_path}',
+                           f'/api/2.0/fs/files{_escape_multi_segment_path_parameter(file_path)}',
                            headers=headers,
                            response_headers=response_headers,
                            raw=True)
@@ -864,7 +870,9 @@ class FilesAPI:
 
         headers = {}
 
-        self._api.do('HEAD', f'/api/2.0/fs/directories{directory_path}', headers=headers)
+        self._api.do('HEAD',
+                     f'/api/2.0/fs/directories{_escape_multi_segment_path_parameter(directory_path)}',
+                     headers=headers)
 
     def get_metadata(self, file_path: str) -> GetMetadataResponse:
         """Get file metadata.
@@ -880,7 +888,7 @@ class FilesAPI:
         headers = {}
         response_headers = ['content-length', 'content-type', 'last-modified', ]
         res = self._api.do('HEAD',
-                           f'/api/2.0/fs/files{file_path}',
+                           f'/api/2.0/fs/files{_escape_multi_segment_path_parameter(file_path)}',
                            headers=headers,
                            response_headers=response_headers)
         return GetMetadataResponse.from_dict(res)
@@ -924,10 +932,11 @@ class FilesAPI:
         headers = {'Accept': 'application/json', }
 
         while True:
-            json = self._api.do('GET',
-                                f'/api/2.0/fs/directories{directory_path}',
-                                query=query,
-                                headers=headers)
+            json = self._api.do(
+                'GET',
+                f'/api/2.0/fs/directories{_escape_multi_segment_path_parameter(directory_path)}',
+                query=query,
+                headers=headers)
             if 'contents' in json:
                 for v in json['contents']:
                     yield DirectoryEntry.from_dict(v)
@@ -956,4 +965,8 @@ class FilesAPI:
         if overwrite is not None: query['overwrite'] = overwrite
         headers = {'Content-Type': 'application/octet-stream', }
 
-        self._api.do('PUT', f'/api/2.0/fs/files{file_path}', query=query, headers=headers, data=contents)
+        self._api.do('PUT',
+                     f'/api/2.0/fs/files{_escape_multi_segment_path_parameter(file_path)}',
+                     query=query,
+                     headers=headers,
+                     data=contents)

databricks/sdk/service/iam.py

@@ -2590,6 +2590,9 @@ class PermissionsAPI:
     For the mapping of the required permissions for specific actions or abilities and other important
     information, see [Access Control].
     
+    Note that to manage access control on service principals, use **[Account Access Control
+    Proxy](:service:accountaccesscontrolproxy)**.
+    
     [Access Control]: https://docs.databricks.com/security/auth-authz/access-control/index.html"""
 
     def __init__(self, api_client):