MaxCompute クライアントのインストールと起動 - - Alibaba Cloud ドキュメントセンター

MaxCompute クライアント (odpscmd) はご利用のローカルコンピューター上で動作し、コマンドを実行して MaxCompute サービスを管理するためのシンプルかつ効率的な方法です。本トピックでは、MaxCompute クライアントのインストールおよび起動方法について説明します。正常に起動できた場合、MaxCompute プロジェクトへの接続が完了しています。

注意事項

バージョン互換性
- v0.28.0 以降では、MaxCompute クライアントは JDK 1.9 をサポートしています。v0.28.0 より前のバージョンは JDK 1.8 のみをサポートしています。クライアントをインストール後、コマンドラインインターフェイス (CLI) でクライアントのバージョンを確認できます。
エンコーディング: クライアントはデフォルトで UTF-8 エンコーディングを使用します。ご利用のローカル環境が異なるエンコーディングを使用している場合、クエリ結果やアップロードされたファイル内の中国語文字が文字化けすることがあります。これは、MaxCompute テーブルをクエリする際や、Tunnel コマンドでローカルのデータファイルをアップロードする際に発生する可能性があります。

odpscmd のインストールと構成

v0.27.0 以降、odpscmd は MaxCompute V2.0 データの型をサポートしています。サポートされているデータの型の完全なリストについては、「MaxCompute V2.0 データの型」をご参照ください。

GitHub からMaxCompute クライアントパッケージをダウンロードします。リリースページから最新の odpscmd_public.zip をダウンロードしてください。

GitHub のリンクにアクセスできない場合は、代わりに OSS からパッケージをダウンロードしてください。
パッケージを展開します。展開後のディレクトリには、bin、conf、lib、および plugins の 4 つのフォルダが含まれています。

conf フォルダ内で odps_config.ini を開き、以下のパラメーターを構成します。このファイルではコメントに # を使用します。以下の表に各パラメーターの説明を示します。

パラメーター	必須	説明	例
`project_name`	はい	アクセスする MaxCompute プロジェクトです。ワークスペースが標準モードの場合、本番プロジェクト名と開発プロジェクト名 (`_dev`) を区別する必要があります。プロジェクト名を確認するには、MaxCompute コンソールにログインし、ご利用のリージョンを選択した後、[構成の管理] > [プロジェクト] に移動します。「ワークスペースモードの違い」をご参照ください。	`doc_test_dev`
`access_id`	はい	Alibaba Cloud アカウントまたは RAM ユーザーの AccessKey ID です。AccessKey 管理ページから取得できます。	—
`access_key`	はい	AccessKey ID に対応する AccessKey Secret です。	—
`end_point`	はい	MaxCompute サービスのエンドポイントです。ご利用のプロジェクトのリージョンおよびネットワークタイプに基づいて設定してください。リージョンおよびネットワークごとのエンドポイントについては、「エンドポイント」をご参照ください。これは Tunnel エンドポイントではなく、MaxCompute エンドポイントである必要があります。エンドポイントが正しくない場合、接続エラーが発生します。	`http://service.cn-hangzhou.maxcompute.aliyun.com/api`
`log_view_host`	いいえ	ジョブのランタイム情報を表示し、失敗時のトラブルシューティングを行うための LogView URL です。このパラメーターの設定を推奨します。設定しない場合、ジョブが失敗した際に問題を迅速に特定できません。固定値：`http://logview.odps.aliyun.com`。	`http://logview.odps.aliyun.com`
`https_check`	いいえ	リクエストに HTTPS を使用するかどうかを指定します。`True` または `False`。デフォルト：`False`。	`True`
`data_size_confirm`	いいえ	入力データの最大サイズ (単位：GB) です。制限はありません。推奨値：`100`。	`100`
`update_url`	いいえ	予約済みパラメーターです。空欄のままにしてください。	—
`use_instance_tunnel`	いいえ	InstanceTunnel を使用して SQL クエリ結果をダウンロードするかどうかを指定します。`True` または `False`。デフォルト：`False`。	`True`
`instance_tunnel_max_record`	いいえ	`use_instance_tunnel` が `True` の場合に返される SQL クエリ結果の最大レコード数です。最大値：`10000`。	`10000`
`tunnel_endpoint`	いいえ	Tunnel サービスのパブリックエンドポイントです。設定しない場合、Tunnel は MaxCompute エンドポイントのリージョンおよびネットワークに基づいて自動的にルートされます。設定した場合、Tunnel はそのエンドポイントを使用し、自動ルートを行いません。リージョンおよびネットワークごとの Tunnel エンドポイントについては、「エンドポイント」をご参照ください。	`http://dt.cn-hangzhou.maxcompute.aliyun.com`
`set.<key>`	いいえ	MaxCompute プロジェクトのプロパティを設定します。利用可能なプロパティについては、「プロパティ一覧」をご参照ください。	`set.odps.sql.decimal.odps2=true`

MaxCompute クライアントの起動

方法 1：スクリプトをダブルクリック

インストールディレクトリの bin フォルダで：

Windows：odpscmd.bat をダブルクリックします。
macOS：odpscmd をダブルクリックします。

クライアントが正常に起動・接続されると、確認メッセージが表示されます。

方法 2：コマンドラインから実行

コマンドラインウィンドウで bin フォルダに移動し、次のコマンドを実行します。

Windows：odpscmd
Linux または macOS：sh odpscmd
Ubuntu：./odpscmd（Ubuntu では sh odpscmd を実行するとエラーが返されます）

クライアントが正常に起動・接続されると、確認メッセージが表示されます。

コマンドラインから起動する際、起動パラメーターを渡すことで直接コマンドを実行できます。「起動パラメーター」をご参照ください。

次のステップ

MaxCompute プロジェクト内にテーブルを作成します。
データをインポートし、ファイルや JAR パッケージなどのリソースをアップロードします。

:MaxCompute クライアントのインストールとログイン