Partager via

Utilisation de base pour l’interface CLI Databricks

Note

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 page vous montre comment répertorier les groupes de commandes et les commandes Databricks CLI, 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 ?.

Pour installer et configurer l’authentification pour l’interface CLI Databricks, consultez le didacticiel de l’interface CLI Databricks.

Répertorier les commandes CLI disponibles

Pour répertorier les groupes de commandes CLI disponibles, utilisez l’option --help ou l’option -h, par exemple :

databricks -h

Pour répertorier les commandes d’un groupe de commandes, utilisez l’option --help ou l’option -h. Par exemple, pour afficher les commandes clusters :

databricks clusters -h

Afficher l’aide d’une commande CLI

Pour afficher les informations d'utilisation d'une commande, utilisez l'option --help ou l'option -h avec la commande. Par exemple, pour afficher l’aide de la commande clusters list :

databricks clusters list -h

La référence de commande est également disponible. Consultez Commandes CLI Databricks.

Exécuter une commande

Vous trouverez des informations d’utilisation et une syntaxe complètes pour les commandes individuelles dans l’aide et la référence de 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

Tip

Vous pouvez exécuter des commandes CLI Databricks à partir d’un espace de travail Databricks à l’aide du terminal web. Le terminal web de l’espace de travail peut être utilisé par de nombreux utilisateurs sur un calcul et ne vous oblige pas à configurer l’authentification. Consultez Exécuter des commandes d’interpréteur de commandes dans un terminal web Azure Databricks.

Entrée et sortie JSON

Certaines commandes DE l’interface CLI Databricks ont un --json indicateur ou d’autres options qui acceptent l’entrée de chaîne JSON. En outre, certaines commandes génèrent une chaîne JSON.

Mise en forme de chaîne

Le format des chaînes JSON dépend de votre système d’exploitation :

Linux ou macOS

Placez les paramètres de chaîne JSON entre guillemets doubles et placez la charge utile JSON entière entre guillemets simples. Par exemple:

'{"cluster_id": "1234-567890-abcde123"}'

'["20230323", "Amsterdam"]'

Windows

Placez les paramètres de chaîne JSON et la charge utile JSON entière entre guillemets doubles et précèdez les caractères de guillemets doubles à l’intérieur de la charge utile JSON avec une barre oblique inverse (\). Par exemple:

"{\"cluster_id\": \"1234-567890-abcde123\"}"

"[\"20230323\", \"Amsterdam\"]"

Définir des champs dans une chaîne JSON

L’indicateur --json sur de nombreuses commandes vous permet de définir des champs d’objet qui peuvent ne pas être disponibles en tant que commandes ou options CLI. Par exemple, l’appel suivant ajoute un utilisateur avec l’ID 9ddddddd-1eee-4eee-a666-8fff7c111111 au groupe avec l’ID 7eeeeeee-9ccc-4aaa-b777-1aaaaaaaaaa:

Linux ou macOS

databricks account groups patch 7eeeeeee-9ccc-4aaa-b777-1aaa2eeeee6f --json '{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [
        {
        "value": "9ddddddd-1eee-4eee-a666-8fff7c111111"
        }
      ]
    }
  ]
}'

Windows

databricks account groups patch 7eeeeeee-9ccc-4aaa-b777-1aaa2eeeee6f --json "{
  \"schemas\": [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"],
  \"Operations\": [
    {
      \"op\": \"add\",
      \"path\": \"members\",
      \"value\": [
        {
            \"value\": \"9ddddddd-1eee-4eee-a666-8fff7c111111\"
        }
      ]
    }
  ]
}"

Filtrer la sortie JSON avec jq

Pour les commandes CLI Databricks qui génèrent json, vous pouvez utiliser le processeur de ligne de commande 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.

Configuration du serveur proxy

Pour router les requêtes et réponses de l’interface CLI Databricks via un serveur proxy, définissez la HTTPS_PROXY variable d’environnement sur l’ordinateur sur lequel l’interface CLI Databricks est installée sur l’URL du serveur proxy.

Pour définir des variables d’environnement, consultez la documentation de votre système d’exploitation.

  • Last updated on