CLI

Prev Next

VPC環境で利用できます。

Data Queryで提供する CLIの使用方法を説明します。

参考

NAVERクラウドプラットフォームの 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列ずつ上/下に移動
左/右矢印 Columnを左/右に移動
q 結果照会を停止してクエリプロンプトに移動

4. CLI終了

クエリプロンプト上に quitを入力します。

dataquery> quit