ワークスペース CLI (レガシ)

  • [アーティクル]

重要

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

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

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

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

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 を実行します。

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

または

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

または

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

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

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

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

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