Package com.databricks.sdk.service.sql
-
Interface Summary 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.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.StatementExecutionService The SQL Statement Execution API manages the execution of arbitrary SQL statements and the fetching of result data.WarehousesService A SQL warehouse is a compute resource that lets you run SQL commands on data objects within Databricks SQL. -
Class Summary Class Description AccessControl Alert AlertOptions Alert configuration options.AlertsAPI The alerts API can be used to perform CRUD operations on alerts.CancelExecutionRequest Cancel statement executionChannel ChannelInfo Channel information for the SQL warehouse at the time of query executionChunkInfo 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 CreateAlert CreateDashboardRequest Create a dashboard objectCreateWarehouseRequest CreateWarehouseResponse Dashboard A JSON representing a dashboard containing widgets of visualizations and text boxes.DashboardOptions DashboardsAPI In general, there is little need to modify dashboards using the API.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 alertDeleteDashboardRequest Remove a dashboardDeleteQueryRequest Delete a queryDeleteWarehouseRequest Delete a warehouseEditAlert EditWarehouseRequest EndpointConfPair EndpointHealth EndpointInfo EndpointTagPair EndpointTags ExecuteStatementRequest ExecuteStatementResponse ExternalLink GetAlertRequest Get an alertGetDashboardRequest Retrieve a definitionGetDbsqlPermissionRequest Get object ACLGetQueryRequest Get a query definition.GetResponse GetStatementRequest Get status, manifest, and result first chunkGetStatementResponse GetStatementResultChunkNRequest Get result chunk by indexGetWarehouseRequest Get warehouse infoGetWarehouseResponse GetWorkspaceWarehouseConfigResponse ListDashboardsRequest Get dashboard objectsListQueriesRequest Get a list of queriesListQueriesResponse ListQueryHistoryRequest List QueriesListResponse ListWarehousesRequest List warehousesListWarehousesResponse 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 RepeatedEndpointConfPairs RestoreDashboardRequest Restore a dashboardRestoreQueryRequest Restore a queryResultData 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 SetRequest Set object ACLSetResponse SetWorkspaceWarehouseConfigRequest StartRequest Start a warehouseStatementExecutionAPI The SQL Statement Execution API manages the execution of arbitrary SQL statements and the fetching of result data.StatementStatus Status response includes execution state and if relevant, error information.StopRequest Stop a warehouseSuccess TerminationReason TimeRange TransferOwnershipObjectId TransferOwnershipRequest Transfer object ownershipUser Visualization The visualization description API changes frequently and is unsupported.WarehousesAPI A SQL warehouse is a compute resource that lets you run SQL commands on data objects within Databricks SQL.WarehouseTypePair Widget WidgetOptions -
Enum Summary Enum Description AlertState State of the alert.ChannelName ColumnInfoTypeName Name of type (INT, STRUCT, MAP, and so on)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`.Format Statement execution supports three result formats: `JSON_ARRAY` (default), `ARROW_STREAM`, and `CSV`.GetWarehouseResponseWarehouseType Warehouse type: `PRO` or `CLASSIC`.GetWorkspaceWarehouseConfigResponseSecurityPolicy Security policy for warehousesListOrder 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 This describes an enumPlansState Whether plans exist for the execution, or the reason why they are missingQueryStatementType Type of statement for this queryQueryStatus This describes an enumServiceErrorCode SetWorkspaceWarehouseConfigRequestSecurityPolicy Security policy for warehousesSpotInstancePolicy Configurations whether the warehouse should use spot instances.State State of the warehouseStatementState 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 fetchStatus Health status of the warehouse.SuccessMessage TerminationReasonCode status code indicating why the cluster was terminatedTerminationReasonType type of the terminationTimeoutAction When in synchronous mode with `wait_timeout > 0s` it determines the action taken when the timeout is reached:WarehouseType Warehouse type: `PRO` or `CLASSIC`.WarehouseTypePairWarehouseType Warehouse type: `PRO` or `CLASSIC`.