Execute Query Lambda By Version

post https://api.{region}.rockset.com/v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions/{version}

Execute a particular version of a Query Lambda.

Path Params

workspace

string

required

Defaults to commons

name of the workspace

queryLambda

string

required

name of the Query Lambda

version

string

required

version

Body Params

JSON object

async

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.)

async_options

object

Options for configuring Asynchronous Query Mode.

debug_threshold_ms

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.

default_row_limit

int32

Row limit to use if no limit specified in the SQL query text.

initial_paginate_response_doc_count

int32

[DEPRECATED] Use max_initial_results instead. Number of documents to return in addition to paginating for this query call. Only relevant if paginate flag is also set.

max_initial_results

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.

paginate

boolean

Flag to paginate and store the results of this query for later / sequential retrieval.

parameters

array of objects

List of named parameters.

parameters

timeout_ms

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.

virtual_instance_id

string

Virtual instance on which to run the query.

Responses

Response body

object

collections

array of strings

List of collections referenced in the query.

collections

column_fields

array of objects

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

column_fields

object

name

string

required

Name of the field.

type

string

required

Data type of the field.

last_offset

string

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

pagination

object

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

current_page_doc_count

int64

Number of documents returned in this result set.

next_cursor

string

Cursor to use to get the list of documents.

next_cursor_offset

int64

The doc offset that next_cursor starts at.

next_page_link

string

Direct link to the next page of results.

start_cursor

string

Cursor used to retrieve the first set of documents.

query_errors

array of objects

Errors encountered while executing the query.

query_errors

object

message

string

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

status_code

int32

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

type

string

The type of error.

query_id

string

Unique ID for this query.

query_lambda_path

string

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

results

array of objects

Results from the query.

results

object

results_total_doc_count

int64

Number of results generated by the query.

stats

object

Meta information about the query including execution latencies.

elapsed_time_ms

int64

Query time in milliseconds.

throttled_time_micros

int64

Time query was throttled by admission control.

status

string

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

QUEUED RUNNING COMPLETED ERROR

warnings

array of strings

warnings

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/versions/version \
3
     --header 'Authorization: ApiKey YOUR_ROCKSET_KEY' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'


xxxxxxxxxx
40
}
1
{
2
  "collections": [
3
    "string"
4
  ],
5
  "column_fields": [
6
    {
7
      "name": "_id",
8
      "type": "string"
9
    }
10
  ],
11
  "last_offset": "string",
12
  "pagination": {
13
    "current_page_doc_count": 1000,
14
    "next_cursor": "testnextcursor",
15
    "next_cursor_offset": 2000,
16
    "next_page_link": "https://api.rs2.usw2.rockset.com/....",
17
    "start_cursor": "startcursor"
18
  },
19
  "query_errors": [
20
    {
21
      "message": "Too many rows",
22
      "status_code": 429,
23
      "type": "ResourceExceeded"
24
    }
25
  ],

200Query Lambda executed successfully

400bad request

401unauthorized

403forbidden

404not found

405not allowed

406not acceptable

408request timeout

409conflict

415not supported

429resource exceeded

500internal error

501not implemented

502bad gateway

503not ready