Share via

Utilisation de base pour l’interface CLI Databricks

  • Article

Remarque

Ces informations s'appliquent aux versions Databricks CLI 0,205 et supérieures, qui sont en version préliminaire publique. Pour trouver votre version de l’interface CLI Databricks, exécutez databricks -v.

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 l'article :

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

Utiliser jq pour analyser la sortie JSON de l’interface CLI

Certaines réponses de sortie des commandes de l’interface CLI Databricks sont au format JSON. Dans de nombreux cas, l’interface CLI Databricks met en forme la sortie JSON afin qu’elle soit plus facile à lire. Toutefois, il peut parfois être utile d’extraire des parties de la sortie JSON au lieu d’afficher l’ensemble de la réponse. Par exemple, pour afficher uniquement le nom complet d’un cluster Azure Databricks avec l’ID de cluster spécifié, vous pouvez vous servir de l’utilitaire jq :

databricks clusters get 1234-567890-abcde123 | jq -r .cluster_name

Sortie :

My-11.3-LTS-Cluster

Vous pouvez installer jq sur macOS par exemple en utilisant Homebrew avec brew install jq, ou sur Windows en utilisant 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.

Indicateurs généraux

Les indicateurs suivants sont disponibles pour toutes les commandes de l’interface CLI Databricks. Certains indicateurs ne s’appliquent pas à certaines commandes. Pour plus d’informations, consultez la documentation de la commande.

Indicateur Description
-h ou --help Affiche l’aide pour l’interface CLI Databricks, le groupe de commandes associé ou la commande associée.
-e ou --environment string Chaîne représentant l’environnement groupé à utiliser, le cas échéant, pour la commande associée.
--log-file Chaîne représentant le fichier d’écriture des journaux de sortie. Si cet indicateur n’est pas spécifié, la valeur par défaut consiste à écrire les journaux de sortie dans stderr.
--log-format text pour écrire les journaux de sortie au format texte ou json pour écrire les journaux de sortie au format JSON. Si cet indicateur n’est pas spécifié, les journaux de sortie sont écrits au format texte.
--log-level Chaîne représentant le niveau de format du journal. Si cet indicateur n’est pas spécifié, le niveau de format du journal est désactivé.
-o ou --output text pour écrire la sortie au format texte ou json pour écrire la sortie au format JSON. Si cet indicateur n’est pas spécifié, la sortie est écrite au format texte.
-p ou --profile Chaîne représentant le profil de configuration nommé à utiliser dans votre fichier .databrickscfg. Si cet indicateur n’est pas spécifié, le profil nommé DEFAULT est utilisé s’il en existe un. Vous pouvez appuyer sur Tab après --profile ou -p pour afficher une liste de profils de configuration disponibles existants à choisir, au lieu d’entrer manuellement le nom du profil de configuration.
--progress-format Format des journaux d’avancement à afficher (default (valeur par défaut), append, inplace ou json).