安装并登录MaxCompute本地客户端

适用范围

• 待安装MaxCompute客户端的设备已安装Java 8或以上版本。

• 版本兼容性

  • MaxCompute客户端从v0.28.0版开始支持JDK 1.9，v0.28.0以下版本只支持JDK 1.8。根据本文步骤安装客户端后，可在命令行界面查看客户端版本号。

  • MaxCompute客户端的输出格式不承诺向前兼容，不同版本间的客户端命令格式及行为有差异，请勿依赖客户端的输出格式执行任何解析工作。

  • 更多客户端版本，请参见aliyun-odps-console。

• 编码格式

  客户端默认编码为UTF-8，若本机环境编码不是UTF-8，通过客户端查询MaxCompute表数据返回值有中文时可能会出现乱码，或通过客户端执行Tunnel命令上传本地数据文件到MaxCompute，也可能会出现中文乱码。

安装并配置MaxCompute客户端

客户端从v0.27.0版本开始支持MaxCompute 2.0新数据类型，推荐使用新数据类型。支持的数据类型列表，请参见2.0数据类型版本。

操作流程如下：

1. 下载MaxCompute客户端安装包（Github）。

   说明

   • 通过上方链接进入客户端发布界面，下载最新版本的MaxCompute客户端安装包（odpscmd_public.zip）。

   • 如果上方链接无法下载，可以尝试单击此处的MaxCompute客户端安装包（OSS）下载。更多关于GitHub链接访问失败的问题，推荐在搜索引擎中查找相关解决方案。

2. 解压下载的安装包文件，得到bin、conf、lib和plugins文件夹。

3. 进入conf文件夹，配置odps_config.ini文件。

   odps_config.ini文件中使用井号（#）作为注释。参数说明如下。

   参数	是否必填	描述	示例
   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。	无
   end_point	是	MaxCompute服务的连接地址。 需要根据创建MaxCompute项目时选择的地域以及网络连接方式配置Endpoint。各地域及网络对应的Endpoint值，请参见Endpoint。 重要 Endpoint用于MaxCompute服务，Tunnel Endpoint用于MaxCompute的Tunnel服务，此处请填写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

   请确保上述信息配置正确，若信息配置错误，会导致项目连接失败。

启动MaxCompute客户端

启动MaxCompute客户端有如下两种方式，任选其一即可：

相关文档

• MaxCompute客户端支持的详细命令语法信息，请参见常用命令列表或SQL命令及函数。

• 使用MaxCompute客户端详细说明及配置时的常见报错，请参见使用本地客户端（odpscmd）连接。