Uso básico da CLI da Databricks

nota

Essas informações se aplicam ao site Databricks CLI versões 0.205 e superiores. A CLI da Databricks está em visualização pública.

Databricks CLI O uso está sujeito à LicençaDatabricks e ao Aviso de PrivacidadeDatabricks, incluindo qualquer provisionamento de Dados de Uso.

Esta página mostra como listar os grupos de comandos e comandos CLI Databricks , exibir a ajuda CLI Databricks e trabalhar com a saída CLI Databricks . Veja O que é a CLI do Databricks?

Para instalar e configurar a autenticação para a CLI do Databricks, consulte o tutorial da CLI do Databricks.

Listar comandos CLI disponíveis

Para listar os grupos de comandos CLI disponíveis, use a opção --help ou -h , por exemplo:

Bash

databricks -h

Para listar os comandos de qualquer grupo de comandos, use a opção --help ou -h . Por exemplo, para listar o comando clusters :

Bash

databricks clusters -h

Exibir a ajuda do comando da CLI

Para exibir informações de uso de um comando, use a opção --help ou -h com o comando. Por exemplo, para exibir a ajuda do comando clusters list :

Bash

databricks clusters list -h

A referência de comandos também está disponível. Consulte o comando CLI Databricks.

execução a comando

Informações completas sobre o uso e a sintaxe de cada comando podem ser encontradas na ajuda e referência da linha de comando, mas os comandos CLI Databricks geralmente seguem a seguinte sintaxe:

databricks <command-group> <command-name> <subcommand-name> [command-argument-value1] [--<flag1-name> <flag1-value>]

Nem todos os comandos possuem subcomandos adicionais. Sinalizadores globais estão disponíveis, e alguns comandos possuem sinalizadores adicionais. Por exemplo, o comando a seguir exibe os agrupamentos disponíveis, utilizando um sinalizador específico do comando:

Bash

databricks clusters list --can-use-client JOBS

dica

Você pode executar comandos CLI Databricks a partir de um workspace Databricks usando o terminal web. O terminal web workspace pode ser usado por vários usuários em um mesmo compute e não requer configuração de autenticação. Consulte o comando shell de execução no terminal web Databricks.

Entrada e saída JSON

Alguns comandos CLI Databricks possuem um sinalizador --json ou outras opções que aceitam entrada de strings JSON . Além disso, alguns comandos geram strings JSON .

Formatação de strings

O formato das strings JSON depende do seu sistema operacional:

Linux or macOS

Coloque os parâmetros das strings JSON entre aspas duplas e coloque toda a carga útil JSON entre aspas simples. Por exemplo:

'{"cluster_id": "1234-567890-abcde123"}'

'["20230323", "Amsterdam"]'

Windows

Inclua os parâmetros de strings JSON e toda a carga útil JSON em aspas duplas e preceda os caracteres de aspas duplas dentro da carga útil JSON com uma barra invertida (\). Por exemplo:

"{\"cluster_id\": \"1234-567890-abcde123\"}"

"[\"20230323\", \"Amsterdam\"]"

Definir campos em strings JSON

O parâmetro --json em muitos comandos permite definir campos de objetos que podem não estar disponíveis como comandos ou opções CLI . Por exemplo, a seguinte chamada adiciona um usuário com o ID 9ddddddd-1eee-4eee-a666-8fff7c111111 ao grupo com o ID 7eeeeeee-9ccc-4aaa-b777-1aaaaaaaaaa:

Linux or macOS

Bash

databricks account groups patch 7eeeeeee-9ccc-4aaa-b777-1aaa2eeeee6f --json '{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [
        {
        "value": "9ddddddd-1eee-4eee-a666-8fff7c111111"
        }
      ]
    }
  ]
}'

Windows

Bash

databricks account groups patch 7eeeeeee-9ccc-4aaa-b777-1aaa2eeeee6f --json "{
  \"schemas\": [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"],
  \"Operations\": [
    {
      \"op\": \"add\",
      \"path\": \"members\",
      \"value\": [
        {
            \"value\": \"9ddddddd-1eee-4eee-a666-8fff7c111111\"
        }
      ]
    }
  ]
}"

Filtrar a saída JSON com jq

Para comandos CLI Databricks que geram saída JSON, você pode usar o processador de linha de comando jq para filtrar a saída. Por exemplo, para listar apenas o nome de exibição de um cluster Databricks com o ID de cluster especificado:

Bash

databricks clusters get 1234-567890-abcde123 | jq -r .cluster_name

Output

My-11.3-LTS-Cluster

O senhor pode instalar o jq no macOS usando o Homebrew com brew install jq ou no Windows usando o Chocolatey com choco install jq. Para obter mais informações sobre jq, consulte o Manual do jq.

Configuração do servidor proxy

Para rotear as solicitações e respostas da CLI da Databricks por meio de um servidor proxy, defina a variável de ambiente HTTPS_PROXY na máquina em que a CLI da Databricks está instalada para o URL do servidor proxy.

Para definir a variável de ambiente, consulte a documentação do seu sistema operacional.