apps grupo de comando

O apps grupo de comandos dentro da CLI Databricks permite-te gerir aplicações. Os aplicativos são executados diretamente na instância Databricks de um cliente, integram-se aos seus dados, usam e estendem os serviços Databricks e permitem que os usuários interajam por meio do logon único. Consulte Aplicativos Databricks.

Criar aplicativos do Databricks

Criar uma nova aplicação.

databricks apps create NAME [flags]

Arguments

NAME

    O nome do aplicativo. O nome deve conter apenas caracteres alfanuméricos minúsculos e hífenes. Ele deve ser exclusivo dentro do espaço de trabalho.

Opções

--budget-policy-id string

    ID da política de orçamento para a aplicação.

--compute-size ComputeSize

    A dimensão de computação para a aplicação. Valores suportados: LARGE, MEDIUM.

--description string

    A descrição do aplicativo.

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

--no-compute

    Se verdadeiro, o aplicativo não será iniciado após a criação.

--no-wait

    Não aguarde para alcançar o estado ACTIVE.

--space string

    Nome do espaço a que esta aplicação pertence.

--timeout duration

    Tempo máximo para atingir o estado ATIVO (padrão 20m0s).

--usage-policy-id string

    ID da política de utilização da aplicação.

Bandeiras globais

Examples

O exemplo a seguir cria um aplicativo básico:

databricks apps create my-analytics-app --description "Analytics dashboard app"

O exemplo a seguir cria um aplicativo sem iniciá-lo:

databricks apps create my-data-app --description "Data processing app" --no-compute

O exemplo a seguir cria um aplicativo com um tempo limite personalizado:

databricks apps create my-ml-app --description "Machine learning app" --timeout 30m

Databricks aplicações criar-atualizar

Cria uma atualização da app e inicia o processo de atualização. O processo de atualização é assíncrono e o estado da atualização pode ser verificado com o método GetAppUpdate.

databricks apps create-update APP_NAME UPDATE_MASK [flags]

Arguments

APP_NAME

    O nome do aplicativo.

UPDATE_MASK

    A máscara de campo deve ser uma única cadeia de caracteres, com vários campos separados por vírgulas (sem espaços). O caminho do campo é relativo ao objeto recurso, usando um ponto (.) para navegar por subcampos (por exemplo, author.given_name). A especificação de elementos em campos de sequência ou mapa não é permitida, pois apenas todo o campo de coleta pode ser especificado. Os nomes de campo devem corresponder exatamente aos nomes de campo de recurso.

    Uma máscara de campo de * indica substituição total. Recomenda-se sempre listar explicitamente os campos a ser atualizados e evitar usar * curingas, pois isso pode levar a resultados indesejados se a API mudar no futuro.

Opções

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

--no-wait

    Não espere para chegar ao estado de sucesso.

--timeout duration

    Tempo máximo para atingir o estado SUCCEEDADO (padrão 20m0s).

Bandeiras globais

Examples

O exemplo seguinte cria uma atualização de aplicação com uma máscara de campo específica:

databricks apps create-update my-analytics-app "description" --json '{"description": "Updated app description"}'

O exemplo seguinte cria uma atualização de aplicação sem esperar pela conclusão:

databricks apps create-update my-data-app "budget_policy_id" --json '{"budget_policy_id": "new-policy-123"}' --no-wait

O exemplo seguinte cria uma atualização de aplicação com um timeout personalizado:

databricks apps create-update my-ml-app "description,budget_policy_id" --json '{"description": "Updated ML app", "budget_policy_id": "ml-policy-456"}' --timeout 30m

Eliminar aplicações Databricks

Exclua um aplicativo.

Quando executado a partir de um diretório de projeto Databricks Apps (contendo databricks.yml) sem qualquer NAME argumento, este comando destrói todos os recursos implementados pelo projeto. Quando um NAME argumento é fornecido ou quando não está no diretório do projeto, a aplicação especificada é eliminada usando diretamente a API.

databricks apps delete [NAME] [flags]

Arguments

NAME

    O nome do aplicativo. Obrigatório quando não está num diretório de projeto. Quando fornecida num diretório de projeto, usa eliminação de API em vez de destruição de projetos.

Opções

--auto-approve

    Evite aprovações interativas para eliminar recursos e ficheiros.

--force-lock

    Aquisição forçada de bloqueio de implantação.

Bandeiras globais

Examples

O exemplo a seguir exclui um aplicativo:

databricks apps delete my-analytics-app

O exemplo seguinte destrói todos os recursos do projeto de um diretório de projeto:

databricks apps delete

O exemplo seguinte destrói recursos do projeto com aprovação automática:

databricks apps delete --auto-approve

Implantação de aplicativos Databricks

Crie uma implementação de uma aplicação.

Quando executado a partir de um diretório de projeto Databricks Apps (contendo databricks.yml) sem argumento APP_NAME , este comando executa um pipeline de implementação melhorada que valida o projeto, implementa-o no espaço de trabalho e executa a aplicação. Quando um APP_NAME argumento é fornecido ou quando não está num diretório de projeto, cria-se uma implementação de aplicação usando diretamente a API.

databricks apps deploy [APP_NAME] [flags]

Arguments

APP_NAME

    O nome do aplicativo. Obrigatório quando não está num diretório de projeto. Quando fornecido num diretório de projeto, utiliza deploy API em vez de deployment de projeto.

Opções

--deployment-id string

    O ID exclusivo da implantação.

--force

    Validação de ramificação Git de substituição forçada.

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

--mode AppDeploymentMode

    O modo do qual a implantação gerenciará o código-fonte. Valores suportados: AUTO_SYNC, SNAPSHOT.

--no-wait

    Não espere para chegar ao estado de sucesso.

--skip-tests

    Ignorar a execução de testes durante a validação (por defeito verdadeiro).

--skip-validation

    Ignora a validação do projeto (build, typecheck, lint).

--source-code-path string

    O caminho do sistema de arquivos do código-fonte do espaço de trabalho usado para realizar a implantação da aplicação.

--timeout duration

    Tempo máximo para atingir o estado SUCCEEDADO (padrão 20m0s).

Bandeiras globais

Examples

O exemplo a seguir cria uma implantação com o modo de sincronização automática:

databricks apps deploy my-analytics-app --source-code-path /Workspace/Users/someone@example.com/my-app --mode AUTO_SYNC

O exemplo a seguir cria uma implementação em modo instantâneo:

databricks apps deploy my-data-app --source-code-path /Workspace/Users/someone@example.com/data-app --mode SNAPSHOT

O exemplo a seguir cria uma implantação com uma ID de implantação personalizada:

databricks apps deploy my-ml-app --deployment-id "v1.2.3" --source-code-path /Workspace/Users/someone@example.com/ml-app

Os aplicativos Databricks obtêm

Obtenha informações para a aplicação com o nome fornecido.

databricks apps get NAME [flags]

Arguments

NAME

    O nome do aplicativo.

Opções

Bandeiras globais

Examples

O exemplo a seguir obtém informações do aplicativo:

databricks apps get my-analytics-app

O exemplo a seguir obtém informações do aplicativo no formato JSON:

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

O exemplo a seguir obtém informações do aplicativo usando um perfil específico:

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

Aplicações Databricks Obter Implementação

Obtenha informações para a implantação do aplicativo com o nome e a ID de implantação fornecidos.

databricks apps get-deployment APP_NAME DEPLOYMENT_ID [flags]

Arguments

APP_NAME

    O nome do aplicativo.

DEPLOYMENT_ID

    O ID exclusivo da implantação.

Opções

Bandeiras globais

Examples

O exemplo a seguir obtém informações de implantação:

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

O exemplo a seguir obtém informações de implantação no formato JSON:

databricks apps get-deployment my-data-app v2.1.0 --output json

O exemplo a seguir obtém informações de implantação usando um perfil específico:

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

Databricks apps get-update

Obtenha o estado de uma atualização da aplicação.

databricks apps get-update APP_NAME [flags]

Arguments

APP_NAME

    O nome do aplicativo.

Opções

Bandeiras globais

Examples

O exemplo seguinte mostra o estado de uma atualização da aplicação:

databricks apps get-update my-analytics-app

O seguinte exemplo recebe o estado de atualização em formato JSON:

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

O exemplo seguinte obtém o estado de atualização usando um perfil específico:

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

Importação de aplicações Databricks

(Experimental) Importa uma aplicação Databricks existente como um pacote.

Importa uma aplicação Databricks existente e converte-a para uma configuração bundle. Este comando cria um novo diretório bundle com a configuração da app, descarrega o código-fonte da app, vincula o bundle à app existente e implementa-o usando o modo de deployment direto.

databricks apps import [flags]

Arguments

None

Opções

--cleanup

    Limpa a pasta da aplicação anterior e todo o seu conteúdo.

--force-import

    Forçar a reimportação de uma aplicação que já foi importada (só funciona para aplicações que possuis).

--name string

    Nome da aplicação a importar. Se não for especificado, lista todas as aplicações para seleção interativa.

--output-dir string

    Diretório para onde enviar o pacote. Por defeito, o nome da aplicação é atribuído.

-q, --quiet

    Suprimir mensagens informativas (mostrar apenas erros e avisos).

