メインコンテンツまでスキップ

ワークスペース CLI (legacy)

important

このドキュメントは廃止されており、更新されない可能性があります。

この情報は、従来の Databricks CLI バージョン 0.18 以下に適用されます。 Databricks では、代わりに新しい Databricks CLI バージョン 0.205 以降を使用することをお勧めします。 「Databricks CLI とは」を参照してください。Databricks CLI のバージョンを確認するには、 databricks -vを実行します。

Databricks CLI バージョン 0.18 以前から Databricks CLI バージョン 0.205 以降に移行するには、「 Databricks CLI の移行」を参照してください。

Databricks ワークスペース CLI サブコマンドを実行するには、それらを databricks workspace. これらのサブコマンドは、ワークスペース APIを呼び出します。

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

ワークスペースからのオブジェクトの削除​

使用方法のドキュメントを表示するには、 databricks workspace delete --help または databricks workspace rm --helpを実行します。

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

又は：

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

成功した場合、出力は表示されません。

ワークスペースからローカルファイルシステムへのファイルのエクスポート​

使用方法のドキュメントを表示するには、 databricks workspace export --helpを実行します。

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

このオプションは、 Databricks Git フォルダーからノートブックをエクスポートするためにも使用できます。

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

成功した場合、出力は表示されません。

ワークスペースからローカルファイルシステムへのディレクトリのエクスポート​

使用方法のドキュメントを表示するには、 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

ローカルファイルシステムからワークスペースにファイルをインポートする​

使用方法のドキュメントを表示するには、 databricks workspace import --helpを実行します。

インポートできるのは、拡張子が .scala、 .py、 .sql、 .r、 .R のファイルのみです。インポートすると、これらの拡張子はノートブック名から削除されます。

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

ローカルファイルシステムからワークスペースにディレクトリをインポートする​

使用方法のドキュメントを表示するには、 databricks workspace import_dir --helpを実行します。

このコマンドは、ディレクトリを再帰的にインポートします ローカル ファイル システムからワークスペースへ。 ディレクトリと 拡張子が .scala、 .py、 .sql、 .r、 .R のファイルがインポートされます。インポートすると、これらの拡張子はノートブック名から削除されます。

ターゲット パスにある既存のノートブックを上書きするには、フラグ --overwrite または -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

ワークスペース内のオブジェクトを一覧表示する​

使用方法のドキュメントを表示するには、 databricks workspace list --help または databricks workspace ls --helpを実行します。

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

又は：

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

ワークスペースにディレクトリを作成する​

使用方法のドキュメントを表示するには、 databricks workspace mkdirs --helpを実行します。

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

成功した場合、出力は表示されません。

に最終更新