databricks-sdk 0.27.1__py3-none-any.whl → 0.29.0__py3-none-any.whl

databricks/sdk/service/sharing.py

@@ -531,17 +531,23 @@ class CreateShare:
     comment: Optional[str] = None
     """User-provided free-form text description."""
 
+    storage_root: Optional[str] = None
+    """Storage root URL for the share."""
+
     def as_dict(self) -> dict:
         """Serializes the CreateShare into a dictionary suitable for use as a JSON request body."""
         body = {}
         if self.comment is not None: body['comment'] = self.comment
         if self.name is not None: body['name'] = self.name
+        if self.storage_root is not None: body['storage_root'] = self.storage_root
         return body
 
     @classmethod
     def from_dict(cls, d: Dict[str, any]) -> CreateShare:
         """Deserializes the CreateShare from a dictionary."""
-        return cls(comment=d.get('comment', None), name=d.get('name', None))
+        return cls(comment=d.get('comment', None),
+                   name=d.get('name', None),
+                   storage_root=d.get('storage_root', None))
 
 
 @dataclass
@@ -1215,6 +1221,12 @@ class ShareInfo:
     owner: Optional[str] = None
     """Username of current owner of share."""
 
+    storage_location: Optional[str] = None
+    """Storage Location URL (full path) for the share."""
+
+    storage_root: Optional[str] = None
+    """Storage root URL for the share."""
+
     updated_at: Optional[int] = None
     """Time at which this share was updated, in epoch milliseconds."""
 
@@ -1230,6 +1242,8 @@ class ShareInfo:
         if self.name is not None: body['name'] = self.name
         if self.objects: body['objects'] = [v.as_dict() for v in self.objects]
         if self.owner is not None: body['owner'] = self.owner
+        if self.storage_location is not None: body['storage_location'] = self.storage_location
+        if self.storage_root is not None: body['storage_root'] = self.storage_root
         if self.updated_at is not None: body['updated_at'] = self.updated_at
         if self.updated_by is not None: body['updated_by'] = self.updated_by
         return body
@@ -1243,6 +1257,8 @@ class ShareInfo:
                    name=d.get('name', None),
                    objects=_repeated_dict(d, 'objects', SharedDataObject),
                    owner=d.get('owner', None),
+                   storage_location=d.get('storage_location', None),
+                   storage_root=d.get('storage_root', None),
                    updated_at=d.get('updated_at', None),
                    updated_by=d.get('updated_by', None))
 
@@ -1576,6 +1592,9 @@ class UpdateShare:
     owner: Optional[str] = None
     """Username of current owner of share."""
 
+    storage_root: Optional[str] = None
+    """Storage root URL for the share."""
+
     updates: Optional[List[SharedDataObjectUpdate]] = None
     """Array of shared data object updates."""
 
@@ -1586,6 +1605,7 @@ class UpdateShare:
         if self.name is not None: body['name'] = self.name
         if self.new_name is not None: body['new_name'] = self.new_name
         if self.owner is not None: body['owner'] = self.owner
+        if self.storage_root is not None: body['storage_root'] = self.storage_root
         if self.updates: body['updates'] = [v.as_dict() for v in self.updates]
         return body
 
@@ -1596,6 +1616,7 @@ class UpdateShare:
                    name=d.get('name', None),
                    new_name=d.get('new_name', None),
                    owner=d.get('owner', None),
+                   storage_root=d.get('storage_root', None),
                    updates=_repeated_dict(d, 'updates', SharedDataObjectUpdate))
 
 
@@ -2193,7 +2214,11 @@ class SharesAPI:
     def __init__(self, api_client):
         self._api = api_client
 
-    def create(self, name: str, *, comment: Optional[str] = None) -> ShareInfo:
+    def create(self,
+               name: str,
+               *,
+               comment: Optional[str] = None,
+               storage_root: Optional[str] = None) -> ShareInfo:
         """Create a share.
         
         Creates a new share for data objects. Data objects can be added after creation with **update**. The
@@ -2203,12 +2228,15 @@ class SharesAPI:
           Name of the share.
         :param comment: str (optional)
           User-provided free-form text description.
+        :param storage_root: str (optional)
+          Storage root URL for the share.
         
         :returns: :class:`ShareInfo`
         """
         body = {}
         if comment is not None: body['comment'] = comment
         if name is not None: body['name'] = name
+        if storage_root is not None: body['storage_root'] = storage_root
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
 
         res = self._api.do('POST', '/api/2.1/unity-catalog/shares', body=body, headers=headers)
@@ -2288,6 +2316,7 @@ class SharesAPI:
                comment: Optional[str] = None,
                new_name: Optional[str] = None,
                owner: Optional[str] = None,
