Note
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
warehouses 内の コマンド グループを使用すると、SQL ウェアハウスを管理できます。 SQL ウェアハウスは、Databricks SQL 内のデータ オブジェクトに対して SQL コマンドを実行できるコンピューティング リソースです。 「SQL ウェアハウスに接続する」を参照してください。
Databricksウェアハウスの作成
新しい SQL ウェアハウスを作成します。
databricks warehouses create [flags]
Arguments
None
オプション
--auto-stop-mins int
SQL ウェアハウスが自動的に停止されるまでにアイドル状態にする必要がある時間 (つまり、 RUNNING クエリなし) を分単位で指定します。
--cluster-size string
この倉庫に割り当てられたクラスタのサイズ。
--creator-name string
倉庫作成者名
--enable-photon
ウェアハウスで Photon 最適化クラスターを使用するかどうかを構成します。
--enable-serverless-compute
ウェアハウスでサーバーレス コンピューティングを使用するかどうかを構成します。
--instance-profile-arn string
Deprecated.
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--max-num-clusters int
同時実行クエリを処理するために自動スケーラーが作成するクラスターの最大数。
--min-num-clusters int
この SQL ウェアハウスに対して保持される使用可能なクラスターの最小数。
--name string
クラスターの論理名。
--no-wait
RUNNING 状態に達するまで待たない
--spot-instance-policy SpotInstancePolicy
ウェアハウスがスポット インスタンスを使用するかどうかの設定。 サポートされる値: COST_OPTIMIZED、POLICY_UNSPECIFIED、RELIABILITY_OPTIMIZED
--timeout duration
RUNNING状態に達するまでの最大時間 (既定では 20 ミリ秒)
--warehouse-type CreateWarehouseRequestWarehouseType
倉庫の種類: PRO または CLASSIC。 サポートされる値: CLASSIC、PRO、TYPE_UNSPECIFIED
Examples
次の例では、基本的な構成で新しい SQL ウェアハウスを作成します。
databricks warehouses create --name "my-warehouse" --cluster-size "Small" --min-num-clusters 1 --max-num-clusters 10 --auto-stop-mins 60
次の例では、Photon を有効にしてサーバーレス ウェアハウスを作成します。
databricks warehouses create --name "serverless-warehouse" --enable-serverless-compute --enable-photon --warehouse-type PRO
databricks ウェアハウスを削除する
SQL ウェアハウスを削除します。
databricks warehouses delete ID [flags]
Arguments
ID
Required. SQL ウェアハウスの ID。
オプション
Examples
次の例では、指定した ID の倉庫を削除します。
databricks warehouses delete 1234567890abcdef
databricks 倉庫の編集
ウェアハウスを更新します。 SQL ウェアハウスの構成を更新します。
databricks warehouses edit ID [flags]
Arguments
ID
Required. 構成用のウェアハウスID。
オプション
--auto-stop-mins int
SQL ウェアハウスが自動的に停止されるまでにアイドル状態にする必要がある時間 (つまり、 RUNNING クエリなし) を分単位で指定します。
--cluster-size string
この倉庫に割り当てられたクラスタのサイズ。
--creator-name string
倉庫作成者名
--enable-photon
ウェアハウスで Photon 最適化クラスターを使用するかどうかを構成します。
--enable-serverless-compute
ウェアハウスでサーバーレス コンピューティングを使用するかどうかを構成します。
--instance-profile-arn string
Deprecated.
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--max-num-clusters int
同時実行クエリを処理するために自動スケーラーが作成するクラスターの最大数。
--min-num-clusters int
この SQL ウェアハウスに対して保持される使用可能なクラスターの最小数。
--name string
クラスターの論理名。
--no-wait
RUNNING状態に達するまで待つ必要はありません
--spot-instance-policy SpotInstancePolicy
ウェアハウスがスポット インスタンスを使用するかどうかの設定。 サポートされる値: COST_OPTIMIZED、POLICY_UNSPECIFIED、RELIABILITY_OPTIMIZED
--timeout duration
RUNNING状態に達するまでの最大時間 (既定では 20 ミリ秒)
--warehouse-type EditWarehouseRequestWarehouseType
倉庫の種類。 サポートされる値: CLASSIC、PRO、TYPE_UNSPECIFIED
Examples
次の例では、クラスターサイズと自動停止時間を変更するようにウェアハウスを更新します。
databricks warehouses edit 1234567890abcdef --cluster-size "Medium" --auto-stop-mins 30
次の例では、既存の倉庫に対して Photon を有効にします。
databricks warehouses edit 1234567890abcdef --enable-photon
databricks warehousesを取得する
1 つの SQL ウェアハウスの情報を取得します。
databricks warehouses get ID [flags]
Arguments
ID
Required. SQL ウェアハウスの ID。
オプション
Examples
次の例では、指定した ID を持つ倉庫に関する情報を取得します。
databricks warehouses get 1234567890abcdef
databricks Warehouses の一覧
ユーザーが管理アクセス許可を持つすべての SQL ウェアハウスを一覧表示します。
databricks warehouses list [flags]
Arguments
None
オプション
--run-as-user-id int
倉庫の一覧を取得するために使用されるサービス プリンシパル。
Examples
次の例では、すべての倉庫を一覧表示します。
databricks warehouses list
次の例では、特定のサービス プリンシパルを使用する倉庫の一覧を示します。
databricks warehouses list --run-as-user-id 123456789
databricks ウェアハウスの起動
SQL ウェアハウスを開始します。
databricks warehouses start ID [flags]
Arguments
ID
Required. SQL ウェアハウスの ID。
オプション
--no-wait
RUNNING状態に達するまで待つ必要はありません
--timeout duration
RUNNING状態に達するまでの最大時間 (既定では 20 ミリ秒)
Examples
次の例では、指定した ID で倉庫を開始します。
databricks warehouses start 1234567890abcdef
次の例は、ウェアハウスが RUNNING 状態になるのを待たずにウェアハウスを開始します。
databricks warehouses start 1234567890abcdef --no-wait
databricks ウェアハウスが停止します
SQL ウェアハウスを停止せよ。
databricks warehouses stop ID [flags]
Arguments
ID
Required. SQL ウェアハウスの ID。
オプション
--no-wait
STOPPED状態に達するまで待つ必要はありません
--timeout duration
STOPPED状態に達するまでの最大時間 (既定では 20 ミリ秒)
Examples
次の例では、指定した ID の倉庫を停止します。
databricks warehouses stop 1234567890abcdef
次の例では、倉庫が STOPPED 状態になるまで待機せずに停止します。
databricks warehouses stop 1234567890abcdef --no-wait
databricks warehouses(データブリックスウェアハウス) get-workspace-warehouse-config(ワークスペースウェアハウス設定取得)
ワークスペース内のすべての SQL ウェアハウスによって共有されるワークスペース レベルの構成を取得します。
databricks warehouses get-workspace-warehouse-config [flags]
Arguments
None
オプション
Examples
次の例では、ワークスペース ウェアハウスの構成を取得します。
databricks warehouses get-workspace-warehouse-config
databricks warehouses set-workspace-warehouse-config
ワークスペース内のすべての SQL ウェアハウスによって共有されるワークスペース レベルの構成を設定します。
databricks warehouses set-workspace-warehouse-config [flags]
Arguments
None
オプション
--google-service-account string
GCP のみ: Google Cloud Storage にアクセスするためにクラスターに渡すために使用される Google サービス アカウント。
--instance-profile-arn string
AWS のみ: IAM ロールをクラスターに渡すために使用されるインスタンスプロファイル。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--security-policy SetWorkspaceWarehouseConfigRequestSecurityPolicy
倉庫のセキュリティ ポリシー。 サポートされる値: DATA_ACCESS_CONTROL、NONE、PASSTHROUGH
Examples
次の例では、セキュリティ ポリシーを使用してワークスペース ウェアハウスの構成を設定します。
databricks warehouses set-workspace-warehouse-config --security-policy DATA_ACCESS_CONTROL
Databricks ウェアハウスの権限レベル取得
SQL ウェアハウスのアクセス許可レベルを取得します。
databricks warehouses get-permission-levels WAREHOUSE_ID [flags]
Arguments
WAREHOUSE_ID
アクセス許可を取得または管理する SQL ウェアハウス。
オプション
Examples
次の例では、倉庫のアクセス許可レベルを取得します。
databricks warehouses get-permission-levels 1234567890abcdef
databricks ウェアハウス 権限取得
SQL ウェアハウスのアクセス許可を取得します。 SQL ウェアハウスは、ルート オブジェクトからアクセス許可を継承できます。
databricks warehouses get-permissions WAREHOUSE_ID [flags]
Arguments
WAREHOUSE_ID
アクセス許可を取得または管理する SQL ウェアハウス。
オプション
Examples
次の例では、ウェアハウスのアクセス許可を取得します。
databricks warehouses get-permissions 1234567890abcdef
Databricks倉庫のアクセス許可設定
SQL ウェアハウスのアクセス許可を設定します。 オブジェクトに対する権限を設定し、既存の権限が存在する場合は置き換えます。 指定されていない場合は、すべての直接アクセス許可を削除します。 オブジェクトは、ルート オブジェクトからアクセス許可を継承できます。
databricks warehouses set-permissions WAREHOUSE_ID [flags]
Arguments
WAREHOUSE_ID
アクセス許可を取得または管理する SQL ウェアハウス。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
Examples
次の例では、JSON ファイルを使用してウェアハウスのアクセス許可を設定します。
databricks warehouses set-permissions 1234567890abcdef --json @permissions.json
databricks ウェアハウスの権限更新
SQL ウェアハウスのアクセス許可を更新します。 SQL ウェアハウスは、ルート オブジェクトからアクセス許可を継承できます。
databricks warehouses update-permissions WAREHOUSE_ID [flags]
Arguments
WAREHOUSE_ID
アクセス許可を取得または管理する SQL ウェアハウス。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
Examples
次の例では、JSON ファイルを使用してウェアハウスのアクセス許可を更新します。
databricks warehouses update-permissions 1234567890abcdef --json @permissions.json
グローバル フラグ
--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 文字列
該当する場合は、使用するバンドル ターゲット