com.databricks.sdk.service.sql

Class QueriesLegacyAPI

java.lang.Object

com.databricks.sdk.service.sql.QueriesLegacyAPI

@Generated
public class QueriesLegacyAPI
extends Object

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 is now available. Please see the latest version. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

Constructor Summary

Constructors

Constructor and Description
QueriesLegacyAPI(ApiClient apiClient) Regular-use constructor
QueriesLegacyAPI(QueriesLegacyService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
LegacyQuery	create(QueryPostContent request) Create a new query definition.
void	delete(DeleteQueriesLegacyRequest request) Delete a query.
void	delete(String queryId)
LegacyQuery	get(GetQueriesLegacyRequest request) Get a query definition.
LegacyQuery	get(String queryId)
QueriesLegacyService	impl()
Iterable<LegacyQuery>	list(ListQueriesLegacyRequest request) Get a list of queries.
void	restore(RestoreQueriesLegacyRequest request) Restore a query.
void	restore(String queryId)
LegacyQuery	update(QueryEditContent request) Change a query definition.
LegacyQuery	update(String queryId)

Methods inherited from class java.lang.Object

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

Constructor Detail

QueriesLegacyAPI

public QueriesLegacyAPI(ApiClient apiClient)

Regular-use constructor

QueriesLegacyAPI

public QueriesLegacyAPI(QueriesLegacyService mock)

Constructor for mocks

Method Detail

create

public LegacyQuery create(QueryPostContent request)

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 is now available. Please use :method:queries/create instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

delete

public void delete(String queryId)

delete

public void delete(DeleteQueriesLegacyRequest request)

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 is now available. Please use :method:queries/delete instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

get

public LegacyQuery get(String queryId)

get

public LegacyQuery get(GetQueriesLegacyRequest request)

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 is now available. Please use :method:queries/get instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

list

public Iterable<LegacyQuery> list(ListQueriesLegacyRequest request)

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 is now available. Please use :method:queries/list instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

restore

public void restore(String queryId)

restore

public void restore(RestoreQueriesLegacyRequest request)

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 is now available. Please see the latest version. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

update

public LegacyQuery update(String queryId)

update

public LegacyQuery update(QueryEditContent request)

Change a query definition.

Modify this query definition.

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

**Note**: A new version of the Databricks SQL API is now available. Please use :method:queries/update instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

impl

public QueriesLegacyService impl()