Didacticiel CLI Databricks
L'utilisation de Databricks CLI est soumise à la licence Databricks et à la politique de confidentialité Databricks, y compris toutes les dispositions relatives aux données d'utilisation.
L'utilitaire d'interface de ligne de commande Databricks (également appelé Databricks CLI) fournit une interface facile à utiliser pour automatiser la plateforme Databricks depuis votre terminal, invite de commande ou scripts d'automatisation. Voir Databricks CLI.
Cet article explique comment installer et configurer rapidement le Databricks CLI.
Confirmer les exigences de la machine locale
Ce didacticiel suppose que :
- Pour Linux ou macOS, vous avez Homebrew installé.
Pour d'autres façons d'installer la CLI si vous ne pouvez pas utiliser Homebrew, consultez Installer ou mettre à jour la CLI Databricks.
- Pour Windows, vous avez winget, Chocolatey ou Windows Subsystem for Linux (WSL) installés.
L'installation de la CLI Databricks avec Chocolatey est expérimentale. Pour connaître d'autres façons d'installer la CLI, consultez Installer ou mettre à jour la CLI Databricks.
Installez la CLI Databricks
- Installez la CLI Databricks:
- Linux, macOS
- Windows
Utilisez Homebrew pour installer la CLI Databricks en exécutant les commandes suivantes :
brew tap databricks/tap
brew trust databricks/tap
brew install databricks
La commande brew trust est requise à partir de Homebrew 6.0.0.
Vous pouvez utiliser winget, Chocolatey ou le sous-système Windows pour Linux (WSL) pour installer le CLI Databricks. Si vous ne pouvez pas utiliser winget, Chocolatey ou WSL, vous devez ignorer cette procédure et utiliser l'invite de commande ou PowerShell pour installer le CLI Databricks à partir de la source à la place.
Installing the Databricks CLI with Chocolatey is Experimental.
Pour utiliser winget afin d'installer le CLI Databricks, exécutez les deux commandes suivantes, puis redémarrez votre invite de commandes :
winget search databricks
winget install Databricks.DatabricksCLI
Pour utiliser Chocolatey afin d'installer le Databricks CLI, exécutez la commande suivante :
choco install databricks-cli
Pour utiliser WSL afin d’installer la CLI Databricks :
-
Installez
curletzipvia WSL. Pour plus d'informations, consultez la documentation de votre système d'exploitation. -
Utilisez WSL pour installer la CLI Databricks en exécutant la commande suivante :
Bashcurl -fsSL https://raw.githubusercontent.com/databricks/setup-cli/main/install.sh | sh
-
Confirmez que le CLI Databricks est installé en exécutant la commande suivante, qui affiche la version actuelle du CLI Databricks installé. Cette version doit être 0,205,0 ou supérieure :
Bashdatabricks -v
Configurer l'accès à votre workspace
Ensuite, configurez l'accès à votre workspace Databricks.
Ce tutoriel utilise l'authentification OAuth user-to-machine (U2M) pour authentifier la CLI à l'aide de votre compte utilisateur Databricks. Pour configurer la CLI afin d'utiliser d'autres types d'authentification Databricks, consultez Authentification pour la CLI Databricks.
-
Utilisez la CLI Databricks pour initier localement la gestion des jetons OAuth en exécutant la commande suivante pour chaque compte ou workspace cible.
Pour les Opérations au niveau du compte, dans la commande suivante, remplacez les espaces réservés suivants :
- Remplacez
<account-console-url>par votre Databricks https://accounts.cloud.databricks.com. - Remplacez
<account-id>par votre ID de compte Databricks. Consultez Localiser votre ID de compte.
Bashdatabricks auth login --host <account-console-url> --account-id <account-id>Pour les opérations au niveau du workspace, dans la commande suivante, remplacez
<workspace-url>par l'URL de votre instance de workspace Databricks, parhttps://dbc-a1b2345c-d6e7.cloud.databricks.comexemple.Bashdatabricks auth login --host <workspace-url> - Remplacez
-
La CLI Databricks vous invite à enregistrer les informations que vous avez saisies en tant que profil de configuration Databricks. Appuyez sur
Enterpour accepter le nom de profil suggéré, ou entrez le nom d’un profil nouveau ou existant. Tout profil existant portant le même nom est écrasé avec les informations que vous avez saisies. Vous pouvez utiliser des profils pour basculer rapidement votre contexte d'authentification entre plusieurs comptes ou workspaces.Pour obtenir une liste de tous les profils existants, dans un terminal ou une invite de commande distinct, utilisez la CLI Databricks pour exécuter la commande
databricks auth profiles. Pour consulter les paramètres existants d’un profil spécifique, exécutez la commandedatabricks auth env --profile <profile-name>. -
Dans votre navigateur web, suivez les instructions à l'écran pour vous connecter à votre compte ou Workspace Databricks.
-
Pour afficher la valeur actuelle du token OAuth d'un profil et le timestamp d'expiration à venir du token, exécutez l'une des commandes suivantes :
Pour les opérations au niveau du compte, exécutez les commandes suivantes :
databricks auth token -p <profile-name>databricks auth token --host <workspace-url> --account-id <account-id>databricks auth token --host <workspace-url> --account-id <account-id> -p <profile-name>
Si vous avez plusieurs profils avec les mêmes valeurs
--hostet--account-id, vous devrez peut-être spécifier les options--host,--account-idet-pensemble pour aider l’interface CLI Databricks à trouver les informations de jeton OAuth correspondantes.Pour les Workspace-level Opérations, exécutez les commandes suivantes :
databricks auth token -p <profile-name>databricks auth token --host <workspace-url>databricks auth token --host <workspace-url> -p <profile-name>
Si vous avez plusieurs profils avec les mêmes valeurs
--host, vous pourriez avoir besoin de spécifier les options--hostet-pensemble pour aider la CLI Databricks à trouver les informations de jeton OAuth correspondantes.
Étapes suivantes
- Pour savoir comment utiliser la CLI, consultez l'utilisation de base de la CLI Databricks.
- Pour un aperçu des commandes CLI disponibles, consultez les commandes CLI de Databricks.
- Si le CLI ne s'exécute pas ou produit des résultats inattendus, consultez Vérifier votre installation de CLI.