O cliente MaxCompute (odpscmd) é executado no computador local e oferece uma maneira simples e eficiente de executar comandos e gerenciar serviços do MaxCompute. Este tópico descreve como instalar e iniciar o cliente MaxCompute. Uma inicialização bem-sucedida indica conexão estabelecida com um projeto do MaxCompute.
Observações 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 suporta JDK 1.9. Versões anteriores à v0.28.0 suportam apenas JDK 1.8. Após instale o cliente, visualize a versão na interface de linha de comando (CLI).
O formato de saída do cliente MaxCompute não possui compatibilidade retroativa. Os formatos de comando e o comportamento podem variar entre as versões do cliente. Não utilize o formato de saída do cliente para análise (parsing).
Para outras versões do cliente, consulte aliyun-odps-console.
-
Codificação de caracteres
O cliente utiliza UTF-8 por padrão. Caso a codificação de caracteres do ambiente local não seja UTF-8, caracteres ilegíveis poderão aparecer ao consultar dados com caracteres chineses em uma tabela do MaxCompute ou ao usar um comando Tunnel para fazer upload de arquivos locais que os contenham.
Instalar e configure o odpscmd
O odpscmd v0.27.0 e versões posteriores suportam os tipos de dados do MaxCompute 2.0. Recomendamos o uso desses tipos de dados. Para obter uma lista dos tipos de dados suportados, consulte Tipos de dados (V2.0).
Procedimento
-
Baixe o pacote de instalação do odpscmd (GitHub).
NotaAcesse a página de lançamento e baixe a versão mais recente do pacote de instalação do odpscmd (odpscmd_public.zip).
Caso não consiga 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 buscar soluções online.
Descompacte o pacote baixado. O diretório extraído contém as pastas bin, conf, lib e plugins.
-
Acesse a pasta conf e configure o arquivo odps_config.ini.
No arquivo odps_config.ini, o sinal de cerquilha (#) indica um comentário. A tabela a seguir descreve os parâmetros.
Parâmetro
Obrigatório
Descrição
Exemplo
project_name
Sim
Nome do projeto MaxCompute de destino.
Se você crie um workspace no modo padrão, diferencie os nomes dos projetos para o ambiente de produção e o ambiente de desenvolvimento (_dev) ao configurar o parâmetro project_name. Para mais informações, consulte Diferenças entre modos de workspace.
-
Faça login no 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 MaxCompute.
doc_test_dev
access_id
Sim
AccessKey ID da sua conta Alibaba Cloud ou usuário RAM. Obtenha o AccessKey ID na página AccessKey Management.
N/A
access_key
Sim
AccessKey Secret correspondente ao AccessKey ID.
N/A
end_point
Sim
Endpoint do serviço MaxCompute.
Configure o endpoint com base na região do projeto MaxCompute e no tipo de conexão de rede. Para obter uma lista de endpoints para diferentes regiões e tipos de rede, consulte Endpoints.
Importante-
Um endpoint conecta-se ao serviço MaxCompute, enquanto um tunnel endpoint conecta-se ao serviço MaxCompute Tunnel. Especifique aqui o endpoint para o serviço MaxCompute.
-
Uma configuração incorreta de endpoint causa erro de acesso.
http://service.cn-hangzhou.maxcompute.aliyun.com/api
log_view_host
Não
URL do LogView. Recomendamos configurar este parâmetro. Sem essa configuração, não será possível identificar rapidamente a causa de uma falha de job.
Utilize esta URL para visualizar informações detalhadas sobre a execução do job e solucionar erros. O valor fixo é http://logview.odps.aliyun.com.
http://logview.odps.aliyun.com
https_check
Não
Define se o HTTPS deve ser ativado para criptografar solicitações de acesso ao projeto MaxCompute. Valores válidos:
-
True: Ativa HTTPS.
-
False: Utiliza HTTP.
O valor padrão é False.
True
data_size_confirm
Não
Tamanho máximo dos dados de entrada em GB. Este valor não possui limite superior. Valor recomendado: 100.
100
update_url
Não
Parâmetro reservado para uso futuro.
N/A
use_instance_tunnel
Não
Define se o InstanceTunnel deve ser usado para baixar resultados de execução SQL. Valores válidos:
-
True: Usa InstanceTunnel para baixar resultados de execução SQL.
-
False: Não usa InstanceTunnel para baixar resultados de execução SQL.
O valor padrão é False.
True
instance_tunnel_max_record
Não
Número máximo de registros em um resultado de execução SQL. Se use_instance_tunnel estiver definido como True, configure este parâmetro. O valor máximo é 10.000.
10000
tunnel_endpoint
Não
Endpoint público para o serviço Tunnel.
-
Sem a configuração deste parâmetro, o Tunnel roteia automaticamente as solicitações para o tunnel endpoint correspondente à rede do serviço MaxCompute.
-
Ao configurar um tunnel endpoint, o Tunnel usa esse valor e não realiza o 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
Define uma propriedade para o projeto MaxCompute.
Para mais informações sobre propriedades, consulte a lista de propriedades.
set.odps.sql.decimal.odps2=true
Certifique-se de que as informações acima estejam configuradas corretamente. Configurações incorretas podem causar falhas na conexão com o projeto.
-
Iniciar o cliente MaxCompute
Utilize um dos métodos a seguir para iniciar o cliente MaxCompute:
Script file
No diretório bin da instalação do cliente MaxCompute, clique em duas vezes 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 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!
Command-line window
Em uma janela de linha de comando, navegue até o diretório bin da instalação do cliente MaxCompute. Execute odpscmd no Windows ou sh odpscmd no Linux ou macOS para iniciar o cliente MaxCompute. Uma mensagem de sucesso indica que o cliente se conectou ao projeto MaxCompute.
No Ubuntu, sh odpscmd retorna um erro. Use ./odpscmd em vez disso.
Ao iniciar o cliente MaxCompute a partir de uma janela de linha de comando, especifique parâmetros de inicialização para executar comandos. Para mais informações, consulte Parâmetros de inicialização.
Próximos passos
Criar uma tabela no projeto MaxCompute.
Importar dados e fazer upload de recursos, como arquivos e pacotes JAR.
Documentação relacionada
Para detalhes sobre a sintaxe de comandos suportada pelo cliente MaxCompute, consulte Comandos comuns ou Instruções SQL e funções.
Para instruções detalhadas sobre como usar o cliente MaxCompute e informações sobre erros comuns de configuração, consulte Conectar-se a um projeto usando o cliente MaxCompute (odpscmd).