Note
此資訊適用於 Databricks CLI 版本 0.205 及以上。 Databricks CLI 處於 公開預覽狀態。
Databricks CLI 的使用受限於 Databricks 授權 和 Databricks 隱私權聲明,包括任何使用數據條款。
warehouses
Databricks CLI 中的指令群組允許你管理 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 字串或 @path 具有要求本文的 JSON 檔案。
--max-num-clusters int
自動調整程式將建立以處理並行查詢的叢集數目上限。
--min-num-clusters int
將為此 SQL 倉儲維護的可用叢集數目下限。
--name string
叢集的邏輯名稱。
--no-wait
不要等到達到運行狀態
--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 倉庫 create-default-warehouse-override
為使用者建立預設的倉庫覆寫。 使用者可以自行建立覆蓋。 管理員可以為任何使用者建立覆蓋權限。
databricks warehouses create-default-warehouse-override DEFAULT_WAREHOUSE_OVERRIDE_ID TYPE [flags]
Arguments
DEFAULT_WAREHOUSE_OVERRIDE_ID
覆蓋的ID。 使用數字使用者 ID 或目前使用者的字串 me 即可。
TYPE
那種覆蓋行為。 支援的值:CUSTOM、LAST_SELECTED。
選項
--json JSON
內嵌 JSON 字串或 @path 具有要求本文的 JSON 檔案。
--name string
預設倉庫覆寫的資源名稱。
--warehouse-id string
當類型為 CUSTOM時,特定的倉庫 ID 為 。
Examples
以下範例為目前使用者建立自訂倉庫覆寫:
databricks warehouses create-default-warehouse-override me CUSTOM --warehouse-id 1234567890abcdef
Databricks 資料倉庫刪除
刪除 SQL 倉儲。
databricks warehouses delete ID [flags]
Arguments
ID
Required. SQL 倉儲的標識碼。
選項
Examples
下列範例會刪除具有指定標識符的倉儲:
databricks warehouses delete 1234567890abcdef
Databricks 倉庫 delete-default-warehouse-override
刪除使用者預設的倉庫覆寫。 使用者可以刪除自己的覆寫。 管理員可以刪除任何使用者的覆寫權限。 刪除後,工作區的預設倉庫會被使用。
databricks warehouses delete-default-warehouse-override NAME [flags]
Arguments
NAME
預設倉庫的資源名稱被覆蓋刪除。 格式:default-warehouse-overrides/{default_warehouse_override_id}。 ID 可以是數字使用者 ID,也可以是目前使用者的字串 me 。
選項
Examples
以下範例刪除了目前使用者的預設倉庫覆寫:
databricks warehouses delete-default-warehouse-override default-warehouse-overrides/me
databricks 資料倉庫編輯
更新倉儲。 更新 SQL 倉儲的組態。
databricks warehouses edit ID [flags]
Arguments
ID
Required. 要設定之倉儲的標識碼。
選項
--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 字串或 @path 具有要求本文的 JSON 檔案。
--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 數據倉庫獲取
取得單一 SQL 倉儲的資訊。
databricks warehouses get ID [flags]
Arguments
ID
Required. SQL 倉儲的標識碼。
選項
Examples
下列範例會取得具有指定標識符之倉儲的相關信息:
databricks warehouses get 1234567890abcdef
Databricks 倉庫 get-default-warehouse-override
取得使用者預設的倉庫覆寫。 使用者可以自行取得覆蓋權限。 管理員可以為任何使用者取得覆蓋權限。 若不存在覆寫,則使用工作區預設倉庫。
databricks warehouses get-default-warehouse-override NAME [flags]
Arguments
NAME
預設倉庫覆蓋的資源名稱,要取回。 格式:default-warehouse-overrides/{default_warehouse_override_id}。 ID 可以是數字使用者 ID,也可以是目前使用者的字串 me 。
選項
Examples
以下範例取得目前使用者的預設倉庫覆寫:
databricks warehouses get-default-warehouse-override default-warehouse-overrides/me
databricks 資料倉庫取得工作區倉庫配置 (get-workspace-warehouse-config)
取得工作區中所有 SQL 倉儲共用的工作區層級設定。
databricks warehouses get-workspace-warehouse-config [flags]
Arguments
None
選項
Examples
下列範例會取得工作區倉儲組態:
databricks warehouses get-workspace-warehouse-config
databricks 倉儲清單
列出用戶擁有管理許可權的所有 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 倉庫列表-預設-倉庫覆寫
在工作區列出所有預設的倉庫覆寫。 只有工作區管理員能列出所有覆寫。
databricks warehouses list-default-warehouse-overrides [flags]
選項
--page-size int
最多可回傳的覆蓋次數。
--page-token string
來自先前 list-default-warehouse-overrides 通話的分頁標記。
Examples
以下範例列出所有預設倉庫覆寫:
databricks warehouses list-default-warehouse-overrides
Databricks warehouses set-workspace-warehouse-config
設定工作區中所有 SQL 倉儲共用的工作區層級設定。
databricks warehouses set-workspace-warehouse-config [flags]
Arguments
None
選項
--google-service-account string
僅限 GCP:Google 服務帳戶用於通過叢集以存取 Google Cloud Storage。
--instance-profile-arn string
僅限 AWS:用來將 IAM 角色傳遞至叢集的實例設定檔。
--json JSON
內嵌 JSON 字串或 @path 具有要求本文的 JSON 檔案。
--security-policy SetWorkspaceWarehouseConfigRequestSecurityPolicy
倉儲的安全策略。 支援的值:DATA_ACCESS_CONTROL、NONE、PASSTHROUGH
Examples
下列範例會使用安全策略來設定工作區倉儲組態:
databricks warehouses set-workspace-warehouse-config --security-policy DATA_ACCESS_CONTROL
databricks 資料倉庫啟動
啟動 SQL 倉儲。
databricks warehouses start ID [flags]
Arguments
ID
Required. SQL 倉儲的標識碼。
選項
--no-wait
不要等待到達 RUNNING 狀態
--timeout duration
達到 RUNNING 狀態的時間上限(預設為 20 毫秒)
Examples
下列範例會啟動具有指定標識符的倉儲:
databricks warehouses start 1234567890abcdef
下列範例會啟動倉儲,而不等待它到達 RUNNING 狀態:
databricks warehouses start 1234567890abcdef --no-wait
databricks 資料倉庫停止運作
停止 SQL 倉儲。
databricks warehouses stop ID [flags]
Arguments
ID
Required. SQL 倉儲的標識碼。
選項
--no-wait
不要等待到達 STOPPED 狀態
--timeout duration
達到 STOPPED 狀態的時間上限(預設為 20 毫秒)
Examples
下列範例會停止具有指定標識符的倉儲:
databricks warehouses stop 1234567890abcdef
下列範例會停止倉儲,而不等待它到達 STOPPED 狀態:
databricks warehouses stop 1234567890abcdef --no-wait
Databricks 倉庫更新-預設-倉庫覆寫
更新使用者現有的預設倉庫覆寫。 使用者可以自行更新覆蓋。 管理員可以為任何使用者更新覆寫權限。
databricks warehouses update-default-warehouse-override NAME UPDATE_MASK TYPE [flags]
Arguments
NAME
預設倉庫覆寫的資源名稱。 格式:default-warehouse-overrides/{default_warehouse_override_id}。
UPDATE_MASK
欄位遮罩指定要更新哪些欄位。 用來 * 更新所有欄位。 當 --allow-missing 設定時,該欄位會被忽略,所有欄位都會被套用。
TYPE
那種覆蓋行為。 支援的值:CUSTOM、LAST_SELECTED。
選項
--allow-missing
如果設定好但找不到覆寫,則改建一個新的覆寫。
--json JSON
內嵌 JSON 字串或 @path 具有要求本文的 JSON 檔案。
--name string
預設倉庫覆寫的資源名稱。
--warehouse-id string
當類型為 CUSTOM時,特定的倉庫 ID 為 。
Examples
以下範例更新目前使用者的覆寫權限至特定倉庫:
databricks warehouses update-default-warehouse-override default-warehouse-overrides/me warehouse_id CUSTOM --warehouse-id 1234567890abcdef
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 字串或 @path 具有要求本文的 JSON 檔案。
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 字串或 @path 具有要求本文的 JSON 檔案。
Examples
下列範例會使用 JSON 檔案更新倉儲的許可權:
databricks warehouses update-permissions 1234567890abcdef --json @permissions.json
全域旗標
--debug
是否要啟用偵錯記錄。
-h 或 --help
顯示 Databricks CLI、相關命令群組或相關命令的幫助說明。
--log-file 字串
字串,表示要寫入輸出記錄檔的檔案。 若未指定此旗標,則預設值是將輸出記錄寫入 stderr。
--log-format 格式
記錄格式類型或 textjson。 預設值是 text。
--log-level 字串
表示日誌格式層級的字串。 若未指定,則日誌的格式層級功能將被停用。
-o, --output 類型
指令輸出類型或 textjson。 預設值是 text。
-p, --profile 字串
要用來執行命令之檔案中的 ~/.databrickscfg 配置檔名稱。 如果未指定此旗標,則如果存在,則會使用名為 DEFAULT 的配置檔。
--progress-format 格式
顯示進度記錄的格式:default、、appendinplace、 或json
-t, --target 字串
如果適用,要使用的套件組合目標