apps groupe de commande

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.

Le apps groupe de commandes 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 l’authentification unique. Consultez Databricks Apps.

Créer des applications Databricks

Créer une application.

databricks apps create NAME [flags]

Arguments

NAME

    Nom de l’application. Le nom doit contenir uniquement des caractères alphanumériques minuscules et des traits d’union. Il doit être unique dans l’espace de travail.

Options

--budget-policy-id string

    ID de stratégie budgétaire pour l’application.

--description string

    Description de l’application.

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

--no-compute

    Si la valeur est true, l’application ne sera pas démarrée après la création.

--no-wait

    N’attendez pas d’atteindre l’état ACTIVE.

--timeout duration

    Durée maximale d’atteindre l’état ACTIVE (20m0s par défaut).

Indicateurs globaux

Examples

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 le 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 supprimer les applications

Supprimez une application.

databricks apps delete NAME [flags]

Arguments

NAME

    Nom de l’application.

Options

Indicateurs globaux

Examples

L’exemple suivant supprime une application :

databricks apps delete my-analytics-app

Déploiement des applications Databricks

Créez un déploiement d’application pour l’application avec le nom fourni.

databricks apps deploy APP_NAME [flags]

Arguments

APP_NAME

    Nom de l’application.

Options

--deployment-id string

    ID unique du déploiement.

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

--mode AppDeploymentMode

    Le mode selon lequel le déploiement gérera le code source. Valeurs prises en charge : AUTO_SYNC, SNAPSHOT.

--no-wait

    N’attendez pas d’atteindre l’état SUCCEEDED.

--source-code-path string

    Chemin dans le système de fichiers de l’espace de travail vers le code source utilisé pour créer le déploiement de l’application.

--timeout duration

    Durée maximale d’atteindre l’état SUCCEEDED (20m0s par défaut).

Indicateurs globaux

Examples

L’exemple suivant crée un déploiement en 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 avec le mode d’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 ID 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 obtenir

Obtenez des informations sur l’application dont le nom est fourni.

databricks apps get NAME [flags]

Arguments

NAME

    Nom de l’application.

Options

Indicateurs globaux

Examples

L’exemple suivant obtient des informations sur l’application :

databricks apps get my-analytics-app

L’exemple suivant obtient les informations d’application au format JSON :

databricks apps get my-data-app --output json

L’exemple suivant obtient des informations d’application à l’aide d’un profil spécifique :

databricks apps get my-ml-app --profile production

Applications Databricks obtenir-déploiement

Obtenez 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

    Nom de l’application.

DEPLOYMENT_ID

    ID unique du déploiement.

Options

Indicateurs globaux

Examples

L’exemple suivant obtient les informations de déploiement :

databricks apps get-deployment my-analytics-app v1.0.0

L’exemple suivant obtient des 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

liste des applications databricks

Répertorier toutes les applications dans l’espace de travail.

databricks apps list [flags]

Arguments

None

Options

--page-size int

    Limite supérieure pour les éléments retournés.

--page-token string

    Jeton de pagination pour accéder à la page suivante des applications.

Indicateurs globaux

Examples

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 répertorie les applications avec pagination :

databricks apps list --page-token "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

databricks apps list-deployments (commande pour lister les déploiements)

Répertoriez tous les déploiements d’applications pour l’application avec le nom fourni.

databricks apps list-deployments APP_NAME [flags]

Arguments

APP_NAME

    Nom de l’application.

Options

--page-size int

    Limite supérieure pour les éléments retournés.

--page-token string

    Jeton de pagination pour accéder à la page suivante des applications.

Indicateurs globaux

Examples

L’exemple suivant répertorie tous les déploiements d’une application :

databricks apps list-deployments my-analytics-app

L’exemple suivant répertorie les déploiements avec une taille de page spécifique :

databricks apps list-deployments my-data-app --page-size 10

journaux des applications Databricks

Diffusez en continu les journaux stdout/stderr pour une application Databricks à l’aide de son flux de journaux. Par défaut, cette commande extrait les journaux les plus récents jusqu’à --tail-lines et se ferme. 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

    Nom de l’application.

Options

-f, --follow

    Continuez à diffuser les journaux jusqu'à annulation ou jusqu'à ce qu'un délai d'expiration spécifié soit atteint.

--tail-lines int

    Nombre de lignes de journal récentes à afficher avant la diffusion en continu. Réglez sur 0 pour tout afficher. Valeur par défaut : 200

--timeout duration

    Durée maximale de diffusion en continu lorsque --follow est défini. Définir sur 0 pour désactiver le délai d’expiration.

--search string

    Envoyez un terme de recherche au service de journal avant la diffusion en continu.

--source strings

    Restreindre les journaux d'activité à des sources APP ou SYSTEM.

