磚CLI的遷移

本文描述了如何從磚CLI或低於0.17版本遷移到磚CLI版本0.200或更高版本。磚CLI版本0.200及以上公共預覽。

為了簡單起見,本文引用磚CLI版本0.17及以下的“遺留”CLI,和磚CLI 0.200及以上版本的“新”CLI。

更多關於遺留和新綜合領先指標的信息,見:

磚CLI(遺留)CLI的遺產。
磚CLI新的CLI。

卸載遺留CLI

如果你有你想要的遺留CLI安裝和卸載它,使用皮普(或pip3,這取決於您的Python版本)運行卸載命令,如下所示:

皮普卸載databricks-cli

安裝新的CLI

如果你不已經有了新的CLI安裝,安裝它,明白了設置CLI。

驗證CLI安裝

如果你不確定你是否使用新的CLI,按照說明在本節中,根據需要來驗證和調整。你遵循這些指令之前,確保退出任何Python虛擬環境,conda環境,或類似的環境。

檢查默認安裝CLI的版本,運行以下命令:

磚- v

如果版本號不是你期望什麼,做以下之一:

如果你想使用CLI的隻有一個版本:卸載以前版本的CLI不再需要使用。您可能需要更新您的操作係統的路徑這剩餘的版本的CLI的路徑,你想用上市。
如果你想繼續使用CLI的多個版本:預謀的完整路徑CLI的版本,您想要使用每個調用CLI。
如果你想繼續使用CLI的多個版本,但你不想保持將完整路徑CLI是你最經常使用的版本:確保完整路徑,首先列出在你的操作係統的版本路徑。請注意,您必須預先考慮的完整路徑中未列出的第一個版本的CLI您的操作係統路徑。

更新操作係統的路徑,請執行以下操作:

的路徑列表磚安裝通過運行以下命令之一:
```
這一磚#或:在磚
```
得到你想要的路徑安裝使用沒有將完整路徑每對CLI的調用。如果你不確定這是路徑,運行每個位置的完整路徑,緊隨其後- v,例如:
```
/usr/local/bin/databricks - v
```
把安裝的路徑,你想先使用路徑運行以下命令,更換/usr/local/bin您想要使用的路徑。不添加磚的這條路。例如:
```
出口路徑=“/ usr /地方/ bin:美元的路徑”
```
來驗證路徑是正確地設置為當前終端會話,運行磚緊隨其後的是- v並檢查版本號:
```
磚- v
```
有路徑這樣每次你啟動終端,從步驟3添加命令shell初始化文件。例如,對於Zshell,該文件通常位於~ / . zshrc。Bash,該文件通常位於~ / . bashrc。對於其他外殼,看到您的shell提供者的文檔。
你更新你的初始化文件之後,必須重新啟動您的終端應用更新路徑價值。

右鍵單擊安裝磚沒有將您想要使用完整路徑每對CLI的調用。
點擊打開文件位置。
注意,路徑磚例如,C:\Windows。
在開始菜單、搜索環境變量。
點擊編輯環境變量為您的帳戶。
選擇路徑變量用戶變量<用戶名>部分。
點擊編輯。
點擊新。
輸入您想要添加的路徑,沒有databricks.exe(如C:\Windows)。
使用向上移動按鈕來移動路徑,隻需添加到列表的開始。
點擊好吧。
來驗證路徑正確設置,打開一個新命令提示符運行磚緊隨其後的是- v,檢查版本號:
```
磚- v
```

使用額外的身份驗證類型

遺留CLI和新的CLI都支持磚個人訪問令牌的身份驗證。然而,磚建議你使用其他的磚的身份驗證類型如果可能,隻有新的CLI支持。

個人訪問令牌認證,如果你必須使用磚磚建議你使用一個相關的服務主體而不是磚帳戶或用戶工作區。看到提供一個服務主體為磚自動化UI -磚。

新的CLI支持OAuth標記除了磚個人訪問令牌。這些額外的標記是更安全的,因為他們通常在一小時內到期,而磚個人訪問令牌可以無限期有效從一天到。這一點尤其重要,如果令牌是不小心簽入到版本控製係統,由其他人可以訪問。此外,新的CLI可以到期時自動刷新這些額外的令牌,而刷新數據磚個人訪問令牌是一個手動過程或很難自動化。

