| Interface | Description |
|---|---|
| AlertsService |
The alerts API can be used to perform CRUD operations on 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.
|
| QueriesService |
These endpoints are used for CRUD operations on query definitions.
|
| QueryHistoryService |
Access the history of queries through SQL warehouses.
|
| QueryVisualizationsService |
This is an evolving API that facilitates the addition and removal of vizualisations from existing
queries within the Databricks Workspace.
|
| 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.
|
| Class | Description |
|---|---|
| AccessControl | |
| Alert | |
| AlertOptions |
Alert configuration options.
|
| AlertQuery | |
| AlertsAPI |
The alerts API can be used to perform CRUD operations on alerts.
|
| BaseChunkInfo |
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.
|
| CancelExecutionRequest |
Cancel statement execution
|
| CancelExecutionResponse | |
| Channel | |
| ChannelInfo |
Channel information for the SQL warehouse at the time of query execution
|
| ColumnInfo | |
| CreateAlert | |
| CreateQueryVisualizationRequest |
Add visualization to a query
|
| CreateWarehouseRequest | |
| CreateWarehouseResponse | |
| CreateWidget | |
| Dashboard |
A JSON representing a dashboard containing widgets of visualizations and text boxes.
|
| DashboardEditContent | |
| DashboardOptions | |
| DashboardPostContent | |
| DashboardsAPI |
In general, there is little need to modify dashboards using the API.
|
| DashboardWidgetsAPI |
This is an evolving API that facilitates the addition and removal of widgets from existing
dashboards within the Databricks Workspace.
|
| DataSource |
A JSON object representing a DBSQL data source / SQL warehouse.
|
| DataSourcesAPI |
This API is provided to assist you in making new query objects.
|
| DbsqlPermissionsAPI |
The SQL Permissions API is similar to the endpoints of the :method:permissions/set.
|
| DeleteAlertRequest |
Delete an alert
|
| DeleteDashboardRequest |
Remove a dashboard
|
| DeleteDashboardWidgetRequest |
Remove widget
|
| DeleteQueryRequest |
Delete a query
|
| DeleteQueryVisualizationRequest |
Remove visualization
|
| DeleteResponse | |
| DeleteWarehouseRequest |
Delete a warehouse
|
| DeleteWarehouseResponse | |
| EditAlert | |
| EditWarehouseRequest | |
| EditWarehouseResponse | |
| EndpointConfPair | |
| EndpointHealth | |
| EndpointInfo | |
| EndpointTagPair | |
| EndpointTags | |
| ExecuteStatementRequest | |
| ExecuteStatementResponse | |
| ExternalLink | |
| GetAlertRequest |
Get an alert
|
| GetDashboardRequest |
Retrieve a definition
|
| GetDbsqlPermissionRequest |
Get object ACL
|
| GetQueryRequest |
Get a query definition.
|
| GetResponse | |
| GetStatementRequest |
Get status, manifest, and result first chunk
|
| GetStatementResponse | |
| GetStatementResultChunkNRequest |
Get result chunk by index
|
| GetWarehousePermissionLevelsRequest |
Get SQL warehouse permission levels
|
| GetWarehousePermissionLevelsResponse | |
| GetWarehousePermissionsRequest |
Get SQL warehouse permissions
|
| GetWarehouseRequest |
Get warehouse info
|
| GetWarehouseResponse | |
| GetWorkspaceWarehouseConfigResponse | |
| ListDashboardsRequest |
Get dashboard objects
|
| ListQueriesRequest |
Get a list of queries
|
| ListQueriesResponse | |
| ListQueryHistoryRequest |
List Queries
|
| ListResponse | |
| ListWarehousesRequest |
List warehouses
|
| ListWarehousesResponse | |
| MultiValuesOptions |
If specified, allows multiple values to be selected for this parameter.
|
| OdbcParams | |
| Parameter | |
| QueriesAPI |
These endpoints are used for CRUD operations on query definitions.
|
| Query | |
| QueryEditContent | |
| QueryFilter |
A filter to limit query history results.
|
| QueryHistoryAPI |
Access the history of queries through SQL warehouses.
|
| QueryInfo | |
| QueryList | |
| QueryMetrics |
Metrics about query execution.
|
| QueryOptions | |
| QueryPostContent | |
| QueryVisualizationsAPI |
This is an evolving API that facilitates the addition and removal of vizualisations from existing
queries within the Databricks Workspace.
|
| RepeatedEndpointConfPairs | |
| RestoreDashboardRequest |
Restore a dashboard
|
| RestoreQueryRequest |
Restore a query
|
| RestoreResponse | |
| ResultData |
Contains the result data of a single chunk when using `INLINE` disposition.
|
| ResultManifest |
The result manifest provides schema and metadata for the result set.
|
| ResultSchema |
The schema is an ordered list of column descriptions.
|
| ServiceError | |
| SetRequest |
Set object ACL
|
| SetResponse | |
| SetWorkspaceWarehouseConfigRequest | |
| SetWorkspaceWarehouseConfigResponse | |
| StartRequest |
Start a warehouse
|
| StartWarehouseResponse | |
| StatementExecutionAPI |
The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL
warehouse and fetch the result.
|
| StatementParameterListItem | |
| StatementStatus |
The status response includes execution state and if relevant, error information.
|
| StopRequest |
Stop a warehouse
|
| StopWarehouseResponse | |
| Success | |
| TerminationReason | |
| TimeRange | |
| TransferOwnershipObjectId | |
| TransferOwnershipRequest |
Transfer object ownership
|
| UpdateResponse | |
| User | |
| Visualization |
The visualization description API changes frequently and is unsupported.
|
| WarehouseAccessControlRequest | |
| WarehouseAccessControlResponse | |
| WarehousePermission | |
| WarehousePermissions | |
| WarehousePermissionsDescription | |
| WarehousePermissionsRequest | |
| WarehousesAPI |
A SQL warehouse is a compute resource that lets you run SQL commands on data objects within
Databricks SQL.
|
| WarehouseTypePair | |
| Widget | |
| WidgetOptions | |
| WidgetPosition |
Coordinates of this widget on a dashboard.
|
| Enum | Description |
|---|---|
| AlertOptionsEmptyResultState |
State that alert evaluates to when query result is empty.
|
| AlertState |
State of the alert.
|
| ChannelName | |
| ColumnInfoTypeName |
The name of the base data type.
|
| CreateWarehouseRequestWarehouseType |
Warehouse type: `PRO` or `CLASSIC`.
|
| Disposition |
The fetch disposition provides two modes of fetching results: `INLINE` and `EXTERNAL_LINKS`.
|
| 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
|
| 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 |
Whether plans exist for the execution, or the reason why they are missing
|
| QueryStatementType |
Type of statement for this query
|
| QueryStatus |
Query status with one the following values: * `QUEUED`: Query has been received and queued.
|
| RunAsRole |
Sets the **Run as** role for the object.
|
| 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 © 2024. All rights reserved.