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