有關更多信息,請參見設置身份驗證。

命令組和命令的比較

下表列出了遺留CLI命令組和他們的新CLI命令組的等價物。綜合領先指標之間存在顯著差異,額外的表遺留CLI命令或選項列表及其新的CLI命令或選項的等價物。

命令組

遺留命令組	新命令組
`cluster-policies`	`cluster-policies`。所有的命令名稱都是一樣的。
`集群`	`集群`。所有的命令名稱都是一樣的。
`配置`	`配置`。看到配置選項。
`fs`	`fs`。看到fs命令。
`組`	`組`。看到組織的命令。
`instance-pools`	`instance-pools`。所有的命令名稱都是一樣的。
`工作`	`工作`。所有的命令名稱都是一樣的。
`庫`	`庫`。所有的命令名稱都是一樣的除了`列表`。的`列表`命令不再可用;使用`all-cluster-statuses`或`集群狀態`而不是命令。
`管道`	`管道`。看到管道命令。
`回購`	`回購`。所有的命令名稱都是一樣的。
`運行`	`工作`。看到運行命令。
`秘密`	`秘密`。看到秘密的命令。
`堆棧`	在新的CLI。磚建議您使用磚起程拓殖的提供者代替。
`令牌`	`令牌`。看到令牌的命令。
`unity-catalog`	各種各樣的。看到unity-catalog命令組。
`工作空間`	`工作空間`。看到工作區命令。

配置選項

遺留的選擇	新選項
`- o`	遺留CLI使用`- o`OAuth身份驗證。新的CLI OAuth的看OAuth機器對機器(M2M)身份驗證或OAuth user-to-machine (U2M)身份驗證。新的CLI重新改`- o`指定是否CLI在文本或JSON格式輸出。
`——oauth`	新的CLI OAuth的看OAuth機器對機器(M2M)身份驗證或OAuth user-to-machine (U2M)身份驗證。
`- s`或`——範圍`	新的CLI OAuth的看OAuth機器對機器(M2M)身份驗證或OAuth user-to-machine (U2M)身份驗證。
`- t`或`——令牌`	`- t`或`——令牌`(相同)
`- f`或`——token-file`	在新的CLI。
`——主機`	`——主機`(相同)
`——aad-token`	使用`——主機`並指定一個Azure Active Directory (Azure)令牌當提示,而不是磚個人訪問令牌。
`——不安全`	在新的CLI。
`——jobs-api-version`	在新的CLI。新的CLI API 2.1隻使用工作。調用遺留工作遺留CLI API 2.0使用看看喬布斯CLI(遺留)。
`——調試`	新的CLI的調試和日誌記錄調試模式。
`——簡介`	`——簡介`(同樣的)或`- p`
`- h`或`——幫助`	`- h`或`——幫助`(相同)

fs命令

所有fs在遺留CLI命令是相同的在新的CLI,除了fsmv這不是新的CLI中可用。

遺留的命令	新命令
`fs貓`	`fs貓`(相同)
`fscp`	`fscp`(相同)
`fsls`	`fsls`(相同)
`fsmkdir`	`fsmkdir`
`fsmv`	在新的CLI。
`fsrm`	`fsrm`(相同)

組織的命令

遺留的命令	新命令
`組添加成員`	`組補丁`
`組創建`	`組創建`(相同)
`組刪除`	`組刪除`(相同)
`組列表`	`組列表`(相同)
`組國家`	`組列表`
`組list-parents`	`組列表`
`組remove-member`	`組補丁`

管道命令

遺留的命令	新命令
`管道創建`	`管道創建`(相同)
`管道刪除`	`管道刪除`(相同)
`管道部署`	`管道創建`或`管道編輯`
`管道編輯`	`管道更新`
`管道得到`	`管道得到`(相同)
`管道列表`	`管道list-pipeline-events`或`管道list-pipelines`或`管道列表`
`管道重置`	`管道重置`(相同)
`管道開始`	`管道開始更新`
`管道停止`	`管道停止`(相同)
`管道更新`	`管道更新`(相同)

運行命令

遺留的命令	新命令
`運行取消`	`工作cancel-run`
`運行得到`	`工作運行`
`運行輸出`	`工作get-run-output`
`運行列表`	`工作列表用`
`運行提交`	`工作提交`

