Run query asynchronously

Prev Next

Available in VPC

Run a query asynchronously.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /api/v2/queries/async

Request headers

For information about the headers common to all Data Query APIs, see Data Query request headers.

Request body

You can include the following data in the body of your request:

Field Type Required Description
query String Required Execution query statement
executionParameters Array Optional Query execution parameter
isReuse Boolean Optional Whether to reuse query results
  • true | false
    • true: Reuse
    • false: Not reuse
reuseMaxAge Integer Conditional Time allowed to reuse query results (minute)
  • 1-10080 (default: 60)
  • Required if isReuse is true.
  • e.g., If 60 is entered: Reuse valid results if they were returnable 60 minutes before the query was executed.
dataSource String Optional Query execution data source name
database String Optional Query execution database name

Request example

The request example is as follows:

curl --location --request POST 'https://kr.dataquery.naverncp.com/api/v2/queries/async' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "query": "SELECT * FROM public_data.korea_trade_insurance.exchange_rate",
    "isReuse": false
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
id String - Execution ID
columns Array - Column information
  • [] (valid value when asynchronously executed)
  • Check response result: See Get query result.
data Array - Query execution result
  • [] (valid value when asynchronously executed)
  • Check response result: See Get query result.
offset Long - Offset to use for page query
  • If isFinished is false, use it for the next page query request.
isFinished Boolean - Whether all pages have been queried
  • true | false
    • true: Completed (Next page does not exist.)
    • false: Incomplete (Next page exists.)

Response status codes

For information about the HTTP status codes common to all Data Query APIs, see Data Query response status codes.

Response example

The response example is as follows:

{
    "id": "dc82c8a8-****-****-****-990cb114e172",
    "columns": [],
    "data": [],
    "offset": 0,
    "isFinished": false
}