--output-file string

    Chemin de fichier facultatif pour enregistrer des logs en plus de la sortie standard (stdout).

Indicateurs globaux

Examples

L’exemple suivant extrait les journaux de logs les plus récents d'une appli :

databricks apps logs my-analytics-app

L’exemple suivant diffuse en continu les journaux jusqu’à ce qu’ils ne sont pas interrompus :

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 en continu les logs avec un délai d'inactivité de 10 minutes :

databricks apps logs my-ml-app --follow --timeout 10m

L'exemple suivant filtre les logs selon un terme de recherche :

databricks apps logs my-analytics-app --search "error"

L’exemple suivant restreint les logs uniquement à la sortie au niveau de l’application :

databricks apps logs my-data-app --source APP

L’exemple suivant écrit des logs dans stdout et un fichier :

databricks apps logs my-ml-app --output-file /tmp/app-logs.txt

databricks apps exécuter localement

Démarrez une application localement.

databricks apps run-local [flags]

Arguments

None

Options

--app-port int

    Port sur lequel exécuter l’application (par défaut 8000).

--debug

    Active le mode débogage.

--debug-port string

    Port utilisé pour exécuter le débogueur.

--entry-point string

    Spécifiez le point d’entrée personnalisé avec la configuration (fichier .yml) de l’application. La valeur par défaut est app.yml.

--env strings

    Définir des variables d’environnement

--port int

    Port sur lequel exécuter le proxy d’application (par défaut 8001).

--prepare-environment

    Prépare l’environnement pour l’exécution de l’application. Nécessite uv pour être installé.

Indicateurs globaux

Examples

L’exemple suivant exécute une application localement avec les paramètres par défaut :

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

Démarrage des applications Databricks

Démarrez le dernier déploiement actif de l’application dans l’espace de travail.

databricks apps start NAME [flags]

Arguments

NAME

    Nom de l’application.

Options

--no-wait

    N’attendez pas d’atteindre l’état ACTIVE.

--timeout duration

    Durée maximale d’atteindre l’état ACTIVE (20m0s par défaut).

Indicateurs globaux

Examples

L’exemple suivant démarre une application :

databricks apps start my-analytics-app

L’exemple suivant démarre une application sans attendre :

databricks apps start my-data-app --no-wait

L’exemple suivant démarre une application avec un délai d’expiration personnalisé :

databricks apps start my-ml-app --timeout 30m

Les applications databricks s’arrêtent

Arrêtez le déploiement actif de l’application dans l’espace de travail.

databricks apps stop NAME [flags]

Arguments

NAME

    Nom de l’application.

Options

--no-wait

    N’attendez pas d’atteindre l’état STOPPED.

--timeout duration

    Durée maximale d’atteindre l’état ARRÊTÉ (20m0s par défaut).

Indicateurs globaux

Examples

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

    Nom de l’application. Le nom doit contenir uniquement des caractères alphanumériques minuscules et des traits d’union. Il doit être unique dans l’espace de travail.

Options

--budget-policy-id string

    ID de stratégie budgétaire pour l’application.

--description string

    Description de l’application.

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Examples

L’exemple suivant met à jour la description d’une application :

databricks apps update my-analytics-app --description "Updated analytics dashboard"

niveaux-de-permission-obtenus-application-databricks

Obtenez les niveaux d’autorisation de l’application.

databricks apps get-permission-levels APP_NAME [flags]

Arguments

APP_NAME

    Application pour laquelle obtenir ou gérer des autorisations.

Options

Indicateurs globaux

Examples

L’exemple suivant obtient les niveaux d’autorisation pour une application :

databricks apps get-permission-levels my-analytics-app

Databricks applications obtenir les autorisations

Obtenez 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

    Application pour laquelle obtenir ou gérer des autorisations.

Options

Indicateurs globaux

Examples

L’exemple suivant obtient des autorisations pour une application :

databricks apps get-permissions my-analytics-app

L’exemple suivant obtient des autorisations à l’aide d’un profil spécifique :

databricks apps get-permissions my-ml-app --profile production

** databricks apps set-permissions : Commande pour définir les autorisations dans les applications Databricks

Définissez les autorisations d’application.

Définit des autorisations sur un objet, en remplaçant les autorisations existantes s’ils 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

    Application pour laquelle obtenir ou gérer des autorisations.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Examples

L’exemple suivant définit des 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"}]}'

Commande "databricks apps update-permissions" pour mettre à jour les autorisations des applications.

Mettez à jour les autorisations sur une application. Les applications peuvent hériter des autorisations de leur objet racine.

databricks apps update-permissions APP_NAME [flags]

Arguments

APP_NAME

    Application pour laquelle obtenir ou gérer des autorisations.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Examples

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"}]}'

Indicateurs globaux

--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