使用限制

MaxCompute客戶端從v0.28.0版開(kāi)始支持JDK 1.9，v0.28.0以下版本只支持JDK 1.8。您可以啟動(dòng)MaxCompute客戶端后，在命令行界面查看客戶端版本號(hào)。更多啟動(dòng)客戶端操作，請(qǐng)參見(jiàn)運(yùn)行MaxCompute客戶端。

費(fèi)用說(shuō)明

使用MaxCompute客戶端連接項(xiàng)目不收費(fèi)，但是通過(guò)客戶端執(zhí)行的操作可能會(huì)觸發(fā)MaxComput計(jì)費(fèi)。例如，當(dāng)您使用客戶端提交一個(gè)SQL查詢和寫(xiě)入命令，此SQL命令在MaxCompute上運(yùn)行會(huì)消耗計(jì)算資源，同時(shí)寫(xiě)入數(shù)據(jù)會(huì)占用存儲(chǔ)空間，將產(chǎn)生計(jì)算費(fèi)用和存儲(chǔ)費(fèi)用。MaxCompute計(jì)費(fèi)詳情請(qǐng)參見(jiàn)計(jì)費(fèi)項(xiàng)與計(jì)費(fèi)方式概述。

注意事項(xiàng)

• MaxCompute客戶端的輸出格式不承諾向前兼容，不同版本間的客戶端命令格式及行為有差異，請(qǐng)勿依賴客戶端的輸出格式執(zhí)行任何解析工作。更多客戶端版本，請(qǐng)參見(jiàn)aliyun-odps-console。

• 當(dāng)您通過(guò)MaxCompute客戶端首次執(zhí)行tunnel download命令時(shí)，MaxCompute客戶端會(huì)為您在當(dāng)前設(shè)備的客戶端安裝目錄plugins/dship下創(chuàng)建一個(gè)session文件夾，用于存放日志。如果多名用戶共用同一設(shè)備執(zhí)行tunnel download命令時(shí)，為確保數(shù)據(jù)安全，可以通過(guò)如下方式解決該問(wèn)題：

  • 通過(guò)設(shè)備自身的文件夾權(quán)限管理功能，管控session文件夾權(quán)限。

  • 在tunnel download命令中添加-sd <新session文件夾名稱>或-session-dir <新session文件夾名稱>參數(shù)，將數(shù)據(jù)下載至其他session文件夾。更多tunnel download命令信息，請(qǐng)參見(jiàn)Download。

• MaxCompute客戶端的命令行使用兩個(gè)減號(hào)（--）作為注釋。

• 客戶端默認(rèn)編碼為UTF-8，因此您需要注意您本機(jī)的環(huán)境編碼。若本機(jī)環(huán)境編碼不是UTF-8，則當(dāng)您通過(guò)客戶端查詢MaxCompute表數(shù)據(jù)返回值有中文可能會(huì)出現(xiàn)亂碼或者您通過(guò)客戶端執(zhí)行Tunnel命令上傳本地?cái)?shù)據(jù)文件到MaxCompute，也可能會(huì)出現(xiàn)中文亂碼。

安裝并配置MaxCompute客戶端

安裝并配置MaxCompute客戶端的操作流程如下：

1. 下載MaxCompute客戶端安裝包（Github）。

   說(shuō)明

   • 您可以通過(guò)上方鏈接進(jìn)入客戶端發(fā)布界面，下載最新版本的MaxCompute客戶端安裝包（odpscmd_public.zip）。

   • 如果上方鏈接無(wú)法下載，您可以嘗試單擊此處的odpscmd_public_0.48.0進(jìn)行下載。更多關(guān)于Github鏈接訪問(wèn)失敗的問(wèn)題，推薦您直接在搜索引擎中查找相關(guān)解決方案。

2. 解壓下載的安裝包文件，得到bin、conf、lib和plugins文件夾。

