odps cmd工具-MaxCompute客户端（odpscmd）下载、安装、配置、运行_云原生大数据计算服务 MaxCompute(MaxCompute)-阿里云帮助中心

如果您习惯使用命令行工具或者需要快速执行任务且不需要图形界面，建议您使用MaxCompute客户端访问MaxCompute项目并执行命令。MaxCompute客户端直接在您的本地计算机上运行，提供了一个简单且高效的方式来执行命令和管理MaxCompute服务。本文为您介绍下载、安装、配置和运行客户端并提供客户端相关使用说明信息。

前提条件

在使用MaxCompute客户端前，请您确认已满足如下条件：

待安装MaxCompute客户端的设备已安装Java 8或以上版本。
已创建MaxCompute项目。

更多创建MaxCompute项目操作，请参见创建MaxCompute项目。
使用MaxCompute客户端的RAM用户已被添加至MaxCompute项目所属的DataWorks工作空间。

更多添加工作空间成员操作，请参见授权给其他用户。

使用限制

MaxCompute客户端从v0.28.0版开始支持JDK 1.9，v0.28.0以下版本只支持JDK 1.8。您可以启动MaxCompute客户端后，在命令行界面查看客户端版本号。更多启动客户端操作，请参见运行MaxCompute客户端。

费用说明

使用MaxCompute客户端连接项目不收费，但是通过客户端执行的操作可能会触发MaxComput计费。例如，当您使用客户端提交一个SQL查询和写入命令，此SQL命令在MaxCompute上运行会消耗计算资源，同时写入数据会占用存储空间，将产生计算费用和存储费用。MaxCompute计费详情请参见计费项与计费方式概述。

注意事项

MaxCompute客户端的输出格式不承诺向前兼容，不同版本间的客户端命令格式及行为有差异，请勿依赖客户端的输出格式执行任何解析工作。更多客户端版本，请参见 aliyun-odps-console 。
当您通过MaxCompute客户端首次执行 tunnel download 命令时，MaxCompute客户端会为您在当前设备的客户端安装目录 plugins/dship 下创建一个session文件夹，用于存放日志。如果多名用户共用同一设备执行 tunnel download 命令时，为确保数据安全，可以通过如下方式解决该问题：
- 通过设备自身的文件夹权限管理功能，管控session文件夹权限。
- 在 tunnel download 命令中添加 -sd <新session文件夹名称> 或 -session-dir <新session文件夹名称> 参数，将数据下载至其他session文件夹。更多 tunnel download 命令信息，请参见 Download 。
MaxCompute客户端的命令行使用两个减号（--）作为注释。
客户端默认编码为UTF-8，因此您需要注意您本机的环境编码。若本机环境编码不是UTF-8，则当您通过客户端查询MaxCompute表数据返回值有中文可能会出现乱码或者您通过客户端执行Tunnel命令上传本地数据文件到MaxCompute，也可能会出现中文乱码。

安装并配置MaxCompute客户端

参数	是否必填	描述	示例
project_name	是	访问的目标MaxCompute项目名称。如果您创建了标准模式的工作空间，在配置 project_name 时，请注意区分生产环境与开发环境（_dev）的项目名称，请参见必读：简单模式和标准模式的区别。您可以登录 MaxCompute控制台，在工作区 > 项目管理页面获取MaxCompute项目名称。	doc_test_dev
access_id	是	阿里云账号或RAM用户的AccessKey ID。您可以进入 AccessKey管理页面获取AccessKey ID。	无
access_key	是	AccessKey ID对应的AccessKey Secret。您可以进入 AccessKey管理页面获取AccessKey Secret。	无
end_point	是	MaxCompute服务的连接地址。您需要根据创建MaxCompute项目时选择的地域以及网络连接方式配置Endpoint。各地域及网络对应的Endpoint值，请参见 Endpoint 。	http://service.cn-hangzhou.maxcompute.aliyun.com/api
log_view_host	否	Logview地址。您可以通过该地址查看作业的详细运行信息，并为报错处理提供依据。固定取值为：http://logview.odps.aliyun.com。	http://logview.odps.aliyun.com
https_check	否	是否开启HTTPS访问机制，对访问MaxCompute项目的请求进行加密。取值范围如下： True：采用HTTPS机制。 False：采用HTTP机制。默认值为False。	True
data_size_confirm	否	输入数据量的最大值，单位为GB。取值范围无限制。推荐设置为100 GB。	100
update_url	否	预留参数，暂无需关注。	无
use_instance_tunnel	否	是否使用 InstanceTunnel 下载SQL执行结果。取值范围如下： True：使用InstanceTunnel下载SQL执行结果。 False：不使用InstanceTunnel下载SQL执行结果。默认值为False。	True
instance_tunnel_max_record	否	客户端返回的SQL执行结果的最大记录数。如果 use_instance_tunnel 值为 True ，需要配置该参数。最大值为10000。	10000
tunnel_endpoint	否	Tunnel服务的公网访问链接。如果您未配置Tunnel Endpoint，Tunnel会自动路由到MaxCompute服务所在网络对应的Tunnel Endpoint。如果您配置了Tunnel Endpoint，则以配置为准，不进行自动路由。各地域及网络对应的Tunnel Endpoint值，请参见 Endpoint 。	http://dt.cn-hangzhou.maxcompute.aliyun.com
set.<key>	否	设置MaxCompute项目的属性。更多属性信息，请参见属性列表。	set.odps.sql.decimal.odps2=true

