쿼리 실행

Prev Next

VPC 환경에서 이용 가능합니다.

쿼리를 실행합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
POST /api/v2/queries

요청 헤더

Data Query API에서 공통으로 사용하는 헤더에 대한 정보는 Data Query 요청 헤더를 참조해 주십시오.

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
query String Required 실행 쿼리문
executionParameters Array Optional 쿼리 실행 파라미터
timeout Integer Optional 쿼리 실행 최대 시간(초)
  • 1~60 (기본값: 20)
isReuse Boolean Optional 쿼리 결과 재사용 여부
  • true | false (기본값)
    • true: 재사용
    • false: 재사용 안 함
reuseMaxAge Integer Conditional 쿼리 결과 재사용 허용 시간(분)
  • 1~10080 (기본값: 60)
  • isReuse가 true인 경우, 필수 입력
  • <예시> 60을 입력한 경우: 쿼리 실행 시점으로부터 60분 전에 반환 가능한 유효 결과 존재 시 해당 결과 재사용
dataSource String Optional 쿼리 실행 데이터 소스 이름
database String Optional 쿼리 실행 데이터베이스 이름
projectId Integer Optional 쿼리 실행 프로젝트 아이디

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://kr.dataquery.naverncp.com/api/v2/queries' \
--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 where currency_code = ? and date > ?",
            "executionParameters": [
                "CNY",
                "2023.01.01"
            ],
            "timeout": 20,
            "isReuse": true,
            "reuseMaxAge": 60
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
id String - 실행 아이디
columns Array - 컬럼 정보: Column
data Array - 쿼리 실행 결과
  • 각 행이 Column의 컬럼 순서와 일대일 매핑된 배열로 반환
  • 복합 타입(row) 컬럼인 경우, {필드명=값} 형태의 문자열로 직렬화
    • 2개 이상 반환 시 쉼표(,)로 구분
offset Long - 페이지 조회 시 사용할 오프셋
  • isFinished가 false인 경우, 다음 페이지 조회 요청에 사용
isFinished Boolean - 전체 페이지 조회 완료 여부
  • true | false
    • true: 완료 (다음 페이지 존재 안 함)
    • false: 미완료 (다음 페이지 존재)

Column

Column에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
name String - 컬럼 이름
type String - 컬럼 타입
typeSignature Object - 컬럼 타입 정보
typeSignature.rawType String - 기본 타입 이름
typeSignature.arguments Array - 타입 파라미터 목록: ClientTypeSignatureParameter

ClientTypeSignatureParameter

ClientTypeSignatureParameter에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
kind String - 타입 파라미터 종류
  • TYPE | NAMED_TYPE | LONG | VARIABLE
value Union - 타입 파라미터 값
  • Object | Number | String
    • Object: kind가 TYPE 또는 NAMED_TYPE인 경우 (복합 타입)
    • Number: kind가 LONG인 경우
    • String: kind가 VARIABLE인 경우
value.fieldName Object - 복합 타입의 필드 이름 객체
value.fieldName.name String - 필드 이름
value.typeSignature Object - 복합 타입의 필드 타입 객체
value.typeSignature.rawType String - 기본 타입 이름
value.typeSignature.arguments Array - 타입 파라미터 목록: ClientTypeSignatureParameter

응답 상태 코드

Data Query API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Data Query 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "id": "fc6b118d-****-****-****-f350f9881f24",
    "columns": [
        {
            "name": "currency_code",
            "type": "varchar",
            "typeSignature": {
                "rawType": "varchar",
                "arguments": [
                    {
                        "kind": "LONG",
                        "value": 2147483647
                    }
                ]
            }
        },
        {
            "name": "date",
            "type": "varchar",
            "typeSignature": {
                "rawType": "varchar",
                "arguments": [
                    {
                        "kind": "LONG",
                        "value": 2147483647
                    }
                ]
            }
        },
        {
            "name": "trade_rate",
            "type": "varchar",
            "typeSignature": {
                "rawType": "varchar",
                "arguments": [
                    {
                        "kind": "LONG",
                        "value": 2147483647
                    }
                ]
            }
        },
        {
            "name": "us_conversion_rate",
            "type": "varchar",
            "typeSignature": {
                "rawType": "varchar",
                "arguments": [
                    {
                        "kind": "LONG",
                        "value": 2147483647
                    }
                ]
            }
        }
    ],
    "data": [
        [
            "CNY",
            "2023.1.9",
            "184.56",
            "0.1456"
        ],
        [
            "CNY",
            "2023.1.17",
            "183.87",
            "0.149"
        ],
        [
            "CNY",
            "2023.1.30",
            "182.33",
            "0.1482"
        ],
        [
            "CNY",
            "2023.2.8",
            "184.89",
            "0.1472"
        ],
        ...
    ],
    "offset": 4845,
    "isFinished": true
}