Create a new query definition.
create_query.Rd
Creates a new query definition. Queries created with this endpoint belong to the authenticated user making the request.
Usage
create_query(
client,
data_source_id = NULL,
description = NULL,
name = NULL,
options = NULL,
parent = NULL,
query = NULL,
run_as_role = NULL
)
queriesCreate(
client,
data_source_id = NULL,
description = NULL,
name = NULL,
options = NULL,
parent = NULL,
query = NULL,
run_as_role = NULL
)
Arguments
- client
Required. Instance of DatabricksClient()
- data_source_id
Data source ID maps to the ID of the data source used by the resource and is distinct from the warehouse ID.
- description
General description that conveys additional information about this query such as usage notes.
- name
The title of this query that appears in list views, widget headings, and on the query page.
- options
Exclusively used for storing a list parameter definitions.
- parent
The identifier of the workspace folder containing the object.
- query
The text of the query to be run.
- run_as_role
Sets the Run as role for the object.
Details
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.