Uso básico de la CLI de Databricks

Nota:

Esta información se aplica a las versiones 0.205 y posteriores de la CLI de Databricks, que se encuentran en Versión preliminar pública. Para encontrar su versión de la CLI de Databricks, ejecute databricks -v.

En este artículo se muestra cómo enumerar los comandos y los 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?.

En este artículo se supone que ya ha instalado la CLI de Databricks y ha configurado la CLI para la autenticación. Vea:

• Instalación o actualización de la CLI de Databricks
• Autenticación para la CLI de Databricks

Enumeración de grupos de comandos de la CLI

Puedes listar los grupos de comandos utilizando la opción --help o -h. Por ejemplo:

databricks -h

Enumerar comandos de la CLI

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

databricks clusters -h

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

Puedes mostrar la ayuda de un comando utilizando la opción --helpo -h. Por ejemplo, para mostrar la ayuda del clusters list comando:

databricks clusters list -h

Use jq para analizar la salida JSON de la CLI

Algunas respuestas de salida de comandos de la CLI de Databricks tienen el formato JSON. En muchos casos, la CLI de Databricks da formato a la salida JSON para que sea más fácil de leer. Sin embargo, a veces puede ser útil analizar partes del JSON en lugar de enumerar toda la respuesta. Por ejemplo, para listar sólo el nombre de visualización de un clúster Azure Databricks con el ID de clúster especificado, puedes utilizar la utilidad jq:

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

Salida:

My-11.3-LTS-Cluster

Puede instalar jq, por ejemplo 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.

Parámetros de cadena JSON

El formato de los parámetros de cadena se controla de forma diferente en JSON en función del sistema operativo:

Linux o macOS

Debe incluir parámetros de cadena JSON entre comillas dobles y debe incluir toda la carga JSON entre comillas simples. He aquí algunos ejemplos:

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

'["20230323", "Amsterdam"]'

Windows

Debes encerrar los parámetros de cadena JSON y toda la carga útil JSON entre comillas dobles, y los caracteres de comillas dobles dentro de la carga útil JSON deben ir precedidos de \. He aquí algunos ejemplos:

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

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

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 variable de entorno HTTPS_PROXY en la máquina donde esté instalada la CLI de Databricks en la dirección URL del servidor proxy.

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

Marcas globales

Las marcas siguientes están disponibles para todos los comandos de la CLI de Databricks. Tenga en cuenta que algunas marcas no se aplican a algunos comandos. Para más información, consulta la documentación del comando.

Marca	Descripción
-h o --help	Mostrar ayuda para la CLI de Databricks o el grupo de comandos relacionado o el comando relacionado.
-e o --environment string	Cadena que representa el entorno de agrupación que se va a usar si procede para el comando relacionado.
--log-file	Cadena que representa el objeto en el que se van a escribir los registros de salida. Si no se especifica esta marca, el valor predeterminado es escribir registros de salida en stderr.
--log-format	text para escribir registros de salida en texto o json para escribir registros de salida en JSON. Si no se especifica esta marca, los registros de salida se escriben como texto.
--log-level	Cadena que representa el nivel de formato de registro. Si no se especifica, el nivel de formato de registro está deshabilitado.
-o o --output	text para escribir la salida como texto o json para escribir la salida como JSON. Si no se especifica esta marca, la salida se escribe como texto.
-p o --profile	Cadena que representa el perfil de configuración con nombre que se va a usar en el .databrickscfg archivo. Si no se especifica esta bandera, se utiliza el perfil nombrado DEFAULT, si existe. Puede presionar Tab después de --profile o -p para mostrar una lista de perfiles de configuración disponibles entre los que elegir, en lugar de escribir manualmente el nombre del perfil de configuración.
--progress-format	Formato de los registros de progreso que se van a mostrar (default (valor predeterminado) o append o inplace o json).