Bandeiras globais

Examples

O exemplo seguinte importa uma aplicação, criando um diretório com o nome da aplicação:

databricks apps import --name my-streamlit-app

O exemplo seguinte importa uma aplicação com um diretório de saída personalizado:

databricks apps import --name my-app --output-dir ~/my-apps/analytics

O exemplo seguinte importa uma aplicação e limpa a pasta antiga da app:

databricks apps import --name my-app --cleanup

Lista de aplicativos Databricks

Liste todos os aplicativos no espaço de trabalho.

databricks apps list [flags]

Arguments

None

Opções

--page-size int

    Limite superior para itens devolvidos.

--page-token string

    Token de paginação para ir para a próxima página de aplicativos.

--space string

    Filtra as aplicações pelo nome do espaço da app.

Bandeiras globais

Examples

O exemplo a seguir lista todos os aplicativos:

databricks apps list

O exemplo a seguir lista aplicativos com um tamanho de página específico:

databricks apps list --page-size 10

O exemplo a seguir lista aplicativos com paginação:

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

Lista de implementações de aplicativos Databricks

Liste todas as implantações do aplicativo com o nome fornecido.

databricks apps list-deployments APP_NAME [flags]

Arguments

APP_NAME

    O nome do aplicativo.

Opções

--page-size int

    Limite superior para itens devolvidos.

--page-token string

    Token de paginação para ir para a próxima página de aplicativos.

Bandeiras globais

Examples

O exemplo a seguir lista todas as implantações de um aplicativo:

databricks apps list-deployments my-analytics-app

O exemplo a seguir lista implantações com um tamanho de página específico:

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

Databricks Apps Logs

Transmite registos stdout/stderr para uma aplicação Databricks usando o seu fluxo de logs. Por defeito, este comando recolhe os registos mais recentes até --tail-lines e sai. A filtragem do lado do servidor está disponível usando --search e a filtragem do lado do cliente está disponível usando --source APP|SYSTEM.

databricks apps logs [NAME] [flags]

Arguments

NAME

    O nome do aplicativo.

Opções

-f, --follow

    Continue a transmitir registos até que sejam cancelados ou até que seja atingido um tempo limite especificado.

--tail-lines int

    Número de linhas de registo recentes para mostrar antes de transmitir. Configurar para 0 mostrar tudo. Predefinição: 200

--timeout duration

    Tempo máximo para transmitir quando --follow está definido. Defina como 0 para desativar o timeout.

--search string

    Envie um termo de pesquisa ao serviço de registo antes de fazer streaming.

--source strings

    Restrinja os registos a APP ou SYSTEM fontes.

--output-file string

    Caminho opcional de ficheiro para escrever logs além do stdout.

Bandeiras globais

Examples

O exemplo seguinte obtém os registos mais recentes de uma aplicação:

databricks apps logs my-analytics-app

O exemplo seguinte transmite registos continuamente até serem interrompidos:

databricks apps logs my-analytics-app --follow

O exemplo seguinte obtém as últimas 500 linhas de registos:

databricks apps logs my-data-app --tail-lines 500

O exemplo seguinte transmite registos com um timeout de 10 minutos:

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

O exemplo seguinte filtra os registos por um termo de pesquisa:

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

O exemplo seguinte restringe os logs apenas à saída ao nível da aplicação:

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

O exemplo seguinte escreve logs tanto no stdout como num ficheiro:

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

Aplicativos Databricks executados localmente

Inicie um aplicativo localmente.

databricks apps run-local [flags]

Arguments

None

Opções

--app-port int

    Porta na qual executar o aplicativo (padrão 8000).

--debug

    Habilite o modo de depuração.

--debug-port string

    Porta na qual executar o depurador.

--entry-point string

    Especifique o ponto de entrada personalizado com configuração (arquivo .yml) para o aplicativo. O padrão é app.yml.

--env strings

    Defina variáveis de ambiente.

--port int

    Porta na qual executar o proxy do aplicativo (padrão 8001).

--prepare-environment

    Prepara o ambiente para executar o aplicativo. É necessário que o UV esteja instalado.

Bandeiras globais

Examples

O exemplo a seguir executa um aplicativo localmente com configurações padrão:

databricks apps run-local

O exemplo a seguir executa um aplicativo localmente em uma porta específica:

databricks apps run-local --app-port 9000 --port 9001

Início dos aplicativos Databricks

Inicie a última implantação ativa do aplicativo no espaço de trabalho.

databricks apps start [NAME] [flags]

Arguments

NAME

    O nome do aplicativo.

Opções

--no-wait

    Não aguarde para alcançar o estado ACTIVE.

