| AccessControl |
|
| Alert |
|
| AlertOptions |
Alert configuration options.
|
| AlertQuery |
|
| AlertsService |
The alerts API can be used to perform CRUD operations on alerts.
|
| AlertState |
State of the alert.
|
| CancelExecutionRequest |
Cancel statement execution
|
| Channel |
|
| ChannelInfo |
Channel information for the SQL warehouse at the time of query execution
|
| ChannelName |
Name of the channel
|
| ChunkInfo |
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.
|
| ColumnInfo |
|
| ColumnInfoTypeName |
Name of type (INT, STRUCT, MAP, and so on)
|
| CreateAlert |
|
| CreateDashboardRequest |
Create a dashboard object
|
| CreateWarehouseRequest |
|
| CreateWarehouseRequestWarehouseType |
Warehouse type: `PRO` or `CLASSIC`.
|
| CreateWarehouseResponse |
|
| Dashboard |
A JSON representing a dashboard containing widgets of visualizations and text boxes.
|
| DashboardOptions |
|
| DashboardsService |
In general, there is little need to modify dashboards using the API.
|
| DataSource |
A JSON object representing a DBSQL data source / SQL warehouse.
|
| 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.
|
| DeleteAlertRequest |
Delete an alert
|
| DeleteDashboardRequest |
Remove a dashboard
|
| DeleteQueryRequest |
Delete a query
|
| DeleteWarehouseRequest |
Delete a warehouse
|
| Disposition |
The fetch disposition provides two modes of fetching results: `INLINE` and `EXTERNAL_LINKS`.
|
| EditAlert |
|
| EditWarehouseRequest |
|
| EditWarehouseRequestWarehouseType |
Warehouse type: `PRO` or `CLASSIC`.
|
| EndpointConfPair |
|
| EndpointHealth |
|
| EndpointInfo |
|
| EndpointInfoWarehouseType |
Warehouse type: `PRO` or `CLASSIC`.
|
| EndpointTagPair |
|
| EndpointTags |
|
| ExecuteStatementRequest |
|
| ExecuteStatementResponse |
|
| ExternalLink |
|
| Format |
Statement execution supports three result formats: `JSON_ARRAY` (default), `ARROW_STREAM`, and
`CSV`.
|
| 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
|
| GetWarehouseRequest |
Get warehouse info
|
| GetWarehouseResponse |
|
| GetWarehouseResponseWarehouseType |
Warehouse type: `PRO` or `CLASSIC`.
|
| GetWorkspaceWarehouseConfigResponse |
|
| GetWorkspaceWarehouseConfigResponseSecurityPolicy |
Security policy for warehouses
|
| ListDashboardsRequest |
Get dashboard objects
|
| ListOrder |
|
| ListQueriesRequest |
Get a list of queries
|
| ListQueriesResponse |
|
| ListQueryHistoryRequest |
List Queries
|
| ListResponse |
|
| ListWarehousesRequest |
List warehouses
|
| ListWarehousesResponse |
|
| ObjectType |
A singular noun object type.
|
| ObjectTypePlural |
Always a plural of the object type.
|
| OdbcParams |
|
| OwnableObjectType |
The singular form of the type of object which can be owned.
|
| Parameter |
|
| ParameterType |
Parameters can have several different types.
|
| PermissionLevel |
This describes an enum
|
| PlansState |
Whether plans exist for the execution, or the reason why they are missing
|
| QueriesService |
These endpoints are used for CRUD operations on query definitions.
|
| Query |
|
| QueryEditContent |
|
| QueryFilter |
A filter to limit query history results.
|
| QueryHistoryService |
Access the history of queries through SQL warehouses.
|
| QueryInfo |
|
| QueryList |
|
| QueryMetrics |
Metrics about query execution.
|
| QueryOptions |
|
| QueryPostContent |
|
| QueryStatementType |
Type of statement for this query
|
| QueryStatus |
This describes an enum
|
| RepeatedEndpointConfPairs |
|
| RestoreDashboardRequest |
Restore a dashboard
|
| RestoreQueryRequest |
Restore a query
|
| ResultData |
Result data chunks are delivered in either the `chunk` field when using `INLINE` disposition, or
in the `external_link` field when using `EXTERNAL_LINKS` disposition.
|
| ResultManifest |
The result manifest provides schema and metadata for the result set.
|
| ResultSchema |
Schema is an ordered list of column descriptions.
|
| ServiceError |
|
| ServiceErrorCode |
|
| SetRequest |
Set object ACL
|
| SetResponse |
|
| SetWorkspaceWarehouseConfigRequest |
|
| SetWorkspaceWarehouseConfigRequestSecurityPolicy |
Security policy for warehouses
|
| SpotInstancePolicy |
Configurations whether the warehouse should use spot instances.
|
| StartRequest |
Start a warehouse
|
| State |
State of the warehouse
|
| StatementExecutionService |
The SQL Statement Execution API manages the execution of arbitrary SQL statements and the
fetching of result data.
|
| 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
|
| StatementStatus |
Status response includes execution state and if relevant, error information.
|
| Status |
Health status of the warehouse.
|
| StopRequest |
Stop a warehouse
|
| Success |
|
| SuccessMessage |
|
| TerminationReason |
|
| TerminationReasonCode |
status code indicating why the cluster was terminated
|
| TerminationReasonType |
type of the termination
|
| TimeoutAction |
When in synchronous mode with `wait_timeout > 0s` it determines the action taken when the timeout
is reached:
|
| TimeRange |
|
| TransferOwnershipObjectId |
|
| TransferOwnershipRequest |
Transfer object ownership
|
| User |
|
| Visualization |
The visualization description API changes frequently and is unsupported.
|
| WarehousesService |
A SQL warehouse is a compute resource that lets you run SQL commands on data objects within
Databricks SQL.
|
| WarehouseTypePair |
|
| WarehouseTypePairWarehouseType |
Warehouse type: `PRO` or `CLASSIC`.
|
| Widget |
|
| WidgetOptions |
|