Execute SQL Query on a specific Virtual Instance

Make a SQL query to Rockset.

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Virtual Instance RRN

Body Params

JSON object

boolean

If true, the query will run asynchronously for up to 30 minutes. The query request will immediately return with a query id that can be used to retrieve the query status and results. If false or not specified, the query will return with results once completed or timeout after 2 minutes. (To return results directly for shorter queries while still allowing a timeout of up to 30 minutes, set async_options.client_timeout_ms.)

object

Options for configuring Asynchronous Query Mode.

int64

If query execution takes longer than this value, debug information will be logged. If the query text includes the DEBUG hint and this parameter is also provided, only this value will be used and the DEBUG hint will be ignored.

int64

This limits the maximum number of results in the initial response. A pagination cursor is returned if the number of results exceeds max_initial_results. If max_initial_results is not set, all results will be returned in the initial response up to 4 million. If max_initial_results is set, the value must be between 0 and 100,000. If the query is async and client_timeout_ms is exceeded, max_initial_results does not apply since none of the results will be returned with the initial response.

object
required

Main query request body.

int64

If a query exceeds the specified timeout, the query will automatically stop and return an error. The query timeout defaults to a maximum of 2 minutes. If async is true, the query timeout defaults to a maximum of 30 minutes.

Responses

Response body
object
array of strings

List of collections referenced in the query.

collections
array of objects

Meta information about each column in the result set. Not populated in SELECT * queries.

column_fields
object
string
required

Name of the field.

string
required

Data type of the field.

string

If this was a write query, this is the log offset the query was written to.

object

Pagination information. Only populated if paginate is specified in the query request.

int64

Number of documents returned in this result set.

string

Cursor to use to get the list of documents.

int64

The doc offset that next_cursor starts at.

string
string

Cursor used to retrieve the first set of documents.

array of objects

Errors encountered while executing the query.

query_errors
object
string

A message associated with the error, containing more information about it.

int32

The HTTP status code associated with this error, had it been sent as the response status code

string

The type of error.

string

Unique ID for this query.

string

The full path of the executed query lambda. Includes version information.

array of objects

Results from the query.

results
object
int64

Number of results generated by the query.

object

Meta information about the query including execution latencies.

int64

Query time in milliseconds.

int64

Time query was throttled by admission control.

string

Status of query execution. Possible values: QUEUED, RUNNING, COMPLETED, ERROR.

QUEUED RUNNING COMPLETED ERROR

array of strings
warnings

Language
Credentials
URL