com.databricks.sdk.service.sql

Class QueriesAPI

java.lang.Object

com.databricks.sdk.service.sql.QueriesAPI

@Generated
public class QueriesAPI
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
QueriesAPI(ApiClient apiClient) Regular-use constructor
QueriesAPI(QueriesService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
Query	create(CreateQueryRequest request) Create a query.
void	delete(String id)
void	delete(TrashQueryRequest request) Delete a query.
Query	get(GetQueryRequest request) Get a query.
Query	get(String id)
QueriesService	impl()
Iterable<ListQueryObjectsResponseQuery>	list(ListQueriesRequest request) List queries.
Iterable<Visualization>	listVisualizations(ListVisualizationsForQueryRequest request) List visualizations on a query.
Iterable<Visualization>	listVisualizations(String id)
Query	update(String id, String updateMask)
Query	update(UpdateQueryRequest request) Update a query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueriesAPI

public QueriesAPI(ApiClient apiClient)

Regular-use constructor

QueriesAPI

public QueriesAPI(QueriesService mock)

Constructor for mocks

Method Detail

create

public Query create(CreateQueryRequest request)

Create a query.

Creates a query.

delete

public void delete(String id)

delete

public void delete(TrashQueryRequest request)

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

public Query get(String id)

get

public Query get(GetQueryRequest request)

Get a query.

Gets a query.

list

public Iterable<ListQueryObjectsResponseQuery> list(ListQueriesRequest request)

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

public Iterable<Visualization> listVisualizations(String id)

listVisualizations

public Iterable<Visualization> listVisualizations(ListVisualizationsForQueryRequest request)

List visualizations on a query.

Gets a list of visualizations on a query.

update

public Query update(String id,
                    String updateMask)

update

public Query update(UpdateQueryRequest request)

Update a query.

Updates a query.

impl

public QueriesService impl()