groupe de commandesapps
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.
Le groupe de commandes apps dans l’ interface CLI Databricks vous permet de gérer les applications. Les applications s’exécutent directement sur l’instance Databricks d’un client, s’intègrent à leurs données, utilisent et étendent les services Databricks, et permettent aux utilisateurs d’interagir via le Single Sign On. See Databricks Apps.
créer des applications databricks
Créer une nouvelle application.
databricks apps create NAME [flags]
Arguments
NAME
Le nom de l'application. Le nom ne doit contenir que des caractères alphanumériques minuscules et des tirets. Il doit être unique au sein du workspace.
Options
--budget-policy-id string
ID de stratégie de budget pour l'application.
--compute-size ComputeSize
La taille de compute pour l'application. Valeurs prises en charge : LARGE, MEDIUM.
--description string
La description de l'application.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--no-compute
Si vrai, l'application ne sera pas start après la création.
--no-wait
N'attendez pas d'atteindre l'état ACTIF.
--space string
Nom de l'espace auquel cette application appartient.
--timeout duration
Durée maximale pour atteindre l'état ACTIF (default 20m0s).
--usage-policy-id string
ID de la politique d'utilisation de l'application.
Exemples
L'exemple suivant crée une application de base :
databricks apps create my-analytics-app --description "Analytics dashboard app"
L'exemple suivant crée une application sans la démarrer :
databricks apps create my-data-app --description "Data processing app" --no-compute
L'exemple suivant crée une application avec un délai d'expiration personnalisé :
databricks apps create my-ml-app --description "Machine learning app" --timeout 30m
databricks apps create-update
Crée une mise à jour d'application et démarre le processus de mise à jour. Le processus de mise à jour est asynchrone et le statut de la mise à jour peut être vérifié avec la méthode GetAppUpdate.
databricks apps create-update APP_NAME UPDATE_MASK [flags]
Arguments
APP_NAME
Le nom de l'application.
UPDATE_MASK
Le masque de champ doit être une chaîne unique, avec plusieurs champs séparés par des virgules (sans espaces). Le chemin du champ est relatif à l'objet ressource, en utilisant un point (.) pour naviguer dans les sous-champs (par exemple, author.given_name). La spécification d’éléments dans des champs de séquence ou de carte n’est pas autorisée, car seul le champ de collection entier peut être spécifié. Les noms de champs doivent correspondre exactement aux noms des champs de ressource.
Un masque de champ de * indique un remplacement complet. Il est recommandé de toujours répertorier explicitement les champs mis à jour et d'éviter d'utiliser des caractères génériques *, car cela peut entraîner des résultats inattendus si l'API change à l'avenir.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--no-wait
N'attendez pas d'atteindre l'état SUCCEEDED.
--timeout duration
Durée maximale pour atteindre l'état RÉUSSI (default 20m0s).
Exemples
L'exemple suivant crée une mise à jour d'application avec un masque de champ spécifique :
databricks apps create-update my-analytics-app "description" --json '{"description": "Updated app description"}'
L'exemple suivant crée une mise à jour d'application sans attendre la fin :
databricks apps create-update my-data-app "budget_policy_id" --json '{"budget_policy_id": "new-policy-123"}' --no-wait
L'exemple suivant crée une mise à jour d'application avec un délai d'attente personnalisé :
databricks apps create-update my-ml-app "description,budget_policy_id" --json '{"description": "Updated ML app", "budget_policy_id": "ml-policy-456"}' --timeout 30m
Supprimer les applications Databricks
Supprimer une application.
Lorsqu’elle est exécutée depuis un répertoire de projet Databricks Apps (contenant databricks.yml) sans un argument NAME, cette commande détruit toutes les ressources déployées par le projet. Lorsqu'un argument NAME est fourni ou lorsqu'il n'est pas dans un répertoire de projet, supprime l'application spécifiée directement à l'aide de l'API.
databricks apps delete [NAME] [flags]
Arguments
NAME
Le nom de l'application. Obligatoire si vous n'êtes pas dans un répertoire de projet. Lorsqu'il est fourni dans un répertoire de projet, il utilise la suppression d'API au lieu de la destruction de projet.
Options
--auto-approve
Ignorer les approbations interactives pour la suppression des ressources et des fichiers.
--force-lock
Forcez l’acquisition du verrou de déploiement.
Exemples
L’exemple suivant supprime une application :
databricks apps delete my-analytics-app
L'exemple suivant détruit toutes les ressources du projet à partir d'un répertoire de projet :
databricks apps delete
L'exemple suivant détruit les ressources du projet avec approbation automatique :
databricks apps delete --auto-approve
déploiement d'applications Databricks
Créer un déploiement d'application.
Lorsqu'elle est exécutée depuis un répertoire de projet Databricks Apps (contenant databricks.yml) sans argument APP_NAME, cette commande exécute un pipeline de déploiement amélioré qui valide le projet, le déploie sur le Workspace et exécute l'application. Lorsqu'un argument APP_NAME est fourni ou lorsque vous n'êtes pas dans un répertoire de projet, un déploiement d'application est créé directement à l'aide de l'API.
databricks apps deploy [APP_NAME] [flags]
Arguments
APP_NAME
Le nom de l'application. Obligatoire si vous n'êtes pas dans un répertoire de projet. Lorsqu'il est fourni dans un répertoire de projet, il utilise le déploiement d'API au lieu du déploiement de projet.
Options
--deployment-id string
L'identifiant unique du déploiement.
--force
Forcer le remplacement de la validation de la branch Git.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--mode AppDeploymentMode
Le mode de gestion du code source par le déploiement. Valeurs prises en charge : AUTO_SYNC, SNAPSHOT.
--no-wait
N'attendez pas d'atteindre l'état SUCCEEDED.
--skip-tests
Ignorer l'exécution des tests pendant la validation (default true).
--skip-validation
Ignorer la validation du projet (compilation, vérification de type, lint).
--source-code-path string
Le chemin du système de fichiers du Workspace pour le code source utilisé pour créer le déploiement de l'application.
--timeout duration
Durée maximale pour atteindre l'état RÉUSSI (default 20m0s).
Exemples
L'exemple suivant crée un déploiement avec le mode de synchronisation automatique :
databricks apps deploy my-analytics-app --source-code-path /Workspace/Users/someone@example.com/my-app --mode AUTO_SYNC
L’exemple suivant crée un déploiement en mode instantané :
databricks apps deploy my-data-app --source-code-path /Workspace/Users/someone@example.com/data-app --mode SNAPSHOT
L'exemple suivant crée un déploiement avec un identifiant de déploiement personnalisé :
databricks apps deploy my-ml-app --deployment-id "v1.2.3" --source-code-path /Workspace/Users/someone@example.com/ml-app
databricks apps get
Obtenez des informations pour l'application portant le nom fourni.
databricks apps get NAME [flags]
Arguments
NAME
Le nom de l'application.
Options
Exemples
L’exemple suivant obtient les informations de l’application :
databricks apps get my-analytics-app
L'exemple suivant obtient les informations de l'application au format JSON :
databricks apps get my-data-app --output json
L'exemple suivant obtient les informations d'application en utilisant un profil spécifique :
databricks apps get my-ml-app --profile production
databricks apps get-deployment
Obtenir des informations sur le déploiement de l'application avec le nom et l'ID de déploiement fournis.
databricks apps get-deployment APP_NAME DEPLOYMENT_ID [flags]
Arguments
APP_NAME
Le nom de l'application.
DEPLOYMENT_ID
L'identifiant unique du déploiement.
Options
Exemples
L’exemple suivant obtient les information de déploiement :
databricks apps get-deployment my-analytics-app v1.0.0
L'exemple suivant obtient les informations de déploiement au format JSON :
databricks apps get-deployment my-data-app v2.1.0 --output json
L'exemple suivant obtient des informations de déploiement à l'aide d'un profil spécifique :
databricks apps get-deployment my-ml-app latest --profile production
databricks apps get-update
Obtenir l'état d'une mise à jour d'application.
databricks apps get-update APP_NAME [flags]
Arguments
APP_NAME
Le nom de l'application.
Options
Exemples
L'exemple suivant obtient le statut d'une mise à jour d'application :
databricks apps get-update my-analytics-app
L’exemple suivant obtient l’état de la mise à jour au format JSON :
databricks apps get-update my-data-app --output json
L'exemple suivant obtient l'état de mise à jour à l'aide d'un profil spécifique :
databricks apps get-update my-ml-app --profile production
importation d'applications Databricks
(Expérimental) Importez une application Databricks existante en tant que bundle.
Importez une application Databricks existante et convertissez-la en configuration de bundle. Cette commande crée un nouveau répertoire de bundle avec la configuration de l'application, télécharge le code source de l'application, lie le bundle à l'application existante et le déploie en utilisant le mode de déploiement direct.
databricks apps import [flags]
Arguments
Aucun
Options
--cleanup
Nettoyez le dossier d'application précédent et tout son contenu.
--force-import
Forcer la réimportation d'une application déjà importée (fonctionne uniquement pour les applications que vous possédez).
--name string
Nom de l'application à importer. Si non spécifié, liste toutes les applications pour la sélection interactive.
--output-dir string
Répertoire de sortie du bundle. default, le nom de l'application est utilisé.
-q, --quiet
Supprimer les messages d'information (afficher uniquement les erreurs et les invites).
Exemples
L'exemple suivant importe une application, créant un répertoire nommé d'après l'application :
databricks apps import --name my-streamlit-app
L'exemple suivant importe une application avec un répertoire de sortie personnalisé :
databricks apps import --name my-app --output-dir ~/my-apps/analytics
L'exemple suivant importe une application et nettoie l'ancien dossier d'application :
databricks apps import --name my-app --cleanup
liste des applications Databricks
Lister toutes les applications dans le Workspace.
databricks apps list [flags]
Arguments
Aucun
Options
--page-size int
Limite supérieure pour les éléments renvoyés.
--page-token string
Jeton de pagination pour accéder à la page suivante d'applications.
--space string
Filtrer les applications par le nom de l'App Space.
Exemples
L'exemple suivant répertorie toutes les applications :
databricks apps list
L'exemple suivant répertorie les applications avec une taille de page spécifique :
databricks apps list --page-size 10
L'exemple suivant liste les applications avec pagination :
databricks apps list --page-token "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
databricks apps list-deployments
Listez tous les déploiements d'applications pour l'application portant le nom fourni.
databricks apps list-deployments APP_NAME [flags]
Arguments
APP_NAME
Le nom de l'application.
Options
--page-size int
Limite supérieure pour les éléments renvoyés.
--page-token string
Jeton de pagination pour accéder à la page suivante d'applications.
Exemples
L'exemple suivant répertorie tous les déploiements d'une application :
databricks apps list-deployments my-analytics-app
L'exemple suivant liste les déploiements avec une taille de page spécifique :
databricks apps list-deployments my-data-app --page-size 10
Databricks Apps Logs
Stream les logs stdout/stderr d’une application Databricks à l’aide de son log stream. Par default, cette commande récupère les Logs les plus récents jusqu’à --tail-lines et se termine. Le filtrage côté serveur est disponible à l’aide de --search et le filtrage côté client est disponible à l’aide de --source APP|SYSTEM.
databricks apps logs [NAME] [flags]
Arguments
NAME
Le nom de l'application.
Options
-f, --follow
Continuer le streaming des logs jusqu’à l’annulation ou l’atteinte d’un délai d’expiration spécifié.
--tail-lines int
Nombre de lignes de log récentes à afficher avant le streaming. Définissez sur 0 pour tout afficher. default: 200
--timeout duration
Durée maximale de Stream lorsque --follow est défini. Définissez sur 0 pour désactiver le délai d'expiration.
--search string
Envoyez un terme de recherche au service de logs avant le streaming.
--source strings
Restreignez les Logs à APP ou SYSTEM sources.
--output-file string
Chemin d'accès facultatif au fichier pour écrire les logs en plus de la sortie standard.
Exemples
L'exemple suivant récupère les logs les plus récents pour une application :
databricks apps logs my-analytics-app
L'exemple suivant diffuse les Logs en continu jusqu'à interruption :
databricks apps logs my-analytics-app --follow
L'exemple suivant récupère les 500 dernières lignes de logs :
databricks apps logs my-data-app --tail-lines 500
L'exemple suivant diffuse des logs avec un délai d'expiration de 10 minutes :
databricks apps logs my-ml-app --follow --timeout 10m
L'exemple suivant filtre les logs par terme de recherche :
databricks apps logs my-analytics-app --search "error"
L’exemple suivant limite les Logs à la sortie de niveau application uniquement :
databricks apps logs my-data-app --source APP
L'exemple suivant écrit les logs à la fois dans stdout et dans un fichier :
databricks apps logs my-ml-app --output-file /tmp/app-logs.txt
databricks apps run-local
start une application localement.
databricks apps run-local [flags]
Arguments
Aucun
Options
--app-port int
Port sur lequel exécuter l’application (default 8000).
--debug
Activer le mode débogage.
--debug-port string
Port sur lequel exécuter le débogueur.
--entry-point string
Spécifiez le point d’entrée personnalisé avec la configuration (fichier .yml) pour l’application. La valeur default est app.yml.
--env strings
Définir les variables d'environnement.
--port int
Port sur lequel exécuter le proxy d'application (default 8001).
--prepare-environment
Prépare l'environnement pour l'exécution de l'application. Nécessite l'installation de uv.
Exemples
L'exemple suivant exécute une application localement avec les paramètres default :
databricks apps run-local
L'exemple suivant exécute une application localement sur un port spécifique :
databricks apps run-local --app-port 9000 --port 9001
databricks apps start
start le dernier déploiement actif de l'application dans le Workspace.
databricks apps start [NAME] [flags]
Arguments
NAME
Le nom de l'application.
Options
--no-wait
N'attendez pas d'atteindre l'état ACTIF.
--timeout duration
Durée maximale pour atteindre l'état ACTIF (default 20m0s).
Exemples
L'exemple suivant start une application :
databricks apps start my-analytics-app
L'exemple suivant start une application sans attendre :
databricks apps start my-data-app --no-wait
L'exemple suivant start une application avec un délai d'attente personnalisé :
databricks apps start my-ml-app --timeout 30m
Databricks Apps : arrêt
Arrêtez le déploiement actif de l'application dans le workspace.
databricks apps stop [NAME] [flags]
Arguments
NAME
Le nom de l'application.
Options
--no-wait
N'attendez pas d'atteindre l'état ARRÊTÉ.
--timeout duration
Durée maximale pour atteindre l'état ARRÊTÉ (default 20m0s).
Exemples
L'exemple suivant arrête une application :
databricks apps stop my-analytics-app
L'exemple suivant arrête une application sans attendre :
databricks apps stop my-data-app --no-wait
L'exemple suivant arrête une application avec un délai d'expiration personnalisé :
databricks apps stop my-ml-app --timeout 30m
mise à jour des applications Databricks
Mettez à jour l’application avec le nom fourni.
databricks apps update NAME [flags]
Arguments
NAME
Le nom de l'application. Le nom ne doit contenir que des caractères alphanumériques minuscules et des tirets. Il doit être unique au sein du workspace.
Options
--budget-policy-id string
ID de stratégie de budget pour l'application.
--compute-size ComputeSize
La taille de compute pour l'application. Valeurs prises en charge : LARGE, MEDIUM.
--description string
La description de l'application.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--space string
Nom de l'espace auquel cette application appartient.
--usage-policy-id string
ID de la politique d'utilisation de l'application.
Exemples
L'exemple suivant met à jour la description d'une application :
databricks apps update my-analytics-app --description "Updated analytics dashboard"
databricks apps get-permission-levels
Obtenir les niveaux d'autorisation des applications.
databricks apps get-permission-levels APP_NAME [flags]
Arguments
APP_NAME
L'application pour laquelle obtenir ou gérer les autorisations.
Options
Exemples
L'exemple suivant obtient les niveaux d'autorisation pour une application :
databricks apps get-permission-levels my-analytics-app
Databricks apps get-permissions
Obtenir les autorisations d'une application. Les applications peuvent hériter des autorisations de leur objet racine.
databricks apps get-permissions APP_NAME [flags]
Arguments
APP_NAME
L'application pour laquelle obtenir ou gérer les autorisations.
Options
Exemples
L’exemple suivant obtient les autorisations pour une application :
databricks apps get-permissions my-analytics-app
L’exemple suivant obtient les autorisations à l’aide d’un profil spécifique :
databricks apps get-permissions my-ml-app --profile production
databricks apps set-permissions
Définissez les autorisations de l'application.
Définit les autorisations sur un objet, en remplaçant les autorisations existantes si elles existent. Supprime toutes les autorisations directes si aucune n'est spécifiée. Les objets peuvent hériter des autorisations de leur objet racine.
databricks apps set-permissions APP_NAME [flags]
Arguments
APP_NAME
L'application pour laquelle obtenir ou gérer les autorisations.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
Exemples
L’exemple suivant définit les autorisations à l’aide de la configuration JSON :
databricks apps set-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_USE"}]}'
databricks apps update-permissions
Mettre à jour les autorisations d'une application. Les applications peuvent hériter des autorisations de leur objet racine.
databricks apps update-permissions APP_NAME [flags]
Arguments
APP_NAME
L'application pour laquelle obtenir ou gérer les autorisations.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
Exemples
L'exemple suivant met à jour les autorisations à l'aide de la configuration JSON :
databricks apps update-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_MANAGE"}]}'
Drapeaux globaux
--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