Uses of Package
com.databricks.sdk.service.sql

Packages that use com.databricks.sdk.service.sql

Package	Description
com.databricks.sdk
com.databricks.sdk.service.sql

Classes in com.databricks.sdk.service.sql used by com.databricks.sdk

Class and Description
AlertsAPI 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.
DashboardsAPI In general, there is little need to modify dashboards using the API.
DashboardsService 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.
DashboardWidgetsService This is an evolving API that facilitates the addition and removal of widgets from existing dashboards within the Databricks Workspace.
DataSourcesAPI This API is provided to assist you in making new query objects.
DataSourcesService 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.
DbsqlPermissionsService The SQL Permissions API is similar to the endpoints of the :method:permissions/set.
QueriesAPI These endpoints are used for CRUD operations on query definitions.
QueriesService These endpoints are used for CRUD operations on query definitions.
QueryHistoryAPI Access the history of queries through SQL warehouses.
QueryHistoryService Access the history of queries through SQL warehouses.
QueryVisualizationsAPI 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 vizualisations from existing queries within the Databricks Workspace.
StatementExecutionAPI The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL warehouse and fetch the result.
StatementExecutionService The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL warehouse and fetch the result.
WarehousesAPI A SQL warehouse is a compute resource that lets you run SQL commands on data objects within Databricks SQL.
WarehousesService A SQL warehouse is a compute resource that lets you run SQL commands on data objects within Databricks SQL.

Classes in com.databricks.sdk.service.sql used by com.databricks.sdk.service.sql

Class and Description
AccessControl
Alert
AlertOptions Alert configuration options.
AlertOptionsEmptyResultState State that alert evaluates to when query result is empty.
AlertQuery
AlertsService The alerts API can be used to perform CRUD operations on alerts.
AlertState State of the alert.
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
Channel
ChannelInfo Channel information for the SQL warehouse at the time of query execution
ChannelName
ColumnInfo
ColumnInfoTypeName The name of the base data type.
CreateAlert
CreateQueryVisualizationRequest Add visualization to a query
CreateWarehouseRequest
CreateWarehouseRequestWarehouseType Warehouse type: `PRO` or `CLASSIC`.
CreateWarehouseResponse
CreateWidget
Dashboard A JSON representing a dashboard containing widgets of visualizations and text boxes.
DashboardEditContent
DashboardOptions
DashboardPostContent
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.
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
DeleteDashboardWidgetRequest Remove widget
DeleteQueryRequest Delete a query
DeleteQueryVisualizationRequest Remove visualization
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
ExecuteStatementRequestOnWaitTimeout When `wait_timeout > 0s`, the call will block up to the specified time.
ExecuteStatementResponse
ExternalLink
Format
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
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
MultiValuesOptions If specified, allows multiple values to be selected for this parameter.
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 * `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
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 Query status with one the following values: * `QUEUED`: Query has been received and queued.
QueryVisualizationsService 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
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.
RunAsRole Sets the **Run as** role for the object.
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 Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL warehouse and fetch the result.
StatementParameterListItem
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 The 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
TimeRange
TransferOwnershipObjectId
TransferOwnershipRequest Transfer object ownership
User
Visualization The visualization description API changes frequently and is unsupported.
WarehouseAccessControlRequest
WarehouseAccessControlResponse
WarehousePermission
WarehousePermissionLevel Permission level
WarehousePermissions
WarehousePermissionsDescription
WarehousePermissionsRequest
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
WidgetPosition Coordinates of this widget on a dashboard.