Aller au contenu principal

groupe de commandesjobs

remarque

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 jobs au sein de la CLI Databricks vous permet de créer, modifier et supprimer des Jobs. See Lakeflow Jobs.

databricks jobs cancel-all-runs

Annulez toutes les exécutions actives d'un Job. Les exécutions sont annulées de manière asynchrone, ce qui n'empêche pas le start de nouvelles exécutions.

databricks jobs cancel-all-runs [flags]

Arguments

Aucun

Options

--all-queued-runs

parameter booléen facultatif pour annuler toutes les exécutions en attente.

--job-id int

L'identifiant canonique du Job pour annuler toutes les exécutions.

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

databricks jobs cancel-run

Annuler une exécution.

Annule une exécution de job ou une exécution de tâche. L'exécution est annulée de manière asynchrone, elle peut donc encore être en cours d'exécution lorsque cette requête se termine.

databricks jobs cancel-run RUN_ID [flags]

Arguments

RUN_ID

Ce champ est obligatoire.

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 TERMINATED ou SKIPPED

--timeout duration

durée maximale pour atteindre l'état TERMINÉ ou IGNORÉ (default 20m0s)

Indicateurs globaux

databricks jobs create

Créez un nouveau job.

databricks jobs create [flags]

Arguments

Aucun

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

databricks jobs delete

Supprimer un job.

databricks jobs delete JOB_ID [flags]

Arguments

JOB_ID

L'identifiant canonique du job à supprimer. Ce champ est obligatoire.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

databricks jobs delete-run

Supprimez une exécution non active. Renvoie une erreur si l'exécution est active.

databricks jobs delete-run RUN_ID [flags]

Arguments

RUN_ID

ID de l'exécution à supprimer.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Databricks Jobs export-run

Exporter et récupérer la tâche d'exécution du Job.

databricks jobs export-run RUN_ID [flags]

Arguments

RUN_ID

L'identifiant canonique pour l'exécution. Ce champ est obligatoire.

Options

--views-to-export ViewsToExport

Quelles vues exporter. Valeurs prises en charge : ALL, CODE, DASHBOARDS

Indicateurs globaux

databricks jobs get

Récupère les détails d'un seul Job.

Les grands tableaux dans les résultats seront paginés lorsqu'ils dépasseront 100 éléments. Une demande pour un seul Job renverra toutes les propriétés de ce Job, ainsi que les 100 premiers éléments des propriétés de tableau (tâches, Job clusters, environnements et parameters). Utilisez le champ next_page_token pour vérifier s'il y a plus de résultats et transmettez sa valeur en tant que page_token dans les requêtes suivantes. Si les propriétés d'un tableau contiennent plus de 100 éléments, des résultats supplémentaires seront renvoyés lors des requêtes suivantes. Les tableaux sans résultats supplémentaires seront vides sur les pages ultérieures.

databricks jobs get JOB_ID [flags]

Arguments

JOB_ID

L'identifiant canonique du job pour récupérer des informations. Ce champ est obligatoire.

Options

--page-token string

Utilisez next_page_token renvoyé par la réponse GetJob précédente pour demander la page suivante des propriétés de tableau du Job.

Indicateurs globaux

databricks jobs get-run

Récupère les métadonnées d'une exécution de Job.

Les grands tableaux dans les résultats seront paginés lorsqu'ils dépasseront 100 éléments. Une demande pour une seule exécution renverra toutes les propriétés de cette exécution, ainsi que les 100 premiers éléments des propriétés de tableau (tâches, job_clusters, job_parameters et repair_history). Utilisez le champ next_page_token pour vérifier s'il y a plus de résultats et transmettez sa valeur en tant que page_token dans les requêtes suivantes. Si les propriétés d'un tableau contiennent plus de 100 éléments, des résultats supplémentaires seront renvoyés lors des requêtes suivantes. Les tableaux sans résultats supplémentaires seront vides sur les pages ultérieures.

databricks jobs get-run RUN_ID [flags]

Arguments

RUN_ID

L'identifiant canonique de l'exécution pour laquelle récupérer les métadonnées. Ce champ est obligatoire.