+               storage_root: Optional[str] = None,
                updates: Optional[List[SharedDataObjectUpdate]] = None) -> ShareInfo:
         """Update a share.
         
@@ -2299,6 +2328,8 @@ class SharesAPI:
         In the case that the share name is changed, **updateShare** requires that the caller is both the share
         owner and a metastore admin.
         
+        If there are notebook files in the share, the __storage_root__ field cannot be updated.
+        
         For each table that is added through this method, the share owner must also have **SELECT** privilege
         on the table. This privilege must be maintained indefinitely for recipients to be able to access the
         table. Typically, you should use a group as the share owner.
@@ -2313,6 +2344,8 @@ class SharesAPI:
           New name for the share.
         :param owner: str (optional)
           Username of current owner of share.
+        :param storage_root: str (optional)
+          Storage root URL for the share.
         :param updates: List[:class:`SharedDataObjectUpdate`] (optional)
           Array of shared data object updates.
         
@@ -2322,6 +2355,7 @@ class SharesAPI:
         if comment is not None: body['comment'] = comment
         if new_name is not None: body['new_name'] = new_name
         if owner is not None: body['owner'] = owner
+        if storage_root is not None: body['storage_root'] = storage_root
         if updates is not None: body['updates'] = [v.as_dict() for v in updates]
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
 

databricks/sdk/service/sql.py

@@ -182,7 +182,7 @@ class AlertQuery:
 
     data_source_id: Optional[str] = None
     """Data source ID maps to the ID of the data source used by the resource and is distinct from the
-    warehouse ID. [Learn more].
+    warehouse ID. [Learn more]
     
     [Learn more]: https://docs.databricks.com/api/workspace/datasources/list"""
 
@@ -360,7 +360,6 @@ class ChannelInfo:
 
 
 class ChannelName(Enum):
-    """Name of the channel"""
 
     CHANNEL_NAME_CURRENT = 'CHANNEL_NAME_CURRENT'
     CHANNEL_NAME_CUSTOM = 'CHANNEL_NAME_CUSTOM'
@@ -857,7 +856,7 @@ class DataSource:
 
     id: Optional[str] = None
     """Data source ID maps to the ID of the data source used by the resource and is distinct from the
-    warehouse ID. [Learn more].
+    warehouse ID. [Learn more]
     
     [Learn more]: https://docs.databricks.com/api/workspace/datasources/list"""
 
@@ -1391,8 +1390,9 @@ class ExecuteStatementRequest:
     """The SQL statement to execute. The statement can optionally be parameterized, see `parameters`."""
 
     warehouse_id: str
-    """Warehouse upon which to execute a statement. See also [What are SQL
-    warehouses?](/sql/admin/warehouse-type.html)"""
+    """Warehouse upon which to execute a statement. See also [What are SQL warehouses?]
+    
+    [What are SQL warehouses?]: https://docs.databricks.com/sql/admin/warehouse-type.html"""
 
     byte_limit: Optional[int] = None
     """Applies the given byte limit to the statement's result size. Byte counts are based on internal
@@ -2242,7 +2242,7 @@ class Query:
 
     data_source_id: Optional[str] = None
     """Data source ID maps to the ID of the data source used by the resource and is distinct from the
-    warehouse ID. [Learn more].
+    warehouse ID. [Learn more]
     
     [Learn more]: https://docs.databricks.com/api/workspace/datasources/list"""
 
@@ -2375,7 +2375,7 @@ class Query:
 class QueryEditContent:
     data_source_id: Optional[str] = None
     """Data source ID maps to the ID of the data source used by the resource and is distinct from the
-    warehouse ID. [Learn more].
+    warehouse ID. [Learn more]
     
     [Learn more]: https://docs.databricks.com/api/workspace/datasources/list"""
 
@@ -2473,7 +2473,7 @@ class QueryInfo:
     """Channel information for the SQL warehouse at the time of query execution"""
 
     duration: Optional[int] = None
-    """Total execution time of the query from the client’s point of view, in milliseconds."""
+    """Total execution time of the statement ( excluding result fetch time )."""
 
     endpoint_id: Optional[str] = None
     """Alias for `warehouse_id`."""
@@ -2808,7 +2808,7 @@ class QueryOptions:
 class QueryPostContent:
     data_source_id: Optional[str] = None
     """Data source ID maps to the ID of the data source used by the resource and is distinct from the
-    warehouse ID. [Learn more].
+    warehouse ID. [Learn more]
     
     [Learn more]: https://docs.databricks.com/api/workspace/datasources/list"""
 
