Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 2.24 KB

File metadata and controls

37 lines (28 loc) · 2.24 KB

QueryResponse

Response body for POST /query Query results are returned immediately along with a result_id for later retrieval. The actual persistence to storage happens asynchronously in the background. To check if a result is ready for SQL queries, poll GET /results/{id} and check status: - \"processing\": Persistence is still in progress - \"ready\": Result is available for retrieval and SQL queries - \"failed\": Persistence failed (check error_message for details)

Properties

Name Type Description Notes
columns List[str]
execution_time_ms int
nullable List[bool] Nullable flags for each column (parallel to columns vec). True if the column allows NULL values, false if NOT NULL.
query_run_id str Unique identifier for the query run record (qrun...).
result_id str Unique identifier for retrieving this result via GET /results/{id}. Null if catalog registration failed (see `warning` field for details). When non-null, the result is being persisted asynchronously. [optional]
row_count int
rows List[List[object]] Array of rows, where each row is an array of column values. Values can be strings, numbers, booleans, or null.
warning str Warning message if result persistence could not be initiated. When present, `result_id` will be null and the result cannot be retrieved later. The query results are still returned in this response. [optional]

Example

from hotdata.models.query_response import QueryResponse

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

# convert the object into a dict
query_response_dict = query_response_instance.to_dict()
# create an instance of QueryResponse from a dict
query_response_from_dict = QueryResponse.from_dict(query_response_dict)

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