Partager via


Interface CLI (héritée) de l’espace de travail

Important

Cette documentation a été mise hors service et peut ne pas être mise à jour.

Ces informations s’appliquent aux anciennes versions Databricks CLI 0,18 et inférieures. Databricks vous recommande d’utiliser à la place la nouvelle version 0.205 ou supérieure de l’interface CLI Databricks. Consultez Qu’est-ce que l’interface CLI Databricks ?. Pour trouver votre version de l’interface CLI Databricks, exécutez databricks -v.

Pour migrer de l’interface CLI Databricks version 0.18 ou antérieure vers l’interface CLI Databricks version 0.205 ou ultérieure, consultez Migration de l’interface CLI Databricks.

Vous exécutez les sous-commandes CLI de l'espace de travail Databricks en les ajoutant à la commande databricks workspace. Ces sous-commandes appellent l’API Espace de travail.

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

Supprimer un objet d’un espace de travail

Pour afficher la documentation d’utilisation, exécutez 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"

En cas de réussite, aucune sortie ne s’affiche.

Exporter un fichier à partir d’un espace de travail vers votre système de fichiers local

Pour afficher la documentation d’utilisation, exécutez databricks workspace export --help.

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

Cette option peut également servir à exporter des notebooks à partir d’un dossier Git Databricks:

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

En cas de réussite, aucune sortie ne s’affiche.

Exporter un fichier à partir d’un espace de travail vers votre système de fichiers local

Pour afficher la documentation d’utilisation, exécutez 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

Importer un fichier à partir de votre système de fichiers local dans un espace de travail

Pour afficher la documentation d’utilisation, exécutez databricks workspace import --help.

Seuls les fichiers avec les extensions .scala , .py, .sql, .r,.R peuvent être importés. Une fois importées, ces extensions sont supprimées du nom du bloc-notes.

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

Importer un répertoire à partir de votre système de fichiers local dans un espace de travail

Pour afficher la documentation d’utilisation, exécutez databricks workspace import_dir --help.

Cette commande importe de manière récursive un répertoire du système de fichiers local dans l’espace de travail. Seuls les répertoires et les fichiers avec les extensions .scala, .py, .sql, .r, .R sont importés. Une fois importées, ces extensions sont supprimées du nom du bloc-notes.

Pour remplacer les blocs-notes existants dans le chemin d’accès cible, ajoutez l’indicateur --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

Lister les objets dans un espace de travail

Pour afficher la documentation d’utilisation, exécutez 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

Créez un répertoire dans l’espace de travail

Pour afficher la documentation d’utilisation, exécutez databricks workspace mkdirs --help.

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

En cas de réussite, aucune sortie ne s’affiche.