Aller au contenu principal
Dernière mise à jour le

Workspace CLI (hérité)

important

Cette documentation a été retirée et pourrait ne pas être mise à jour.

Ces informations s'appliquent aux anciennes versions de la CLI Databricks 0.18 et antérieures. Databricks vous recommande d'utiliser plutôt la version 0.205 ou ultérieure de Databricks CLI. Voir CLI Databricks. Pour trouver votre version de la CLI Databricks, exécutez databricks -v.

Pour migrer de Databricks CLI version 0.18 ou inférieure vers Databricks CLI version 0.205 ou supérieure, consultez la migration de Databricks CLI.

Vous exécutez les sous-commandes CLI du Workspace Databricks en les ajoutant à databricks workspace. Ces sous-commandes appellent l'API du workspace.

Bash
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 Workspace​

Pour afficher la documentation d'utilisation, exécutez databricks workspace delete --help ou databricks workspace rm --help.

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

Ou :

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

En cas de succès, aucune sortie n'est affichée.

Exporter un fichier d'un Workspace vers votre système de fichiers local​

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

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

Cette option peut également être utilisée pour exporter des Notebooks depuis un dossier Git Databricks:

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

En cas de succès, aucune sortie n'est affichée.

Exporter un répertoire d'un Workspace vers votre système de fichiers local​

Pour afficher la documentation d'utilisation, exécutez databricks workspace export_dir --help.

Bash
databricks workspace export_dir --overwrite /Users/someone@example.com/my-folder /Users/me/Downloads/my-folder
Console
/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 de votre système de fichiers local vers un Workspace​

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. Lors de l'importation, ces extensions sont supprimées du nom du notebook.

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

Importer un répertoire de votre système de fichiers local vers un workspace​

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 le Workspace. Seuls les répertoires et les fichiers avec les extensions .scala, .py, .sql, .r, .R sont importés. Lors de l'importation, ces extensions sont supprimées du nom du Notebook.

Pour remplacer les Notebooks existants au chemin cible, ajoutez le drapeau --overwrite ou -o.

Bash
tree
Console
.
├── a.py
├── b.scala
├── c.sql
├── d.R
└── e
Bash
databricks workspace import_dir . /Users/someone@example.com/example
Console
./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
Bash
databricks workspace ls /Users/someone@example.com/example -l
Console
NOTEBOOK   a  PYTHON
NOTEBOOK   b  SCALA
NOTEBOOK   c  SQL
NOTEBOOK   d  R
DIRECTORY  e

Répertorier les objets dans un workspace​

Pour afficher la documentation d'utilisation, exécutez databricks workspace list --help ou databricks workspace ls --help.

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

Ou :

Bash
databricks workspace ls --absolute --long --id /Users/someone@example.com
Console
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éer un répertoire dans un Workspace​

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

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

En cas de succès, aucune sortie n'est affichée.

Sur cette page