external-locations コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI内のexternal-locationsコマンド グループには、外部ロケーションを作成および管理するコマンド for Unity Catalogが含まれています。「 Unity Catalog ボリュームとは」を参照してください。
databricks external-locations create
メタストアに新しい外部ロケーション エントリを作成します。 呼び出し元は、メタストア管理者であるか、メタストアと関連付けられているストレージ資格情報の両方に対する CREATE_EXTERNAL_LOCATION 特権を持っている必要があります。
databricks external-locations create NAME URL CREDENTIAL_NAME [flags]
引数
NAME
外部ロケーションの名前。
URL
外部ロケーションのパスURL。
CREDENTIAL_NAME
この場所で使用されるストレージ資格情報の名前。
オプション
--comment string
ユーザー指定の自由形式のテキスト説明。
--enable-file-events
この外部ロケーションでファイルイベントを有効にするかどうか。
--fallback
この外部ロケーションに対してフォールバック モードが有効になっているかどうかを示します。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--read-only
外部ロケーションが読み取り専用であるかどうかを示します。
--skip-validation
外部ロケーションに関連付けられたストレージ資格情報の検証をスキップします。
例
次の例では、コメントを使用して外部ロケーションを作成します。
databricks external-locations create my-external-location s3://my-bucket/path my-credential --comment "External location for data lake"
次の例では、読み取り専用の外部ロケーションを作成します。
databricks external-locations create my-external-location s3://my-bucket/path my-credential --read-only
databricks external-locations delete
指定した外部ロケーションをメタストアから削除します。 呼び出し元は、外部ロケーションの所有者である必要があります。
databricks external-locations delete NAME [flags]
引数
NAME
外部ロケーションの名前。
オプション
--force
依存する外部テーブルまたはマウントがある場合でも強制的に削除します。
例
次の例では、 my-external-locationという名前の外部ロケーションを削除します。
databricks external-locations delete my-external-location
次の例では、依存関係がある場合でも外部ロケーションを強制的に削除します。
databricks external-locations delete my-external-location --force
databricks external-locations get
メタストアから外部ロケーションを取得します。 呼び出し元は、メタストア管理者、外部ロケーションの所有者、または外部ロケーションに対する何らかの権限を持つユーザーである必要があります。
databricks external-locations get NAME [flags]
引数
NAME
外部ロケーションの名前。
オプション
--include-browse
プリンシパルが選択的なメタデータにのみアクセスできる応答に外部ロケーションを含めるかどうか。
例
次の例では、 my-external-locationという名前の外部ロケーションに関する情報を取得します。
databricks external-locations get my-external-location
次の例では、ブラウズメタデータを含む情報を取得します。
databricks external-locations get my-external-location --include-browse
databricks external-locations list
メタストアから外部ロケーションを一覧表示します。 呼び出し元は、メタストア管理者、外部ロケーションの所有者、または外部ロケーションに対する何らかの権限を持つユーザーである必要があります。 配列内の要素の特定の順序を保証するものではありません。
databricks external-locations list [flags]
オプション
--include-browse
プリンシパルが選択的なメタデータにのみアクセスできる応答に外部ロケーションを含めるかどうか。
--max-results int
返す外部ロケーションの最大数。
--page-token string
前のクエリに基づいて次のページに移動するための不透明なページネーショントークン。
例
次の例は、すべての外部ロケーションをリストします。
databricks external-locations list
次の例は、最大 10 個の結果を持つ外部ロケーションをリストします。
databricks external-locations list --max-results 10
databricks external-locations update
メタストアの外部ロケーションを更新します。 呼び出し元は、外部ロケーションの所有者であるか、メタストア管理者である必要があります。 2 番目のケースでは、管理者は外部ロケーションの名前のみを更新できます。
databricks external-locations update NAME [flags]
引数
NAME
外部ロケーションの名前。
オプション
--comment string
ユーザー指定の自由形式のテキスト説明。
--credential-name string
この場所で使用されるストレージ資格情報の名前。
--enable-file-events
この外部ロケーションでファイルイベントを有効にするかどうか。
--fallback
この外部ロケーションに対してフォールバック モードが有効になっているかどうかを示します。
--force
URL を変更すると依存する外部テーブルまたはマウントが無効になる場合でも、強制的に更新します。
--isolation-mode IsolationMode
サポートされている値: ISOLATION_MODE_ISOLATED、 ISOLATION_MODE_OPEN
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--new-name string
外部ロケーションの新しい名前。
--owner string
外部ロケーションの所有者。
--read-only
外部ロケーションが読み取り専用であるかどうかを示します。
--skip-validation
外部ロケーションに関連付けられたストレージ資格情報の検証をスキップします。
--url string
外部ロケーションのパスURL。
例
次の例では、外部ロケーションの名前を変更します。
databricks external-locations update my-external-location --new-name my-renamed-location
次の例では、外部ロケーションの所有者を変更します。
databricks external-locations update my-external-location --owner someone@example.com
グローバルフラグ
--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
該当する場合は、使用するバンドル・ターゲット