Commandes CLI Databricks

Note

Ces informations s'appliquent aux versions 0.205 et ultérieures de l'interface CLI Databricks. 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.

Cet article fournit des informations sur les commandes CLI Databricks disponibles. Ces informations complètent l’aide relative à la ligne de commande. Pour plus d'informations sur l'installation et l'utilisation de l'interface CLI Databricks, consultez Installer ou mettre à jour l’interface CLI Databricks et Qu’est-ce que l’interface CLI Databricks ?.

L'interface CLI Databricks comprend les groupes de commandes répertoriés dans les tableaux suivants. Les groupes de commandes contiennent des jeux de commandes associées, qui peuvent également contenir des sous-commandes. Pour afficher les informations d'utilisation et de syntaxe d'un groupe de commandes, d'une commande individuelle ou d'une sous-commande :

• databricks <command-group> -h
• databricks <command-group> <command-name> -h
• databricks <command-group> <command-name> <subcommand-name> -h

De nombreuses commandes CLI correspondent à des opérations documentées dans les Informations de référence sur l’API REST Azure Databricks.

Commandes d’espace de travail

Group	Description et commandes
fs	Commandes permettant de gérer les fichiers et le système de fichiers : cat, , cpls, , mkdirrm
git-credentials	Commandes permettant d’enregistrer des jetons d’accès personnels pour que Databricks puisse effectuer des opérations au nom de l'utilisateur : create, , deleteget, , listupdate
repos	Commandes permettant aux utilisateurs de gérer leurs dépôts Git : create, , deleteget, , listupdate get-permission-levels get-permissions set-permissions update-permissions
secrets	Commandes permettant de gérer les secrets, les étendues de secrets et les autorisations d’accès : create-scope, , delete-acl, , delete-scopedelete-secretget-aclget-secretlist-aclslist-scopeslist-secretsput-aclput-secret
workspace	Commandes permettant de répertorier, d’importer, d’exporter et de supprimer des notebooks et des dossiers dans l'espace de travail : delete, export, , export-dirget-status, import, import-dir, , list,mkdirs get-permission-levels get-permissions set-permissions update-permissions

Commandes de calcul

Group	Description et commandes
stratégies de cluster	Commandes pour contrôler la capacité des utilisateurs à configurer des clusters en fonction d’un ensemble de règles : create, , deleteedit, , getlist get-permission-levels get-permissions set-permissions update-permissions
clusters	Commandes permettant de créer, de démarrer, de modifier, de lister, d’arrêter et de supprimer des clusters : change-owner, create, deleteediteventsget, , , listlist-node-typeslist-zonespermanent-deletepinresizerestartspark-versionsstartunpin get-permission-levels get-permissions set-permissions update-permissions
global-init-scripts	Commandes permettant aux administrateurs de l’espace de travail de configurer des scripts d’initialisation globaux pour leur espace de travail : create, , deleteget, , listupdate
instances-pools	Commandes permettant de créer, modifier, supprimer et répertorier des pools d’instances à l’aide d’instances cloud prêtes à l’emploi, ce qui réduit les temps de démarrage et de mise à l’échelle automatique des clusters : create, , deleteedit, , getlist get-permission-levels get-permissions set-permissions update-permissions
profils d’instance	Commandes permettant aux administrateurs d’ajouter, de répertorier et de supprimer des profils d’instance que les utilisateurs peuvent utiliser pour lancer des clusters : add edit list remove
Bibliothèques	Commandes permettant d'installer, de désinstaller et obtenir l’état des bibliothèques sur un cluster : all-cluster-statuses cluster-status install uninstall
policy-families	Commandes permettant d'afficher les familles de stratégies disponibles : get, list

Commandes de travaux

Group	Description et commandes
jobs	Commandes permettant de gérer les tâches : cancel-all-runs, cancel-run, , create, deletedelete-run, export-run, getget-runget-run-outputlistlist-runsrepair-runresetrun-nowsubmit,update get-permission-levels get-permissions set-permissions update-permissions

Commandes de Lakeflow Spark pour les pipelines déclaratifs

Group	Description et commandes
pipelines	Commandes permettant de créer, modifier, supprimer, démarrer et afficher des détails sur les pipelines : create, , delete, getget-update, , list-pipeline-eventslist-pipelineslist-updatesstart-updatestopupdate get-permission-levels get-permissions set-permissions update-permissions

Commandes de Machine Learning

