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. 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 este artículo se muestra cómo enumerar la CLI de Databricks los grupos de comandos y comandos, 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. Consulte Instalación o actualización de la CLI de Databricks y 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
Ejecución de un comando
Puede encontrar información de uso completa y sintaxis para comandos individuales en la ayuda de la línea de comandos, pero comandos de la CLI de Databricks generalmente se ajustan 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. 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
Sugerencia
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 en un proceso y no requiere la configuración de claves. Consulte Ejecución de comandos de shell en el terminal web de Azure Databricks.
Usar jq para filtrar la salida JSON
Algunos comandos de la CLI de Databricks generan JSON, lo que significa que puede usar 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.
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.