Note
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
external-locations 内の コマンド グループには、Unity カタログの外部の場所を作成および管理するためのコマンドが含まれています。
「Unity カタログ ボリュームとは」を参照してください。
databricks 外部ロケーション作成
メタストアに新しい外部の場所エントリを作成します。 呼び出し元は、メタストア管理者であるか、メタストアと関連するストレージ資格情報の両方に対する CREATE_EXTERNAL_LOCATION 特権を持っている必要があります。
databricks external-locations create NAME URL CREDENTIAL_NAME [flags]
Arguments
NAME
外部の場所の名前。
URL
外部の場所のパス URL。
CREDENTIAL_NAME
この場所で使用されるストレージ資格情報の名前。
オプション
--comment string
ユーザー指定の自由形式のテキストの説明。
--enable-file-events
この外部の場所でファイル イベントを有効にするかどうかを指定します。
--fallback
この外部の場所でフォールバック モードが有効になっているかどうかを示します。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--read-only
外部の場所が読み取り専用かどうかを示します。
--skip-validation
外部の場所に関連付けられているストレージ資格情報の検証をスキップします。
Examples
次の例では、コメントを含む外部の場所を作成します。
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 の外部ロケーションを削除
指定した外部の場所をメタストアから削除します。 呼び出し元は、外部の場所の所有者である必要があります。
databricks external-locations delete NAME [flags]
Arguments
NAME
外部の場所の名前。
オプション
--force
依存する外部テーブルまたはマウントがある場合でも、強制的に削除します。
Examples
次の例では、 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]
Arguments
NAME
外部の場所の名前。
オプション
--include-browse
プリンシパルが選択的メタデータにのみアクセスできる応答に外部の場所を含めるかどうか。
Examples
次の例では、 my-external-locationという名前の外部の場所に関する情報を取得します。
databricks external-locations get my-external-location
次の例では、参照メタデータを含む情報を取得します。
databricks external-locations get my-external-location --include-browse
databricks の外部ロケーション リスト
メタストアからの外部の場所を一覧表示します。 呼び出し元は、メタストア管理者、外部の場所の所有者、または外部の場所に対する権限を持つユーザーである必要があります。 配列内の要素の特定の順序は保証されません。
databricks external-locations list [flags]
オプション
--include-browse
プリンシパルが選択的メタデータにのみアクセスできる応答に外部の場所を含めるかどうか。
--include-unbound
ワークスペースにバインドされていない外部の場所を含めるかどうか。
--max-results int
返される外部の場所の最大数。
--page-token string
前のクエリに基づいて次のページに移動する不透明な改ページ トークン。
Examples
次の例では、すべての外部の場所を一覧表示します。
databricks external-locations list
次の例では、最大 10 件の結果を含む外部の場所を一覧表示します。
databricks external-locations list --max-results 10
databricks の外部ロケーションの更新
メタストア内の外部の場所を更新します。 呼び出し元は、外部の場所の所有者であるか、メタストア管理者である必要があります。2 番目のケースでは、管理者は外部の場所の名前のみを更新できます。
databricks external-locations update NAME [flags]
Arguments
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。
Examples
次の例では、外部の場所の名前を変更します。
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 文字列
出力ログを書き込むファイルを表す文字列。 このフラグが指定されていない場合、既定では stderr に出力ログが書き込まれます。
--log-format 形式
ログ形式の種類、 text 、または json。 既定値は text です。
--log-level 文字列
ログ形式レベルを表す文字列。 指定しない場合、ログ形式レベルは無効になります。
-o, --output 型
コマンド出力の種類( text または json)。 既定値は text です。
-p, --profile 文字列
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。 このフラグが指定されていない場合は、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。
--progress-format 形式
進行状況ログを表示する形式: default、 append、 inplace、または json
-t, --target 文字列
該当する場合は、使用するバンドル ターゲット