jobs grupo de comando
Esta informação se aplica a Databricks CLI versões 0.205 e acima. A CLI do Databricks está em pré-visualização pública.
Databricks CLI O uso está sujeito à LicençaDatabricks e à Política de PrivacidadeDatabricks, incluindo qualquer disposição sobre Dados de Uso.
O grupo de comandos jobs dentro do Databricks CLI permite criar, editar e excluir tarefas. Consulte as vagas disponíveis emLakeFlow.
databricks Cancelar todas as execuções
Cancelar todas as execuções ativas de um trabalho. As execuções são canceladas de forma assíncrona, portanto, isso não impede que novas execuções sejam iniciadas.
databricks jobs cancel-all-runs [flags]
Argumentos
Nenhuma
Opções
--all-queued-runs
Parâmetro booleano opcional para cancelar todas as execuções em fila.
--job-id int
O identificador canônico da tarefa cuja execução deve ser cancelada.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
Cancelamento da execução de tarefas no Databricks
Cancelar uma execução.
Cancela uma execução de trabalho ou uma execução de tarefa. A execução é cancelada de forma assíncrona, portanto, ainda pode estar em andamento quando esta solicitação for concluída.
databricks jobs cancel-run RUN_ID [flags]
Argumentos
RUN_ID
Esse campo é obrigatório.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--no-wait
não espere para atingir o estado ENCERRADO ou IGNORADO
--timeout duration
tempo máximo para atingir o estado TERMINADO ou IGNORADO (default 20m0s)
Tarefa do Databricks criada
Crie uma nova tarefa.
databricks jobs create [flags]
Argumentos
Nenhuma
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
Exclusão de tarefa do Databricks
Excluir uma tarefa.
databricks jobs delete JOB_ID [flags]
Argumentos
JOB_ID
O identificador canônico da tarefa a ser excluída. Esse campo é obrigatório.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
Tarefa do Databricks: exclusão de execução
Exclua uma execução não ativa. Retorna um erro se a execução estiver ativa.
databricks jobs delete-run RUN_ID [flags]
Argumentos
RUN_ID
ID da execução a ser excluída.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
Exportação de tarefas do Databricks - execução
Exportar e recuperar a tarefa de execução do trabalho.
databricks jobs export-run RUN_ID [flags]
Argumentos
RUN_ID
O identificador canônico para a execução. Esse campo é obrigatório.
Opções
--views-to-export ViewsToExport
Qual visualização exportar. Valores suportados: ALL, CODE, DASHBOARDS
databricks Obter trabalho
Recupera os detalhes de um único trabalho.
Matrizes grandes nos resultados serão paginadas quando excederem 100 elementos. Uma solicitação para um único trabalho retornará todas as propriedades desse trabalho e os primeiros 100 elementos das propriedades da matriz (tarefa, job_clusters, ambientes e parâmetros). Use o campo next_page_token para verificar mais resultados e passar seu valor como page_token nas solicitações subsequentes. Se alguma propriedade da matriz tiver mais de 100 elementos, resultados adicionais serão retornados nas solicitações subsequentes. As matrizes sem resultados adicionais ficarão vazias nas páginas posteriores.
databricks jobs get JOB_ID [flags]
Argumentos
JOB_ID
O identificador canônico da tarefa sobre a qual se deseja obter informações. Esse campo é obrigatório.
Opções
--page-token string
Utilize next_page_token retornado da resposta GetJob anterior para solicitar a próxima página das propriedades da matriz do Job.
Tarefa do Databricks obter execução
Recupera os metadados de uma execução de tarefa.
Matrizes grandes nos resultados serão paginadas quando excederem 100 elementos. Uma solicitação para uma única execução retornará todas as propriedades para essa execução e os primeiros 100 elementos das propriedades da matriz (tarefa, job_clusters, job_parameters e repair_history). Use o campo next_page_token para verificar mais resultados e passar seu valor como page_token nas solicitações subsequentes. Se alguma propriedade da matriz tiver mais de 100 elementos, resultados adicionais serão retornados nas solicitações subsequentes. As matrizes sem resultados adicionais ficarão vazias nas páginas posteriores.
databricks jobs get-run RUN_ID [flags]
Argumentos
RUN_ID
O identificador canônico da execução para a qual os metadados devem ser recuperados. Esse campo é obrigatório.
Opções
--include-history
Inclua o histórico de reparos na resposta.
--include-resolved-values
Inclua valores de parâmetros resolvidos na resposta.
--page-token string
Utilize next_page_token retornado da resposta GetRun anterior para solicitar a próxima página das propriedades da matriz da execução.
Tarefa do Databricks obter-execução-saída
Recuperar a saída e os metadados de uma única tarefa execução. Quando uma tarefa do Notebook retorna um valor por meio do dbutils.Notebook.exit() chamada, é possível utilizar este comando para recuperar esse valor. A Databricks restringe esta API ao retorno dos primeiros 5 MB da saída. Para retornar um resultado maior, é possível armazenar os resultados da tarefa em um serviço de armazenamento em nuvem.
Este comando valida se o parâmetro run_id é válido e retorna um código de status HTTP 400 se o parâmetro run_id for inválido. As execuções são automaticamente removidas após 60 dias. Caso deseje fazer referência a eles após 60 dias, é necessário salvar os resultados de execução antigos antes que eles expirem.
databricks jobs get-run-output RUN_ID [flags]
Argumentos
RUN_ID
O identificador canônico para a execução.
Opções
Lista de vagas na Databricks
Recuperar uma lista de tarefas.
databricks jobs list [flags]
Argumentos
Nenhuma
Opções
--expand-tasks
Se deve incluir detalhes de tarefa e agrupamento na resposta.
--limit int
O número de tarefas a serem retornadas.
--name string
Um filtro na lista com base no nome exato (sem distinção entre maiúsculas e minúsculas) do trabalho.
--offset int
O deslocamento da primeira tarefa a retornar, em relação à tarefa criada mais recentemente.
--page-token string
Utilize next_page_token ou prev_page_token retornado da solicitação anterior para listar a próxima ou a página anterior do Trabalho, respectivamente.
Lista de tarefas do Databricks - execução
Listar a execução do trabalho em ordem decrescente pela hora de início.
databricks jobs list-runs [flags]
Argumentos
Nenhuma
Opções
--active-only
Se active_only for verdadeiro, apenas as execuções ativas serão incluídas nos resultados; caso contrário, serão listadas tanto as execuções ativas quanto as concluídas.
--completed-only
Se completed_only for verdadeiro, apenas as execuções concluídas serão incluídas nos resultados; caso contrário, serão listadas tanto as execuções ativas quanto as concluídas.
--expand-tasks
Se deve incluir detalhes de tarefa e agrupamento na resposta.
--job-id int
A tarefa para a qual listar execução.
--limit int
O número de execução a retornar.
--offset int
O deslocamento da primeira execução a retornar, em relação à execução mais recente.
--page-token string
Utilize next_page_token ou prev_page_token retornado da solicitação anterior para listar a próxima ou a página anterior de execução, respectivamente.
--run-type RunType
O tipo de execução a ser retornada. Valores suportados: [JOB_RUN, SUBMIT_RUN, WORKFLOW_RUN]
--start-time-from int
Mostrar execuções que começam neste valor ou após ele.
--start-time-to int
Mostrar execuções que começam neste valor ou antes dele.
Reparação de tarefas do Databricks - execução
Reexecutar uma ou mais tarefas do trabalho. As tarefas são reexecutadas como parte da execução original do trabalho. Eles utilizam as configurações atuais de Job e tarefa e podem ser visualizados no histórico da execução original do Job.
databricks jobs repair-run RUN_ID [flags]
Argumentos
RUN_ID
O ID de execução da tarefa a ser reparada. A execução não deve estar em andamento.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--latest-repair-id int
O ID do reparo mais recente.
--no-wait
não espere para atingir o estado ENCERRADO ou IGNORADO
--performance-target PerformanceTarget
O modo desempenho em uma tarefa do serverless. Valores suportados: [PERFORMANCE_OPTIMIZED, STANDARD]
--rerun-all-failed-tasks
Se for verdadeiro, repare todas as tarefas com falha.
--rerun-dependent-tasks
Se for verdadeiro, repare todas as tarefas que dependem da tarefa em rerun_tasks, mesmo que tenham sido bem-sucedidas anteriormente.
--timeout duration
tempo máximo para atingir o estado TERMINADO ou IGNORADO (default 20m0s)
Redefinição de tarefas do Databricks
Substitua todas as configurações para o trabalho especificado. Utilize o comando “ databricks jobs update ” para atualizar parcialmente as configurações da tarefa.
databricks jobs reset [flags]
Argumentos
Nenhuma
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
databricks Execução de tarefa agora
Executa uma tarefa e retorna o run_id da execução acionada.
databricks jobs run-now JOB_ID [flags]
Argumentos
JOB_ID
A identificação da tarefa a ser executada.
Opções
--idempotency-token string
Tokens opcionais para garantir a idempotência das solicitações de execução de tarefas.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--no-wait
não espere para atingir o estado ENCERRADO ou IGNORADO
--performance-target PerformanceTarget
O modo desempenho em uma tarefa do serverless. Valores suportados: [PERFORMANCE_OPTIMIZED, STANDARD]
--timeout duration
tempo máximo para atingir o estado TERMINADO ou IGNORADO (default 20m0s)
Envio de tarefa no Databricks
Crie e acione uma execução única. Isso permite que você envie uma carga de trabalho diretamente, sem criar uma tarefa.
databricks jobs submit [flags]
Argumentos
Nenhuma
Opções
--budget-policy-id string
A identificação especificada pelo usuário da política orçamentária a ser utilizada para esta execução única.
--idempotency-token string
Um token opcional que pode ser utilizado para garantir a idempotência das solicitações de execução de tarefas.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--no-wait
não espere para atingir o estado ENCERRADO ou IGNORADO
--run-name string
Um nome opcional para a execução.
--timeout duration
tempo máximo para atingir o estado TERMINADO ou IGNORADO (default 20m0s)
--timeout-seconds int
Um tempo limite opcional aplicado a cada execução deste trabalho.
Atualização de vagas na Databricks
Adicione, atualize ou remova configurações específicas de um trabalho existente. Utilize “ reset ” para substituir todas as configurações do trabalho.
databricks jobs update JOB_ID [flags]
Argumentos
JOB_ID
O identificador canônico da tarefa a ser atualizada. Esse campo é obrigatório.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
databricks Tarefa obter-níveis-de-permissão
Obter níveis de permissão de trabalho.
databricks jobs get-permission-levels JOB_ID [flags]
Argumentos
JOB_ID
A tarefa para a qual se deseja obter ou gerenciar permissões.
Opções
Tarefa do Databricks obter permissões
Obter as permissões de um trabalho. Os trabalhos podem herdar permissões de seu objeto raiz.
databricks jobs get-permissions JOB_ID [flags]
Argumentos
JOB_ID
A tarefa para a qual se deseja obter ou gerenciar permissões.
Opções
databricks Definir permissões de tarefa
Defina as permissões do trabalho.
Define as permissões em um objeto, substituindo as permissões existentes, se elas existirem. Exclui todas as permissões diretas se nenhuma for especificada. Os objetos podem herdar permissões do objeto raiz.
databricks jobs set-permissions JOB_ID [flags]
Argumentos
JOB_ID
A tarefa para a qual se deseja obter ou gerenciar permissões.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
databricks Atualização de permissões de trabalho
Atualize as permissões em uma tarefa. Os trabalhos podem herdar permissões de seu objeto raiz.
databricks jobs update-permissions JOB_ID [flags]
Argumentos
JOB_ID
A tarefa para a qual se deseja obter ou gerenciar permissões.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
Bandeiras globais
--debug
Se deve habilitar o registro de depuração.
-h ou --help
Exibir ajuda para o comando Databricks CLI ou para o grupo de comandos relacionado ou para o comando relacionado.
--log-file string
Uma string que representa o arquivo no qual a saída logs deve ser gravada. Se este sinalizador não for especificado, o default deverá gravar a saída logs no stderr.
--log-format Formato
O tipo de formato do log, text ou json. O valor de default é text.
--log-level string
Uma string que representa o nível de formato do log. Se não for especificado, o nível de formato do log será desativado.
-o, --output Tipo
O tipo de saída do comando, text ou json. O valor de default é text.
-p, --profile string
O nome do perfil no arquivo ~/.databrickscfg a ser utilizado para executar o comando. Se esse sinalizador não for especificado, se existir, o perfil chamado DEFAULT será usado.
--progress-format Formato
O formato para exibir o progresso logs: default, append, inplace ou json
-t, --target string
Se aplicável, o destino do pacote a ser usado