Compartilhar via


Grupo de comandos apps

Note

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. A CLI do Databricks está em Visualização Pública.

O uso da CLI do Databricks está sujeito à Licença do Databricks e ao Aviso de Privacidade do Databricks, incluindo quaisquer provisionamentos de Dados de Uso.

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

criar aplicativos do databricks

Crie um aplicativo.

databricks apps create NAME [flags]

Arguments

NAME

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

Opções

--budget-policy-id string

    ID da política de orçamento para o aplicativo.

--description string

    A descrição do aplicativo.

--json JSON

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

--no-compute

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

--no-wait

    Não espere até atingir o estado ATIVO.

--timeout duration

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

Sinalizadores 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

exclusão de aplicativos do databricks

Excluir um aplicativo.

databricks apps delete NAME [flags]

Arguments

NAME

    O nome do aplicativo.

Opções

Sinalizadores globais

Examples

O exemplo a seguir exclui um aplicativo:

databricks apps delete my-analytics-app

implantação de aplicativos do Databricks

Crie uma implantação de aplicativo para o aplicativo com o nome fornecido.

databricks apps deploy APP_NAME [flags]

Arguments

APP_NAME

    O nome do aplicativo.

Opções

--deployment-id string

    O ID exclusivo da implantação.

--json JSON

    A cadeia de caracteres JSON inserida em linha 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 com suporte: AUTO_SYNC e SNAPSHOT.

--no-wait

    Não espere até alcançar o estado SUCCEEDED.

--source-code-path string

    O caminho do sistema de arquivos do workspace do código-fonte usado para criar a implantação do aplicativo.

--timeout duration

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

Sinalizadores 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 implantação com o modo de 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

obter aplicativos do databricks

Obtenha informações para o aplicativo com o nome fornecido.

databricks apps get NAME [flags]

Arguments

NAME

    O nome do aplicativo.

Opções

Sinalizadores 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

implantação de aplicativos do databricks

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

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

Sinalizadores 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

lista de aplicativos do databricks

Listar todos os aplicativos no espaço de trabalho.

databricks apps list [flags]

Arguments

None

Opções

--page-size int

    Limite superior para itens retornados.

--page-token string

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

Sinalizadores 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..."

implantações de lista de aplicativos do databricks

Liste todas as implantações de aplicativo para o 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 retornados.

--page-token string

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

Sinalizadores 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

logs de aplicativos do Databricks

Transmita logs stdout/stderr para um aplicativo do Databricks usando seu fluxo de log. Por padrão, esse comando busca os logs mais recentes até --tail-lines e encerra. 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 transmitindo os logs até que seja cancelado ou que um tempo limite especificado seja atingido.

--tail-lines int

    Número de linhas de log recentes a serem mostradas antes do streaming. Definido para 0 para mostrar tudo. Padrão: 200

--timeout duration

    Tempo máximo para transmitir quando --follow for definido. Defina como 0 para desabilitar o tempo limite.

--search string

    Envie um termo de pesquisa para o serviço de registros antes do streaming.

--source strings

    Restrinja logs às APP ou SYSTEM fontes.

--output-file string

    Caminho de arquivo opcional para gravar logs além de stdout.

Sinalizadores globais

Examples

O exemplo a seguir busca os logs mais recentes de um aplicativo:

databricks apps logs my-analytics-app

O exemplo a seguir transmite continuamente os logs até ser interrompido.

databricks apps logs my-analytics-app --follow

O exemplo a seguir busca as últimas 500 linhas de logs:

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

O exemplo a seguir transmite logs com um tempo limite de 10 minutos:

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

O exemplo a seguir filtra logs por um termo de pesquisa:

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

O exemplo a seguir restringe os logs somente à saída no nível do aplicativo:

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

O exemplo a seguir grava logs em stdout e em um arquivo:

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

databricks apps run-local

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 (.yml arquivo) para o aplicativo. Usa app.yml como padrão.

--env strings

    Configure as 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 seja instalado.

Sinalizadores 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

iniciar aplicativos do databricks

Inicie a última implantação ativa do aplicativo no workspace.

databricks apps start NAME [flags]

Arguments

NAME

    O nome do aplicativo.

Opções

--no-wait

    Não espere até atingir o estado ATIVO.

--timeout duration

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

Sinalizadores 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

parar aplicativos databricks

Interrompa a implantação ativa do aplicativo no workspace.

databricks apps stop NAME [flags]

Arguments

NAME

    O nome do aplicativo.

Opções

--no-wait

    Não espere até alcançar o estado STOPPED.

--timeout duration

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

Sinalizadores 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 apps do 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 hifens. Ele deve ser exclusivo dentro do espaço de trabalho.

Opções

--budget-policy-id string

    ID da política de orçamento para o aplicativo.

--description string

    A descrição do aplicativo.

--json JSON

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

Sinalizadores globais

Examples

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

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

obtenção dos níveis de permissão de apps do Databricks

Obter níveis de permissão do aplicativo.

databricks apps get-permission-levels APP_NAME [flags]

Arguments

APP_NAME

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

Opções

Sinalizadores 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 obtenção de aplicativos do 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

Sinalizadores 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

configuração de permissões de aplicativos do Databricks

Definir permissões de aplicativo.

Define permissões em um objeto, substituindo as permissões existentes se elas existirem. Excluirá 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 inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores 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 do 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 inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

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

Sinalizadores globais

--debug

  Indica se deve habilitar o registro em log de depuração.

-h ou --help

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

--log-file corda

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

--log-format formato

    O tipo de formato de log, text ou json. O valor padrão é text.

--log-level corda

    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á desabilitado.

-o, --output tipo

    O tipo de saída de comando, text ou json. O valor padrão é text.

-p, --profile corda

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

--progress-format formato

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

-t, --target corda

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