Le client MaxCompute (odpscmd) s'exécute sur votre ordinateur local et offre un moyen simple et efficace d'exécuter des commandes et de gérer les services MaxCompute. Cette rubrique explique comment installer et démarrer le client MaxCompute. Un démarrage réussi signifie que vous êtes connecté à un projet MaxCompute.
Remarques d'utilisation
Le client MaxCompute nécessite Java 8 ou une version ultérieure.
-
Compatibilité des versions
À partir de la version 0.28.0, le client MaxCompute prend en charge JDK 1.9. Les versions antérieures à la 0.28.0 ne prennent en charge que JDK 1.8. Une fois le client installé, consultez sa version dans l'interface de ligne de commande (CLI).
Le format de sortie du client MaxCompute n'est pas rétrocompatible. Les formats de commande et les comportements peuvent différer selon les versions du client. N'utilisez pas le format de sortie du client pour l'analyse syntaxique.
Pour les autres versions du client, consultez aliyun-odps-console.
-
Encodage des caractères
Le client utilise UTF-8 par défaut. Si l'encodage des caractères de votre environnement local n'est pas UTF-8, des caractères illisibles peuvent apparaître lorsque vous interrogez des données contenant des caractères chinois depuis une table MaxCompute ou utilisez une commande Tunnel pour télécharger des fichiers locaux en contenant.
Installation et configuration d'odpscmd
Les versions odpscmd 27.0 et ultérieures prennent en charge les types de données MaxCompute 2.0. Nous vous recommandons d'utiliser ces types de données. Pour obtenir la liste des types de données pris en charge, consultez la section Types de données (V2.0).
Procédure
-
Téléchargez le package d'installation odpscmd (GitHub).
RemarqueSuivez le lien vers la page de publication et téléchargez la dernière version du package d'installation odpscmd (odpscmd_public.zip).
Si vous ne parvenez pas à télécharger le package depuis le lien GitHub, essayez de télécharger le package d'installation odpscmd (OSS). En cas de difficultés d'accès à GitHub, nous vous recommandons de rechercher des solutions en ligne.
Décompressez le package téléchargé. Le répertoire extrait contient les dossiers bin, conf, lib et plugins.
-
Accédez au dossier conf et configurez le fichier odps_config.ini.
Dans le fichier odps_config.ini, le signe dièse (#) indique un commentaire. Le tableau suivant décrit les paramètres.
Paramètre
Obligatoire
Description
Exemple
project_name
Oui
Nom du projet MaxCompute de destination.
Si vous avez créé un espace de travail en mode standard, faites la distinction entre les noms de projet pour l'environnement de production et l'environnement de développement (_dev) lors de la configuration du paramètre project_name. Pour plus d'informations, consultez la section Différences entre les modes d'espace de travail.
-
Connectez-vous à la console MaxCompute et sélectionnez une région dans le coin supérieur gauche.
-
Dans le volet de navigation de gauche, choisissez .
-
Sur la page Projects, affichez le nom de votre projet MaxCompute.
doc_test_dev
access_id
Oui
ID AccessKey de votre compte Alibaba Cloud ou utilisateur RAM. Obtenez l'ID AccessKey depuis la page Gestion des clés d'accès.
S.O.
access_key
Oui
Clé secrète AccessKey correspondant à l'ID AccessKey.
S.O.
end_point
Oui
Endpoint du service MaxCompute.
Vous devez configurer l'endpoint en fonction de la région où se trouve votre projet MaxCompute et du type de connexion réseau. Pour obtenir la liste des endpoints selon les régions et les types de réseau, consultez la section Endpoints.
Important-
Un endpoint permet de se connecter au service MaxCompute, tandis qu'un endpoint Tunnel permet de se connecter au service MaxCompute Tunnel. Spécifiez ici l'endpoint pour le service MaxCompute.
-
Une configuration incorrecte de l'endpoint entraîne une erreur d'accès.
http://service.cn-hangzhou.maxcompute.aliyun.com/api
log_view_host
Non
URL LogView. Nous vous recommandons de configurer ce paramètre. Sans cette configuration, vous ne pourrez pas identifier rapidement la cause d'un échec de tâche.
Utilisez cette URL pour afficher des informations détaillées sur l'exécution des tâches et résoudre les erreurs. La valeur fixe est http://logview.odps.aliyun.com.
http://logview.odps.aliyun.com
https_check
Non
Indique si HTTPS doit être activé pour chiffrer les requêtes d'accès au projet MaxCompute. Valeurs possibles :
-
True : active HTTPS.
-
False : utilise HTTP.
La valeur par défaut est False.
True
data_size_confirm
Non
Taille maximale des données d'entrée en Go. Cette valeur n'a pas de limite supérieure. Valeur recommandée : 100.
100
update_url
Non
Ce paramètre est réservé pour une utilisation future.
S.O.
use_instance_tunnel
Non
Indique si InstanceTunnel doit être utilisé pour télécharger les résultats d'exécution SQL. Valeurs possibles :
-
True : utilise InstanceTunnel pour télécharger les résultats d'exécution SQL.
-
False : n'utilise pas InstanceTunnel pour télécharger les résultats d'exécution SQL.
La valeur par défaut est False.
True
instance_tunnel_max_record
Non
Nombre maximal d'enregistrements dans un résultat d'exécution SQL. Si le paramètre use_instance_tunnel est défini sur True, vous devez configurer ce paramètre. La valeur maximale est 10 000.
10000
tunnel_endpoint
Non
Endpoint public pour le service Tunnel.
-
Si vous ne configurez pas ce paramètre, Tunnel achemine automatiquement les requêtes vers l'endpoint Tunnel correspondant au réseau du service MaxCompute.
-
Si vous configurez un endpoint Tunnel, Tunnel utilise cette valeur et n'effectue pas d'acheminement automatique.
Pour obtenir la liste des endpoints Tunnel selon les régions et les types de réseau, consultez la section Endpoints.
http://dt.cn-hangzhou.maxcompute.aliyun.com
set.<key>
Non
Définit une propriété pour le projet MaxCompute.
Pour plus d'informations sur les propriétés, consultez la liste des propriétés.
set.odps.sql.decimal.odps2=true
Assurez-vous que les informations précédentes sont correctement configurées. Des configurations incorrectes peuvent entraîner des échecs de connexion au projet.
-
Démarrage du client MaxCompute
Utilisez l'une des méthodes suivantes pour démarrer le client MaxCompute :
Fichier de script
Dans le répertoire bin de votre installation du client MaxCompute, double-cliquez sur odpscmd.bat (sous Windows) ou odpscmd (sous macOS) pour démarrer le client MaxCompute. La sortie suivante indique une connexion réussie au projet 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!
Fenêtre de ligne de commande
Dans une fenêtre de ligne de commande, accédez au répertoire bin de votre installation du client MaxCompute. Exécutez odpscmd sous Windows ou sh odpscmd sous Linux ou macOS pour démarrer le client MaxCompute. Un message de succès indique que le client est connecté au projet MaxCompute.
Sous Ubuntu, sh odpscmd renvoie une erreur. Utilisez plutôt ./odpscmd.
Lorsque vous démarrez le client MaxCompute depuis une fenêtre de ligne de commande, vous pouvez spécifier des paramètres de démarrage pour exécuter des commandes. Pour plus d'informations, consultez la section Paramètres de démarrage.
Étapes suivantes
Créer une table dans le projet MaxCompute.
Importer des données et télécharger des ressources telles que des fichiers et des packages JAR.
Documentation connexe
Pour plus de détails sur la syntaxe des commandes prises en charge par le client MaxCompute, consultez les sections Commandes courantes ou Instructions SQL et fonctions.
Pour des instructions détaillées sur l'utilisation du client MaxCompute et des informations sur les erreurs de configuration courantes, consultez la section Connexion à un projet à l'aide du client MaxCompute (odpscmd).