秘密的命令

遺留的命令	新命令
`秘密創建範圍`	`秘密創建範圍`(相同)
`秘密刪除`	`秘密delete-secret`
`秘密delete-acl`	`秘密delete-acl`(相同)
`秘密delete-scope`	`秘密delete-scope`(相同)
`秘密get-acl`	`秘密get-acl`(相同)
`秘密列表`	`秘密list-secrets`
`秘密list-acls`	`秘密list-acls`(相同)
`秘密list-scopes`	`秘密list-scopes`(相同)
`秘密把`	`秘密put-secret`
`秘密put-acl`	`秘密put-acl`(相同)
`秘密寫`	`秘密put-secret`
`秘密write-acl`	`秘密put-acl`

令牌的命令

遺留的命令	新命令
`令牌創建`	`令牌創建`(相同)
`令牌列表`	`令牌列表`(相同)
`令牌撤銷`	`令牌刪除`

unity-catalog命令組

unity-catalog<命令>在遺留CLI變成<命令>新的CLI。

遺留命令組	新命令組
`unity-catalog目錄`	`目錄`(相同但下降`unity-catalog`)
`unity-catalogexternal-locations`	`external-locations`(相同但下降`unity-catalog`)
`unity-catalog血統`	在新的CLI。看到數據沿襲API。
`unity-catalogmetastores`	`metastores`(相同但下降`unity-catalog`)
`unity-catalog權限`	`獎助金`
`unity-catalog供應商`	`供應商`(相同但下降`unity-catalog`)
`unity-catalog收件人`	`收件人`(相同但下降`unity-catalog`)
`unity-catalog模式`	`模式`(相同但下降`unity-catalog`)
`unity-catalog股票`	`股票`(相同但下降`unity-catalog`)
`unity-catalogstorage-credentials`	`storage-credentials`(相同但下降`unity-catalog`)
`unity-catalog表`	`表`(相同但下降`unity-catalog`)

工作區命令

遺留的命令	新命令
`工作空間刪除`	`工作空間刪除`(相同)
`工作空間出口`	`工作空間出口`(相同)
`工作空間export_dir`	`工作空間出口`
`工作空間進口`	`工作空間進口`(相同)
`工作空間import_dir`	`工作空間進口`
`工作空間列表`	`工作空間列表`(相同)
`工作空間ls`	`工作空間列表`
`工作空間mkdir`	`工作空間mkdir`(相同)
`工作空間rm`	`工作空間刪除`

違約和位置參數

大多數新的CLI命令至少有一個默認參數沒有一篇選項。一些新的CLI命令有兩個或兩個以上的位置參數,必須指定一個特定的順序,沒有相應的選項。這不同於遺留CLI,大多數命令對所有參數需要指定選項。例如,新的CLI集群得到命令以一個集群ID作為默認參數。然而,遺留CLIclusers得到命令要求您指定一個——cluster-id隨著集群ID選項。例如:

遺留CLI:

             #這是遺留CLI。磚集群——cluster-id1234年567890 - a1b23c4d#這* *不* *處理遺留CLI——“錯誤:#失蹤。之一(“cluster-id”、“集群名稱”)必須提供。”磚集群獲得1234年567890 - a1b23c4d
            

新的CLI:

             #這是新的CLI。磚集群獲得1234年567890 - a1b23c4d#這* *不* *使用新的CLI -“錯誤:未知的國旗:——cluster-id”磚集群——cluster-id1234年567890 - a1b23c4d
            

另外一個例子,新的CLI獎助金得到命令有兩個默認參數:可獲得的類型可到手的的全名緊隨其後。然而,遺留CLIunity-catalog權限得到命令要求您指定一個——< securable-type >選擇以及可獲得的的全名。例如:

遺留CLI:

磚unity-catalog main.default權限得到——模式

新的CLI:

             #這是新的CLI。磚撥款模式main.default#這* *不* *使用新的CLI -“錯誤:未知的國旗:——模式”磚main.default贈款,模式
            

調試模式

遺留CLI提供了一個——調試選擇顯示整個堆棧跟蹤錯誤。新的CLI,——調試選擇是不認可。相反,使用以下選項:

