w.queries: Queries

class databricks.sdk.service.sql.QueriesAPI

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.

create([, auto_resolve_display_name: Optional[bool], query: Optional[CreateQueryRequestQuery]]) → Query

Usage:

import time

from databricks.sdk import WorkspaceClient
from databricks.sdk.service import sql

w = WorkspaceClient()

srcs = w.data_sources.list()

query = w.queries.create(
    query=sql.CreateQueryRequestQuery(
        display_name=f"sdk-{time.time_ns()}",
        warehouse_id=srcs[0].warehouse_id,
        description="test query from Go SDK",
        query_text="SELECT 1",
    )
)

# cleanup
w.queries.delete(id=query.id)

Creates a query.

Parameters:

• auto_resolve_display_name – bool (optional) If true, automatically resolve query display name conflicts. Otherwise, fail the request if the query’s display name conflicts with an existing query’s display name.

• query – CreateQueryRequestQuery (optional)

Returns:

Query

delete(id: str)

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.

Parameters:

id – str

get(id: str) → Query

Usage:

import time

from databricks.sdk import WorkspaceClient
from databricks.sdk.service import sql

w = WorkspaceClient()

srcs = w.data_sources.list()

query = w.queries.create(
    query=sql.CreateQueryRequestQuery(
        display_name=f"sdk-{time.time_ns()}",
        warehouse_id=srcs[0].warehouse_id,
        description="test query from Go SDK",
        query_text="SHOW TABLES",
    )
)

by_id = w.queries.get(id=query.id)

# cleanup
w.queries.delete(id=query.id)

Gets a query.

Parameters:

id – str

Returns:

Query

list([, page_size: Optional[int], page_token: Optional[str]]) → Iterator[ListQueryObjectsResponseQuery]

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.

Parameters:

• page_size – int (optional)

• page_token – str (optional)

Returns:

Iterator over ListQueryObjectsResponseQuery

list_visualizations(id: str [, page_size: Optional[int], page_token: Optional[str]]) → Iterator[Visualization]

Gets a list of visualizations on a query.

Parameters:

• id – str

• page_size – int (optional)

• page_token – str (optional)

Returns:

Iterator over Visualization

update(id: str, update_mask: str [, auto_resolve_display_name: Optional[bool], query: Optional[UpdateQueryRequestQuery]]) → Query

Usage:

import time

from databricks.sdk import WorkspaceClient
from databricks.sdk.service import sql

w = WorkspaceClient()

srcs = w.data_sources.list()

query = w.queries.create(
    query=sql.CreateQueryRequestQuery(
        display_name=f"sdk-{time.time_ns()}",
        warehouse_id=srcs[0].warehouse_id,
        description="test query from Go SDK",
        query_text="SHOW TABLES",
    )
)

updated = w.queries.update(
    id=query.id,
    query=sql.UpdateQueryRequestQuery(
        display_name=f"sdk-{time.time_ns()}",
        description="UPDATED: test query from Go SDK",
        query_text="SELECT 2+2",
    ),
    update_mask="display_name,description,query_text",
)

# cleanup
w.queries.delete(id=query.id)

Updates a query.

Parameters:

• id – str

• update_mask –

  str The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (.) to navigate sub-fields (e.g., author.given_name). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.

  A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the future.

• auto_resolve_display_name – bool (optional) If true, automatically resolve alert display name conflicts. Otherwise, fail the request if the alert’s display name conflicts with an existing alert’s display name.

• query – UpdateQueryRequestQuery (optional)

Returns:

Query