odps@project_name>help;
--等价于如下命令。
odps@project_name>h;

odps@project_name>help table;
--返回结果如下。
Usage: alter table <tablename> merge smallfiles
Usage: export table <tablename>
Usage: show tables [in <project_name>] [like '<prefix>']
       list|ls tables [-p,-project <project_name>]
Usage: describe|desc [<projectname>.]<tablename> [partition(<spec>)]
Usage: read [<project_name>.]<table_name> [(<col_name>[,..])] [PARTITION (<partition_spec>)] [line_num]

...\odpscmd\bin>odpscmd -h

odps@project_name>whoami;

odps@project_name>quit;
--等价于如下命令。
odps@project_name>q;

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

命令	说明	命令示例
`--help` 或 `-h`	获取MaxCompute客户端的全部命令帮助信息。	`odpscmd --help`
`--config`	指定配置文件 odps_config.ini 的路径。默认配置文件的路径是 `odpscmd_public/conf/odps_config.ini` 。	`odpscmd --config=D:/odpscmd/conf/odps_config.ini`
`--project`	指定访问的MaxCompute项目名称。	`odpscmd --project=doc_test`
`--endpoint`	指定连接MaxCompute服务的Endpoint信息。更多Endpoint信息，请参见 Endpoint 。	`odpscmd --endpoint=http://service.cn-shanghai.maxcompute.aliyun.com/api`
`-k`	运行从指定位置开始的语句。当 `n≤0` 时，从第一条语句开始执行。每条语句以分号（;）分隔。	忽略前两条语句，直接从第三条语句开始执行。 `odpscmd -k 3 -e "drop table table_name;create table table_name (dummy string);insert overwrite table table_name select count(*) from table_name;"`
`-r`	设置作业运行失败时的重试次数。	`odpscmd -r 2 -e "select * from sale_detail;select * from table_test;"`
`-f`	指定读取的文件。	准备本地脚本文件 script.txt ，假设存放在D盘，文件内容如下。 `drop table if exists test_table_mj; create table test_table_mj (id string, name string); drop table test_table_mj;` 在系统命令行窗口，换到MaxCompute客户端安装路径下的 bin 目录，运行如下命令。 `..\odpscmd\bin>odpscmd -f D:/script.txt;`
`-e`	指定执行的命令。	`odpscmd -e "select * from sale_detail;"`

--Windows命令行执行窗口运行命令如下。
...\odpscmd\bin>odpscmd -e "set odps.sql.select.output.format={""needHeader"":false,""fieldDelim"":"" ""};select * from noheader;" >D:\test.txt
--返回结果会保存在D:\test.txt中。
--Shell执行窗口运行命令如下。
/Users/.../odpscmd/bin/odpscmd -e "set odps.sql.select.output.format={\"needHeader\":false,\"fieldDelim\":\"\"};select * from noheader;" >/Users/A/temp/test.txt 
--返回结果会保存在/Users/A/temp/test.txt中。
--返回结果如下。
3

版本	变更类型	描述
v0.47.0-public	新功能	HTTP命令：新增HTTP命令，使得用户能够便捷地以当前用户的身份发起HTTP请求。保持会话变量：新增 `keep-session-variables` 启动参数。开启后，执行 USE 命令切换项目时，之前设置的会话变量将不会被清除。例如， `set a=b` ，即使在不同的项目之间切换，这些设置也会被保持。 Tunnel命令升级： `tunnel upload` 和 `tunnel download` 命令新增 `-qn` 选项，用于指定访问MaxCompute使用的Tunnel Quota名称。 `tunnel upload` 命令新增 `-dfp` 选项，用于设置上传DATETIME类型文本的格式。 Tunnel命令详情，请参见 Tunnel命令。
v0.46.5-public	新功能	支持 USE 功能，保持之前设置的SESSION级别Flag。 Tunnel命令升级支持 `tunnel upsert` 命令。详情请参见 Tunnel命令。下载行级权限的表时，返回执行数据过滤SQL的执行信息。
v0.45.1-public	新功能	支持 MaxCompute JSON数据类型和 MaxCompute TIMESTAMP_NTZ数据类型。
v0.43.2-public	新功能	支持创建External Volume。 Show命令支持查询当前MaxCompute项目中所有内建函数、或符合某规则的内建函数的信息。
v0.40.10-public	缺陷修复	删除 Log4j 依赖。
v0.40.8-public	新功能	支持项目按Schema存储。更多信息请参见 Schema操作。
v0.37.5-public	新功能	支持复杂数据类型通过Tunnel上传、下载。
v0.37.4-public	功能增强	优化命令对应的帮助信息。 `desc extended partition` 命令支持返回更多分区属性信息。
v0.36.0-public	新功能	支持创建External Project连接DLF（Data Lake Formation），实现湖仓一体功能。更多湖仓一体信息，请参见 MaxCompute湖仓一体概述。
v0.36.0-public	缺陷修复	修复下载TIMESTAMP类型数据时，纳秒（nano）部分处理不正确的问题。

使用本地客户端（odpscmd）连接

前提条件

使用限制

费用说明

注意事项

安装并配置MaxCompute客户端

运行MaxCompute客户端

方式一：安装包的脚本文件

方式二：系统的命令行执行窗口

MaxCompute客户端相关操作

获取全部命令帮助

在MaxCompute客户端查看命令帮助信息

在系统的命令行执行窗口查看命令帮助信息

获取当前登录用户信息

退出MaxCompute客户端

下一步

常见报错

参考：启动参数

参考：版本更新记录