Commandes 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.
Cet article fournit des informations sur les commandes Databricks CLI disponibles. Ces informations complètent l'aide de la ligne de commande. Pour plus d'informations sur l'installation et l'utilisation du Databricks CLI, consultez Installer ou mettre à jour le Databricks CLI et Databricks CLI.
La CLI Databricks inclut les groupes de commandes répertoriés dans les tableaux suivants. Les groupes de commandes contiennent des ensembles de commandes associées, qui peuvent également contenir des sous-commandes. Pour afficher les informations d'utilisation et de syntaxe pour un groupe de commandes, une commande individuelle ou une sous-commande :
databricks <command-group> -hdatabricks <command-group> <command-name> -hdatabricks <command-group> <command-name> <subcommand-name> -h
De nombreuses commandes CLI correspondent à des opérations qui sont documentées dans la référence de l’API REST Databricks.
Commandes du Workspace
Groupe | Description et commandes |
|---|---|
Commandes pour la gestion des fichiers et du système de fichiers :
| |
Commandes pour l'enregistrement des jetons d'accès personnels pour Databricks afin d'effectuer des opérations au nom de l'utilisateur :
| |
Commandes pour permettre aux utilisateurs de gérer leurs dépôts Git :
| |
Commandes pour gérer les secrets, les Secret Scope et les autorisations d’accès :
| |
Commandes pour lister, importer, exporter et supprimer des notebooks et des dossiers dans le workspace :
|
Commandes de compute
Groupe | Description et commandes |
|---|---|
Commandes pour contrôler la capacité des utilisateurs à configurer les clusters en fonction d'un ensemble de règles :
| |
Commandes qui vous permettent de créer, start, modifier, lister, arrêter et supprimer des clusters :
| |
Commandes pour gérer les ressources d’environnement, y compris les environnements de base au niveau du workspace qui définissent la version de l’environnement et les dépendances pour les notebooks et jobs serverless :
| |
Commandes qui permettent aux administrateurs de Workspace de configurer des scripts d'initialisation globaux pour leur Workspace :
| |
Commandes pour créer, modifier, supprimer et lister les Pools d'instances utilisant des instances cloud prêtes à l'emploi, ce qui réduit les temps de start des clusters et d'auto-scaling :
| |
Commandes permettant aux administrateurs d’ajouter, de lister et de supprimer les profils d’instance avec lesquels les utilisateurs peuvent lancer des clusters :
| |
Commandes pour installer, désinstaller et obtenir l'état des bibliothèques sur un cluster :
| |
Commandes pour afficher et gérer l'état de conformité de la politique des clusters dans votre workspace :
| |
Commandes pour afficher les familles de politiques disponibles :
|
Commandes Jobs
Groupe | Description et commandes |
|---|---|
Commandes de gestion des Jobs :
| |
Commandes pour afficher et gérer le statut de conformité de la politique des Jobs dans votre Workspace :
|
Commandes de pipeline
Groupe | Description et commandes |
|---|---|
Commandes pour modifier et gérer les LakeFlow Pipelines :
|
Commandes Machine Learning
Groupe | Description et commandes |
|---|---|
Commandes pour interagir avec les expérimentations, qui sont l'unité principale d'organisation dans MLflow ; toutes les exécutions MLflow appartiennent à une expérience :
| |
Commandes pour interagir avec les fonctionnalités dans le Magasin de fonctionnalités Databricks, qui fournit un registre central pour les fonctionnalités utilisées dans vos modèles d'IA et de ML.
| |
Commandes pour le Workspace Model Registry :
|
Commandes de service en temps réel
Groupe | Description et commandes |
|---|---|
Commandes pour créer, mettre à jour et supprimer des Endpoints de diffusion de modèles :
|
Commandes d'identité et d'accès
Groupe | Description et commandes |
|---|---|
Commandes pour la gestion des comptes Databricks :
| |
Commandes pour l'authentification :
| |
Commandes pour récupérer des informations sur l'utilisateur ou le Service Principal actuellement authentifié :
| |
Commandes pour les groupes qui simplifient la gestion des identités, ce qui facilite l'attribution de l'accès au Workspace Databricks, aux données et à d'autres objets sécurisables :
| |
Commandes pour la gestion des groupes dans le workspace Databricks à l'aide de l'API mise à jour. Les groupes simplifient la gestion des identités, facilitant l'attribution de l'accès au Workspace Databricks, aux données et à d'autres objets sécurisables :
| |
Commandes pour créer, lire, écrire, modifier, mettre à jour et gérer l'accès pour divers utilisateurs sur différents objets et endpoints :
| |
Commandes de gestion des secrets de Service Principal au niveau du Workspace. Utilisez les secrets générés pour obtenir des jetons d’accès OAuth pour un Service Principal :
| |
Commandes pour les identités à utiliser avec des jobs, des outils automatisés et des systèmes tels que des scripts, des applications et des plateformes CI/CD :
| |
Commandes de gestion des identités de Service Principal à l'aide de l'API mise à jour, pour une utilisation avec des jobs, des outils automatisés et des systèmes tels que des scripts, des applications et des plateformes CI/CD :
| |
Commandes pour les identités d'utilisateur reconnues par Databricks et représentées par des adresses e-mail :
| |
Commandes pour la gestion des identités utilisateur dans le Workspace Databricks à l'aide de l'API mise à jour :
| |
Commandes pour gérer les identités et l'accès au workspace :
|
Commandes liées à SQL
Groupe | Description et commandes |
|---|---|
Commandes pour effectuer des opérations sur les alertes :
| |
Obsolète. Commandes pour effectuer des opérations sur les alertes héritées :
| |
Commandes pour gérer les alertes SQL à l'aide de l'API mise à jour. Une alerte exécute périodiquement une requête, évalue une condition de son résultat et avertit les utilisateurs et/ou les destinations de notification si la condition est remplie :
| |
Obsolète. Commandes pour créer de nouveaux objets de query :
| |
Commandes pour effectuer des opérations sur les définitions de query :
| |
Obsolète. Commandes pour effectuer des Opérations sur les définitions de query héritées :
| |
Commandes pour accéder à l'historique des requêtes via les SQL Warehouse :
| |
Commandes pour gérer les SQL warehouses, qui sont une ressource de compute qui vous permet d'exécuter des commandes SQL sur des objets de données dans Databricks SQL :
|
Commandes Unity Catalog
Groupe | Description et commandes |
|---|---|
Commandes pour gérer les listes d'autorisation d'artefacts. Dans Databricks Runtime 13.3 et versions ultérieures, vous pouvez ajouter des bibliothèques et des scripts d'initialisation à la liste d'autorisation dans UC afin que les utilisateurs puissent tirer parti de ces artefacts sur le compute configuré avec le mode d'accès standard :
| |
Commandes pour gérer les catalogues, la première couche de l'espace de noms à trois niveaux de Unity Catalog :
| |
Commandes pour créer une connexion à une source de données externe :
| |
Commandes permettant de gérer les identifiants, qui sont le mécanisme d'authentification et d'autorisation pour accéder aux services sur votre tenant cloud. Chaque identifiant est soumis aux politiques de contrôle d'accès de Unity Catalog qui déterminent quels utilisateurs et groupes peuvent accéder à l'identifiant.
| |
Commandes pour gérer les configurations de classification des données pour les catalogues Unity Catalog. La classification des données identifie et tague automatiquement les données sensibles dans les tables Unity Catalog :
| |
Commandes pour gérer la qualité des données des objets Unity Catalog (prennent actuellement en charge les schémas et les tables) :
| |
Commandes pour créer, mettre à jour, supprimer et lister les attributions de tags entre les entités Unity Catalog :
| |
Commandes pour définir et gérer les relations de traçabilité entre les objets Databricks et les systèmes externes :
| |
Commandes pour gérer les emplacements externes, qui combinent un chemin de stockage cloud avec un identifiant de stockage qui autorise l'accès au chemin de stockage cloud :
| |
Commandes pour enregistrer et gérer les métadonnées concernant les systèmes externes au sein de Unity Catalog :
| |
Commandes pour gérer les fonctions définies par l'utilisateur (UDF) dans Unity Catalog :
| |
Commandes pour accorder l'accès aux données dans Unity Catalog :
| |
Commandes pour gérer les metastores, qui sont le conteneur de niveau supérieur des objets dans Unity Catalog :
| |
Commandes pour gérer les versions de modèle. Databricks fournit une version hébergée de MLflow Model Registry dans Unity Catalog.
| |
Commandes pour gérer les tables en ligne, qui offrent une latence plus faible et un accès QPS plus élevé aux données des tables Delta :
| |
Commandes pour gérer les politiques de contrôle d'accès basé sur les attributs (ABAC) dans Unity Catalog. Avec les politiques ABAC, l'accès est contrôlé en fonction des attributs des données plutôt que des Ressources spécifiques :
| |
Commandes pour gérer les moniteurs, qui compute et surveillent les métriques de qualité des données ou des modèles pour une table au fil du temps :
| |
Obsolète. Commandes pour gérer les moniteurs de qualité des données sur les objets Unity Catalog. Utilisez la qualité des données à la place :
| |
Commandes pour gérer les modèles enregistrés. Databricks fournit une version hébergée de MLflow Model Registry dans Unity Catalog.
| |
Commandes pour gérer les quotas de ressources imposés par Unity Catalog sur tous les objets sécurisables, qui limitent le nombre de ressources pouvant être créées.
| |
Commandes pour permettre aux utilisateurs de demander l'accès aux éléments sécurisables de Unity Catalog.
| |
Commandes pour gérer les schémas, qui sont la deuxième couche de l’espace de noms à trois niveaux de Unity Catalog :
| |
Commandes pour gérer les identifiants de stockage, qui sont un mécanisme d'authentification et d'autorisation pour accéder aux données stockées sur votre tenant cloud :
| |
Commandes pour gérer les schémas système, qui sont des schémas qui résident dans le catalogue système :
| |
Commandes pour gérer les contraintes de clé primaire et de clé étrangère qui encodent les relations entre les champs des tables :
| |
Commandes pour gérer les tables, qui se trouvent dans la troisième couche de l'espace de noms à trois niveaux du Unity Catalog :
| |
Commandes pour gérer les identifiants de chemin d'accès temporaire, qui sont des identifiants à courte durée de vie et à portée réduite utilisés pour accéder aux emplacements de stockage cloud externes enregistrés dans Databricks.
| |
Commandes pour gérer les identifiants de table temporaires, qui sont des identifiants de courte durée et à portée limitée, utilisés pour accéder aux emplacements de stockage cloud où les données de table sont stockées dans Databricks.
| |
Commandes de gestion des volumes, qui sont une capacité Unity Catalog (UC) pour l'accès, le stockage, la gouvernance, l'organisation et le traitement des fichiers :
| |
Commandes pour gérer les liaisons de Workspace sécurisables. Les ressources sécurisables dans Databricks peuvent être configurées en tant que
|
Étiqueter les commandes
Groupe | Description et commandes |
|---|---|
Commandes pour gérer les politiques de tags gouvernés dans Databricks :
| |
Commandes pour gérer les attributions de balises sur les objets associés au Workspace :
|
commandes OpenSharing
Groupe | Description et commandes |
|---|---|
Commandes pour gérer les fournisseurs de données, qui représentent les organisations qui partagent des données :
| |
Commandes pour gérer l'activation du destinataire, ce qui n'est applicable que dans le modèle de partage Databricks-to-Open où l'objet destinataire a le type d'authentification TOKEN :
| |
Commandes pour gérer les destinataires, que vous créez à l'aide de
| |
Commandes pour gérer les politiques de fédération pour les destinataires OIDC dans le modèle de partage Databricks-to-Open :
| |
Commandes pour gérer les partages, qui sont des conteneurs instanciés avec
|
Commandes de paramètres
Groupe | Description et commandes |
|---|---|
Commandes permettant aux administrateurs de configurer les listes d'accès IP :
| |
Commandes pour gérer les destinations de notification d'un Workspace :
| |
Commandes pour permettre aux utilisateurs de gérer les paramètres au niveau du Workspace :
| |
Commandes qui permettent aux administrateurs d’obtenir tous les jetons et de supprimer les jetons pour d’autres utilisateurs :
| |
Commandes pour créer, lister et révoquer des jetons qui peuvent être utilisés pour authentifier et accéder aux APIs REST Databricks :
| |
Commandes pour mettre à jour les paramètres du workspace :
| |
Commandes pour gérer les paramètres au niveau du Workspace à l'aide de l'API mise à jour :
|
Commandes des outils de développement
Groupe | Description et commandes |
|---|---|
Commandes pour installer, gérer et mettre à jour les compétences Databricks AI pour les agents de codage :
| |
Commandes pour gérer les Declarative Automation Bundles, qui vous permettent d'exprimer vos projets Databricks sous forme de code :
| |
Synchroniser un répertoire local avec un répertoire de Workspace. | |
Commandes pour configurer et établir des connexions SSH vers votre compute et votre workspace Databricks.
|
Commandes de Recherche IA
Groupe | Description et commandes |
|---|---|
Commandes pour gérer les Endpoint de recherche IA, qui représentent les ressources de compute pour héberger les index de recherche IA :
| |
Commandes pour gérer les index de recherche IA, une représentation efficace de vos vecteurs d'intégration qui prend en charge les query de recherche par plus proches voisins (ANN) approximatives, efficaces et en temps réel :
|
Commandes du tableau de bord
Groupe | Description et commandes |
|---|---|
Commandes pour modifier Genie, qui offre une expérience sans code aux utilisateurs professionnels, alimentée par l'AI/BI :
| |
Commandes qui fournissent des Opérations de gestion spécifiques pour les tableaux de bord AI/BI :
| |
Commandes pour les API Lakeview basées sur des jetons pour l'intégration de tableaux de bord AI/BI dans des applications externes :
|
Commandes des assistants de connaissances
Groupe | Description et commandes |
|---|---|
Commandes pour gérer les Assistants de connaissances et les Ressources associées :
|
Commandes marketplace
Groupe | Description et commandes |
|---|---|
Commandes pour la gestion des réalisations, qui sont des entités qui permettent aux consommateurs de prévisualiser les installations.
| |
Commandes pour gérer les installations, qui sont des entités permettant aux consommateurs d’interagir avec les listings de Databricks Marketplace.
| |
Commandes pour gérer les listings des consommateurs Databricks Marketplace :
| |
Commandes pour la gestion des demandes de personnalisation, qui permettent aux clients d'interagir avec le flux de listing individualisé de la marketplace.
| |
Commandes pour la gestion des fournisseurs, qui sont les entités qui publient des listings sur la Marketplace.
| |
Commandes pour la gestion des filtres d'échanges Marketplace, qui définissent les groupes pouvant accéder à un échange.
| |
Commandes pour la gestion des échanges sur la Marketplace, qui permettent aux fournisseurs de partager leurs listes avec un ensemble ciblé de clients.
| |
Commandes pour la gestion des fichiers Marketplace, tels que les aperçus de Notebook et les icônes de fournisseur.
| |
Commandes pour la gestion des listings de fournisseurs :
| |
Commandes de gestion des demandes de personnalisation, qui sont une alternative aux listings instantanément disponibles.
| |
Commandes pour gérer l'analytique basée sur des modèles pour les fournisseurs :
| |
Commandes pour gérer les fournisseurs, qui gèrent les assets dans la marketplace.
|
Commandes d'applications
Groupe | Description et commandes |
|---|---|
Commandes pour gérer les applications Databricks, qui s'exécutent directement sur votre instance Databricks, s'intègrent à vos données, utilisent et étendent les services Databricks, et permettent aux utilisateurs d'interagir via le Single Sign On.
|
Commandes de Salles blanches
Groupe | Description et commandes |
|---|---|
Commandes pour afficher les nouvelles versions des assets de salle blanche upload.
| |
Commandes pour gérer les asset de salle blanche, qui sont des objets de données et de code tels que des tables, des volumes et des Notebook partagés avec la salle blanche.
| |
Commandes pour gérer les règles d'approbation automatique de la salle blanche.
| |
Commandes pour gérer les exécutions de tâches de salle blanche, qui sont les exécutions de notebooks dans une salle blanche.
| |
Commandes pour gérer les salles blanches. Les salles blanches utilisent OpenSharing et le compute serverless pour fournir un environnement sécurisé et protégeant la confidentialité, où plusieurs parties peuvent travailler ensemble sur des données d'entreprise sensibles sans accès direct aux données de chacun.
|
Commandes de base de données
Groupe | Description et commandes |
|---|---|
Commandes pour gérer les instances de base de données Lakebase.
| |
Commandes pour créer et gérer l'infrastructure Lakebase Autoscaling Postgres, y compris les projets, les branches, les endpoints de compute et les rôles :
| |
Une commande pour se connecter à une instance de base de données spécifiée. |
Commandes supplémentaires
Groupe | Description et commandes |
|---|---|
Commandes pour envoyer des requêtes à l'API REST Databricks :
| |
Commandes pour générer le script d'autocomplétion pour le shell spécifié :
| |
Configurez la CLI Databricks. | |
| Afficher les informations récapitulatives pour toutes les commandes Databricks CLI. |
Commandes pour gérer les installations Databricks Labs :
| |
Récupérer la version de la CLI actuellement utilisée. |
Drapeaux globaux
Les drapeaux suivants sont disponibles pour toutes les commandes Databricks CLI. Notez que certains drapeaux ne s'appliquent pas à certaines commandes. Pour des informations détaillées sur les commandes spécifiques et leurs drapeaux, consultez l'aide de la ligne de commande.
--debug
Activer ou non la journalisation de débogage.
-h OU --help
Afficher l'aide de Databricks CLI ou du groupe de commandes associé ou de la commande associée.
--log-file chaîne
Une chaîne représentant le fichier dans lequel écrire les logs de sortie. Si cet indicateur n'est pas spécifié, la default est d'écrire les logs de sortie dans stderr.
--log-format Format
Le type de format de log, text ou json. La valeur par default est text.
--log-level chaîne
Une chaîne représentant le niveau de format du log. S'il n'est pas spécifié, le niveau de format du log est désactivé.
-o, --output Type
Le type de sortie de commande, text ou json. La valeur par default est text.
-p, --profile chaîne
Nom du profil dans le fichier ~/.databrickscfg à utiliser pour exécuter la commande. Si cet indicateur n'est pas spécifié, alors s'il existe, le profil nommé DEFAULT est utilisé.
--progress-format Format
Le format pour afficher les logs de progression : default, append, inplace ou json
-t, --target chaîne
Le cas échéant, la cible de bundle à utiliser