--timeout duration

    Tempo máximo para atingir o estado ATIVO (padrão 20m0s).

Bandeiras globais

Examples

O exemplo a seguir inicia um aplicativo:

databricks apps start my-analytics-app

O exemplo a seguir inicia um aplicativo sem esperar:

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

O exemplo a seguir inicia um aplicativo com um tempo limite personalizado:

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

Os aplicativos Databricks param

Pare a implantação ativa do aplicativo no espaço de trabalho.

databricks apps stop [NAME] [flags]

Arguments

NAME

    O nome do aplicativo.

Opções

--no-wait

    Não espere para chegar ao estado PARADO.

--timeout duration

    Tempo máximo para atingir o estado STOP (padrão 20m0s).

Bandeiras globais

Examples

O exemplo a seguir interrompe um aplicativo:

databricks apps stop my-analytics-app

O exemplo a seguir interrompe um aplicativo sem esperar:

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

O exemplo a seguir interrompe um aplicativo com um tempo limite personalizado:

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

Atualização de aplicativos Databricks

Atualize o aplicativo com o nome fornecido.

databricks apps update NAME [flags]

Arguments

NAME

    O nome do aplicativo. O nome deve conter apenas caracteres alfanuméricos minúsculos e hífenes. Ele deve ser exclusivo dentro do espaço de trabalho.

Opções

--budget-policy-id string

    ID da política de orçamento para a aplicação.

--compute-size ComputeSize

    A dimensão de computação para a aplicação. Valores suportados: LARGE, MEDIUM.

--description string

    A descrição do aplicativo.

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

--space string

    Nome do espaço a que esta aplicação pertence.

--usage-policy-id string

    ID da política de utilização da aplicação.

Bandeiras globais

Examples

O exemplo a seguir atualiza a descrição de um aplicativo:

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

Obter níveis de permissão das aplicações Databricks

Obtenha níveis de permissão de aplicativos.

databricks apps get-permission-levels APP_NAME [flags]

Arguments

APP_NAME

    O aplicativo para o qual obter ou gerenciar permissões.

Opções

Bandeiras globais

Examples

O exemplo a seguir obtém níveis de permissão para um aplicativo:

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

Permissões de aplicativos Databricks

Obtenha as permissões de um aplicativo. Os aplicativos podem herdar permissões de seu objeto raiz.

databricks apps get-permissions APP_NAME [flags]

Arguments

APP_NAME

    O aplicativo para o qual obter ou gerenciar permissões.

Opções

Bandeiras globais

Examples

O exemplo a seguir obtém permissões para um aplicativo:

databricks apps get-permissions my-analytics-app

O exemplo a seguir obtém permissões usando um perfil específico:

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

Definir permissões de aplicativos Databricks

Defina as permissões do aplicativo.

Define 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 de seu objeto raiz.

databricks apps set-permissions APP_NAME [flags]

Arguments

APP_NAME

    O aplicativo para o qual obter ou gerenciar permissões.

Opções

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

Bandeiras globais

Examples

O exemplo a seguir define permissões usando a configuração JSON:

databricks apps set-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_USE"}]}'

Permissões de atualização de aplicativos Databricks

Atualize as permissões em um aplicativo. Os aplicativos podem herdar permissões de seu objeto raiz.

databricks apps update-permissions APP_NAME [flags]

Arguments

APP_NAME

    O aplicativo para o qual obter ou gerenciar permissões.

Opções

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

Bandeiras globais

Examples

O exemplo a seguir atualiza as permissões usando a configuração JSON:

databricks apps update-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_MANAGE"}]}'

Bandeiras globais

--debug

  Se o log de depuração deve ser habilitado.

-h ou --help

    Exiba a ajuda para a CLI do Databricks ou para o grupo de comandos relacionado ou para o comando relacionado.

--log-file String

    Uma cadeia de caracteres que representa o arquivo para gravar logs de saída. Se esse sinalizador não for especificado, o padrão é gravar logs de saída no stderr.

--log-format Formato

    O tipo text de formato de log ou json. O valor predefinido é text.

--log-level String

    Uma cadeia de caracteres que representa o nível de formato de log. Se não for especificado, o nível de formato de log será desativado.

-o, --output tipo

    O tipo de saída do comando, text ou json. O valor predefinido é text.

-p, --profile String

    O nome do perfil no ~/.databrickscfg arquivo a ser usado para executar o comando. Se esse sinalizador não for especificado, se ele existir, o perfil nomeado DEFAULT será usado.

--progress-format Formato

    O formato para exibir logs de progresso: default, append, inplace, ou json

-t, --target String

    Se aplicável, o destino do pacote a ser usado