Documentation Index

Fetch the complete documentation index at: https://guide.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

CLI

Prev Next

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

Data Query에서 제공하는 CLI 사용 방법을 설명합니다.

참고

네이버 클라우드 플랫폼의 Data Query CLI는 현재 User&Password 인증 방식 외 다른 인증 방식을 지원하지 않습니다.

  • User: 사용자 AccessKey, Password: 사용자 SecretKey 입력을 통해 사용자 인증

준비 사항

CLI를 사용할 환경에 Java 8 이상이 설치되어 있어야 합니다.

사용 방법

Data Query CLI 사용 방법을 설명합니다.

1. 다운로드

Data Query용 CLI 실행 파일을 아래 링크를 통해 다운로드합니다.

dataquery-cli-101-437.zip

참고

Data Query CLI는 오픈소스인 trinodb/trino를 기반으로 합니다. 관련 라이선스 정보는 파일 내 NOTICE 파일을 참조해 주십시오.

2. CLI 실행

다운로드 받은 파일을 아래 사용 방법을 참고하여 실행합니다.

2.1. 기본 사용 방법

dataquery-cli --user $ACCESS_KEY --password --server $DATAQUERY_ENDPOINT
주의

secretKey 정보는 명령어 실행 시 --password 옵션 뒤에 입력하지 않으며, 실행 후 Password: 프롬프트가 표시되면 입력합니다.

주의

Windows 환경에서 CLI를 사용하는 경우, 아래 내용을 주의해 주십시오.

  • 제공되는 cli 바이너리 파일을 java 명령을 통해 실행하거나 아래 별도의 명령어 파일을 생성하여 실행 가능합니다.
  • cli 상에서 쿼리 결과를 페이징하는 pager 설정이 Windows에서는 기본 제공이 아니기 때문에 pager 옵션을 빈문자열로 실행해야 오류(경고) 메시지가 터미널 내에 발생하지 않습니다.
  • 예시는 다음과 같습니다.
    • dataquery-cli.bat 파일
      @echo off
      java -jar dataquery-cli --pager="" %*
      
    • 실행
      dataquery-cli.bat --user {ACCESS_KEY} --password --server {DATAQUERY_ENDPOINT}
      

2.2. 사용 가능한 옵션

dataquery-cli --옵션명 형태로 사용합니다.

옵션명 데이터 타입 입력값 필수 여부 비고
user String 사용자 accessKey Y
password String 사용자 secretKey Y
server String Data Query Endpoint Y 리전별 Data Query Service Endpoint 참고
reuse-query-result Boolean true 또는 false N * default : false
reuse-query-max-age Integer 1 ~ 10,080 N * default : 60
* reuse-query-result 값이 true 인 경우에만 사용됩니다. (단위: 분)

리전별 Data Query Service Endpoint
현재 KR 리전만 사용 가능하며, 리전 확대 예정입니다.

리전 Endpoint
KR https://kr.dataquery.naverncp.com
참고

dataquery-cli는 trino-cli를 기반으로 제공합니다. 위 안내된 옵션 외 추가 내용은 Trino 문서를 참조해 주십시오.

2.3. 쿼리 결과 재사용 옵션을 포함한 사용 방법

<예시> 제출할 쿼리 결과로 최근 1시간 내 동일 요청쿼리를 재사용하도록 CLI 실행

dataquery-cli --user $ACCESS_KEY \
--password \
--server $DATAQUERY_ENDPOINT \
--reuse-query-result \
--reuse-query-max-age 60

3. 쿼리 제출 및 결과 확인

실행된 CLI 쿼리 프롬프트에서 쿼리를 제출하고 결과를 확인합니다.

dataquery> SELECT movieId, COUNT(*) AS ratingCount
        -> FROM public_data.the_movies_dataset.ratings_small
        -> GROUP BY movieId
        -> ORDER BY ratingCount DESC
        -> LIMIT 10;
//결과 예시
 movieId | ratingCount
---------+-------------
     356 |         341
     296 |         324
     318 |         311
     593 |         304
     260 |         291
     480 |         274
    2571 |         259
       1 |         247
     527 |         244
     589 |         237
(10 rows)

Query 20240304_152527_00139_zuari, FINISHED, 3 nodes
Splits: 30 total, 30 done (100.00%)
0.49 [100K rows, 2.33MB] [204K rows/s, 4.75MB/s]
참고

CLI 쿼리 결과 정보가 사용자 터미널 창 크기를 넘어선다면 Pagination이 동작합니다. 아래 입력 키를 참고하여 쿼리 결과를 조회할 수 있습니다.

입력 키 설명
CTRL + f 다음 페이지 이동
CTRL + b 이전 페이지 이동
g 첫 페이지 이동
G 마지막 페이지 이동
상/하 화살표 1개 Row 씩 상/하 이동
좌/우 화살표 Column 좌/우 이동
q 결과 조회를 중지하고 쿼리 프롬프트로 이동

4. CLI 종료

쿼리 프롬프트 상에 quit를 입력합니다.

dataquery> quit