com.databricks.sdk.service.sql

Interface QueriesService

@Generated
public interface QueriesService

The queries API can be used to perform CRUD operations on queries. A query is a Databricks SQL object that includes the target SQL warehouse, query text, name, description, tags, and parameters. Queries can be scheduled using the `sql_task` type of the Jobs API, e.g. :method:jobs/create.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
Query	create(CreateQueryRequest createQueryRequest) Create a query.
void	delete(TrashQueryRequest trashQueryRequest) Delete a query.
Query	get(GetQueryRequest getQueryRequest) Get a query.
ListQueryObjectsResponse	list(ListQueriesRequest listQueriesRequest) List queries.
ListVisualizationsForQueryResponse	listVisualizations(ListVisualizationsForQueryRequest listVisualizationsForQueryRequest) List visualizations on a query.
Query	update(UpdateQueryRequest updateQueryRequest) Update a query.

Method Detail

create

Query create(CreateQueryRequest createQueryRequest)

Create a query.

Creates a query.

delete

void delete(TrashQueryRequest trashQueryRequest)

Delete a query.

Moves a query to the trash. Trashed queries immediately disappear from searches and list views, and cannot be used for alerts. You can restore a trashed query through the UI. A trashed query is permanently deleted after 30 days.

get

Query get(GetQueryRequest getQueryRequest)

Get a query.

Gets a query.

list

ListQueryObjectsResponse list(ListQueriesRequest listQueriesRequest)

List queries.

Gets a list of queries accessible to the user, ordered by creation time. **Warning:** Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban.

listVisualizations

ListVisualizationsForQueryResponse listVisualizations(ListVisualizationsForQueryRequest listVisualizationsForQueryRequest)

List visualizations on a query.

Gets a list of visualizations on a query.

update

Query update(UpdateQueryRequest updateQueryRequest)

Update a query.

Updates a query.