CLI del área de trabajo (heredada)

  • Artículo

Importante

Esta documentación se ha retirado y es posible que no se actualice.

Esta información se aplica a las versiones heredadas de la CLI de Databricks 0.18 y versiones posteriores. En su lugar, Databricks recomienda usar la versión más reciente 0.205 o posterior de la CLI de Databricks. Consulte ¿Qué es la CLI de Databricks?. Para encontrar su versión de la CLI de Databricks, ejecute databricks -v.

Para migrar de la versión 0.18 o inferior a la versión 0.205 o superior de la CLI de Databricks, consulte Migración de la CLI de Databricks.

Para ejecutar subcomandos de la CLI del área de trabajo de Databricks, anéxelos a databricks workspace. Estos subcomandos llaman a la API de áreas de trabajo.

databricks workspace -h

Usage: databricks workspace [OPTIONS] COMMAND [ARGS]...

  Utility to interact with the Databricks workspace. Workspace paths must be
  absolute and be prefixed with `/`.

Common Options:
  -v, --version  [VERSION]
  -h, --help     Show this message and exit.

Commands:
  delete      Deletes objects from the Databricks workspace. rm and delete are synonyms.
    Options:
        -r, --recursive
  export      Exports a file from the Databricks workspace.
    Options:
      -f, --format FORMAT      SOURCE, HTML, JUPYTER, or DBC. Set to SOURCE by default.
      -o, --overwrite          Overwrites file with the same name as a workspace file.
  export_dir  Recursively exports a directory from the Databricks workspace.
    Options:
      -o, --overwrite          Overwrites local files with the same names as workspace files.
  import      Imports a file from local to the Databricks workspace.
    Options:
      -l, --language LANGUAGE  SCALA, PYTHON, SQL, R  [required]
      -f, --format FORMAT      SOURCE, HTML, JUPYTER, or DBC. Set to SOURCE by default.
      -o, --overwrite          Overwrites workspace files with the same names as local files.
  import_dir  Recursively imports a directory to the Databricks workspace.

    Only directories and files with the extensions .scala, .py, .sql, .r, .R,
    .ipynb are imported. When imported, these extensions are stripped off
    the name of the notebook.

    Options:
      -o, --overwrite          Overwrites workspace files with the same names as local files.
      -e, --exclude-hidden-files
  list        Lists objects in the Databricks workspace. ls and list are synonyms.
    Options:
      --absolute               Displays absolute paths.
      -l                       Displays full information including ObjectType, Path, Language
  ls          Lists objects in the Databricks workspace. ls and list are synonyms.
    Options:
      --absolute               Displays absolute paths.
      -l                       Displays full information including ObjectType, Path, Language
  mkdirs      Makes directories in the Databricks workspace.
  rm          Deletes objects from the Databricks workspace. rm and delete are synonyms.
    Options:
        -r, --recursive

Eliminación de un objeto de un área de trabajo

Para mostrar la documentación de uso, ejecute databricks workspace delete --help o databricks workspace rm --help.

databricks workspace delete --recursive "/Users/someone@example.com/My Folder"

O:

databricks workspace rm --recursive "/Users/someone@example.com/My Folder"

Si se ejecuta correctamente, no se muestra ninguna salida.

Exportación de un archivo desde un área de trabajo al sistema de archivos local

Para mostrar la documentación de uso, ejecute databricks workspace export --help.

databricks workspace export --overwrite --format JUPYTER "/Users/someone@example.com/My Python Notebook" /Users/me/Downloads

Esta opción también se puede usar para exportar cuadernos desde una carpeta Git de Databricks:

databricks workspace export "/Repos/someone@example.com/MyRepoNotebook" /Users/me/Downloads

Si se ejecuta correctamente, no se muestra ninguna salida.

Exportación de un directorio desde un área de trabajo al sistema de archivos local

Para mostrar la documentación de uso, ejecute databricks workspace export_dir --help.

databricks workspace export_dir --overwrite /Users/someone@example.com/my-folder /Users/me/Downloads/my-folder

/Users/someone@example.com/my-folder/My Python Notebook -> /Users/me/Downloads/my-folder/My Python Notebook.py
/Users/someone@example.com/my-folder/My Scala Notebook -> /Users/me/Downloads/my-folder/My Scala Notebook.scala
/Users/someone@example.com/my-folder/My R Notebook -> /Users/me/Downloads/my-folder/My R Notebook.r
/Users/someone@example.com/my-folder/My SQL Notebook -> /Users/me/Downloads/my-folder/My SQL Notebook.sql

Importación de un archivo desde el sistema de archivos local a un área de trabajo

Para mostrar la documentación de uso, ejecute databricks workspace import --help.

Solo se pueden importar los archivos con las extensiones .scala, .py, .sql, .r y .R. Estas extensiones se quitan del nombre del cuaderno cuando se importan.

databricks workspace import ./a.py /Users/someone@example.com/example

./a.py -> /Users/someone@example.com/example/a

Importación de un directorio desde el sistema de archivos local a un área de trabajo

Para mostrar la documentación de uso, ejecute databricks workspace import_dir --help.

Este comando permite importar de forma recursiva un directorio desde el sistema de archivos local al área de trabajo. Solo se importan directorios y archivos con las extensiones .scala, .py, .sql, .r y .R. Estas extensiones se quitan del nombre del cuaderno cuando se importan.

Para sobrescribir los cuadernos existentes en la ruta de acceso de destino, agregue la marca --overwrite o -o.

tree

.
├── a.py
├── b.scala
├── c.sql
├── d.R
└── e

databricks workspace import_dir . /Users/someone@example.com/example

./a.py -> /Users/someone@example.com/example/a
./b.scala -> /Users/someone@example.com/example/b
./c.sql -> /Users/someone@example.com/example/c
./d.R -> /Users/someone@example.com/example/d

databricks workspace ls /Users/someone@example.com/example -l

NOTEBOOK   a  PYTHON
NOTEBOOK   b  SCALA
NOTEBOOK   c  SQL
NOTEBOOK   d  R
DIRECTORY  e

Enumeración de objetos de un área de trabajo

Para mostrar la documentación de uso, ejecute databricks workspace list --help o databricks workspace ls --help.

databricks workspace list --absolute --long --id /Users/someone@example.com

O:

databricks workspace ls --absolute --long --id /Users/someone@example.com

NOTEBOOK           /Users/someone@example.com/My Python Notebook  PYTHON  1234567898012345
NOTEBOOK           /Users/someone@example.com/My Scala Notebook   SCALA   2345678980123456
NOTEBOOK           /Users/someone@example.com/My R Notebook       R       3456789801234567
DIRECTORY          /Users/someone@example.com/My Directory                4567898012345678
MLFLOW_EXPERIMENT  /Users/someone@example.com/My_Experiment               5678980123456789

Creación de un directorio en un área de trabajo

Para mostrar la documentación de uso, ejecute databricks workspace mkdirs --help.

databricks workspace mkdirs "/Users/someone@example.com/My New Folder"

Si se ejecuta correctamente, no se muestra ninguna salida.