Group	Description et commandes
experiments	Commandes permettant d’interagir avec les expériences, unité principale d’organisation dans MLflow (toutes les exécutions MLflow appartiennent à une expérience) : create-experiment, , create-run, delete-experimentdelete-rundelete-runsdelete-tagget-by-nameget-experimentget-historyget-runGetlist-artifactslist-experimentslog-batchlog-inputslog-metriclog-modellog-paramrestore-experimentrestore-runrestore-runssearch-experimentssearch-runsset-experiment-tagset-tagupdate-experimentupdate-run get-permission-levels get-permissions set-permissions update-permissions
ingénierie des fonctionnalités	Commandes permettant d’interagir avec les fonctionnalités du Magasin de fonctionnalités Databricks, qui fournit un registre central pour les fonctionnalités utilisées dans vos modèles IA et ML. create-feature, , delete-featureget-feature, , list-featuresupdate-feature
model-registry	Commandes pour le registre de modèles de l’espace de travail : approve-transition-request, , create-commentcreate-modelcreate-model-versioncreate-transition-requestcreate-webhookdelete-commentdelete-modeldelete-model-tagdelete-model-versiondelete-model-version-tagdelete-transition-requestdelete-webhookget-latest-versionsget-modelget-model-versionget-model-version-download-urilist-modelslist-transition-requestslist-webhooksreject-transition-requestrename-modelsearch-model-versionssearch-modelsset-model-tagset-model-version-tagtest-registry-webhooktransition-stageupdate-commentupdate-modelupdate-model-versionupdate-webhook get-permission-levels get-permissions set-permissions update-permissions

Commandes de service en temps réel

Group	Description et commandes
service-points de terminaison	Commandes permettant de créer, mettre à jour et supprimer des points de terminaison de service de modèles : build-logs, , create, , deleteexport-metricsgetlistlogspatchputqueryupdate-config get-permission-levels get-permissions set-permissions update-permissions

Commandes de gestion des identités et des accès

Group	Description et commandes
account	Commandes permettant de gérer des comptes Databricks : Identité et accès : access-control, , groupsservice-principals, usersworkspace-assignment Catalogue Unity : metastore-assignments, metastores, storage-credentials Paramètres : ip-access-lists, , network-connectivitysettings Approvisionnement : credentials, , encryption-keysnetworks, private-accessstorage, , vpc-endpointsworkspaces Facturation : billable-usage, log-delivery OAuth : custom-app-integration, , o-auth-published-appspublished-app-integration,service-principal-secrets
auth	Commandes d’authentification : describe, , envlogin, , profilestoken
current-user	Commandes permettant de récupérer des informations sur l’utilisateur ou le principal de service actuellement authentifié : me
groups	Commandes pour les groupes simplifiant la gestion des identités, facilitant l’octroi d’accès à l’espace de travail Databricks, aux données et à d'autres objets sécurisables : create, , delete, getlist, , patchupdate
permissions	Commandes permettant de créer, lire, écrire, modifier, mettre à jour et gérer l’accès pour différents utilisateurs sur différents objets et points de terminaison : get, , setupdate get-permission-levels
principaux de service	Commandes pour les identités à utiliser avec des travaux, des outils automatisés et des systèmes tels que des scripts, des applications et des plateformes CI/CD : create, , delete, getlist, , patchupdate
users	Commandes pour les identités utilisateur reconnues par Databricks et représentées par des adresses e-mail : create, , delete, getlist, , patchupdate get-permission-levels get-permissions set-permissions update-permissions

Commandes liées à SQL

Group	Description et commandes
alerts	Commandes permettant d'effectuer des opérations sur les alertes : create, , deleteget, , listupdate
alertes héritées	Commandes pour effectuer des opérations sur les alertes héritées : create, , deleteget, , listupdate
sources de données	Commandes permettant de créer de nouveaux objets de requête : list
queries	Commandes permettant d'effectuer des opérations sur les définitions de requête : create, , delete, getlist, , restoreupdate
requêtes héritées	Commandes pour effectuer des opérations sur les définitions de requête héritées : create, , delete, getlist, , restoreupdate
query-history	Commandes permettant d'accéder à l’historique des requêtes via des entrepôts SQL : list
Entrepôts	Commandes permettant de gérer des entrepôts SQL, qui sont une ressource de calcul qui vous permet d’exécuter des commandes SQL sur des objets de données dans Databricks SQL : create, delete, , editget, get-workspace-warehouse-config, list, set-workspace-warehouse-config, start,stop get-permission-levels get-permissions set-permissions update-permissions

