volumes コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI内のvolumesコマンドグループには、Unity Catalogのボリュームを管理するコマンドが含まれています。ボリュームは、ファイルへのアクセス、保存、管理、整理、および処理のための機能を提供します。「 Unity Catalog ボリュームとは」を参照してください。
databricks volumes create
新しいボリュームを作成します。
ユーザーは、外部ボリュームまたは管理対象ボリュームのいずれかを作成できます。外部ボリュームは指定された外部ロケーションに作成され、マネージド ボリュームは親スキーマ、親カタログ、またはメタストアで指定されたデフォルトの場所に配置されます。
ボリュームの作成を成功させるには、ユーザーは次の条件を満たす必要があります。
- 呼び出し元は、メタストア管理者であるか、親カタログとスキーマの所有者であるか、親カタログに対する
USE_CATALOG特権と親スキーマに対するUSE_SCHEMA特権を持っている必要があります。 - 呼び出し元には、親スキーマに対する
CREATE VOLUME特権が必要です。
外部ボリュームの場合、以下の条件も満たす必要があります。
- 呼び出し元には、外部ロケーションに対する
CREATE EXTERNAL VOLUME権限が必要です。 - 指定されたストレージの場所に他のテーブルやボリュームが存在しません。- 指定されたストレージ・ロケーションが、他の表、ボリューム、カタログ、またはスキーマのロケーションの下にはありません。
databricks volumes create CATALOG_NAME SCHEMA_NAME NAME VOLUME_TYPE [flags]
引数
CATALOG_NAME
スキーマとボリュームがあるカタログの名前
SCHEMA_NAME
ボリュームが
NAME
ボリュームの名前
VOLUME_TYPE
ボリュームのタイプ。外部ボリュームは、指定された外部ロケーションにあります。管理対象ボリュームは、親スキーマ、親カタログ、またはメタストアによって指定されるデフォルトの場所にあります。 「 管理対象ボリュームと外部ボリューム」を参照してください。サポートされている値: EXTERNAL、 MANAGED
オプション
--comment string
巻に添付されたコメント。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--storage-location string
クラウド上のストレージの場所。
例
次の例では、管理対象ボリュームを作成します。
databricks volumes create my_catalog my_schema my_volume MANAGED
次の例では、コメントを使用して外部ボリュームを作成します。
databricks volumes create my_catalog my_schema my_external_volume EXTERNAL --storage-location s3://my-bucket/my-volume --comment "External volume for data processing"
databricks volumes delete
指定した親カタログおよびスキーマからボリュームを削除します。
呼び出し元は、メタストア管理者またはボリュームの所有者である必要があります。後者の場合、呼び出し元も所有者であるか、親カタログに対する USE_CATALOG 特権と親スキーマに対する USE_SCHEMA 特権を持っている必要があります。
databricks volumes delete NAME [flags]
引数
NAME
ボリュームの 3 レベル (完全修飾) 名
オプション
例
次の例では、ボリュームを削除します。
databricks volumes delete my_catalog.my_schema.my_volume
databricks volumes list
親カタログとスキーマの下に現在のメタストアのボリュームを一覧表示します。
返されるボリュームは、呼び出し元ユーザーの権限に基づいてフィルタリングされます。たとえば、メタストア管理者はすべてのボリュームを一覧表示できます。通常のユーザーが、応答でボリュームを受信するには、所有者であるか、ボリュームに対する READ VOLUME 権限を持っている必要があります。後者の場合、呼び出し元も所有者であるか、親カタログに対する USE_CATALOG 特権と親スキーマに対する USE_SCHEMA 特権を持っている必要があります。
配列内の要素の特定の順序を保証するものではありません。
databricks volumes list CATALOG_NAME SCHEMA_NAME [flags]
引数
CATALOG_NAME
カタログの識別子
SCHEMA_NAME
スキーマの識別子
オプション
--include-browse
プリンシパルが選択的なメタデータにのみアクセスできるボリュームをレスポンスに含めるかどうか。
--max-results int
返すボリュームの最大数 (ページ長)。
--page-token string
前の要求によって返された不透明なトークン。
例
次の例は、カタログとスキーマ内のすべてのボリュームをリストします。
databricks volumes list my_catalog my_schema
databricks volumes read
特定のカタログとスキーマのボリュームをメタストアから取得します。
呼び出し元は、メタストア管理者、またはボリュームの所有者 (またはボリュームに対する READ VOLUME 特権を持っている) である必要があります。後者の場合、呼び出し元も所有者であるか、親カタログに対する USE_CATALOG 特権と親スキーマに対する USE_SCHEMA 特権を持っている必要があります。
databricks volumes read NAME [flags]
引数
NAME
ボリュームの 3 レベル (完全修飾) 名
オプション
--include-browse
プリンシパルが選択的なメタデータにのみアクセスできるボリュームをレスポンスに含めるかどうか。
例
次の例では、ボリュームに関する情報を取得します。
databricks volumes read my_catalog.my_schema.my_volume
次の例では、ブラウズメタデータを含むボリューム情報を取得します。
databricks volumes read my_catalog.my_schema.my_volume --include-browse
databricks volumes update
指定された親カタログおよびスキーマの下で、指定されたボリュームを更新します。
呼び出し元は、メタストア管理者またはボリュームの所有者である必要があります。後者の場合、呼び出し元も所有者であるか、親カタログに対する USE_CATALOG 特権と親スキーマに対する USE_SCHEMA 特権を持っている必要があります。
現在、ボリュームの名前、所有者、またはコメントのみを更新できます。
databricks volumes update NAME [flags]
引数
NAME
ボリュームの 3 レベル (完全修飾) 名
オプション
--comment string
巻に添付されたコメント。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--new-name string
ボリュームの新しい名前。
--owner string
ボリュームを所有するユーザーの識別子。
例
次の例では、ボリュームのコメントを更新します。
databricks volumes update my_catalog.my_schema.my_volume --comment "Updated comment for my volume"
次の例では、ボリュームの所有者を変更します。
databricks volumes update my_catalog.my_schema.my_volume --owner someone@example.com
次の例では、ボリュームの名前を変更します。
databricks volumes update my_catalog.my_schema.my_volume --new-name my_new_volume_name
グローバルフラグ
--debug
デバッグログを有効にするかどうか。
-h または --help
Databricks CLI、関連するコマンド グループ、または関連するコマンドのヘルプを表示します。
--log-file string
出力ログの書き込み先となるファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログが stderr に書き込まれます。
--log-format format
ログ・フォーマット・タイプ ( text または json) 。デフォルト値は textです。
--log-level string
ログ形式レベルを表す文字列。指定しない場合、ログ・フォーマット・レベルは使用不可になります。
-o, --output タイプ
コマンド出力タイプ text または json。デフォルト値は textです。
-p, --profile string
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。このフラグが指定されていない場合、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。
--progress-format format
進行状況ログを表示する形式: default、 append、 inplace、 json
-t, --target string
該当する場合は、使用するバンドル・ターゲット