Translate AtScale inbound query to an outbound data warehouse query, without running the query. This API is protected by license key with name FEATURE_CORTEX. Only supports sql language at this time.

POST 
/v1/public/query/plan

Translate AtScale inbound query to an outbound data warehouse query, without running the query. This API is protected by license key with name FEATURE_CORTEX. Only supports sql language at this time.

Request

Header Parameters

Authorization string

application/json

Body

required

language stringrequired

Possible values: non-empty

query stringrequired

Possible values: non-empty

catalogId stringrequired

Possible values: non-empty

timeout stringrequired

Possible values: non-empty

Responses

200

The query has been successfully planned.

application/json

Schema

Schema

queryId stringrequired

Possible values: non-empty

outboundQuery stringrequired

Possible values: non-empty

Example (from schema)

{
  "queryId": "string",
  "outboundQuery": "string"
}

400

Invalid request for example: Invalid parameters, missing parameters.

401

Unauthorized. This error will occur if calling user is not authenticated.

403

Forbidden. This error will occur if calling user does not have access right for the API.

404

Not found. The server cannot find the requested resource.

500

A server error occurred. Check the logs for more details.

Loading...