開始
加載和管理數據
處理數據
政府
引用和資源
2023年8月3日更新
給我們反饋
請注意
這個信息適用於磚CLI 0.200及以上版本,在公共預覽。找到你的版本的磚CLI,運行磚- v。
磚- v
磚的命令行接口(也稱為磚CLI)的效用,提供的磚,磚平台提供了一個易於使用的界麵來自動化終端,命令提示符,或自動化腳本。Beplay体育安卓版本
所有可用的命令信息數據磚CLI 0.200及以上版本,看看CLI命令組。
以下部分描述如何設置磚CLI。
沒有特殊要求在你安裝磚CLI。磚磚CLI提供了作為一個獨立的可執行macOS, Linux和Windows操作係統。
本節描述如何安裝或更新您的開發機磚CLI的可執行文件運行。
您可以安裝手動磚CLI, macOS或Linux使用自製程序,或使用旋度。
旋度
對於這個安裝選項,您手動下載. zip文件,然後手動提取磚CLI從下載的可執行文件. zip文件。
. zip
下載到你的本地開發機器正確的磚CLI. zip文件中列出釋放部分的磚/ cli的在GitHub庫。的. zip文件必須匹配您的開發機的操作係統和架構:
文件名
體係結構
databricks_cli_X.Y.Z_darwin_amd64.zip
macOS,英特爾64位
databricks_cli_X.Y.Z_darwin_arm64.zip
macOS,蘋果矽
databricks_cli_X.Y.Z_linux_amd64.zip
Linux,英特爾64位
databricks_cli_X.Y.Z_linux_arm64.zip
Linux,手臂64位
databricks_cli_X.Y.Z_windows_386.zip
窗戶,英特爾32位
databricks_cli_X.Y.Z_windows_amd64.zip
窗戶,英特爾64位
databricks_cli_X.Y.Z_windows_arm64.zip
窗戶,手臂64位
讓你的機器的架構,看你的操作係統的文檔。
如果你需要驗證的完整性其中之一. zip文件,磚提供了一個校驗和文件命名的databricks_cli_X.Y.Z_SHA256SUMS在相同的列表. zip文件。運行校驗和驗證,看看你的操作係統的文檔。
databricks_cli_X.Y.Z_SHA256SUMS
提取下載的內容. zip文件。提取. zip文件,看到你的操作係統的文檔。
在提取的內容,一個文件夾和名稱相同的出現. zip文件。這個文件夾裏麵是磚CLI的可執行文件。你可以把磚CLI的可執行文件,或者你可以複製或移動到另一個位置。
確認數據磚CLI是否正確安裝。要做到這一點,把磚CLI使用可執行文件的版本- v選擇或通過運行版本命令:
- v
版本
磚- v#或:磚的版本
0.200或以上的版本號是否上市,這意味著磚CLI安裝正確。
如果你運行磚但得到一個錯誤等命令不發現:磚,或者如果你跑了磚- v和版本號為0.17或以下是上市,這意味著您的機器無法找到磚CLI的可執行文件的正確版本。為了解決這個問題,要麼預謀目標磚CLI可執行文件的完整路徑磚,或者確保目標磚CLI的可執行文件的完整路徑中引用您的操作係統路徑代替。注意,如果您有多個磚CLI安裝,你應該調整你的路徑磚CLI的可執行文件,首先列出你最常使用的路徑。這將阻止你不斷地將你常用數據磚CLI可執行文件的完整路徑。管理你的路徑,看你的操作係統的文檔。
磚
命令不發現:磚
路徑
對於這個安裝選項,您使用家釀自動下載並安裝磚CLI的可執行文件。
檢查是否自製程序已經安裝通過運行以下命令從macOS終端或Linux shell提示符。如果安裝自製程序,顯示自製程序版本號:
釀造- v
如果自製程序沒有安裝,安裝它通過運行下麵的命令:
/bin/bash - c”$ (curl https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh -fsSL)”
然後運行以下命令來驗證自製程序安裝,顯示自製程序版本號:
使用自製程序添加磚/ homebrew-tap在GitHub庫可用自製程序開發存儲庫列表中,通過運行下麵的命令:
啤酒龍頭磚/水龍頭
使用自製程序來指導磚/ homebrew-tap存儲庫下載和安裝磚CLI的可執行文件,通過運行下麵的命令:
磚/ homebrew-tap
釀造安裝磚
對於這個安裝選項,您使用旋度自動下載並安裝磚CLI的可執行文件。
旋度應該已經安裝了。你可以檢查是否旋度已經安裝通過運行以下命令從macOS終端,Linux shell提示符,或者Windows命令提示符(請注意,您必須指定一個大寫嗎- v這裏)。如果旋度安裝時,旋度顯示版本號:
curl - v
如果旋度不是已經安裝了,安裝它遵循的指令旋度發布和下載頁為您的操作係統和架構。讓你的機器的架構,看你的操作係統的文檔。
然後運行以下命令來驗證旋度安裝,這顯示了旋度版本號(請注意,您必須指定一個大寫字母- v):
使用旋度下載和安裝數據磚CLI執行通過運行以下命令(請注意,您必須指定正確的大寫和小寫字母-fsSL):
-fsSL
curl https://raw.githubusercontent.com/databricks/setup-cli/main/install.sh -fsSL|上海
這個命令下載並安裝磚CLI的可執行文件的路徑/usr/local/bin/databricks在macOS和LinuxC:\Windows\ databricks.exe在Windows上。
/usr/local/bin/databricks
C:\Windows\ databricks.exe
如果由於某種原因磚CLI已經安裝,出現下麵的錯誤:“目標路徑<路徑>已經存在。”To fix this, you must manually delete the Databricks CLI executable from the preceding path, and then run the旋度再次命令。
<路徑>
查看腳本的內容在你運行它,看到的install.sh文件磚/ setup-cli在GitHub庫。
相同的方法可以用來安裝磚CLI時可用的更新,包括自製程序,手動安裝旋度。磚建議使用相同的方法在安裝過程中您使用而更新。
可選地,刪除磚CLI的可執行文件,. zip文件,. zip提取的文件的文件夾,從之前的手動安裝過程。
安裝最新版本的磚CLI指令後,在前麵的手動安裝過程。
確認是否正確更新磚CLI。要做到這一點,把磚CLI使用可執行文件的版本- v選擇或通過運行版本命令:
如果預期的更新版本號顯示,磚CLI正確更新。
使用自製程序下載並安裝最新版本的磚CLI的可執行通過運行下麵的命令:
釀造升級磚
如果預期的更新版本號顯示,磚CLI安裝正確。
磚CLI的版本的列表,請參閱釋放頁磚/ cli的在GitHub庫。
刪除現有安裝磚CLI的可執行文件的路徑/usr/local/bin/databricks在macOS和Linux或C:\Windows\ databricks.exe在Windows上。
使用旋度下載和安裝最新版本的磚CLI的可執行通過運行以下命令(請注意,您必須指定正確的大寫和小寫字母-fsSL):
如果出現下麵的錯誤,您必須手動刪除前的磚CLI的執行路徑,然後運行旋度又命令:“目標路徑<路徑>已經存在。”
在您可以運行數據磚CLI命令之前,您必須設置身份驗證磚CLI和磚之間。
你必須驗證磚CLI的相關資源在運行時為了運行磚自動化命令在磚帳戶或工作區。取決於你想叫磚工作空間層的命令,磚戶頭級別的命令,或者兩者兼有,您必須驗證數據磚工作區,帳戶,或兩者兼而有之。磚工作區級別的列表和帳戶級別CLI命令組,運行命令磚- h。磚工作區級別的列表和帳戶級別REST API的操作數據磚CLI命令封麵,看到磚REST API。
磚- h
磚CLI的實現了磚客戶端統一身份驗證標準,鞏固和一致的architecural身份驗證和編程方法。這種方法有助於使設置和自動化驗證磚更集中的和可預測的。它允許您配置數據磚身份驗證一次,然後使用該配置多個磚工具和sdk沒有進一步驗證配置更改。關於這個標準的更多信息,請參閱磚客戶端統一身份驗證。
以下部分提供的信息之間的身份驗證數據磚CLI和磚:
磚個人訪問令牌認證
穀歌雲憑據的身份驗證
穀歌雲ID認證
得到的信息配置概要文件
測試你的默認配置配置文件設置
測試您的配置概要文件
身份驗證的評價
磚個人訪問令牌身份驗證使用磚磚個人訪問令牌認證的目標實體,如磚用戶帳戶或磚服務主體。另請參閱磚個人訪問令牌認證。
創建一個磚個人訪問令牌,看到的磚個人訪問令牌認證。
你不能使用磚個人訪問令牌的身份驗證的驗證數據磚帳戶,因為磚戶頭級別的命令不使用磚個人訪問令牌的身份驗證。與磚帳戶進行身份驗證,考慮使用以下身份驗證類型之一:
配置和使用磚個人訪問令牌認證,執行以下操作:
創建或確定一個磚配置概要文件在你使用以下字段.databrickscfg文件。如果你創建配置文件,將占位符替換為適當的值。
.databrickscfg
(< some-unique-configuration-profile-name >)主機= < workspace-url >牌= < personal-access-token >
默認情況下,磚CLI的看起來.databrickscfg文件在你的~(你的用戶家裏)文件夾在Unix, Linux,或macOS,或你的% USERPROFILE %(你的用戶家裏)文件夾在Windows。如果.databrickscfg文件不存在在這個默認位置,手動創建這個文件。不要忘記點(。在文件名的開始。
~
% USERPROFILE %
。
使用磚CLI的——簡介或- p選擇配置概要文件的名稱,作為磚CLI命令調用的一部分,例如磚集群列表- p< configuration-profile-name >。
——簡介
- p
磚集群列表- p< configuration-profile-name >
提示
磚CLI 0.201.0及以上版本,你可以按下選項卡後——簡介或- p顯示現有可用的配置概要文件列表可供選擇,而不是進入手動配置概要文件的名稱。
選項卡
磚個人訪問令牌認證隻有,您可以使用磚CLI創建一個配置概要文件代替手動創建一個在前麵的步驟。要做到這一點,使用磚CLI的運行配置命令如下:
配置
磚配置——主機< workspace-url >概要文件< some-unique-configuration-profile-name >
為< workspace-url >,輸入https://例如,緊隨其後的是您的實例名稱https:// <前綴>。<隨機數> .gcp.m.eheci.com。讓你的實例名,明白了工作區實例名、url和id。
< workspace-url >
https://
https:// <前綴>。<隨機數> .gcp.m.eheci.com
命令提示您輸入您的個人訪問令牌映射到指定的磚< workspace-url >:
✔磚牌:
輸入你的磚個人訪問令牌後,相應的配置概要文件添加到您的.databrickscfg文件。如果磚CLI不能找到這個文件的默認位置,這對你創建這個文件,然後將這個配置概要文件添加到新文件。這個文件在你的默認位置~(你的用戶家裏)文件夾在Unix, Linux,或macOS,或你的% USERPROFILE %(你的用戶家裏)文件夾在Windows。
穀歌雲憑證驗證使用穀歌雲服務帳戶憑據進行身份驗證目標穀歌雲服務帳戶。另請參閱穀歌雲憑據的身份驗證。
配置穀歌雲憑據的身份驗證,必須有穀歌雲CLI在本地安裝。您還必須做到以下幾點:
帳戶級別的命令,在你設置以下值.databrickscfg文件:
(< some-unique-configuration-profile-name >)主機= < account-console-url > account_id = <帳戶id > google_credentials = < path-to-google-service-account-credentials-file >
對工作空間層命令,在你設置以下值.databrickscfg文件:
(< some-unique-configuration-profile-name >)主機= < workspace-url > google_credentials = < path-to-google-service-account-credentials-file >
使用磚CLI的——簡介或- p選擇配置概要文件的名稱,作為磚CLI命令調用的一部分,例如磚賬戶組列表- p< configuration-profile-name >或磚集群列表- p< configuration-profile-name >。
磚賬戶組列表- p< configuration-profile-name >
穀歌雲ID驗證目標穀歌雲服務帳戶進行身份驗證。看到穀歌雲ID認證。
穀歌雲配置ID認證,你必須有穀歌雲CLI在本地安裝。您還必須做到以下幾點:
(< some-unique-configuration-profile-name >)主機= < account-console-url > account_id = <帳戶id > google_service_account = < google-cloud-service-account-email-address >
(< some-unique-configuration-profile-name >)主機= < workspace-url > google_service_account = < google-cloud-service-account-email-address >
添加多個配置概要文件.databrickscfg文件允許您快速運行命令跨各種工作區指定命令的目標配置概要文件的名稱——簡介或- p選擇,對於那些支持這個選項的命令。如果你不指定——簡介或- p選項支持這個選項的命令,該命令將使用默認的默認配置概要文件。
默認的
例如,您可以配置概要文件命名DEV引用一個磚工作區使用開發工作量和一個單獨的配置概要文件命名刺激引用不同的磚工作區為生產工作負載使用。
DEV
刺激
默認情況下,磚CLI的查找.databrickscfg文件在你的~(你的用戶家裏)文件夾在Unix, Linux,或macOS,或你的% USERPROFILE %(你的用戶家裏)文件夾在Windows。您可以更改默認的路徑.databrickscfg文件通過設置環境變量DATABRICKS_CONFIG_FILE。學習如何設置環境變量,看你的操作係統的文檔。
DATABRICKS_CONFIG_FILE
現有的配置概要文件信息,運行身份驗證env命令:
身份驗證env
磚auth env - p < configuration-profile-name >#或:磚auth env -主機< account-console-url >#或:磚auth env -主機< workspace-url >
例如,在這裏是配置概要文件的輸出數據磚個人訪問令牌的身份驗證:
{“env”:{“DATABRICKS_AUTH_TYPE”:“拍”,“DATABRICKS_CONFIG_PROFILE”:“< configuration-profile-name >”,“DATABRICKS_HOST”:“< workspace-url >”,“DATABRICKS_TOKEN”:“<標記值>”}}
所有可用的概要信息,運行身份驗證配置文件命令:
身份驗證配置文件
磚身份驗證配置文件
輸出(為了簡潔起見,橢圓表示省略的內容):
{“配置文件”:({“名稱”:“< configuration-profile-name >”,“主機”:“< workspace-url >”,“雲”:“< cloud-id >”,“auth_type”:“< auth-type >”,“有效的”:真正的},{“…”:“…”}]}
的輸出身份驗證配置文件命令不顯示任何訪問令牌。顯示一個訪問令牌,跑前麵身份驗證env命令。
重要的
磚CLI不工作. netrc文件。你可以有一個. netrc文件在您的環境中為其他的目的,但是磚CLI不會使用它. netrc文件。
. netrc
檢查你是否設置正確的身份驗證,您可以運行一個命令,如以下,它列出了可用的磚的磚工作空間的運行時版本與你有關默認的概要文件。
以下稱假設您沒有任何特殊的環境變量設置,優先於你的設置默認的概要文件。有關更多信息,請參見身份驗證的評價。
磚集群spark-versions
檢查你是否正確設置任何配置概要文件,您可以運行一個命令,如以下與你的工作空間層配置概要文件的名字。這個命令列出了可用的磚磚的運行時版本的工作區與指定的配置概要文件相關聯,代表這裏的占位符< configuration-profile-name >:
< configuration-profile-name >
磚集群spark-versions - p < configuration-profile-name >
列出細節對於一個特定的配置文件,運行以下命令:
磚auth env - p < configuration-profile-name >
列出你所有的細節可用的配置文件,運行以下命令:
每當磚CLI需要收集所需的設置與磚工作區或試圖驗證賬戶,它搜索這些設置在以下地點,按照以下順序。
為包命令,字段的值在一個項目的包設置文件。(包設置文件不支持直接的訪問憑證價值。)
環境變量的值,因為在本文和上市環境變量並為客戶端統一身份驗證領域。
配置概要文件中的字段值.databrickscfg文件,如之前在本文中列出。
每當磚CLI發現所需的設置需要,它在其他地方停止搜索。例如:
磚CLI需要磚的個人訪問令牌的價值。一個DATABRICKS_TOKEN環境變量設置,.databrickscfg文件還包含了多個個人訪問令牌。在這個例子中,磚CLI使用的價值DATABRICKS_TOKEN環境變量,不搜索.databrickscfg文件。
DATABRICKS_TOKEN
的磚包部署- e發展命令需要磚的個人訪問令牌的價值。一個DATABRICKS_TOKEN環境變量沒有設置,.databrickscfg文件包含多個個人訪問令牌。項目的文件包含一個包設置發展通過其環境聲明引用配置文件配置概要文件命名DEV。在這個例子中,磚CLI的搜索.databrickscfg申請一個概要文件命名DEV和概要文件的使用的價值令牌字段。
磚包部署- e發展
發展
配置文件
令牌
的磚包運行- e發展hello-job命令需要磚的個人訪問令牌的價值。一個DATABRICKS_TOKEN環境變量沒有設置,.databrickscfg文件包含多個個人訪問令牌。項目的文件包含一個包設置發展通過其環境聲明引用主機領域特定的磚工作空間的URL。在這個例子中,磚CLI的搜索通過配置概要文件中.databrickscfg一個配置文件,其中包含的文件主機URL字段匹配的工作空間。磚CLI找到一個匹配主機概要文件的字段,然後使用令牌字段值。
磚包運行- e發展hello-job
主機
本節將向您展示如何磚CLI命令組和命令的列表,顯示磚CLI的幫助,並與磚CLI的輸出。
你使用的命令組列表——幫助或- h選擇。例如:
——幫助
- h
你的命令列表命令組使用——幫助或- h選擇。例如,列出集群命令:
集群
磚集群- h
你顯示一個命令使用的幫助——幫助或- h選擇。例如,要顯示的幫助集群列表命令:
集群列表
磚集群列表- h
金橋
一些磚CLI命令的輸出響應格式化為JSON。在許多情況下,磚CLI格式JSON輸出,這樣更容易閱讀。然而,有時它可能是有用的JSON解析的部分而不是清單整個響應。例如,列表的顯示名稱磚集群與指定集群ID,您可以使用實用程序金橋:
磚集群獲得1234年567890 - abcde123|金橋- r .cluster_name
輸出:
我的- 11.3 - lts -集群
你可以安裝金橋例如在macOS使用自製程序釀造安裝金橋或在Windows上使用巧克力色喬科省安裝金橋。的更多信息金橋,請參閱金橋手冊。
釀造安裝金橋
喬科省安裝金橋
的格式字符串參數在JSON處理不同的根據您的操作係統:
在雙引號必須將JSON字符串參數,必須將整個JSON載荷在單引號。一些例子:
”{cluster_id”:“1234 - 567890 abcde123“}”
”(“20230323”、“阿姆斯特丹”)”
必須將JSON字符串參數和整個JSON載荷在雙引號,和裏麵的雙引號字符JSON載荷必須之前\。一些例子:
\
”{\“cluster_id \”, \“1234 - 567890 abcde123 \“}”
“(\“20230323 \”,\“阿姆斯特丹\]”
下麵的國旗都是提供給所有磚CLI命令。注意,一些旗幟並不適用於一些命令。有關更多信息,請參見命令的文檔。
國旗
描述
- h或——幫助
顯示幫助磚CLI或相關的命令組或相關的命令。
- e或——環境字符串
- e
——環境字符串
一個字符串代表包環境使用如果適用於相關的命令。
——日誌文件
一個字符串代表寫日誌輸出。如果沒有指定這個標誌,那麼默認的是寫日誌輸出到stderr。
——日誌格式
文本寫文本或日誌輸出json寫日誌JSON輸出。如果沒有指定這個標誌,那麼輸出日誌寫成文字。
文本
json
——進行日誌級別
一個字符串代表級別的日誌格式。如果未指定日誌格式水平是禁用的。
- o或——輸出
- o
——輸出
文本寫輸出為文本或json寫為JSON輸出。如果沒有指定這個標誌就寫成文本輸出。
- p或——簡介
一個字符串代表指定使用在你的配置概要文件.databrickscfg文件。如果沒有指定這個標誌默認的如果存在一個概要文件使用。對磚CLI 0.201.0及以上版本
你可以按選項卡後——簡介或- p顯示現有可用的配置概要文件列表可供選擇
而不是進入手動配置概要文件的名稱。
——progress-format
進度日誌顯示格式(默認的(默認)或附加或原地或json)。
附加
原地
學習如何從磚CLI或低於0.17版本遷移到磚CLI版本0.200或更高版本,看看磚CLI的遷移。
磚CLI包括下表中列出的命令組。
幫助這些命令組及其在磚CLI命令包括:
顯示幫助命令組和一個列表命令組的命令,運行磚<命令組>- h。
磚<命令組>- h
顯示幫助命令,運行磚<命令組><命令名>- h。
磚<命令組><命令名>- h
大多數CLI命令組直接映射到方法中記錄磚REST API參考。CLI命令組不記錄在REST API參考有自己的單獨的參考文章,鏈接在下表中:
命令組
區域
賬戶
磚賬戶的操作。
警報
磚SQL警告操作。
身份驗證
管理數據磚CLI身份驗證設置。
包
磚資產包的操作。
目錄
統一目錄編目操作。
潔淨室
潔淨室操作。
cluster-policies
集群政策操作。
集群操作。
完成
使磚CLI自動完成的。
磚CLI的配置管理。
當前用戶
得到當前的信息經過身份驗證的用戶或磚服務主體的磚。
指示板
儀表板的操作。
數據源
可用數據源連接信息列表數據磚SQL兔子怒視著。
實驗
MLflow實驗操作。
external-locations
統一目錄外部位置操作。
fs
磚文件係統(DBFS)操作。
功能
統一目錄用戶定義函數(UDF)的操作。
git-credentials
Git憑證操作。
global-init-scripts
全球init腳本操作。
獎助金
統一目錄訪問授權操作。
組
磚工作區組操作。
幫助
instance-pools
操作實例池。
instance-profiles
實例配置文件操作。
ip-access-lists
IP訪問列表操作。
工作
磚的工作業務。
庫
庫操作。
metastores
統一目錄metastore操作。
model-registry
注冊表操作的模式。
權限
磚和端點對象權限操作。
管道
三角洲生活表管道操作。
policy-families
集群政策家庭操作。
供應商
三角洲共享供應商操作。
查詢
磚SQL查詢的操作。
查詢曆史
磚SQL查詢曆史操作。
recipient-activation
三角洲分享receipient激活操作。
收件人
三角洲分享接受者操作。
回購
磚回購業務。
模式
統一目錄模式操作。
秘密
磚的秘密行動。
服務主體
磚服務主體的操作。
serving-endpoints
模型服務端點的操作。
股票
三角洲分享分享業務。
storage-credentials
統一目錄存儲憑證操作。
同步
執行單向同步本地文件係統目錄中的文件更改在遠程數據磚工作區目錄。
table-constraints
表約束操作。
表
統一目錄表操作。
令牌管理
磚個人訪問令牌管理操作。
磚個人訪問令牌的操作。
用戶
磚用戶操作。
顯示了磚CLI的版本。
卷
統一目錄卷操作。
倉庫
磚SQL倉庫操作。
工作空間
磚工作區為筆記本電腦和文件夾操作。
workspace-bindings
統一目錄目錄操作磚工作空間的綁定。
workspace-conf
磚工作空間設置的配置操作。
api
調用任何可用的磚REST API端點。你應該使用這個命令組隻等高級場景的預覽版本具體磚磚的REST API的CLI尚未包裝中的目標磚REST API的相關命令。