Commandes Unity Catalog

Group	Description et commandes
artefact-allowlists	Commandes permettant de gérer des 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 Unity Catalog afin que les utilisateurs puissent utiliser ces artefacts sur les ressources de calcul configurées avec le mode d’accès standard : get, update
catalogs	Commandes pour gérer les catalogues, la première couche de l'espace de noms à trois niveaux du Unity Catalog : create, , deleteget, , listupdate
Pouvoirs	Commandes pour gérer les informations d’identification, qui sont le mécanisme d’authentification et d’autorisation pour accéder aux services sur votre locataire cloud. Chaque informations d’identification est soumise aux stratégies de contrôle d’accès du catalogue Unity qui contrôlent les utilisateurs et les groupes qui peuvent accéder aux informations d’identification. create-credential, delete-credential, , generate-temporary-service-credentialget-credential, list-credentials, , update-credential,validate-credential
connections	Commandes permettant de créer une connexion à une source de données externe : create, , deleteget, , listupdate
external-locations	Commandes permettant de gérer des emplacements externes, qui combinent un chemin d'accès au stockage cloud avec des informations d'identification de stockage autorisant l'accès à ce chemin d'accès : create, , deleteget, , listupdate
functions	Commandes pour gérer les fonctions définies par l’utilisateur dans le catalogue Unity : create, , deleteget, , listupdate
grants	Commandes permettant d'accorder l’accès aux données dans Unity Catalog : get, , get-effectiveupdate
metastores	Commandes permettant de gérer les metastores, qui sont les conteneurs de niveau supérieur des objets dans Unity Catalog : assign, , create, currentdelete, , getlistsummaryunassignupdateupdate-assignment
versions de modèle	Commandes permettant de gérer les versions du modèle. Databricks fournit une version hébergée du registre de modèles MLflow dans Unity Catalog. delete, , getget-by-alias, , listupdate
tables en ligne	Commandes permettant de gérer des tables en ligne, qui fournissent une latence plus faible et un accès QPS plus élevé aux données des tables Delta : create, , deleteget
moniteurs de qualité	Commandes permettant de gérer des moniteurs, qui calculent et surveillent les données ou les métriques de qualité des modèles pour une table au fil du temps : create, delete, , getget-refresh, list-refreshes, , run-refresh,update
registered-models	Commandes permettant de gérer les modèles inscrits. Databricks fournit une version hébergée du registre de modèles MLflow dans Unity Catalog. create, delete, , delete-aliasget, list, , set-alias,update
quotas de ressources	Commandes pour gérer les quotas de ressources appliqués par le catalogue Unity sur tous les objets sécurisables, ce qui limite le nombre de ressources qui peuvent être créées. get-quota, list-quotas
schemas	Commandes pour gérer les schémas, qui sont la deuxième couche de l’espace de noms de trois niveaux du catalogue Unity : create, , deleteget, , listupdate
informations d’identification de stockage	Commandes permettant de gérer les informations d’identification de stockage, qui représentent un mécanisme d’authentification et d’autorisation pour accéder aux données stockées sur votre locataire cloud : create, , delete, getlist, , updatevalidate
schémas système	Commandes permettant de gérer les schémas système, qui sont des schémas qui se trouvent dans le catalogue système : disable, , enablelist
contraintes de table	Commandes permettant de gérer les contraintes de clé primaire et de clé étrangère qui encodent les relations entre les champs des tables : create, delete
tables	Commandes pour gérer les tables, qui se trouvent dans la troisième couche de l’espace de noms de trois niveaux du catalogue Unity : delete, , existsget, , listlist-summaries
informations d’identification temporaires de table	Commandes permettant de gérer les informations d’identification de table temporaires, qui sont des informations d’identification de courte durée et à portée inférieure utilisées pour accéder aux emplacements de stockage cloud où les données de table sont stockées dans Databricks. generate-temporary-table-credentials
volumes	Commandes permettant de gérer les volumes, qui sont une fonctionnalité de Unity Catalog (UC) pour accéder, stocker, gérer, organiser et traiter des fichiers : create, , deletelist, , readupdate
liaisons d’espace de travail	Commandes permettant de gérer les liaisons sécurisées de l'espace de travail. Les éléments sécurisables dans Databricks peuvent être configurés en tant que OPEN ou ISOLATED. get get-bindings update update-bindings

Commandes Delta sharing

