O cliente MaxCompute (odpscmd) é executado no seu computador local e oferece uma forma simples e eficiente de executar comandos e gerenciar services do MaxCompute. Este tópico descreve como instalar e iniciar o cliente MaxCompute. Uma inicialização bem-sucedida indica que a conexão com um projeto do MaxCompute foi estabelecida.
Notas de uso
O cliente MaxCompute requer Java 8 ou superior.
-
Compatibilidade de versões
A partir da versão v0.28.0, o cliente MaxCompute é compatível com o JDK 1.9. As versões anteriores à v0.28.0 suportam apenas o JDK 1.8. Após instalar o cliente, visualize a versão dele na interface de linha de comando (CLI).
O formato de saída do cliente MaxCompute não é compatível com versões anteriores. Os formatos de comando e o comportamento podem variar entre as versões do cliente. Não dependa do formato de saída do cliente para análise.
Para outras versões do cliente, consulte aliyun-odps-console.
-
Codificação de caracteres
O cliente usa UTF-8 por padrão. Se a codificação de caracteres do ambiente local não for UTF-8, caracteres ilegíveis podem ser exibidos ao consultar dados com caracteres chineses em uma tabela do MaxCompute ou ao usar um comando do Tunnel para fazer upload de arquivos locais que os contenham.
Para odpscmd, instale e configure
O odpscmd v0.27.0 e versões posteriores suportam os tipos de dados do MaxCompute 2.0. Recomendamos usar esses tipos de dados. Para obter uma lista dos tipos de dados suportados, consulte Data Types (V2.0).
Procedimento
-
Para obter o pacote, baixe o pacote de instalação do odpscmd (GitHub).
NotaPara baixar, acesse o link da página de releases e baixe a versão mais recente do pacote de instalação do odpscmd (odpscmd_public.zip).
Se não conseguir baixar o pacote pelo link do GitHub, tente baixar o pacote de instalação do odpscmd (OSS). Se tiver problemas para acessar o GitHub, recomendamos pesquisar soluções na internet.
Extraia o pacote baixado. O diretório extraído contém as pastas bin, conf, lib e plugins.
-
Em seguida, acesse a pasta conf e configure o arquivo odps_config.ini.
No arquivo odps_config.ini, a cerquilha (#) indica um comentário. A tabela a seguir descreve os parâmetros.
Parâmetro
Obrigatório
Descrição
Exemplo
project_name
Sim
O nome do projeto do MaxCompute de destino.
Se criou um workspace no modo padrão, diferencie os nomes dos projetos dos ambientes de produção e desenvolvimento (_dev) ao configurar o parâmetro project_name. Para mais informações, consulte Differences between workspace modes.
Acesse o MaxCompute console e selecione uma região no canto superior esquerdo.
No painel de navegação à esquerda, escolha .
Na página Projects, visualize o nome do seu projeto do MaxCompute.
doc_test_dev
access_id
Sim
O AccessKey ID da conta Alibaba Cloud ou do usuário RAM. Obtenha o AccessKey ID na página AccessKey Management.
N/D
access_key
Sim
O AccessKey Secret correspondente ao AccessKey ID.
N/D
end_point
Sim
O endpoint do service MaxCompute.
Configure o endpoint com base na região em que o projeto do MaxCompute está localizado e no tipo de conexão de rede. Para obter uma lista de endpoints para diferentes regiões e tipos de rede, consulte Endpoints.
ImportanteUm endpoint estabelece conexão com o service MaxCompute, enquanto um tunnel endpoint estabelece conexão com o service MaxCompute Tunnel. Especifique aqui o endpoint para o service MaxCompute.
Uma configuração incorreta do endpoint causa erro de acesso.
http://service.cn-hangzhou.maxcompute.aliyun.com/api
log_view_host
Não
A URL do LogView. Recomendamos configurar este parâmetro. Caso não o configure, não será possível identificar rapidamente a causa de uma falha de job.
Use esta URL para visualizar informações detalhadas da execução do job e solucionar erros. O valor fixo é http://logview.odps.aliyun.com.
http://logview.odps.aliyun.com
https_check
Não
Especifica se o HTTPS deve ser ativado para criptografar requisições de acesso ao projeto do MaxCompute. Valores válidos:
True: ative HTTPS.
False: Usa HTTP.
O valor padrão é False.
True
data_size_confirm
Não
O tamanho máximo de dados de entrada em GB. Este valor não possui limite superior. Valor recomendado: 100.
100
update_url
Não
Este parâmetro é reservado para uso futuro.
N/D
use_instance_tunnel
Não
Especifica se o InstanceTunnel deve ser usado para baixar resultados de execução de SQL. Valores válidos:
True: Usa InstanceTunnel para baixar resultados de execução de SQL.
False: Não usa InstanceTunnel para baixar resultados de execução de SQL.
O valor padrão é False.
True
instance_tunnel_max_record
Não
O número máximo de registros em um resultado de execução de SQL. Se use_instance_tunnel estiver definido como True, configure este parâmetro. O valor máximo é 10.000.
10000
tunnel_endpoint
Não
O endpoint público para o service Tunnel.
Se não configurar este parâmetro, o Tunnel roteia automaticamente as requisições para o tunnel endpoint correspondente à rede do service MaxCompute.
Se configurar um tunnel endpoint, o Tunnel usa esse valor e não realiza roteamento automático.
Para obter uma lista de tunnel endpoints para diferentes regiões e tipos de rede, consulte Endpoints.
http://dt.cn-hangzhou.maxcompute.aliyun.com
set.<key>
Não
defina uma propriedade para o projeto do MaxCompute.
Para mais informações sobre propriedades, consulte property list.
set.odps.sql.decimal.odps2=true
Certifique-se de que as informações acima estão configuradas corretamente. Configurações incorretas podem causar falhas na conexão com o projeto.
Inicie o cliente MaxCompute
Use um dos métodos a seguir para iniciar o cliente MaxCompute:
Arquivo de script
No diretório bin da instalação do cliente MaxCompute, clique em odpscmd.bat (no Windows) ou odpscmd (no macOS) para iniciar o cliente MaxCompute. A saída a seguir indica uma conexão bem-sucedida com o projeto do MaxCompute.
odpscmd
Aliyun ODPS Command Line Tool
Version 0.4xxx
@Copyright 2020 Alibaba Cloud Computing Co., Ltd. All rights reserved.
Connecting to http://service.xxx.maxcompute.aliyun.com/api, project: xxx
Executing predefined SET command: SET odps.sql.hive.compatible=true
OK
Endpoint: http://service.xxx.maxcompute.aliyun.com/api
Project: xxx
Schema: default
Quota: default in region N/A
Timezone: Asia/Shanghai
Connected!
Janela de linha de comando
Em uma janela de linha de comando, acesse o diretório bin da instalação do cliente MaxCompute. No Windows, execute odpscmd ou sh odpscmd no Linux ou macOS para iniciar o cliente MaxCompute. Uma mensagem de sucesso indica a conexão do cliente com o projeto do MaxCompute.
No Ubuntu, sh odpscmd retorna erro. Em vez disso, use ./odpscmd.
Ao iniciar o cliente MaxCompute em uma janela de linha de comando, especifique parâmetros de inicialização para executar comandos. Para mais informações, consulte Startup parameters.
Próximos passos
crie uma tabela no projeto do MaxCompute.
Import data e upload resources, como arquivos e pacotes JAR.
Documentação relacionada
Para detalhes sobre a sintaxe de comandos com suporte no cliente MaxCompute, consulte Common commands ou SQL statements and functions.
Para instruções detalhadas de uso do cliente MaxCompute e informações sobre erros comuns de configuração, consulte Connect to a project by using the MaxCompute client (odpscmd).