Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartQueryPlanning

Submits a request to process a query statement.

This operation generates work units that can be retrieved with the GetWorkUnits operation as soon as the query state is WORKUNITS_AVAILABLE or FINISHED.

Request Syntax


{
   "QueryPlanningContext": { 
      "CatalogId": "string",
      "DatabaseName": "string",
      "QueryAsOfTime": number,
      "QueryParameters": { 
         "string" : "string" 
      },
      "TransactionId": "string"
   },
   "QueryString": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

QueryPlanningContext

A structure containing information about the query plan.

Type: QueryPlanningContext object

Required: Yes

QueryString

A PartiQL query statement used as an input to the planner service.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax


{
   "QueryId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

QueryId

The ID of the plan query operation can be used to fetch the actual work unit descriptors that are produced as the result of the operation. The ID is also used to get the query state and as an input to the Execute operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access to a resource was denied.

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

ThrottledException

Contains details about an error where the query request was throttled.

HTTP Status Code: 400