Options

--include-history

Incluez l’historique des réparations dans la réponse.

--include-resolved-values

Incluez les valeurs de parameter résolues dans la réponse.

--page-token string

Utilisez next_page_token renvoyé par la réponse GetRun précédente pour demander la page suivante des propriétés de tableau de l'exécution.

Indicateurs globaux

databricks jobs get-run-output

Récupérez la sortie et les métadonnées d'une seule exécution de tâche. Lorsqu'une tâche de notebook retourne une valeur via dbutils.notebook.exit() Après l'appel, vous pouvez utiliser cette commande pour récupérer cette valeur. Databricks limite cette API à retourner les 5 Mo de la première sortie. Pour obtenir un résultat plus volumineux, vous pouvez stocker les résultats de job dans un service de stockage cloud.

Cette commande valide que le **run_id** parameter est valide et renvoie un code d'état HTTP 400 si le **run_id** parameter est invalide. Les exécutions sont automatiquement supprimées après 60 jours. Si vous souhaitez les référencer au-delà de 60 jours, vous devez enregistrer les anciens résultats d'exécution avant qu'ils n'expirent.

databricks jobs get-run-output RUN_ID [flags]

Arguments

RUN_ID

L'identifiant canonique de l'exécution.

Options

Indicateurs globaux

liste des Jobs Databricks

Récupérez une liste de Jobs.

databricks jobs list [flags]

Arguments

Aucun

Options

--expand-tasks

Indique s'il faut inclure les détails de la tâche et du cluster dans la réponse.

--limit int

Le nombre de Jobs à renvoyer.

--name string

Un filtre sur la liste basé sur le nom du Job exact (insensible à la casse).

--offset int

Le décalage du premier job à retourner, par rapport au job le plus récemment créé.

--page-token string

Utilisez next_page_token ou prev_page_token renvoyé par la requête précédente pour lister respectivement la page suivante ou précédente des jobs.

Indicateurs globaux

databricks jobs list-runs

Listez les exécutions de Job par ordre décroissant en fonction de l'heure de start.

databricks jobs list-runs [flags]

Arguments

Aucun

Options

--active-only

Si active_only est vrai, seules les exécutions actives sont incluses dans les résultats ; sinon, la liste contient les exécutions actives et terminées.

--completed-only

Si completed_only est true, seules les exécutions terminées sont incluses dans les résultats ; sinon, la liste inclut les exécutions actives et terminées.

--expand-tasks

Indique s'il faut inclure les détails de la tâche et du cluster dans la réponse.

--job-id int

Le job pour lequel lister les exécutions.

--limit int

Le nombre d'exécutions à renvoyer.

--offset int

Le décalage de la première exécution à renvoyer, par rapport à l'exécution la plus récente.

--page-token string

Utilisez next_page_token ou prev_page_token renvoyés par la requête précédente pour lister respectivement la page suivante ou précédente des exécutions.

--run-type RunType

Type de séries à renvoyer. Valeurs prises en charge : [JOB_RUN, SUBMIT_RUN, WORKFLOW_RUN]

--start-time-from int

Afficher les exécutions qui ont commencé à partir de cette valeur.

--start-time-to int

Afficher les exécutions start à cette valeur ou avant .

Indicateurs globaux

databricks jobs repair-run

Réexécutez une ou plusieurs tâches de job. Les tâches sont réexécutées dans le cadre de l'exécution du job d'origine. Ils utilisent les paramètres de job et de tâche actuels, et peuvent être consultés dans l'historique de l'exécution du job d'origine.

databricks jobs repair-run RUN_ID [flags]

Arguments

RUN_ID

L'ID d'exécution du Job à réparer. L'exécution ne doit pas être en cours.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

--latest-repair-id int

L'ID de la dernière réparation.

--no-wait

n'attendez pas d'atteindre l'état TERMINATED ou SKIPPED

--performance-target PerformanceTarget

Le mode de performance sur un Job Serverless. Valeurs prises en charge : [PERFORMANCE_OPTIMIZED, STANDARD]

--rerun-all-failed-tasks

Si c'est vrai, réparez toutes les tâches ayant échoué.

--rerun-dependent-tasks

Si vrai, réparer toutes les tâches qui dépendent des tâches dans rerun_tasks, même si elles ont été précédemment réussies.

--timeout duration

durée maximale pour atteindre l'état TERMINÉ ou IGNORÉ (default 20m0s)

Indicateurs globaux

Databricks Job Reset

Remplacez tous les paramètres du Job donné. Utilisez la commande databricks jobs update pour mettre à jour partiellement les paramètres du Job.

databricks jobs reset [flags]

Arguments

Aucun

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Databricks jobs run-now

Exécutez un Job et renvoyez l'ID d'exécution de l'exécution Trigger.

databricks jobs run-now JOB_ID [flags]

Arguments

JOB_ID

L'ID du Job à exécuter

Options

--idempotency-token string

Un jeton facultatif pour garantir l'idempotence des requêtes d'exécution de job.

--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 TERMINATED ou SKIPPED

--performance-target PerformanceTarget

Le mode de performance sur un Job Serverless. Valeurs prises en charge : [PERFORMANCE_OPTIMIZED, STANDARD]

--timeout duration

durée maximale pour atteindre l'état TERMINÉ ou IGNORÉ (default 20m0s)

Indicateurs globaux

databricks jobs submit

Créez et Trigger une exécution unique. Cela vous permet de soumettre une charge de travail directement sans créer de Job.

databricks jobs submit [flags]
remarque

Les Jobs soumis avec databricks jobs submit ne sont pas enregistrés en tant que Job. Ils n'apparaissent pas dans l'interface utilisateur et ne sont pas relancés en cas d'échec. Comme ils ne sont pas enregistrés, Databricks ne peut pas optimiser automatiquement le compute serverless en cas de défaillance. Si votre Job échoue, vous pouvez utiliser le compute classique pour spécifier les besoins en compute du Job. Alternativement, utilisez jobs create et jobs run-now pour créer et exécuter le job.

Arguments

Aucun

Options

--budget-policy-id string

L'utilisateur a spécifié l'ID de la politique budgétaire à utiliser pour cette exécution unique.

--idempotency-token string

Un jeton facultatif qui peut être utilisé pour garantir l'idempotence des requêtes d'exécution de Job.

--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 TERMINATED ou SKIPPED

--run-name string

Nom facultatif pour l'exécution.

--timeout duration

durée maximale pour atteindre l'état TERMINÉ ou IGNORÉ (default 20m0s)

--timeout-seconds int

Un délai d'attente facultatif appliqué à chaque exécution de ce job.

Indicateurs globaux

databricks jobs update

Ajoutez, mettez à jour ou supprimez des paramètres spécifiques d'un job existant. Utilisez reset pour écraser tous les paramètres du job.

databricks jobs update JOB_ID [flags]

Arguments

JOB_ID

L'identifiant canonique du Job à mettre à jour. Ce champ est obligatoire.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

databricks jobs get-permission-levels

Obtenir les niveaux d'autorisation du job.

databricks jobs get-permission-levels JOB_ID [flags]

Arguments

JOB_ID

Le job pour lequel obtenir ou gérer les autorisations.

Options

Indicateurs globaux

databricks jobs get-permissions

Obtenez les autorisations d’un job. Les jobs peuvent hériter d'autorisations de leur objet racine.

databricks jobs get-permissions JOB_ID [flags]

Arguments

JOB_ID

Le job pour lequel obtenir ou gérer les autorisations.

Options

Indicateurs globaux

Définir les autorisations des jobs Databricks

Définir les autorisations de Job.

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 jobs set-permissions JOB_ID [flags]

Arguments

JOB_ID

Le job pour lequel 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.

Indicateurs globaux

databricks jobs update-permissions

Mettez à jour les autorisations sur un job. Les jobs peuvent hériter d'autorisations de leur objet racine.

databricks jobs update-permissions JOB_ID [flags]

Arguments

JOB_ID

Le job pour lequel 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.

Indicateurs globaux

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