databricks-sdk 0.56.0__py3-none-any.whl → 0.58.0__py3-none-any.whl

databricks/sdk/service/sql.py

@@ -665,7 +665,10 @@ class AlertV2:
     """Text of the query to be run."""
 
     run_as_user_name: Optional[str] = None
-    """The run as username. This field is set to "Unavailable" if the user has been deleted."""
+    """The run as username or application ID of service principal. This field is set to "Unavailable"
+    if the user has been deleted. On Create and Update, this field can be set to application ID of
+    an active service principal. Setting this field requires the servicePrincipal/user role. If not
+    specified it'll default to be request user."""
 
     schedule: Optional[CronSchedule] = None
 
@@ -1700,16 +1703,16 @@ class CreateQueryRequestQuery:
 class CreateQueryVisualizationsLegacyRequest:
     """Add visualization to a query"""
 
+    options: Any
+    """The options object varies widely from one visualization type to the next and is unsupported.
+    Databricks does not recommend modifying visualization settings in JSON."""
+
     query_id: str
     """The identifier returned by :method:queries/create"""
 
     type: str
     """The type of visualization: chart, table, pivot table, and so on."""
 
-    options: Any
-    """The options object varies widely from one visualization type to the next and is unsupported.
-    Databricks does not recommend modifying visualization settings in JSON."""
-
     description: Optional[str] = None
     """A short description of this visualization. This is not displayed in the UI."""
 
@@ -1902,7 +1905,6 @@ class CreateWarehouseRequest:
     Supported values: - Must be unique within an org. - Must be less than 100 characters."""
 
     spot_instance_policy: Optional[SpotInstancePolicy] = None
-    """Configurations whether the warehouse should use spot instances."""
 
     tags: Optional[EndpointTags] = None
     """A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS
@@ -1911,8 +1913,6 @@ class CreateWarehouseRequest:
     Supported values: - Number of tags < 45."""
 
     warehouse_type: Optional[CreateWarehouseRequestWarehouseType] = None
-    """Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute, you must set to `PRO`
-    and also set the field `enable_serverless_compute` to `true`."""
 
     def as_dict(self) -> dict:
         """Serializes the CreateWarehouseRequest into a dictionary suitable for use as a JSON request body."""
@@ -2040,9 +2040,6 @@ class CreateWidget:
     width: int
     """Width of a widget"""
 
-    id: Optional[str] = None
-    """Widget ID returned by :method:dashboardwidgets/create"""
-
     text: Optional[str] = None
     """If this is a textbox widget, the application displays this text. This field is ignored if the
     widget contains a visualization in the `visualization` field."""
@@ -2055,8 +2052,6 @@ class CreateWidget:
         body = {}
         if self.dashboard_id is not None:
             body["dashboard_id"] = self.dashboard_id
-        if self.id is not None:
-            body["id"] = self.id
         if self.options:
             body["options"] = self.options.as_dict()
         if self.text is not None:
@@ -2072,8 +2067,6 @@ class CreateWidget:
         body = {}
         if self.dashboard_id is not None:
             body["dashboard_id"] = self.dashboard_id
-        if self.id is not None:
-            body["id"] = self.id
         if self.options:
             body["options"] = self.options
         if self.text is not None:
@@ -2089,7 +2082,6 @@ class CreateWidget:
         """Deserializes the CreateWidget from a dictionary."""
         return cls(
             dashboard_id=d.get("dashboard_id", None),
-            id=d.get("id", None),
             options=_from_dict(d, "options", WidgetOptions),
             text=d.get("text", None),
             visualization_id=d.get("visualization_id", None),
@@ -2865,7 +2857,6 @@ class EditWarehouseRequest:
     Supported values: - Must be unique within an org. - Must be less than 100 characters."""
 
     spot_instance_policy: Optional[SpotInstancePolicy] = None
-    """Configurations whether the warehouse should use spot instances."""
 
     tags: Optional[EndpointTags] = None
     """A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS
@@ -2874,8 +2865,6 @@ class EditWarehouseRequest:
     Supported values: - Number of tags < 45."""
 
     warehouse_type: Optional[EditWarehouseRequestWarehouseType] = None
-    """Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute, you must set to `PRO`
-    and also set the field `enable_serverless_compute` to `true`."""
 
     def as_dict(self) -> dict:
         """Serializes the EditWarehouseRequest into a dictionary suitable for use as a JSON request body."""
@@ -3055,7 +3044,6 @@ class EndpointHealth:
     """Deprecated. split into summary and details for security"""
 
     status: Optional[Status] = None
-    """Health status of the warehouse."""
 
     summary: Optional[str] = None
     """A short summary of the health status in case of degraded/failed warehouses."""
@@ -3178,10 +3166,8 @@ class EndpointInfo:
     """ODBC parameters for the SQL warehouse"""
 
     spot_instance_policy: Optional[SpotInstancePolicy] = None
-    """Configurations whether the warehouse should use spot instances."""
 
     state: Optional[State] = None
-    """State of the warehouse"""
 
     tags: Optional[EndpointTags] = None
     """A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS
@@ -3419,7 +3405,8 @@ class EnumValue:
 @dataclass
 class ExecuteStatementRequest:
     statement: str
-    """The SQL statement to execute. The statement can optionally be parameterized, see `parameters`."""
+    """The SQL statement to execute. The statement can optionally be parameterized, see `parameters`.
+    The maximum query text size is 16 MiB."""
 
     warehouse_id: str
     """Warehouse upon which to execute a statement. See also [What are SQL warehouses?]
@@ -3983,10 +3970,8 @@ class GetWarehouseResponse:
     """ODBC parameters for the SQL warehouse"""
 
     spot_instance_policy: Optional[SpotInstancePolicy] = None
-    """Configurations whether the warehouse should use spot instances."""
 
     state: Optional[State] = None
-    """State of the warehouse"""
 
     tags: Optional[EndpointTags] = None
     """A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS
@@ -3995,8 +3980,6 @@ class GetWarehouseResponse:
     Supported values: - Number of tags < 45."""
 
     warehouse_type: Optional[GetWarehouseResponseWarehouseType] = None
-    """Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute, you must set to `PRO`
-    and also set the field `enable_serverless_compute` to `true`."""
 
     def as_dict(self) -> dict:
         """Serializes the GetWarehouseResponse into a dictionary suitable for use as a JSON request body."""
@@ -4336,8 +4319,6 @@ class LegacyAlert:
 
 
 class LegacyAlertState(Enum):
-    """State of the alert. Possible values are: `unknown` (yet to be evaluated), `triggered` (evaluated
-    and fulfilled trigger conditions), or `ok` (evaluated and did not fulfill trigger conditions)."""
 
     OK = "ok"
     TRIGGERED = "triggered"
@@ -5317,7 +5298,6 @@ class OdbcParams:
 
 
 class OwnableObjectType(Enum):
-    """The singular form of the type of object which can be owned."""
 
     ALERT = "alert"
     DASHBOARD = "dashboard"
@@ -5402,7 +5382,6 @@ class Parameter:
 
 
 class ParameterType(Enum):
-    """Parameters can have several different types."""
 
     DATETIME = "datetime"
     ENUM = "enum"
@@ -5719,12 +5698,16 @@ class QueryEditContent:
 @dataclass
 class QueryFilter:
     query_start_time_range: Optional[TimeRange] = None
-    """A range filter for query submitted time. The time range must be <= 30 days."""
+    """A range filter for query submitted time. The time range must be less than or equal to 30 days."""
 
     statement_ids: Optional[List[str]] = None
     """A list of statement IDs."""
 
     statuses: Optional[List[QueryStatus]] = None
+    """A list of statuses (QUEUED, RUNNING, CANCELED, FAILED, FINISHED) to match query results.
+    Corresponds to the `status` field in the response. Filtering for multiple statuses is not
+    recommended. Instead, opt to filter by a single status multiple times and then combine the
+    results."""
 
     user_ids: Optional[List[int]] = None
     """A list of user IDs who ran the queries."""
@@ -5785,7 +5768,9 @@ class QueryInfo:
     are expected to remain static over time, this cannot be guaranteed."""
 
     duration: Optional[int] = None
-    """Total execution time of the statement ( excluding result fetch time )."""
+    """Total time of the statement execution. This value does not include the time taken to retrieve
+    the results, which can result in a discrepancy between this value and the start-to-finish
+    wall-clock time."""
 
     endpoint_id: Optional[str] = None
     """Alias for `warehouse_id`."""
@@ -6666,7 +6651,6 @@ class ResultManifest:
     format: Optional[Format] = None
 
     schema: Optional[ResultSchema] = None
-    """The schema is an ordered list of column descriptions."""
 
     total_byte_count: Optional[int] = None
     """The total number of bytes in the result set. This field is not available when using `INLINE`
@@ -6772,8 +6756,6 @@ class RunAsMode(Enum):
 
 
 class RunAsRole(Enum):
-    """Sets the **Run as** role for the object. Must be set to one of `"viewer"` (signifying "run as
-    viewer" behavior) or `"owner"` (signifying "run as owner" behavior)"""
 
     OWNER = "owner"
     VIEWER = "viewer"
@@ -7126,7 +7108,6 @@ class StatementParameterListItem:
 @dataclass
 class StatementResponse:
     manifest: Optional[ResultManifest] = None
-    """The result manifest provides schema and metadata for the result set."""
 
     result: Optional[ResultData] = None
 
@@ -7135,7 +7116,6 @@ class StatementResponse:
     reference for all subsequent calls."""
 
     status: Optional[StatementStatus] = None
-    """The status response includes execution state and if relevant, error information."""
 
     def as_dict(self) -> dict:
         """Serializes the StatementResponse into a dictionary suitable for use as a JSON request body."""
@@ -7196,11 +7176,6 @@ class StatementStatus:
     error: Optional[ServiceError] = None
 
     state: Optional[StatementState] = None
-    """Statement execution state: - `PENDING`: waiting for warehouse - `RUNNING`: running -
-    `SUCCEEDED`: execution was successful, result data available for fetch - `FAILED`: execution
-    failed; reason for failure described in accomanying error message - `CANCELED`: user canceled;
-    can come from explicit cancel call, or timeout with `on_wait_timeout=CANCEL` - `CLOSED`:
-    execution successful, and statement closed; result no longer available for fetch"""
 
     def as_dict(self) -> dict:
         """Serializes the StatementStatus into a dictionary suitable for use as a JSON request body."""
@@ -7558,8 +7533,6 @@ class TransferOwnershipObjectId:
 
 @dataclass
 class TransferOwnershipRequest:
-    """Transfer object ownership"""
-
     new_owner: Optional[str] = None
     """Email address for the new owner, who must exist in the workspace."""
 
@@ -8032,6 +8005,73 @@ class UpdateVisualizationRequestVisualization:
         )
 
 
+@dataclass
+class UpdateWidgetRequest:
+    dashboard_id: str
+    """Dashboard ID returned by :method:dashboards/create."""
+
+    options: WidgetOptions
+
+    width: int
+    """Width of a widget"""
+
+    id: Optional[str] = None
+    """Widget ID returned by :method:dashboardwidgets/create"""
+
+    text: Optional[str] = None
+    """If this is a textbox widget, the application displays this text. This field is ignored if the
+    widget contains a visualization in the `visualization` field."""
+
+    visualization_id: Optional[str] = None
+    """Query Vizualization ID returned by :method:queryvisualizations/create."""
+
+    def as_dict(self) -> dict:
+        """Serializes the UpdateWidgetRequest into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.dashboard_id is not None:
+            body["dashboard_id"] = self.dashboard_id
+        if self.id is not None:
+            body["id"] = self.id
+        if self.options:
+            body["options"] = self.options.as_dict()
+        if self.text is not None:
+            body["text"] = self.text
+        if self.visualization_id is not None:
+            body["visualization_id"] = self.visualization_id
+        if self.width is not None:
+            body["width"] = self.width
+        return body
+
+    def as_shallow_dict(self) -> dict:
+        """Serializes the UpdateWidgetRequest into a shallow dictionary of its immediate attributes."""
+        body = {}
+        if self.dashboard_id is not None:
+            body["dashboard_id"] = self.dashboard_id
+        if self.id is not None:
+            body["id"] = self.id
+        if self.options:
+            body["options"] = self.options
+        if self.text is not None:
+            body["text"] = self.text
+        if self.visualization_id is not None:
+            body["visualization_id"] = self.visualization_id
+        if self.width is not None:
+            body["width"] = self.width
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, Any]) -> UpdateWidgetRequest:
+        """Deserializes the UpdateWidgetRequest from a dictionary."""
+        return cls(
+            dashboard_id=d.get("dashboard_id", None),
+            id=d.get("id", None),
+            options=_from_dict(d, "options", WidgetOptions),
+            text=d.get("text", None),
+            visualization_id=d.get("visualization_id", None),
+            width=d.get("width", None),
+        )
+
+
 @dataclass
 class User:
     email: Optional[str] = None
@@ -8159,7 +8199,6 @@ class WarehouseAccessControlRequest:
     """name of the group"""
 
     permission_level: Optional[WarehousePermissionLevel] = None
-    """Permission level"""
 
     service_principal_name: Optional[str] = None
     """application ID of a service principal"""
@@ -8270,7 +8309,6 @@ class WarehousePermission:
     inherited_from_object: Optional[List[str]] = None
 
     permission_level: Optional[WarehousePermissionLevel] = None
-    """Permission level"""
 
     def as_dict(self) -> dict:
         """Serializes the WarehousePermission into a dictionary suitable for use as a JSON request body."""
@@ -8359,7 +8397,6 @@ class WarehousePermissionsDescription:
     description: Optional[str] = None
 
     permission_level: Optional[WarehousePermissionLevel] = None
-    """Permission level"""
 
     def as_dict(self) -> dict:
         """Serializes the WarehousePermissionsDescription into a dictionary suitable for use as a JSON request body."""
@@ -8669,9 +8706,7 @@ class AlertsAPI:
     def create(
         self, *, alert: Optional[CreateAlertRequestAlert] = None, auto_resolve_display_name: Optional[bool] = None
     ) -> Alert:
-        """Create an alert.
-
-        Creates an alert.
+        """Creates an alert.
 
         :param alert: :class:`CreateAlertRequestAlert` (optional)
         :param auto_resolve_display_name: bool (optional)
@@ -8694,9 +8729,7 @@ class AlertsAPI:
         return Alert.from_dict(res)
 
     def delete(self, id: str):
-        """Delete an alert.
-
-        Moves an alert to the trash. Trashed alerts immediately disappear from searches and list views, and
+        """Moves an alert to the trash. Trashed alerts immediately disappear from searches and list views, and
         can no longer trigger. You can restore a trashed alert through the UI. A trashed alert is permanently
         deleted after 30 days.
 
@@ -8712,9 +8745,7 @@ class AlertsAPI:
         self._api.do("DELETE", f"/api/2.0/sql/alerts/{id}", headers=headers)
 
     def get(self, id: str) -> Alert:
-        """Get an alert.
-
-        Gets an alert.
+        """Gets an alert.
 
         :param id: str
 
@@ -8731,9 +8762,7 @@ class AlertsAPI:
     def list(
         self, *, page_size: Optional[int] = None, page_token: Optional[str] = None
     ) -> Iterator[ListAlertsResponseAlert]:
-        """List alerts.
-
-        Gets a list of alerts accessible to the user, ordered by creation time. **Warning:** Calling this API
+        """Gets a list of alerts accessible to the user, ordered by creation time. **Warning:** Calling this API
         concurrently 10 or more times could result in throttling, service degradation, or a temporary ban.
 
         :param page_size: int (optional)
@@ -8768,9 +8797,7 @@ class AlertsAPI:
         alert: Optional[UpdateAlertRequestAlert] = None,
         auto_resolve_display_name: Optional[bool] = None,
     ) -> Alert:
-        """Update an alert.
-
-        Updates an alert.
+        """Updates an alert.
 
         :param id: str
         :param update_mask: str
@@ -8829,9 +8856,7 @@ class AlertsLegacyAPI:
         parent: Optional[str] = None,
         rearm: Optional[int] = None,
     ) -> LegacyAlert:
-        """Create an alert.
-
-        Creates an alert. An alert is a Databricks SQL object that periodically runs a query, evaluates a
+        """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 is now available. Please use :method:alerts/create
@@ -8873,9 +8898,7 @@ class AlertsLegacyAPI:
         return LegacyAlert.from_dict(res)
 
     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 is now available. Please use :method:alerts/delete
@@ -8895,9 +8918,7 @@ class AlertsLegacyAPI:
         self._api.do("DELETE", f"/api/2.0/preview/sql/alerts/{alert_id}", headers=headers)
 
     def get(self, alert_id: str) -> LegacyAlert:
-        """Get an alert.
-
-        Gets an alert.
+        """Gets an alert.
 
         **Note**: A new version of the Databricks SQL API is now available. Please use :method:alerts/get
         instead. [Learn more]
@@ -8917,15 +8938,14 @@ class AlertsLegacyAPI:
         return LegacyAlert.from_dict(res)
 
     def list(self) -> Iterator[LegacyAlert]:
-        """Get alerts.
-
-        Gets a list of alerts.
+        """Gets a list of alerts.
 
         **Note**: A new version of the Databricks SQL API is now available. Please use :method:alerts/list
         instead. [Learn more]
 
         [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html
 
+
         :returns: Iterator over :class:`LegacyAlert`
         """
 
@@ -8937,9 +8957,7 @@ class AlertsLegacyAPI:
         return [LegacyAlert.from_dict(v) for v in res]
 
     def update(self, alert_id: str, name: str, options: AlertOptions, query_id: str, *, rearm: Optional[int] = None):
-        """Update an alert.
-
-        Updates an alert.
+        """Updates an alert.
 
         **Note**: A new version of the Databricks SQL API is now available. Please use :method:alerts/update
         instead. [Learn more]
@@ -8983,9 +9001,7 @@ class AlertsV2API:
         self._api = api_client
 
     def create_alert(self, alert: AlertV2) -> AlertV2:
-        """Create an alert.
-
-        Create Alert
+        """Create Alert
 
         :param alert: :class:`AlertV2`
 
@@ -9001,9 +9017,7 @@ class AlertsV2API:
         return AlertV2.from_dict(res)
 
     def get_alert(self, id: str) -> AlertV2:
-        """Get an alert.
-
-        Gets an alert.
+        """Gets an alert.
 
         :param id: str
 
@@ -9018,9 +9032,7 @@ class AlertsV2API:
         return AlertV2.from_dict(res)
 
     def list_alerts(self, *, page_size: Optional[int] = None, page_token: Optional[str] = None) -> Iterator[AlertV2]:
-        """List alerts.
-
-        Gets a list of alerts accessible to the user, ordered by creation time.
+        """Gets a list of alerts accessible to the user, ordered by creation time.
 
         :param page_size: int (optional)
         :param page_token: str (optional)
@@ -9047,9 +9059,7 @@ class AlertsV2API:
             query["page_token"] = json["next_page_token"]
 
     def trash_alert(self, id: str):
-        """Delete an alert.
-
-        Moves an alert to the trash. Trashed alerts immediately disappear from list views, and can no longer
+        """Moves an alert to the trash. Trashed alerts immediately disappear from list views, and can no longer
         trigger. You can restore a trashed alert through the UI. A trashed alert is permanently deleted after
         30 days.
 
@@ -9065,9 +9075,7 @@ class AlertsV2API:
         self._api.do("DELETE", f"/api/2.0/alerts/{id}", headers=headers)
 
     def update_alert(self, id: str, alert: AlertV2, update_mask: str) -> AlertV2:
-        """Update an alert.
-
-        Update alert
+        """Update alert
 
         :param id: str
           UUID identifying the alert.
@@ -9114,7 +9122,7 @@ class DashboardWidgetsAPI:
         text: Optional[str] = None,
         visualization_id: Optional[str] = None,
     ) -> Widget:
-        """Add widget to a dashboard.
+        """Adds a widget to a dashboard
 
         :param dashboard_id: str
           Dashboard ID returned by :method:dashboards/create.
@@ -9149,7 +9157,7 @@ class DashboardWidgetsAPI:
         return Widget.from_dict(res)
 
     def delete(self, id: str):
-        """Remove widget.
+        """Removes a widget from a dashboard
 
         :param id: str
           Widget ID returned by :method:dashboardwidgets/create
@@ -9173,7 +9181,7 @@ class DashboardWidgetsAPI:
         text: Optional[str] = None,
         visualization_id: Optional[str] = None,
     ) -> Widget:
-        """Update existing widget.
+        """Updates an existing widget
 
         :param id: str
           Widget ID returned by :method:dashboardwidgets/create
@@ -9230,7 +9238,9 @@ class DashboardsAPI:
         run_as_role: Optional[RunAsRole] = None,
         tags: Optional[List[str]] = None,
     ) -> Dashboard:
-        """Create a dashboard object.
+        """Creates a new dashboard object. Only the name parameter is required in the POST request JSON body.
+        Other fields can be included when duplicating dashboards with this API. Databricks does not recommend
+        designing dashboards exclusively using this API.',
 
         :param name: str
           The title of this dashboard that appears in list views and at the top of the dashboard page.
@@ -9269,9 +9279,7 @@ class DashboardsAPI:
         return Dashboard.from_dict(res)
 
     def delete(self, dashboard_id: str):
-        """Remove a dashboard.
-
-        Moves a dashboard to the trash. Trashed dashboards do not appear in list views or searches, and cannot
+        """Moves a dashboard to the trash. Trashed dashboards do not appear in list views or searches, and cannot
         be shared.
 
         :param dashboard_id: str
@@ -9286,9 +9294,7 @@ class DashboardsAPI:
         self._api.do("DELETE", f"/api/2.0/preview/sql/dashboards/{dashboard_id}", headers=headers)
 
     def get(self, dashboard_id: str) -> Dashboard:
-        """Retrieve a definition.
-
-        Returns a JSON representation of a dashboard object, including its visualization and query objects.
+        """Returns a JSON representation of a dashboard object, including its visualization and query objects.
 
         :param dashboard_id: str
 
@@ -9310,9 +9316,7 @@ class DashboardsAPI:
         page_size: Optional[int] = None,
         q: Optional[str] = None,
     ) -> Iterator[Dashboard]:
-        """Get dashboard objects.
-
-        Fetch a paginated list of dashboard objects.
+        """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.
@@ -9342,26 +9346,18 @@ class DashboardsAPI:
             "Accept": "application/json",
         }
 
-        # deduplicate items that may have been added during iteration
-        seen = set()
         query["page"] = 1
         while True:
             json = self._api.do("GET", "/api/2.0/preview/sql/dashboards", query=query, headers=headers)
             if "results" in json:
                 for v in json["results"]:
-                    i = v["id"]
-                    if i in seen:
-                        continue
-                    seen.add(i)
                     yield Dashboard.from_dict(v)
             if "results" not in json or not json["results"]:
                 return
             query["page"] += 1
 
     def restore(self, dashboard_id: str):
-        """Restore a dashboard.
-
-        A restored dashboard appears in list views and searches and can be shared.
+        """A restored dashboard appears in list views and searches and can be shared.
 
         :param dashboard_id: str
 
@@ -9382,9 +9378,7 @@ class DashboardsAPI:
         run_as_role: Optional[RunAsRole] = None,
         tags: Optional[List[str]] = None,
     ) -> Dashboard:
-        """Change a dashboard definition.
-
-        Modify this dashboard definition. This operation only affects attributes of the dashboard object. It
+        """Modify this dashboard definition. This operation only affects attributes of the dashboard object. It
         does not add, modify, or remove widgets.
 
         **Note**: You cannot undo this operation.
@@ -9432,9 +9426,7 @@ class DataSourcesAPI:
         self._api = api_client
 
     def list(self) -> Iterator[DataSource]:
-        """Get a list of SQL warehouses.
-
-        Retrieves a full list of SQL warehouses available in this workspace. All fields that appear in this
+        """Retrieves a full list of SQL warehouses available in this workspace. All fields that appear in this
         API response are enumerated for clarity. However, you need only a SQL warehouse's `id` to create new
         queries against it.
 
@@ -9443,6 +9435,7 @@ class DataSourcesAPI:
 
         [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html
 
+
         :returns: Iterator over :class:`DataSource`
         """
 
@@ -9475,9 +9468,7 @@ class DbsqlPermissionsAPI:
         self._api = api_client
 
     def get(self, object_type: ObjectTypePlural, object_id: str) -> GetResponse:
-        """Get object ACL.
-
-        Gets a JSON representation of the access control list (ACL) for a specified object.
+        """Gets a JSON representation of the access control list (ACL) for a specified object.
 
         **Note**: A new version of the Databricks SQL API is now available. Please use
         :method:workspace/getpermissions instead. [Learn more]
@@ -9506,9 +9497,7 @@ class DbsqlPermissionsAPI:
         *,
         access_control_list: Optional[List[AccessControl]] = None,
     ) -> SetResponse:
-        """Set object ACL.
-
-        Sets the access control list (ACL) for a specified object. This operation will complete rewrite the
+        """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 is now available. Please use
@@ -9540,9 +9529,7 @@ class DbsqlPermissionsAPI:
     def transfer_ownership(
         self, object_type: OwnableObjectType, object_id: TransferOwnershipObjectId, *, new_owner: Optional[str] = None
     ) -> Success:
-        """Transfer object ownership.
-
-        Transfers ownership of a dashboard, query, or alert to an active user. Requires an admin API key.
+        """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 is now available. For queries and alerts, please use
         :method:queries/update and :method:alerts/update respectively instead. [Learn more]
@@ -9586,9 +9573,7 @@ class QueriesAPI:
     def create(
         self, *, auto_resolve_display_name: Optional[bool] = None, query: Optional[CreateQueryRequestQuery] = None
     ) -> Query:
-        """Create a query.
-
-        Creates a query.
+        """Creates a query.
 
         :param auto_resolve_display_name: bool (optional)
           If true, automatically resolve query display name conflicts. Otherwise, fail the request if the
@@ -9611,9 +9596,7 @@ class QueriesAPI:
         return Query.from_dict(res)
 
     def delete(self, id: str):
-        """Delete a query.
-
-        Moves a query to the trash. Trashed queries immediately disappear from searches and list views, and
+        """Moves a query to the trash. Trashed queries immediately disappear from searches and list views, and
         cannot be used for alerts. You can restore a trashed query through the UI. A trashed query is
         permanently deleted after 30 days.
 
@@ -9629,9 +9612,7 @@ class QueriesAPI:
         self._api.do("DELETE", f"/api/2.0/sql/queries/{id}", headers=headers)
 
     def get(self, id: str) -> Query:
-        """Get a query.
-
-        Gets a query.
+        """Gets a query.
 
         :param id: str
 
@@ -9648,9 +9629,7 @@ class QueriesAPI:
     def list(
         self, *, page_size: Optional[int] = None, page_token: Optional[str] = None
     ) -> Iterator[ListQueryObjectsResponseQuery]:
-        """List queries.
-
-        Gets a list of queries accessible to the user, ordered by creation time. **Warning:** Calling this API
+        """Gets a list of queries accessible to the user, ordered by creation time. **Warning:** Calling this API
         concurrently 10 or more times could result in throttling, service degradation, or a temporary ban.
 
         :param page_size: int (optional)
@@ -9680,9 +9659,7 @@ class QueriesAPI:
     def list_visualizations(
         self, id: str, *, page_size: Optional[int] = None, page_token: Optional[str] = None
     ) -> Iterator[Visualization]:
-        """List visualizations on a query.
-
-        Gets a list of visualizations on a query.
+        """Gets a list of visualizations on a query.
 
         :param id: str
         :param page_size: int (optional)
@@ -9717,9 +9694,7 @@ class QueriesAPI:
         auto_resolve_display_name: Optional[bool] = None,
         query: Optional[UpdateQueryRequestQuery] = None,
     ) -> Query:
-        """Update a query.
-
-        Updates a query.
+        """Updates a query.
 
         :param id: str
         :param update_mask: str
@@ -9780,9 +9755,7 @@ class QueriesLegacyAPI:
         run_as_role: Optional[RunAsRole] = None,
         tags: Optional[List[str]] = None,
     ) -> LegacyQuery:
-        """Create a new query definition.
-
-        Creates a new query definition. Queries created with this endpoint belong to the authenticated user
+        """Creates a new query definition. Queries created with this endpoint belong to the authenticated user
         making the request.
 
         The `data_source_id` field specifies the ID of the SQL warehouse to run this query against. You can
@@ -9846,9 +9819,7 @@ class QueriesLegacyAPI:
         return LegacyQuery.from_dict(res)
 
     def delete(self, query_id: str):
-        """Delete a query.
-
-        Moves a query to the trash. Trashed queries immediately disappear from searches and list views, and
+        """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 is now available. Please use :method:queries/delete
@@ -9868,9 +9839,7 @@ class QueriesLegacyAPI:
         self._api.do("DELETE", f"/api/2.0/preview/sql/queries/{query_id}", headers=headers)
 
     def get(self, query_id: str) -> LegacyQuery:
-        """Get a query definition.
-
-        Retrieve a query object definition along with contextual permissions information about the currently
+        """Retrieve a query object definition along with contextual permissions information about the currently
         authenticated user.
 
         **Note**: A new version of the Databricks SQL API is now available. Please use :method:queries/get
@@ -9898,9 +9867,7 @@ class QueriesLegacyAPI:
         page_size: Optional[int] = None,
         q: Optional[str] = None,
     ) -> Iterator[LegacyQuery]:
-        """Get a list of queries.
-
-        Gets a list of queries. Optionally, this list can be filtered by a search term.
+        """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.
@@ -9947,26 +9914,18 @@ class QueriesLegacyAPI:
             "Accept": "application/json",
         }
 
-        # deduplicate items that may have been added during iteration
-        seen = set()
         query["page"] = 1
         while True:
             json = self._api.do("GET", "/api/2.0/preview/sql/queries", query=query, headers=headers)
             if "results" in json:
                 for v in json["results"]:
-                    i = v["id"]
-                    if i in seen:
-                        continue
-                    seen.add(i)
                     yield LegacyQuery.from_dict(v)
             if "results" not in json or not json["results"]:
                 return
             query["page"] += 1
 
     def restore(self, query_id: str):
-        """Restore a query.
-
-        Restore a query that has been moved to the trash. A restored query appears in list views and searches.
+        """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 is now available. Please see the latest version.
@@ -9997,9 +9956,7 @@ class QueriesLegacyAPI:
         run_as_role: Optional[RunAsRole] = None,
         tags: Optional[List[str]] = None,
     ) -> LegacyQuery:
-        """Change a query definition.
-
-        Modify this query definition.
+        """Modify this query definition.
 
         **Note**: You cannot undo this operation.
 
@@ -10070,16 +10027,16 @@ class QueryHistoryAPI:
         max_results: Optional[int] = None,
         page_token: Optional[str] = None,
     ) -> ListQueriesResponse:
-        """List Queries.
-
-        List the history of queries through SQL warehouses, and serverless compute.
+        """List the history of queries through SQL warehouses, and serverless compute.
 
         You can filter by user ID, warehouse ID, status, and time range. Most recently started queries are
         returned first (up to max_results in request). The pagination token returned in response can be used
         to list subsequent query statuses.
 
         :param filter_by: :class:`QueryFilter` (optional)
-          A filter to limit query history results. This field is optional.
+          An optional filter object to limit query history results. Accepts parameters such as user IDs,
+          endpoint IDs, and statuses to narrow the returned data. In a URL, the parameters of this filter are
+          specified with dot notation. For example: `filter_by.statement_ids`.
         :param include_metrics: bool (optional)
           Whether to include the query metrics with each query. Only use this for a small subset of queries
           (max_results). Defaults to false.
@@ -10118,9 +10075,7 @@ class QueryVisualizationsAPI:
         self._api = api_client
 
     def create(self, *, visualization: Optional[CreateVisualizationRequestVisualization] = None) -> Visualization:
-        """Add a visualization to a query.
-
-        Adds a visualization to a query.
+        """Adds a visualization to a query.
 
         :param visualization: :class:`CreateVisualizationRequestVisualization` (optional)
 
@@ -10138,9 +10093,7 @@ class QueryVisualizationsAPI:
         return Visualization.from_dict(res)
 
     def delete(self, id: str):
-        """Remove a visualization.
-
-        Removes a visualization.
+        """Removes a visualization.
 
         :param id: str
 
@@ -10156,9 +10109,7 @@ class QueryVisualizationsAPI:
     def update(
         self, id: str, update_mask: str, *, visualization: Optional[UpdateVisualizationRequestVisualization] = None
     ) -> Visualization:
-        """Update a visualization.
-
-        Updates a visualization.
+        """Updates a visualization.
 
         :param id: str
         :param update_mask: str
@@ -10202,24 +10153,22 @@ class QueryVisualizationsLegacyAPI:
         self._api = api_client
 
     def create(
-        self, query_id: str, type: str, options: Any, *, description: Optional[str] = None, name: Optional[str] = None
+        self, options: Any, query_id: str, type: str, *, description: Optional[str] = None, name: Optional[str] = None
     ) -> LegacyVisualization:
-        """Add visualization to a query.
-
-        Creates visualization in the query.
+        """Creates visualization in the query.
 
         **Note**: A new version of the Databricks SQL API is now available. Please use
         :method:queryvisualizations/create instead. [Learn more]
 
         [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html
 
+        :param options: Any
+          The options object varies widely from one visualization type to the next and is unsupported.
+          Databricks does not recommend modifying visualization settings in JSON.
         :param query_id: str
           The identifier returned by :method:queries/create
         :param type: str
           The type of visualization: chart, table, pivot table, and so on.
-        :param options: Any
-          The options object varies widely from one visualization type to the next and is unsupported.
-          Databricks does not recommend modifying visualization settings in JSON.
         :param description: str (optional)
           A short description of this visualization. This is not displayed in the UI.
         :param name: str (optional)
@@ -10247,9 +10196,7 @@ class QueryVisualizationsLegacyAPI:
         return LegacyVisualization.from_dict(res)
 
     def delete(self, id: str):
-        """Remove visualization.
-
-        Removes a visualization from the query.
+        """Removes a visualization from the query.
 
         **Note**: A new version of the Databricks SQL API is now available. Please use
         :method:queryvisualizations/delete instead. [Learn more]
@@ -10257,7 +10204,7 @@ class QueryVisualizationsLegacyAPI:
         [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html
 
         :param id: str
-          Widget ID returned by :method:queryvizualisations/create
+          Widget ID returned by :method:queryvisualizations/create
 
 
         """
@@ -10280,9 +10227,7 @@ class QueryVisualizationsLegacyAPI:
         type: Optional[str] = None,
         updated_at: Optional[str] = None,
     ) -> LegacyVisualization:
-        """Edit existing visualization.
-
-        Updates visualization in the query.
+        """Updates visualization in the query.
 
         **Note**: A new version of the Databricks SQL API is now available. Please use
         :method:queryvisualizations/update instead. [Learn more]
@@ -10339,6 +10284,7 @@ class RedashConfigAPI:
     def get_config(self) -> ClientConfig:
         """Read workspace configuration for Redash-v2.
 
+
         :returns: :class:`ClientConfig`
         """
 
@@ -10440,9 +10386,7 @@ class StatementExecutionAPI:
         self._api = api_client
 
     def cancel_execution(self, statement_id: str):
-        """Cancel statement execution.
-
-        Requests that an executing statement be canceled. Callers must poll for status to see the terminal
+        """Requests that an executing statement be canceled. Callers must poll for status to see the terminal
         state.
 
         :param statement_id: str
@@ -10471,10 +10415,11 @@ class StatementExecutionAPI:
         schema: Optional[str] = None,
         wait_timeout: Optional[str] = None,
     ) -> StatementResponse:
-        """Execute a SQL statement.
+        """Execute a SQL statement
 
         :param statement: str
-          The SQL statement to execute. The statement can optionally be parameterized, see `parameters`.
+          The SQL statement to execute. The statement can optionally be parameterized, see `parameters`. The
+          maximum query text size is 16 MiB.
         :param warehouse_id: str
           Warehouse upon which to execute a statement. See also [What are SQL warehouses?]
 
@@ -10611,9 +10556,7 @@ class StatementExecutionAPI:
         return StatementResponse.from_dict(res)
 
     def get_statement(self, statement_id: str) -> StatementResponse:
-        """Get status, manifest, and result first chunk.
-
-        This request can be used to poll for the statement's status. When the `status.state` field is
+        """This request can be used to poll for the statement's status. When the `status.state` field is
         `SUCCEEDED` it will also return the result manifest and the first chunk of the result data. When the
         statement is in the terminal states `CANCELED`, `CLOSED` or `FAILED`, it returns HTTP 200 with the
         state set. After at least 12 hours in terminal state, the statement is removed from the warehouse and
@@ -10636,9 +10579,7 @@ class StatementExecutionAPI:
         return StatementResponse.from_dict(res)
 
     def get_statement_result_chunk_n(self, statement_id: str, chunk_index: int) -> ResultData:
-        """Get result chunk by index.
-
-        After the statement execution has `SUCCEEDED`, this request can be used to fetch any chunk by index.
+        """After the statement execution has `SUCCEEDED`, this request can be used to fetch any chunk by index.
         Whereas the first chunk with `chunk_index=0` is typically fetched with
         :method:statementexecution/executeStatement or :method:statementexecution/getStatement, this request
         can be used to fetch subsequent chunks. The response structure is identical to the nested `result`
@@ -10748,9 +10689,7 @@ class WarehousesAPI:
         tags: Optional[EndpointTags] = None,
         warehouse_type: Optional[CreateWarehouseRequestWarehouseType] = None,
     ) -> Wait[GetWarehouseResponse]:
-        """Create a warehouse.
-
-        Creates a new SQL warehouse.
+        """Creates a new SQL warehouse.
 
         :param auto_stop_mins: int (optional)
           The amount of time in minutes that a SQL warehouse must be idle (i.e., no RUNNING queries) before it
@@ -10798,15 +10737,12 @@ class WarehousesAPI:
 
           Supported values: - Must be unique within an org. - Must be less than 100 characters.
         :param spot_instance_policy: :class:`SpotInstancePolicy` (optional)
-          Configurations whether the warehouse should use spot instances.
         :param tags: :class:`EndpointTags` (optional)
           A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes)
           associated with this SQL warehouse.
 
           Supported values: - Number of tags < 45.
         :param warehouse_type: :class:`CreateWarehouseRequestWarehouseType` (optional)
-          Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute, you must set to `PRO` and
-          also set the field `enable_serverless_compute` to `true`.
 
         :returns:
           Long-running operation waiter for :class:`GetWarehouseResponse`.
@@ -10886,9 +10822,7 @@ class WarehousesAPI:
         ).result(timeout=timeout)
 
     def delete(self, id: str):
-        """Delete a warehouse.
-
-        Deletes a SQL warehouse.
+        """Deletes a SQL warehouse.
 
         :param id: str
           Required. Id of the SQL warehouse.
@@ -10920,9 +10854,7 @@ class WarehousesAPI:
         tags: Optional[EndpointTags] = None,
         warehouse_type: Optional[EditWarehouseRequestWarehouseType] = None,
     ) -> Wait[GetWarehouseResponse]:
-        """Update a warehouse.
-
-        Updates the configuration for a SQL warehouse.
+        """Updates the configuration for a SQL warehouse.
 
         :param id: str
           Required. Id of the warehouse to configure.
@@ -10971,15 +10903,12 @@ class WarehousesAPI:
 
           Supported values: - Must be unique within an org. - Must be less than 100 characters.
         :param spot_instance_policy: :class:`SpotInstancePolicy` (optional)
-          Configurations whether the warehouse should use spot instances.
         :param tags: :class:`EndpointTags` (optional)
           A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes)
           associated with this SQL warehouse.
 
           Supported values: - Number of tags < 45.
         :param warehouse_type: :class:`EditWarehouseRequestWarehouseType` (optional)
-          Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute, you must set to `PRO` and
-          also set the field `enable_serverless_compute` to `true`.
 
         :returns:
           Long-running operation waiter for :class:`GetWarehouseResponse`.
@@ -11057,9 +10986,7 @@ class WarehousesAPI:
         ).result(timeout=timeout)
 
     def get(self, id: str) -> GetWarehouseResponse:
-        """Get warehouse info.
-
-        Gets the information for a single SQL warehouse.
+        """Gets the information for a single SQL warehouse.
 
         :param id: str
           Required. Id of the SQL warehouse.
@@ -11075,9 +11002,7 @@ class WarehousesAPI:
         return GetWarehouseResponse.from_dict(res)
 
     def get_permission_levels(self, warehouse_id: str) -> GetWarehousePermissionLevelsResponse:
-        """Get SQL warehouse permission levels.
-
-        Gets the permission levels that a user can have on an object.
+        """Gets the permission levels that a user can have on an object.
 
         :param warehouse_id: str
           The SQL warehouse for which to get or manage permissions.
@@ -11093,9 +11018,7 @@ class WarehousesAPI:
         return GetWarehousePermissionLevelsResponse.from_dict(res)
 
     def get_permissions(self, warehouse_id: str) -> WarehousePermissions:
-        """Get SQL warehouse permissions.
-
-        Gets the permissions of a SQL warehouse. SQL warehouses can inherit permissions from their root
+        """Gets the permissions of a SQL warehouse. SQL warehouses can inherit permissions from their root
         object.
 
         :param warehouse_id: str
@@ -11112,9 +11035,8 @@ class WarehousesAPI:
         return WarehousePermissions.from_dict(res)
 
     def get_workspace_warehouse_config(self) -> GetWorkspaceWarehouseConfigResponse:
-        """Get the workspace configuration.
+        """Gets the workspace level configuration that is shared by all SQL warehouses in a workspace.
 
-        Gets the workspace level configuration that is shared by all SQL warehouses in a workspace.
 
         :returns: :class:`GetWorkspaceWarehouseConfigResponse`
         """
@@ -11127,9 +11049,7 @@ class WarehousesAPI:
         return GetWorkspaceWarehouseConfigResponse.from_dict(res)
 
     def list(self, *, run_as_user_id: Optional[int] = None) -> Iterator[EndpointInfo]:
-        """List warehouses.
-
-        Lists all SQL warehouses that a user has manager permissions on.
+        """Lists all SQL warehouses that a user has manager permissions on.
 
         :param run_as_user_id: int (optional)
           Service Principal which will be used to fetch the list of warehouses. If not specified, the user
@@ -11152,9 +11072,7 @@ class WarehousesAPI:
     def set_permissions(
         self, warehouse_id: str, *, access_control_list: Optional[List[WarehouseAccessControlRequest]] = None
     ) -> WarehousePermissions:
-        """Set SQL warehouse permissions.
-
-        Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
+        """Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
         permissions if none are specified. Objects can inherit permissions from their root object.
 
         :param warehouse_id: str
@@ -11187,9 +11105,7 @@ class WarehousesAPI:
         security_policy: Optional[SetWorkspaceWarehouseConfigRequestSecurityPolicy] = None,
         sql_configuration_parameters: Optional[RepeatedEndpointConfPairs] = None,
     ):
-        """Set the workspace configuration.
-
-        Sets the workspace level configuration that is shared by all SQL warehouses in a workspace.
+        """Sets the workspace level configuration that is shared by all SQL warehouses in a workspace.
 
         :param channel: :class:`Channel` (optional)
           Optional: Channel selection details
@@ -11243,9 +11159,7 @@ class WarehousesAPI:
         self._api.do("PUT", "/api/2.0/sql/config/warehouses", body=body, headers=headers)
 
     def start(self, id: str) -> Wait[GetWarehouseResponse]:
-        """Start a warehouse.
-
-        Starts a SQL warehouse.
+        """Starts a SQL warehouse.
 
         :param id: str
           Required. Id of the SQL warehouse.
@@ -11266,9 +11180,7 @@ class WarehousesAPI:
         return self.start(id=id).result(timeout=timeout)
 
     def stop(self, id: str) -> Wait[GetWarehouseResponse]:
-        """Stop a warehouse.
-
-        Stops a SQL warehouse.
+        """Stops a SQL warehouse.
 
         :param id: str
           Required. Id of the SQL warehouse.
@@ -11291,9 +11203,7 @@ class WarehousesAPI:
     def update_permissions(
         self, warehouse_id: str, *, access_control_list: Optional[List[WarehouseAccessControlRequest]] = None
     ) -> WarehousePermissions:
-        """Update SQL warehouse permissions.
-
-        Updates the permissions on a SQL warehouse. SQL warehouses can inherit permissions from their root
+        """Updates the permissions on a SQL warehouse. SQL warehouses can inherit permissions from their root
         object.
 
         :param warehouse_id: str