El cliente de MaxCompute (odpscmd) se ejecuta en su computadora local y ofrece una forma sencilla y eficiente de ejecutar comandos y gestionar los servicios de MaxCompute. Este tema describe cómo instalar e iniciar el cliente de MaxCompute. Un inicio correcto indica que se ha conectado a un proyecto de MaxCompute.
Notas de uso
El cliente de MaxCompute requiere Java 8 o posterior.
-
Compatibilidad de versiones
A partir de la versión v0.28.0, el cliente de MaxCompute es compatible con JDK 1.9. Las versiones anteriores a la v0.28.0 solo admiten JDK 1.8. Después de instalar el cliente, puede consultar la versión en la interfaz de línea de comandos (CLI).
El formato de salida del cliente de MaxCompute no es retrocompatible. Los formatos de los comandos y su comportamiento pueden variar entre distintas versiones del cliente. No dependa del formato de salida del cliente para realizar análisis sintácticos.
Para otras versiones del cliente, consulte aliyun-odps-console.
-
Codificación de caracteres
El cliente utiliza UTF-8 de forma predeterminada. Si la codificación de caracteres de su entorno local no es UTF-8, podrían aparecer caracteres ilegibles al consultar datos con caracteres chinos desde una tabla de MaxCompute o al usar un comando de Tunnel para cargar archivos locales que los contengan.
Instalación y configuración de odpscmd
Las versiones de odpscmd v0.27.0 y posteriores son compatibles con los tipos de datos de MaxCompute 2.0. Se recomienda utilizar estos tipos de datos. Para consultar la lista de tipos de datos compatibles, véase Data Types (V2.0).
Procedimiento
-
Descargue el paquete de instalación de odpscmd (GitHub).
NotaSiga el enlace a la página de versiones y descargue la versión más reciente del paquete de instalación de odpscmd (odpscmd_public.zip).
Si no puede descargar el paquete desde el enlace de GitHub, intente descargar el paquete de instalación de odpscmd (OSS). Si tiene problemas para acceder a GitHub, le recomendamos buscar soluciones en línea.
Descomprima el paquete descargado. El directorio extraído contiene las carpetas bin, conf, lib y plugins.
-
Vaya a la carpeta conf y configure el archivo odps_config.ini.
En el archivo odps_config.ini, el signo de número (#) indica un comentario. La siguiente tabla describe los parámetros.
Parámetro
Obligatorio
Descripción
Ejemplo
project_name
Sí
Nombre del proyecto de MaxCompute de destino.
Si creó un espacio de trabajo en modo estándar, distinga entre los nombres de proyecto para el entorno de producción y el entorno de desarrollo (_dev) cuando configure el parámetro project_name. Para obtener más información, consulte Differences between workspace modes.
-
Inicie sesión en la MaxCompute console y seleccione una región en la esquina superior izquierda.
-
En el panel de navegación izquierdo, elija .
-
En la página Projects, consulte el nombre de su proyecto de MaxCompute.
doc_test_dev
access_id
Sí
AccessKey ID de su cuenta de Alibaba Cloud o usuario de RAM. Obtenga el AccessKey ID en la página AccessKey Management.
N/A
access_key
Sí
AccessKey Secret correspondiente al AccessKey ID.
N/A
end_point
Sí
Endpoint del servicio de MaxCompute.
Debe configurar el endpoint según la región donde se encuentre su proyecto de MaxCompute y el tipo de conexión de red. Para consultar la lista de endpoints correspondientes a diferentes regiones y tipos de red, véase Endpoints.
Importante-
Un endpoint conecta con el servicio de MaxCompute, mientras que un tunnel endpoint conecta con el servicio MaxCompute Tunnel. Especifique aquí el endpoint para el servicio de MaxCompute.
-
Una configuración incorrecta del endpoint provoca un error de acceso.
http://service.cn-hangzhou.maxcompute.aliyun.com/api
log_view_host
No
URL de LogView. Se recomienda configurar este parámetro. Si no lo configura, no podrá identificar rápidamente la causa de un fallo en el trabajo.
Utilice esta URL para consultar información detallada sobre la ejecución del trabajo y solucionar errores. El valor fijo es http://logview.odps.aliyun.com.
http://logview.odps.aliyun.com
https_check
No
Especifica si se debe habilitar HTTPS para cifrar las solicitudes de acceso al proyecto de MaxCompute. Valores válidos:
-
True: Habilita HTTPS.
-
False: Utiliza HTTP.
El valor predeterminado es False.
True
data_size_confirm
No
Tamaño máximo de datos de entrada en GB. Este valor no tiene límite superior. Valor recomendado: 100.
100
update_url
No
Este parámetro está reservado para uso futuro.
N/A
use_instance_tunnel
No
Especifica si se debe usar InstanceTunnel para descargar los resultados de ejecución de SQL. Valores válidos:
-
True: Usa InstanceTunnel para descargar los resultados de ejecución de SQL.
-
False: No usa InstanceTunnel para descargar los resultados de ejecución de SQL.
El valor predeterminado es False.
True
instance_tunnel_max_record
No
Número máximo de registros en un resultado de ejecución de SQL. Si use_instance_tunnel se establece en True, debe configurar este parámetro. El valor máximo es 10,000.
10000
tunnel_endpoint
No
Endpoint público para el servicio Tunnel.
-
Si no configura este parámetro, Tunnel enruta automáticamente las solicitudes al tunnel endpoint correspondiente a la red del servicio de MaxCompute.
-
Si configura un tunnel endpoint, Tunnel utiliza ese valor y no realiza el enrutamiento automático.
Para consultar la lista de tunnel endpoints correspondientes a diferentes regiones y tipos de red, véase Endpoints.
http://dt.cn-hangzhou.maxcompute.aliyun.com
set.<key>
No
Establece una propiedad para el proyecto de MaxCompute.
Para obtener más información sobre las propiedades, consulte property list.
set.odps.sql.decimal.odps2=true
Asegúrese de que la información anterior esté configurada correctamente. Una configuración errónea puede provocar fallos en la conexión al proyecto.
-
Inicio del cliente de MaxCompute
Utilice uno de los siguientes métodos para iniciar el cliente de MaxCompute:
Archivo de script
En el directorio bin de su instalación del cliente de MaxCompute, haga doble clic en odpscmd.bat (en Windows) o en odpscmd (en macOS) para iniciar el cliente de MaxCompute. La siguiente salida indica que la conexión al proyecto de MaxCompute fue exitosa.
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!
Ventana de línea de comandos
En una ventana de línea de comandos, vaya al directorio bin de su instalación del cliente de MaxCompute. Ejecute odpscmd en Windows o sh odpscmd en Linux o macOS para iniciar el cliente de MaxCompute. Un mensaje de confirmación indica que el cliente se ha conectado al proyecto de MaxCompute.
En Ubuntu, sh odpscmd devuelve un error. Utilice ./odpscmd en su lugar.
Cuando inicie el cliente de MaxCompute desde una ventana de línea de comandos, puede especificar parámetros de inicio para ejecutar comandos. Para obtener más información, consulte Startup parameters.
Siguientes pasos
Create a table en el proyecto de MaxCompute.
Import data y upload resources, como archivos y paquetes JAR.
Documentación relacionada
Para obtener detalles sobre la sintaxis de comandos compatible con el cliente de MaxCompute, consulte Common commands o SQL statements and functions.
Para obtener instrucciones detalladas sobre el uso del cliente de MaxCompute e información sobre errores comunes de configuración, consulte Connect to a project by using the MaxCompute client (odpscmd).