com.databricks.sdk.service.sql

Interface QueriesService

@Generated
public interface QueriesService

These endpoints are used for CRUD operations on query definitions. Query definitions include the target SQL warehouse, query text, name, description, tags, parameters, and visualizations. Queries can be scheduled using the `sql_task` type of the Jobs API, e.g. :method:jobs/create.

**Note**: A new version of the Databricks SQL API will soon be available. [Learn more]

[Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources

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(QueryPostContent queryPostContent) Create a new query definition.
void	delete(DeleteQueryRequest deleteQueryRequest) Delete a query.
Query	get(GetQueryRequest getQueryRequest) Get a query definition.
QueryList	list(ListQueriesRequest listQueriesRequest) Get a list of queries.
void	restore(RestoreQueryRequest restoreQueryRequest) Restore a query.
Query	update(QueryEditContent queryEditContent) Change a query definition.

Method Detail

create

Query create(QueryPostContent queryPostContent)

Create a new query definition.

Creates a new query definition. Queries created with this endpoint belong to the authenticated user making the request.

The `data_source_id` field specifies the ID of the SQL warehouse to run this query against. You can use the Data Sources API to see a complete list of available SQL warehouses. Or you can copy the `data_source_id` from an existing query.

**Note**: You cannot add a visualization until you create the query.

**Note**: A new version of the Databricks SQL API will soon be available. [Learn more]

[Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources

delete

void delete(DeleteQueryRequest deleteQueryRequest)

Delete a query.

Moves a query to the trash. Trashed queries immediately disappear from searches and list views, and they cannot be used for alerts. The trash is deleted after 30 days.

**Note**: A new version of the Databricks SQL API will soon be available. [Learn more]

[Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources

get

Query get(GetQueryRequest getQueryRequest)

Get a query definition.

Retrieve a query object definition along with contextual permissions information about the currently authenticated user.

**Note**: A new version of the Databricks SQL API will soon be available. [Learn more]

[Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources

list

QueryList list(ListQueriesRequest listQueriesRequest)

Get a list of queries.

Gets a list of queries. Optionally, this list can be filtered by a search term.

**Warning**: Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban.

**Note**: A new version of the Databricks SQL API will soon be available. [Learn more]

[Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources

restore

void restore(RestoreQueryRequest restoreQueryRequest)

Restore a query.

Restore a query that has been moved to the trash. A restored query appears in list views and searches. You can use restored queries for alerts.

**Note**: A new version of the Databricks SQL API will soon be available. [Learn more]

[Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources

update

Query update(QueryEditContent queryEditContent)

Change a query definition.

Modify this query definition.

**Note**: You cannot undo this operation.

**Note**: A new version of the Databricks SQL API will soon be available. [Learn more]

[Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources