| Interface | Description |
|---|---|
| AlertsLegacyService |
The alerts API can be used to perform CRUD operations on alerts.
|
| AlertsService |
The alerts API can be used to perform CRUD operations on alerts.
|
| AlertsV2Service |
New version of SQL Alerts
|
| DashboardsService |
In general, there is little need to modify dashboards using the API.
|
| DashboardWidgetsService |
This is an evolving API that facilitates the addition and removal of widgets from existing
dashboards within the Databricks Workspace.
|
| DataSourcesService |
This API is provided to assist you in making new query objects.
|
| DbsqlPermissionsService |
The SQL Permissions API is similar to the endpoints of the :method:permissions/set.
|
| QueriesLegacyService |
These endpoints are used for CRUD operations on query definitions.
|
| QueriesService |
The queries API can be used to perform CRUD operations on queries.
|
| QueryHistoryService |
A service responsible for storing and retrieving the list of queries run against SQL endpoints
and serverless compute.
|
| QueryVisualizationsLegacyService |
This is an evolving API that facilitates the addition and removal of vizualisations from existing
queries within the Databricks Workspace.
|
| QueryVisualizationsService |
This is an evolving API that facilitates the addition and removal of visualizations from existing
queries in the Databricks Workspace.
|
| RedashConfigService |
Redash V2 service for workspace configurations (internal)
|
| StatementExecutionService |
The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL
warehouse and fetch the result.
|
| WarehousesService |
A SQL warehouse is a compute resource that lets you run SQL commands on data objects within
Databricks SQL.
|
| Enum | Description |
|---|---|
| Aggregation | |
| AlertEvaluationState |
UNSPECIFIED - default unspecify value for proto enum, do not use it in the code UNKNOWN - alert
not yet evaluated TRIGGERED - alert is triggered OK - alert is not triggered ERROR - alert
evaluation failed
|
| AlertOperator | |
| AlertOptionsEmptyResultState |
State that alert evaluates to when query result is empty.
|
| AlertState | |
| ChannelName | |
| ColumnInfoTypeName |
The name of the base data type.
|
| ComparisonOperator | |
| CreateWarehouseRequestWarehouseType |
Warehouse type: `PRO` or `CLASSIC`.
|
| DatePrecision | |
| DateRangeValueDynamicDateRange | |
| DateValueDynamicDate | |
| Disposition | |
| EditWarehouseRequestWarehouseType |
Warehouse type: `PRO` or `CLASSIC`.
|
| EndpointInfoWarehouseType |
Warehouse type: `PRO` or `CLASSIC`.
|
| ExecuteStatementRequestOnWaitTimeout |
When `wait_timeout > 0s`, the call will block up to the specified time.
|
| Format | |
| GetWarehouseResponseWarehouseType |
Warehouse type: `PRO` or `CLASSIC`.
|
| GetWorkspaceWarehouseConfigResponseSecurityPolicy |
Security policy for warehouses
|
| LegacyAlertState |
State of the alert.
|
| LifecycleState | |
| ListOrder | |
| ObjectType |
A singular noun object type.
|
| ObjectTypePlural |
Always a plural of the object type.
|
| OwnableObjectType |
The singular form of the type of object which can be owned.
|
| ParameterType |
Parameters can have several different types.
|
| PermissionLevel |
* `CAN_VIEW`: Can view the query * `CAN_RUN`: Can run the query * `CAN_EDIT`: Can edit the query
* `CAN_MANAGE`: Can manage the query
|
| PlansState |
Possible Reasons for which we have not saved plans in the database
|
| QueryStatementType | |
| QueryStatus |
Statuses which are also used by OperationStatus in runtime
|
| RunAsMode | |
| RunAsRole |
Sets the **Run as** role for the object.
|
| SchedulePauseStatus | |
| ServiceErrorCode | |
| SetWorkspaceWarehouseConfigRequestSecurityPolicy |
Security policy for warehouses
|
| SpotInstancePolicy |
Configurations whether the warehouse should use spot instances.
|
| State |
State of the warehouse
|
| StatementState |
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
|
| Status |
Health status of the warehouse.
|
| SuccessMessage | |
| TerminationReasonCode |
status code indicating why the cluster was terminated
|
| TerminationReasonType |
type of the termination
|
| WarehousePermissionLevel |
Permission level
|
| WarehouseTypePairWarehouseType |
Warehouse type: `PRO` or `CLASSIC`.
|
Copyright © 2025. All rights reserved.