3. 進(jìn)入conf文件夾，配置odps_config.ini文件。

   odps_config.ini文件中使用井號(hào)（#）作為注釋。參數(shù)說(shuō)明如下。

   參數(shù)	是否必填	描述	示例
   project_name	是	訪問(wèn)的目標(biāo)MaxCompute項(xiàng)目名稱。 如果您創(chuàng)建了標(biāo)準(zhǔn)模式的工作空間，在配置project_name時(shí)，請(qǐng)注意區(qū)分生產(chǎn)環(huán)境與開(kāi)發(fā)環(huán)境（_dev）的項(xiàng)目名稱，請(qǐng)參見(jiàn)必讀：簡(jiǎn)單模式和標(biāo)準(zhǔn)模式的區(qū)別。 您可以登錄MaxCompute控制臺(tái)，在工作區(qū)> 項(xiàng)目管理頁(yè)面獲取MaxCompute項(xiàng)目名稱。	doc_test_dev
   access_id	是	阿里云賬號(hào)或RAM用戶的AccessKey ID。 您可以進(jìn)入AccessKey管理頁(yè)面獲取AccessKey ID。	無(wú)
   access_key	是	AccessKey ID對(duì)應(yīng)的AccessKey Secret。 您可以進(jìn)入AccessKey管理頁(yè)面獲取AccessKey Secret。	無(wú)
   end_point	是	MaxCompute服務(wù)的連接地址。 您需要根據(jù)創(chuàng)建MaxCompute項(xiàng)目時(shí)選擇的地域以及網(wǎng)絡(luò)連接方式配置Endpoint。各地域及網(wǎng)絡(luò)對(duì)應(yīng)的Endpoint值，請(qǐng)參見(jiàn)Endpoint。 重要 Endpoint用于MaxCompute服務(wù)，Tunnel Endpoint用于MaxCompute的Tunnel服務(wù)，此處請(qǐng)?zhí)顚?xiě)Endpoint。 如果Endpoint配置有誤，會(huì)出現(xiàn)無(wú)法訪問(wèn)錯(cuò)誤，請(qǐng)務(wù)必仔細(xì)確認(rèn)。	http://service.cn-hangzhou.maxcompute.aliyun.com/api
   log_view_host	否	Logview地址。您可以通過(guò)該地址查看作業(yè)的詳細(xì)運(yùn)行信息，并為報(bào)錯(cuò)處理提供依據(jù)。固定取值為：http://logview.odps.aliyun.com。 說(shuō)明 推薦您配置該參數(shù)，如果不配置該參數(shù)，在作業(yè)報(bào)錯(cuò)時(shí)無(wú)法快速定位問(wèn)題。	http://logview.odps.aliyun.com
   https_check	否	是否開(kāi)啟HTTPS訪問(wèn)機(jī)制，對(duì)訪問(wèn)MaxCompute項(xiàng)目的請(qǐng)求進(jìn)行加密。取值范圍如下： True：采用HTTPS機(jī)制。 False：采用HTTP機(jī)制。 默認(rèn)值為False。	True
   data_size_confirm	否	輸入數(shù)據(jù)量的最大值，單位為GB。取值范圍無(wú)限制。推薦設(shè)置為100 GB。	100
   update_url	否	預(yù)留參數(shù)，暫無(wú)需關(guān)注。	無(wú)
   use_instance_tunnel	否	是否使用InstanceTunnel下載SQL執(zhí)行結(jié)果。取值范圍如下： True：使用InstanceTunnel下載SQL執(zhí)行結(jié)果。 False：不使用InstanceTunnel下載SQL執(zhí)行結(jié)果。 默認(rèn)值為False。	True
   instance_tunnel_max_record	否	客戶端返回的SQL執(zhí)行結(jié)果的最大記錄數(shù)。如果use_instance_tunnel值為True，需要配置該參數(shù)。最大值為10000。	10000
   tunnel_endpoint	否	Tunnel服務(wù)的公網(wǎng)訪問(wèn)鏈接。如果您未配置Tunnel Endpoint，Tunnel會(huì)自動(dòng)路由到MaxCompute服務(wù)所在網(wǎng)絡(luò)對(duì)應(yīng)的Tunnel Endpoint。如果您配置了Tunnel Endpoint，則以配置為準(zhǔn)，不進(jìn)行自動(dòng)路由。 各地域及網(wǎng)絡(luò)對(duì)應(yīng)的Tunnel Endpoint值，請(qǐng)參見(jiàn)Endpoint。	http://dt.cn-hangzhou.maxcompute.aliyun.com
   set.<key>	否	設(shè)置MaxCompute項(xiàng)目的屬性。 更多屬性信息，請(qǐng)參見(jiàn)屬性列表。	set.odps.sql.decimal.odps2=true

   說(shuō)明

   請(qǐng)確保上述信息配置正確，若信息配置錯(cuò)誤，會(huì)導(dǎo)致項(xiàng)目連接失敗。

運(yùn)行MaxCompute客戶端

MaxCompute客戶端相關(guān)操作

...\odpscmd\bin>odpscmd -h

odps@project_name>whoami;

odps@project_name>quit;
--等價(jià)于如下命令。
odps@project_name>q;

下一步

登錄MaxCompute客戶端后，即可在MaxCompute項(xiàng)目?jī)?nèi)執(zhí)行SQL命令，請(qǐng)參見(jiàn)通過(guò)客戶端使用MaxCompute。

常見(jiàn)報(bào)錯(cuò)

配置完odps_config.ini文件后啟動(dòng)MaxCompute客戶端，常見(jiàn)報(bào)錯(cuò)如下：

參考：?jiǎn)?dòng)參數(shù)

Usage: odpscmd [OPTION]...
where options include:
    --help                                  (-h)for help
    --config=<config_file>                  specify another config file
    --project=<prj_name>                    use project
    --endpoint=<http://host:port>           set endpoint
    -k <n>                                  will skip begining queries and start from specified position
    -r <n>                                  set retry times
    -f <"file_path;">                       execute command in file
    -e <"command;[command;]...">            execute command, include sql command

在Shell（或Windows命令行）執(zhí)行窗口，用戶可能需要使用odpscmd -e <SQL語(yǔ)句>執(zhí)行得到的動(dòng)態(tài)返回值，Shell的變量會(huì)獲取這個(gè)動(dòng)態(tài)返回值，然后在Shell中執(zhí)行后續(xù)作業(yè)。此場(chǎng)景需要返回值不包含運(yùn)行信息、表頭等額外信息。為便于Shell調(diào)用，您需要配置odps_config.ini文件中的use_instance_tunnel參數(shù)值為false，關(guān)閉Instance Tunnel服務(wù)。然后執(zhí)行set odps.sql.select.output.format={"needHeader":false,"fieldDelim":" "}; 命令，關(guān)閉表頭顯示。

--Windows命令行執(zhí)行窗口運(yùn)行命令如下。
...\odpscmd\bin>odpscmd -e "set odps.sql.select.output.format={""needHeader"":false,""fieldDelim"":"" ""};select * from noheader;" >D:\test.txt
--返回結(jié)果會(huì)保存在D:\test.txt中。

--Shell執(zhí)行窗口運(yùn)行命令如下。
/Users/.../odpscmd/bin/odpscmd -e "set odps.sql.select.output.format={\"needHeader\":false,\"fieldDelim\":\"\"};select * from noheader;" >/Users/A/temp/test.txt 
--返回結(jié)果會(huì)保存在/Users/A/temp/test.txt中。
--返回結(jié)果如下。
1
2
3

參考：版本更新記錄

MaxCompute客戶端近期版本的更新說(shuō)明如下，詳細(xì)信息請(qǐng)單擊對(duì)應(yīng)版本鏈接獲取。