使用——日誌文件<路徑>寫日誌信息到文件中指定<路徑>。如果不提供這個選項,日誌信息輸出到stderr。指定——日誌文件還沒有指定——進行日誌級別導致沒有日誌信息被寫入到文件中。
使用——日誌格式<類型>指定的格式記錄的信息。<類型>可以文本(默認,如果未指定)json。
使用——進行日誌級別<格式>指定級別的信息記錄。允許的值是禁用(默認,如果未指定)跟蹤,調試,信息,警告,錯誤。

遺留CLI,下麵的例子顯示了完整的堆棧跟蹤誤差:

             磚fs ls /調試#輸出:## HTTP調試啟用# NoneType:沒有#錯誤:路徑/必須從“dbfs: /
            

新的CLI,下麵的例子完整的堆棧跟蹤記錄到一個文件中命名new-cli-errors.log在當前工作目錄中。堆棧跟蹤寫入JSON格式的文件:

             磚fs ls /日誌文件new-cli-errors。日誌,日誌格式json,進行日誌級別跟蹤#輸出:##錯誤:預期dbfs路徑(dbfs: /前綴):/##(完整的堆棧跟蹤也寫入new-cli-errors。日誌文件)。
            

常見問題

本節列出了常見問題從遺留遷移到新的CLI。

遺留CLI正在發生什麼?

遺留CLI仍然可用,但是不接受任何非關鍵更新。的遺留CLI文件反映了這一點。磚建議用戶遷移到新的CLI盡快。

遺留CLI一直在實驗有免責聲明,磚計劃沒有新功能工作遺留CLI和遺留CLI通過磚支持渠道不支持。

當遺產CLI會過時嗎?

遺留CLI一直在實驗有免責聲明,磚計劃沒有新功能工作遺留CLI和遺留CLI通過磚支持渠道不支持。

磚還沒有建立一個日期或時間分解遺留CLI。然而,磚建議用戶遷移到新的CLI盡快。

新的CLI會被釋放時一般可用(GA) ?

發布日期或時間釋放新的CLI GA尚未建立。這將取決於磚接收來自用戶的反饋在公共預覽。

關鍵的區別是什麼遺留和新綜合領先指標?

遺留CLI作為一個Python包被釋放。新的CLI發布作為一個獨立的可執行文件,不需要安裝任何運行時依賴關係。
新的CLI磚REST api的完全覆蓋。遺留CLI沒有。
新的CLI可用作為公共預覽。遺留CLI仍處於試驗狀態。

新的CLI完全特性CLI 1:1的遺產?

新的CLI覆蓋幾乎所有的遺留CLI命令。然而,值得注意的是,在新的CLI棧在遺留CLI命令組。同時,一些遺留CLI命令等組織unity-catalog和運行被重構為新新的CLI命令組。移民的指導,請參閱本文前麵提供的信息。

我怎麼從遺留遷移到新的CLI嗎?

移民的指導,請參閱本文前麵提供的信息。注意新的CLI不是作為遺產CLI的替代,需要一些設置從遺留到新的CLI。

遺留和新綜合領先指標存在的可以安裝在同一台機器上嗎?

是的。安裝的遺留和新綜合領先指標可以在同一台機器上存在,但他們必須位於不同的目錄。因為可執行文件都是命名磚你必須控製,運行可執行文件默認情況下通過配置您的機器路徑。如果你想要新的CLI但不知何故不小心跑遺留CLI相反,默認情況下遺留CLI將運行新的CLI使用相同的參數和顯示以下警告消息:

              磚CLI的<新版本號>在<新路徑>當前路徑找到喜歡跑步CLI < old-version-number > <舊路>因為安裝和可用的路徑,我假設你試圖運行新版本。如果你想禁用此行為可以設置DATABRICKS_CLI_DO_NOT_EXECUTE_NEWER_VERSION = 1。執行CLI <新版本號>…- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -磚CLI的<新版本號>
             

如前麵所示警告消息,您可以設置DATABRICKS_CLI_DO_NOT_EXECUTE_NEWER_VERSION環境變量來1禁用此行為和運行遺留CLI。

磚資產包也可作為公共預覽?

不。磚資產包在一個私人預覽新的CLI中的狀態,即使在公共預覽新的CLI。嚐試磚資產包私人的預覽,伸出你的磚接觸。

得到幫助

得到幫助從遺留CLI遷移到新的CLI,看到以下資源: