# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Can edit the query.
Can manage the query.
Can run the query.
Can view the query.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
user canceled; can come from explicit cancel call, or timeout with `on_wait_timeout=CANCEL`.
execution successful, and statement closed; result no longer available for fetch.
execution failed; reason for failure described in accomanying error message.
waiting for warehouse.
running.
execution was successful, result data available for fetch.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Alert configuration options.
No description provided by the author
The alerts API can be used to perform CRUD operations on alerts.
The alerts API can be used to perform CRUD operations on alerts.
Describes metadata for a particular chunk, within a result set; this structure is used both within a manifest, and when fetching individual chunk data or links.
Cancel statement execution.
No description provided by the author
Configures the channel name and DBSQL version of the warehouse.
Details about a Channel.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Add visualization to a query.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A JSON representing a dashboard containing widgets of visualizations and text boxes.
No description provided by the author
No description provided by the author
No description provided by the author
In general, there is little need to modify dashboards using the API.
This is an evolving API that facilitates the addition and removal of widgets from existing dashboards within the Databricks Workspace.
A JSON object representing a DBSQL data source / SQL warehouse.
This API is provided to assist you in making new query objects.
No description provided by the author
No description provided by the author
No description provided by the author
The SQL Permissions API is similar to the endpoints of the :method:permissions/set.
Delete an alert.
Remove a dashboard.
Remove widget.
Delete a query.
Remove visualization.
No description provided by the author
Remove a visualization.
Delete a warehouse.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Represents an empty message, similar to google.protobuf.Empty, which is not available in the firm right now.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Get an alert.
Get an alert.
Retrieve a definition.
Get object ACL.
Get a query definition.
Get a query.
No description provided by the author
Get status, manifest, and result first chunk.
Get result chunk by index.
Get SQL warehouse permission levels.
No description provided by the author
Get SQL warehouse permissions.
Get warehouse info.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The visualization description API changes frequently and is unsupported.
List alerts.
No description provided by the author
No description provided by the author
Get dashboard objects.
Get a list of queries.
List queries.
No description provided by the author
List Queries.
No description provided by the author
No description provided by the author
No description provided by the author
List visualizations on a query.
No description provided by the author
List warehouses.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The queries API can be used to perform CRUD operations on queries.
These endpoints are used for CRUD operations on query definitions.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A service responsible for storing and retrieving the list of queries run against SQL endpoints and serverless compute.
No description provided by the author
No description provided by the author
A query metric that encapsulates a set of measurements for a single query.
No description provided by the author
No description provided by the author
No description provided by the author
This is an evolving API that facilitates the addition and removal of visualizations from existing queries in the Databricks Workspace.
This is an evolving API that facilitates the addition and removal of vizualisations from existing queries within the Databricks Workspace.
No description provided by the author
Restore a dashboard.
Restore a query.
No description provided by the author
No description provided by the author
The result manifest provides schema and metadata for the result set.
The schema is an ordered list of column descriptions.
No description provided by the author
Set object ACL.
No description provided by the author
No description provided by the author
No description provided by the author
Start a warehouse.
No description provided by the author
The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL warehouse and fetch the result.
No description provided by the author
No description provided by the author
The status response includes execution state and if relevant, error information.
Stop a warehouse.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Transfer object ownership.
Delete an alert.
Delete a query.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WaitGetWarehouseRunning is a wrapper that calls [WarehousesAPI.WaitGetWarehouseRunning] and waits to reach RUNNING state.
WaitGetWarehouseStopped is a wrapper that calls [WarehousesAPI.WaitGetWarehouseStopped] and waits to reach STOPPED state.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A SQL warehouse is a compute resource that lets you run SQL commands on data objects within Databricks SQL.
No description provided by the author
No description provided by the author
No description provided by the author
Coordinates of this widget on a dashboard.

# Interfaces

No description provided by the author
No description provided by the author
The alerts API can be used to perform CRUD operations on alerts.
The alerts API can be used to perform CRUD operations on alerts.
No description provided by the author
In general, there is little need to modify dashboards using the API.
No description provided by the author
This is an evolving API that facilitates the addition and removal of widgets from existing dashboards within the Databricks Workspace.
No description provided by the author
This API is provided to assist you in making new query objects.
No description provided by the author
The SQL Permissions API is similar to the endpoints of the :method:permissions/set.
No description provided by the author
No description provided by the author
These endpoints are used for CRUD operations on query definitions.
The queries API can be used to perform CRUD operations on queries.
No description provided by the author
A service responsible for storing and retrieving the list of queries run against SQL endpoints and serverless compute.
No description provided by the author
No description provided by the author
This is an evolving API that facilitates the addition and removal of vizualisations from existing queries within the Databricks Workspace.
This is an evolving API that facilitates the addition and removal of visualizations from existing queries in the Databricks Workspace.
No description provided by the author
The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL warehouse and fetch the result.
No description provided by the author
A SQL warehouse is a compute resource that lets you run SQL commands on data objects within Databricks SQL.

# Type aliases

No description provided by the author
State that alert evaluates to when query result is empty.
No description provided by the author
No description provided by the author
The name of the base data type.
Warehouse type: `PRO` or `CLASSIC`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Warehouse type: `PRO` or `CLASSIC`.
Warehouse type: `PRO` or `CLASSIC`.
When `wait_timeout > 0s`, the call will block up to the specified time.
No description provided by the author
Warehouse type: `PRO` or `CLASSIC`.
Security policy for warehouses.
State of the alert.
No description provided by the author
No description provided by the author
A singular noun object type.
Always a plural of the object type.
The singular form of the type of object which can be owned.
Parameters can have several different types.
* `CAN_VIEW`: Can view the query * `CAN_RUN`: Can run the query * `CAN_EDIT`: Can edit the query * `CAN_MANAGE`: Can manage the query.
Possible Reasons for which we have not saved plans in the database.
No description provided by the author
Statuses which are also used by OperationStatus in runtime.
No description provided by the author
Sets the **Run as** role for the object.
No description provided by the author
Security policy for warehouses.
Configurations whether the warehouse should use spot instances.
State of the warehouse.
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.
Health status of the warehouse.
No description provided by the author
status code indicating why the cluster was terminated.
type of the termination.
Permission level.
Warehouse type: `PRO` or `CLASSIC`.