@@ -3274,8 +3274,10 @@ class StatementParameterListItem:
     type: Optional[str] = None
     """The data type, given as a string. For example: `INT`, `STRING`, `DECIMAL(10,2)`. If no type is
     given the type is assumed to be `STRING`. Complex types, such as `ARRAY`, `MAP`, and `STRUCT`
-    are not supported. For valid types, refer to the section [Data
-    types](/sql/language-manual/functions/cast.html) of the SQL language reference."""
+    are not supported. For valid types, refer to the section [Data types] of the SQL language
+    reference.
+    
+    [Data types]: https://docs.databricks.com/sql/language-manual/functions/cast.html"""
 
     value: Optional[str] = None
     """The value to substitute, represented as a string. If omitted, the value is interpreted as NULL."""
@@ -3960,7 +3962,11 @@ class AlertsAPI:
     """The alerts API can be used to perform CRUD operations on alerts. An alert is a Databricks SQL object that
     periodically runs a query, evaluates a condition of its result, and notifies one or more users and/or
     notification destinations if the condition was met. Alerts can be scheduled using the `sql_task` type of
-    the Jobs API, e.g. :method:jobs/create."""
+    the Jobs API, e.g. :method:jobs/create.
+    
+    **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+    
+    [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources"""
 
     def __init__(self, api_client):
         self._api = api_client
@@ -3977,6 +3983,10 @@ class AlertsAPI:
         Creates an alert. An alert is a Databricks SQL object that periodically runs a query, evaluates a
         condition of its result, and notifies users or notification destinations if the condition was met.
         
+        **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+        
+        [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources
+        
         :param name: str
           Name of the alert.
         :param options: :class:`AlertOptions`
@@ -4005,9 +4015,13 @@ class AlertsAPI:
     def delete(self, alert_id: str):
         """Delete an alert.
         
-        Deletes an alert. Deleted alerts are no longer accessible and cannot be restored. **Note:** Unlike
+        Deletes an alert. Deleted alerts are no longer accessible and cannot be restored. **Note**: Unlike
         queries and dashboards, alerts cannot be moved to the trash.
         
+        **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+        
+        [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources
+        
         :param alert_id: str
         
         
@@ -4022,6 +4036,10 @@ class AlertsAPI:
         
         Gets an alert.
         
+        **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+        
+        [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources
+        
         :param alert_id: str
         
         :returns: :class:`Alert`
@@ -4037,6 +4055,10 @@ class AlertsAPI:
         
         Gets a list of alerts.
         
+        **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+        
+        [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources
+        
         :returns: Iterator over :class:`Alert`
         """
 
@@ -4056,6 +4078,10 @@ class AlertsAPI:
         
         Updates an alert.
         
+        **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+        
+        [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources
+        
         :param alert_id: str
         :param name: str
           Name of the alert.
@@ -4257,8 +4283,8 @@ class DashboardsAPI:
         
         Fetch a paginated list of dashboard objects.
         
-        ### **Warning: Calling this API concurrently 10 or more times could result in throttling, service
-        degradation, or a temporary ban.**
+        **Warning**: Calling this API concurrently 10 or more times could result in throttling, service
+        degradation, or a temporary ban.
         
         :param order: :class:`ListOrder` (optional)
           Name of dashboard attribute to order by.
@@ -4352,7 +4378,11 @@ class DataSourcesAPI:
     
     This API does not support searches. It returns the full list of SQL warehouses in your workspace. We
     advise you to use any text editor, REST client, or `grep` to search the response from this API for the
-    name of your SQL warehouse as it appears in Databricks SQL."""
+    name of your SQL warehouse as it appears in Databricks SQL.
+    
+    **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+    
+    [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources"""
 
     def __init__(self, api_client):
         self._api = api_client
@@ -4364,6 +4394,10 @@ class DataSourcesAPI:
         API response are enumerated for clarity. However, you need only a SQL warehouse's `id` to create new
         queries against it.
         
+        **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+        
+        [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources
+        
         :returns: Iterator over :class:`DataSource`
         """
 
@@ -4384,7 +4418,11 @@ class DbsqlPermissionsAPI:
     
     - `CAN_RUN`: Allows read access and run access (superset of `CAN_VIEW`)
     
-    - `CAN_MANAGE`: Allows all actions: read, run, edit, delete, modify permissions (superset of `CAN_RUN`)"""
+    - `CAN_MANAGE`: Allows all actions: read, run, edit, delete, modify permissions (superset of `CAN_RUN`)
+    
+    **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+    
+    [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources"""
 
     def __init__(self, api_client):
         self._api = api_client
@@ -4394,6 +4432,10 @@ class DbsqlPermissionsAPI:
         
         Gets a JSON representation of the access control list (ACL) for a specified object.
         
+        **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+        
+        [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources
+        
         :param object_type: :class:`ObjectTypePlural`
           The type of object permissions to check.
         :param object_id: str
@@ -4419,6 +4461,10 @@ class DbsqlPermissionsAPI:
         Sets the access control list (ACL) for a specified object. This operation will complete rewrite the
         ACL.
         
+        **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+        
+        [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources
+        
         :param object_type: :class:`ObjectTypePlural`
           The type of object permission to set.
         :param object_id: str
@@ -4447,6 +4493,10 @@ class DbsqlPermissionsAPI:
         
         Transfers ownership of a dashboard, query, or alert to an active user. Requires an admin API key.
         
+        **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+        
+        [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources
+        
         :param object_type: :class:`OwnableObjectType`
           The type of object on which to change ownership.
         :param object_id: :class:`TransferOwnershipObjectId`
@@ -4470,7 +4520,11 @@ class DbsqlPermissionsAPI:
 class QueriesAPI:
     """These endpoints are used for CRUD operations on query definitions. Query definitions include the target
     SQL warehouse, query text, name, description, tags, parameters, and visualizations. Queries can be
-    scheduled using the `sql_task` type of the Jobs API, e.g. :method:jobs/create."""
+    scheduled using the `sql_task` type of the Jobs API, e.g. :method:jobs/create.
+    
+    **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+    
+    [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources"""
 
     def __init__(self, api_client):
         self._api = api_client
@@ -4496,9 +4550,13 @@ class QueriesAPI:
         
         **Note**: You cannot add a visualization until you create the query.
         
+        **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+        
+        [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources
+        
         :param data_source_id: str (optional)
           Data source ID maps to the ID of the data source used by the resource and is distinct from the
-          warehouse ID. [Learn more].
+          warehouse ID. [Learn more]
           
           [Learn more]: https://docs.databricks.com/api/workspace/datasources/list
         :param description: str (optional)
@@ -4540,6 +4598,10 @@ class QueriesAPI:
         Moves a query to the trash. Trashed queries immediately disappear from searches and list views, and
         they cannot be used for alerts. The trash is deleted after 30 days.
         
+        **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+        
+        [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources
+        
         :param query_id: str
         
         
@@ -4555,6 +4617,10 @@ class QueriesAPI:
         Retrieve a query object definition along with contextual permissions information about the currently
         authenticated user.
         
+        **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+        
+        [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources
+        
         :param query_id: str
         
         :returns: :class:`Query`
@@ -4575,8 +4641,12 @@ class QueriesAPI:
         
         Gets a list of queries. Optionally, this list can be filtered by a search term.
         
-        ### **Warning: Calling this API concurrently 10 or more times could result in throttling, service
-        degradation, or a temporary ban.**
+        **Warning**: Calling this API concurrently 10 or more times could result in throttling, service
+        degradation, or a temporary ban.
+        
+        **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+        
+        [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources
         
         :param order: str (optional)
           Name of query attribute to order by. Default sort order is ascending. Append a dash (`-`) to order
@@ -4631,6 +4701,10 @@ class QueriesAPI:
         Restore a query that has been moved to the trash. A restored query appears in list views and searches.
         You can use restored queries for alerts.
         
+        **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+        
+        [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources
+        
         :param query_id: str
         
         
@@ -4656,10 +4730,14 @@ class QueriesAPI:
         
         **Note**: You cannot undo this operation.
         
+        **Note**: A new version of the Databricks SQL API will soon be available. [Learn more]
+        
+        [Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources
+        
         :param query_id: str
         :param data_source_id: str (optional)
           Data source ID maps to the ID of the data source used by the resource and is distinct from the
-          warehouse ID. [Learn more].
+          warehouse ID. [Learn more]
           
           [Learn more]: https://docs.databricks.com/api/workspace/datasources/list
         :param description: str (optional)
@@ -4961,8 +5039,9 @@ class StatementExecutionAPI:
         :param statement: str
           The SQL statement to execute. The statement can optionally be parameterized, see `parameters`.
         :param warehouse_id: str
-          Warehouse upon which to execute a statement. See also [What are SQL
-          warehouses?](/sql/admin/warehouse-type.html)
+          Warehouse upon which to execute a statement. See also [What are SQL warehouses?]
+          
+          [What are SQL warehouses?]: https://docs.databricks.com/sql/admin/warehouse-type.html
         :param byte_limit: int (optional)
           Applies the given byte limit to the statement's result size. Byte counts are based on internal data
           representations and might not match the final size in the requested `format`. If the result was