Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 2.07 KB

QueryRequest.md

File metadata and controls

36 lines (27 loc) · 2.07 KB

QueryRequest

Request body for POST /query

Properties

Name Type Description Notes
var_async bool Run the query in the background and return a query run ID right away. Poll `GET /v1/query-runs/{id}` for its status. [optional] [default to False]
async_after_ms int With `async: true`, wait up to this many milliseconds for the result before falling back to a query run ID. Must be between 1000 and 30000. [optional]
database_id str ID of the database to query. Use this or the `X-Database-Id` header; if both are set they must match, or the request fails with 400. [optional]
default_catalog str Catalog that unqualified table names resolve to. Defaults to the database's default catalog; an unknown catalog fails with 400. [optional]
default_schema str Schema that unqualified table names resolve to. Defaults to the database's `default_schema`; a schema that does not exist makes unqualified tables fail with "table not found". [optional]
dialect str SQL dialect of `sql`: `hotsql` (default), `duckdb`, `postgres`, `snowflake` or `clickhouse`. Other dialects are translated to HotSQL before the query runs. [optional]
sql str

Example

from hotdata.models.query_request import QueryRequest

# TODO update the JSON string below
json = "{}"
# create an instance of QueryRequest from a JSON string
query_request_instance = QueryRequest.from_json(json)
# print the JSON string representation of the object
print(QueryRequest.to_json())

# convert the object into a dict
query_request_dict = query_request_instance.to_dict()
# create an instance of QueryRequest from a dict
query_request_from_dict = QueryRequest.from_dict(query_request_dict)

[Back to Model list] [Back to API list] [Back to README]