Group	Description et commandes
providers	Commandes permettant de gérer les fournisseurs de données, qui représentent les organisations qui partagent des données : create, , delete, getlist, , list-sharesupdate
activation du destinataire	Commandes permettant de gérer l’activation des destinataires, qui s’appliquent uniquement dans le modèle de partage ouvert où l’objet destinataire a le type d'authentification TOKEN : get-activation-url-info, retrieve-token
recipients	Commandes permettant de gérer les destinataires, que vous créez à l'aide de :method:recipients/create pour représenter une organisation dont vous voulez autoriser l’accès aux partages : create, , delete, getlist, , rotate-tokenupdate share-permissions
Actions	Commandes permettant de gérer les partages, qui sont des conteneurs instanciés avec :method:shares/create : create, , delete, getlist, , list-sharesupdate share-permissions, update-permissions

Commandes de paramètres

Group	Description et commandes
ip-access-lists	Commandes permettant aux administrateurs de configurer des listes d’accès IP : create, , delete, getlist, , replaceupdate
destinations de notification	Commandes pour gérer les destinations de notification d’un espace de travail : create, , deleteget, , listupdate
settings	Commandes permettant aux utilisateurs de gérer les paramètres au niveau de l’espace de travail : automatic-cluster-update, , csp-enablementdefault-namespace, , esm-enablementrestrict-workspace-admins
gestion des jetons	Commandes permettant aux administrateurs d’obtenir tous les jetons et de supprimer les jetons d’autres utilisateurs : create-obo-token delete get list get-permission-levels get-permissions set-permissions update-permissions
Jetons	Commandes permettant de créer, répertorier et révoquer des jetons qui peuvent être utilisés pour authentifier les API REST Databricks et y accéder : create, , deletelist
workspace-conf	Commandes permettant de mettre à jour les paramètres de l’espace de travail : get-status, set-status

Commandes des outils de développement

Group	Description et commandes
bundle	Commandes permettant de gérer les packs de ressources Databricks, qui vous permettent d’exprimer vos projets Databricks sous forme de code : deploy, deployment, destroy, generate, init, open, plan, run, schema, summary, sync, validate
sync	Synchronisez un répertoire local avec un répertoire d’espace de travail.

Commandes de recherche vectorielle

Group	Description et commandes
vector-search-endpoints	Commandes permettant de gérer les points de terminaison de recherche vectorielle, qui représentent les ressources de calcul pour héberger des index de recherche vectorielle : create-endpoint delete-endpoint get-endpoint list-endpoints
vector-search-indexes	Commandes permettant de gérer les index de recherche vectorielle, qui sont une représentation efficace de vos vecteurs d’incorporation qui prennent en charge des requêtes efficaces et en temps réel de recherche basées sur la méthode de plus proche voisin approximatif : create-index, delete-data-vector-index, , delete-indexget-index, list-indexes, query-index, , sync-index,upsert-data-vector-index

Commandes de tableau de bord

Group	Description et commandes
dashboards	Commandes pour la modification des tableaux de bord hérités : create, , delete, getlist, , restoreupdate
genie	Commandes pour la modification de Genie, qui offre une expérience sans code pour les utilisateurs professionnels, optimisée par l’IA/BI : create-message, , execute-message-attachment-query, get-messageget-message-attachment-query-result, , get-spacedstart-conversation
Lakeview	Commandes fournissant des opérations de gestion spécifiques pour les tableaux de bord AI/BI : create, create-schedule, , create-subscription, , delete-scheduledelete-subscriptiongetget-publishedget-scheduleget-subscriptionlistlist-scheduleslist-subscriptionsmigratepublishtrashunpublishupdateupdate-schedule

Commandes de la Place de marché

