Utilisation de base pour l’interface CLI Databricks
Remarque
Ces informations s’appliquent à Databricks CLI versions 0.205 et ultérieures. L’interface CLI Databricks est en préversion publique.
L’utilisation de l’interface CLI Databricks est soumise à la licence Databricks et à la notification de confidentialité Databricks, y compris les dispositions relatives aux données d’utilisation.
Cette article montre comment répertorier les groupes de commandes et les commandes de l’interface CLI Databricks, afficher l’aide de l’interface CLI Databricks et utiliser la sortie de l’interface CLI Databricks. Consultez Qu’est-ce que l’interface CLI Databricks ?.
Cet article suppose que vous avez déjà installé l’interface CLI Databricks et configuré l’interface CLI pour l’authentification. Consultez Installer ou mettre à jour l’interface CLI Databricks et Authentification pour l’interface CLI Databricks.
Répertorier les groupes de commandes CLI
Vous pouvez afficher la liste des groupes de commandes à l’aide de l’option --help ou -h. Par exemple :
databricks -h
Répertorier les commandes CLI
Vous pouvez afficher la liste des commandes de n’importe quel groupe de commandes à l’aide de l’option --help ou -h. Par exemple, pour afficher les commandes clusters :
databricks clusters -h
Afficher l’aide d’une commande CLI
Vous pouvez afficher l’aide d’une commande en utilisant l’option --help ou -h. Par exemple, pour afficher l’aide de la commande clusters list :
databricks clusters list -h
Exécuter une commande
Vous trouverez des informations d’utilisation et une syntaxe complètes pour les commandes individuelles dans l’aide de la ligne de commande, mais les commandes CLI Databricks sont généralement conformes à la syntaxe suivante :
databricks <command-group> <command-name> <subcommand-name> [command-argument-value1] [--<flag1-name> <flag1-value>]
Toutes les commandes ne possèdent pas de sous-commandes supplémentaires. Les indicateurs globaux sont disponibles et certaines commandes ont des indicateurs supplémentaires. Par exemple, la commande suivante génère des clusters disponibles à l’aide d’un indicateur spécifique à la commande :
databricks clusters list --can-use-client JOBS
Conseil
Vous pouvez exécuter des commandes CLI Databricks à partir d’un espace de travail Databricks à l’aide du terminal web. Le terminal web peut être utilisé par de nombreux utilisateurs sur un calcul et ne nécessite pas de configurer des clés. Consultez Exécuter des commandes d’interpréteur de commandes dans un terminal web Azure Databricks.
Utiliser jq pour filtrer la sortie JSON
Certaines commandes DE l’interface CLI Databricks génèrent jSON, ce qui signifie que vous pouvez utiliser jq pour filtrer la sortie. Par exemple, pour afficher uniquement le nom complet d’un cluster Azure Databricks avec l’ID de cluster spécifié :
databricks clusters get 1234-567890-abcde123 | jq -r .cluster_name
My-11.3-LTS-Cluster
Vous pouvez installer jq sur MacOS avec Homebrew avec brew install jq ou sur Windows à l’aide de Chocolatey avec choco install jq. Pour plus d’informations sur jq, consultez le Manuel jq.
Paramètre de chaîne JSON
Le format des paramètres de chaîne est géré différemment au format JSON en fonction de votre système d’exploitation :
Linux ou macOS
Vous devez placer les paramètres de chaîne JSON entre guillemets doubles et placer l’intégralité de la charge utile JSON entre guillemets simples. Exemples :
'{"cluster_id": "1234-567890-abcde123"}'
'["20230323", "Amsterdam"]'
Windows
Vous devez mettre les paramètres de chaîne JSON et toute la charge utile JSON entre guillemets doubles et les caractères de guillemet double dans la charge utile JSON doivent être précédés de \. Exemples :
"{\"cluster_id\": \"1234-567890-abcde123\"}"
"[\"20230323\", \"Amsterdam\"]"
Configuration du serveur proxy
Pour transmettre des requêtes et réponses de l’interface CLI Databricks par un serveur proxy, définissez la variable d’environnement HTTPS_PROXY sur l’ordinateur hôte de l’interface CLI Databricks sur l’URL du serveur proxy.
Pour définir des variables d’environnement, consultez la documentation de votre système d’exploitation.