Compartir vía

Uso básico de la CLI de Databricks

Note

Esta información se aplica a las versiones 0.205 y posteriores de la CLI de Databricks. La CLI de Databricks está en versión preliminar pública.

El uso de la CLI de Databricks está sujeto a la licencia de Databricks y al aviso de privacidad de Databricks, incluidas las disposiciones de datos de uso.

En esta página se muestra cómo enumerar los comandos y grupos de comandos de la CLI de Databricks, mostrar la ayuda de la CLI de Databricks y trabajar con la salida de la CLI de Databricks. Consulte ¿Qué es la CLI de Databricks?.

Para instalar y configurar la autenticación para la CLI de Databricks, consulte tutorial de la CLI de Databricks.

Enumerar los comandos de la CLI disponibles

Para enumerar los grupos de comandos de la CLI disponibles, use la --help opción o -h , por ejemplo:

databricks -h

Para enumerar los comandos de cualquier grupo de comandos, use la --help opción o -h . Por ejemplo, para enumerar los clusters comandos:

databricks clusters -h

Visualización de la ayuda de un subcomando de la CLI

Para mostrar información de uso de un comando, use la --help opción o -h con el comando . Por ejemplo, para mostrar la ayuda del clusters list comando:

databricks clusters list -h

La referencia de comandos también está disponible. Vea comandos de la CLI de Databricks.

Ejecución de un comando

Puede encontrar información de uso completa y sintaxis para comandos individuales en la ayuda y referencia de la línea de comandos, pero los comandos de la CLI de Databricks suelen ajustarse a la sintaxis siguiente:

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

No todos los comandos tienen subcomandos adicionales. Las marcas globales están disponibles y algunos comandos tienen marcas adicionales. Por ejemplo, el comando siguiente genera clústeres disponibles mediante una marca específica del comando:

databricks clusters list --can-use-client JOBS

Tip

Puede ejecutar comandos de la CLI de Databricks desde un área de trabajo de Databricks mediante el terminal web. Muchos usuarios pueden usar el terminal web del espacio de trabajo en un solo equipo y no es necesario configurar la autenticación. Consulte Ejecución de comandos de shell en el terminal web de Azure Databricks.

Entrada y salida JSON

Algunos comandos de la CLI de Databricks tienen una --json marca u otras opciones que aceptan entrada de cadena JSON. Además, algunos comandos generan una cadena JSON.

Formato de cadena

El formato de las cadenas JSON depende del sistema operativo:

Linux o macOS

Incluya parámetros de cadena JSON entre comillas dobles y incluya toda la carga JSON entre comillas simples. Por ejemplo:

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

'["20230323", "Amsterdam"]'

Windows

Incluya parámetros de cadena JSON y toda la carga JSON entre comillas dobles y preceda a los caracteres de comillas dobles dentro de la carga JSON con una barra diagonal inversa (\). Por ejemplo:

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

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

Establecimiento de campos en una cadena JSON

La --json marca en muchos comandos permite establecer campos de objeto que pueden no estar disponibles como comandos o opciones de la CLI. Por ejemplo, la siguiente llamada agrega un usuario con el identificador 9ddddddd-1eee-4eee-a666-8fff7c111111 al grupo con el identificador 7eeeeeee-9ccc-4aaa-b777-1aaaaaaaaaa:

Linux o macOS

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

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\"
        }
      ]
    }
  ]
}"

Filtrado de la salida JSON con jq

En el caso de los comandos de la CLI de Databricks que generan JSON, puede usar el procesador de línea de comandos jq para filtrar la salida. Por ejemplo, para mostrar solo el nombre para mostrar de un clúster de Azure Databricks con el identificador de clúster especificado:

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

My-11.3-LTS-Cluster

Puede instalar jq en macOS mediante Homebrew con brew install jq o en Windows mediante Chocolatey con choco install jq. Para más información sobre jq, consulte el manual de jq.

Configuración del servidor proxy

Para enrutar las solicitudes y respuestas de la CLI de Databricks a través de un servidor proxy, establezca la HTTPS_PROXY variable de entorno en la máquina donde se instala la CLI de Databricks en la dirección URL del servidor proxy.

Para establecer variables de entorno, consulte la documentación del sistema operativo.

  • Last updated on