Group	Description et commandes
traitement des consommateurs	Commandes permettant de gérer les exécutions, qui sont des entités permettant aux consommateurs de prévisualiser les installations. get, list
installations de consommateur	Commandes pour gérer les installations, qui sont des entités permettant aux consommateurs d’interagir avec les annonces de la Place de marché Databricks. create, , deletelist, , list-listing-installationsupdate
listings de consommateurs	Commandes pour la gestion des descriptions des consommateurs de la Place de marché Databricks : batch-get get list search
consumer-personnalisation-requests	Commandes pour la gestion des demandes de personnalisation, permettant aux clients d’interagir avec le processus de création de fiches personnalisées du Marketplace. create, , getlist
fournisseurs de consommateurs	Commandes pour la gestion des fournisseurs, qui sont les entités qui publient des descriptions sur la Place de marché. batch-get, , getlist
provider-exchange-filters	Commandes pour la gestion des filtres d’échange de la Place de marché, qui organisent les groupes qui peuvent accéder à un échange. create delete list update
échanges de fournisseurs	Commandes pour la gestion des échanges de la Place de marché, qui permettent aux fournisseurs de partager leurs annonces avec un ensemble organisé de clients. add-listing-to-exchange, create, , deletedelete-listing-from-exchange, get, list, list-exchanges-for-listing, list-listings-for-exchange,update
provider-files	Commandes pour la gestion des fichiers de la place de marché, comme les carnets de prévisualisation et les icônes de fournisseur. create delete get list
listes de fournisseurs	Commandes pour la gestion des listes de fournisseurs : create, , deleteget, , listupdate
provider-personnalisation-requests	Commandes pour la gestion des demandes de personnalisation, qui sont une alternative aux listes disponibles instantanément. list, update
provider-provider-analytics-dashboards	Commandes pour gérer l’analytique avec modèle pour les fournisseurs : create get get-latest-version update
fournisseurs-fournisseurs	Commandes pour gérer les fournisseurs, qui gèrent les ressources dans la Place de marché. create, , deleteget, , listupdate

Commandes d’applications

Group	Description et commandes
apps	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 l’authentification unique. create, delete, deploy, get, get-deployment, list, list-deployments, logs, run-local, start, stop, update

Commandes Clean rooms

Group	Description et commandes
clean-room-assets	Commandes permettant de gérer les ressources de clean room, qui sont des données et des objets de code tels que des tables, des volumes et des notebooks partagés avec la clean room. create, , deleteget, , listupdate
clean-room-task-runs	Commandes permettant de gérer les exécutions de tâches de clean room, qui sont les exécutions de notebooks dans une clean room. list
salles propres	Commandes pour gérer les salles propres. Les salles propres utilisent le partage Delta et le calcul serverless pour fournir un environnement sécurisé et de protection de la confidentialité où plusieurs parties peuvent travailler ensemble sur des données d’entreprise sensibles sans accéder directement aux données des uns des autres. create, , create-output-catalog, deleteget, , listupdate

Commandes de base de données

Group

Description et commandes

base de données

Commandes pour gérer les instances de base de données Lakebase. create-database-catalog, create-database-instance, , create-database-table, create-synced-database-tabledelete-database-catalog, delete-database-instance, delete-database-tabledelete-synced-database-tablefind-database-instance-by-uidgenerate-database-credentialget-database-catalogget-database-instanceget-database-tableget-synced-database-tablelist-database-instances,update-database-instance

Commandes supplémentaires

Group	Description et commandes
api	Commandes permettant d'effectuer des requêtes à l’API REST Databricks : delete, , get, headpatch, , postput
completion	Commandes permettant de générer le script d’auto-complétion pour l’interpréteur de commandes spécifié : bash fish powershell zsh
configure	Configurez l'interface CLI Databricks.
help	Informations récapitulatives de sortie pour toutes les commandes CLI Databricks.
labs	Commandes permettant de gérer les installations Databricks Labs : clear-cache, install, , installedlist, show, , uninstall,upgrade
version	Récupérez la version de l’interface CLI en cours d’utilisation.

Indicateurs globaux

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 sur des commandes spécifiques et leurs indicateurs, consultez l’aide relative à la ligne de commande.

--debug

  Active la journalisation du débogage.

-h ou --help

    Affiche l’aide pour l’interface CLI de Databricks, le groupe de commandes associé ou la commande concernée.

--log-file chaîne

    Chaîne représentant le fichier dans lequel écrire les journaux de sortie. Si cet indicateur n’est pas défini, les journaux de sortie sont écrits par défaut dans stderr.

--log-format Format

    Format des journaux : text ou json. La valeur par défaut est text.

--log-level chaîne

    Chaîne représentant le niveau de journalisation. Si cet indicateur n’est pas défini, le niveau de format de journal est désactivé.

Type -o, --output

    Type de sortie de commande, text ou json. La valeur par défaut est text.

-p, --profile chaîne

    Nom du profil dans le ~/.databrickscfg fichier à utiliser pour exécuter la commande. Si cet indicateur n’est pas spécifié, s’il existe, le profil nommé DEFAULT est utilisé.

--progress-format Format

    Format d’affichage des journaux d’activité de progression : default, append, inplace ou json

-t, --target chaîne

    Le cas échéant, la cible d’offre groupée à utiliser