CLI do espaço de trabalho (legado)

  • Artigo

Importante

Esta documentação foi desativada e pode não ser atualizada.

Essas informações se aplicam às versões herdadas da CLI do Databricks 0.18 e inferiores. O Databricks recomenda que você use a CLI mais recente do Databricks versão 0.205 ou superior. Consulte O que é a CLI do Databricks?. Para encontrar sua versão da CLI do Databricks, execute databricks -v.

Para migrar da CLI do Databricks versão 0.18 ou inferior para a CLI do Databricks versão 0.205 ou superior, consulte Migração da CLI do Databricks.

Execute os subcomandos da CLI do espaço de trabalho Databricks anexando-os ao databricks workspace. Esses subcomandos chamam a API do espaço de trabalho.

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

Excluir um objeto de um espaço de trabalho

Para exibir a documentação de uso, execute databricks workspace delete --help ou databricks workspace rm --help.

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

Ou:

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

Se for bem-sucedida, nenhuma saída será exibida.

Exportar um arquivo de um espaço de trabalho para o sistema de arquivos local

Para exibir a documentação de uso, execute databricks workspace export --help.

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

Essa opção também pode ser usada para exportar blocos de anotações de uma pasta Databricks Git:

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

Se for bem-sucedida, nenhuma saída será exibida.

Exportar um diretório de um espaço de trabalho para o sistema de arquivos local

Para exibir a documentação de uso, execute 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

Importar um arquivo do sistema de arquivos local para um espaço de trabalho

Para exibir a documentação de uso, execute databricks workspace import --help.

Somente arquivos com as extensões .scala, .py, .sql, .r, podem .R ser importados. Quando importadas, essas extensões são removidas do nome do bloco de anotações.

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

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

Importar um diretório do sistema de arquivos local para um espaço de trabalho

Para exibir a documentação de uso, execute databricks workspace import_dir --help.

Este comando importa recursivamente um diretório do sistema de arquivos local para o espaço de trabalho. Somente diretórios e arquivos com as extensões .scala, .py, .sql, .r, .R são importados. Quando importadas, essas extensões são removidas do nome do bloco de anotações.

Para substituir blocos de anotações existentes no caminho de destino, adicione o sinalizador --overwrite ou -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

Listar objetos em um espaço de trabalho

Para exibir a documentação de uso, execute databricks workspace list --help ou databricks workspace ls --help.

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

Ou:

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

Criar um diretório em um espaço de trabalho

Para exibir a documentação de uso, execute databricks workspace mkdirs --help.

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

Se for bem-sucedida, nenhuma saída será exibida.