統一目錄CLI(遺留)
重要的
這個文檔已經退休了,可能不會被更新。
這個信息適用於遺留數據磚CLI版本0.17及以下。磚建議你使用新磚CLI的版本0.200或更高版本。看到磚CLI。找到你的版本的磚CLI,運行磚- v
。
從磚CLI或低於0.17版本遷移到磚CLI版本0.200或更高版本,看看磚CLI的遷移。
遺留在磚磚CLI不可用的穀歌雲。
使用統一編目CLI使用:
你運行統一目錄CLI子命令通過添加磚unity-catalog
。這些子命令調用統一目錄API,其中還包括三角洲共享API。
顯示使用文檔,運行磚unity-catalog——幫助
。
輸出:
用法:磚unity-catalog[選項]命令(ARGS)……效用與磚統一的目錄。選項:- v,版本0.17.1 - h,幫助顯示此消息並退出。命令:目錄external-locations血統metastores權限提供者模式股票storage-credentials表接受者
Metastores
使用unity-catalogmetastores
子命令處理metastores。
顯示使用文檔,運行磚unity-catalogmetastores——幫助
。
創建一個metastore
顯示使用文檔,運行磚unity-catalogmetastores創建——幫助
。另請參閱創建一個目錄metastore統一。
請注意
創建一個metastore並不會自動關聯metastore工作區或存儲憑證。為了完成這些任務,明白了鏈接一個metastore工作區,創建一個存儲憑證,更新一個metastore的設置。
鏈接一個metastore工作區
如果你運行這個命令在一個工作區中,已經有一個分配metastore,您將更新工作區metastore分配。
顯示使用文檔,運行磚unity-catalogmetastores分配——幫助
。
磚unity-catalog metastores分配——workspace-id1234567890123456\——metastore-id 12 a345b6張cd - 7890 - 1 - 3456 e789f0a12b34\——default-catalog-name主要
工作區ID,明白了工作區實例名、url和id。
metastore ID,運行磚unity-catalogmetastores得到概要
。例如,看到的總結當前metastore信息。
輸出:
{}
更新一個metastore的設置
顯示使用文檔,運行磚unity-catalogmetastores更新——幫助
。
磚unity-catalog metastores更新——id 12 a345b6張cd - 7890 - 1 - 3456 e789f0a12b34\——json文件update-metastore.json
metastore ID,運行磚unity-catalogmetastores得到概要
。例如,看到的總結當前metastore信息。
update-metastore.json
:
{“storage_root_credential_id”:“十二a345b6張cd - 7890 - 1 - 3456 e789f0a12b34”}
根證書存儲ID,明白了得到信息存儲憑證。
得到metastore信息
顯示使用文檔,運行磚unity-catalogmetastores得到——幫助
。
磚unity-catalog metastores得到- id 12 a345b6張cd - 7890 - 1 - 3456 e789f0a12b34
metastore ID,運行磚unity-catalogmetastores得到概要
。例如,看到的總結當前metastore信息。
獲取當前metastore賦值為一個工作區
顯示使用文檔,運行磚unity-catalogmetastores來分派任務——幫助
。
磚unity-catalog metastores來分派任務
輸出:
{“workspace_id”:1234567890123456,“metastore_id”:“十二a345b6張cd - 7890 - 1 - 3456 e789f0a12b34”,“default_catalog_name”:“主要”}
拆開metastore從工作區
顯示使用文檔,運行磚unity-catalogmetastoresunassign——幫助
。
磚unity-catalog metastores unassign——workspace-id1234567890123456\——metastore-id 12 a345b6張cd - 7890 - 1 - 3456 e789f0a12b34
工作區ID,明白了工作區實例名、url和id。
metastore ID,運行磚unity-catalogmetastores得到概要
。例如,看到的總結當前metastore信息。
輸出:
{}
刪除一個metastore
警告
在刪除一個metastore之前,您必須刪除任何工作區使用metastore工作區或刪除metastore鏈接。接觸磚支持援助從工作區移除metastore鏈接。
顯示使用文檔,運行磚unity-catalogmetastores刪除——幫助
。
強行刪除metastore,使用——力
選擇。
磚unity-catalog metastores刪除——id 12 a345b6張cd - 7890 - 1 - 3456 e789f0a12b34
metastore ID,運行磚unity-catalogmetastores得到概要
。例如,看到的總結當前metastore信息。
如果操作成功,不返回結果。
存儲憑證
使用unity-catalogstorage-credentials
子命令處理存儲憑證。
顯示使用文檔,運行磚unity-catalogstorage-credentials——幫助
。
創建一個存儲憑證
顯示使用文檔,運行磚unity-catalogstorage-credentials創建——幫助
。
列出可用的存儲憑證
顯示使用文檔,運行磚unity-catalogstorage-credentials列表——幫助
。另請參閱列表存儲憑證。
磚unity-catalog storage-credentials列表
外部位置
使用unity-catalogexternal-locations
子命令處理外部位置。
顯示使用文檔,運行磚unity-catalogexternal-locations——幫助
。
驗證一個外部位置和憑證
顯示使用文檔,運行磚unity-catalogexternal-locations驗證——幫助
。
驗證一個外部位置名稱和證書對在您創建它們
磚unity-catalog external-locations my-external-location驗證——名稱\——cred-name my-storage-root-credential
輸出:
{“isDir”:真正的,“結果”:({“操作”:“讀”,“結果”:“通過”},{“操作”:“列表”,“結果”:“通過”},{“操作”:“寫”,“結果”:“通過”},{“操作”:“刪除”,“結果”:“通過”}]}
更新外部位置的設置
顯示使用文檔,運行磚unity-catalogexternal-locations更新——幫助
。另請參閱修改外部位置。
磚unity-catalog external-locations my-external-location更新——名稱\——json文件update-external-location.json
udpate-external-location.json
:
{“名稱”:“my-external-location-2”}
目錄
使用unity-catalog目錄
子命令處理目錄。
顯示使用文檔,運行磚unity-catalog目錄——幫助
。
創建一個目錄
顯示使用文檔,運行磚unity-catalog目錄創建——幫助
。另請參閱創建一個目錄。
磚unity-catalog目錄創建——我的目錄名稱
輸出:
{“名稱”:“我的目錄”,“所有者”:“someone@example.com”,“metastore_id”:“十二a345b6張cd - 7890 - 1 - 3456 e789f0a12b34”,“created_at”:1656113178995,“created_by”:“someone@example.com”,“updated_at”:1656113178995,“updated_by”:“someone@example.com”,“catalog_type”:“MANAGED_CATALOG”}
更新目錄的設置
顯示使用文檔,運行磚unity-catalog目錄更新——幫助
。
磚unity-catalog目錄更新——我的目錄名稱\——json文件update-catalog.json
update-catalog.json
:
{“名稱”:“my-catalog-2”,“所有者”:“someone@example.com”}
輸出:
{“名稱”:“my-catalog-2”,“所有者”:“someone@example.com”,“metastore_id”:“十二a345b6張cd - 7890 - 1 - 3456 e789f0a12b34”,“created_at”:1656355967835,“created_by”:“someone@example.com”,“updated_at”:1656356095989,“updated_by”:“someone@example.com”,“catalog_type”:“MANAGED_CATALOG”}
可用的目錄列表
顯示使用文檔,運行磚unity-catalog目錄列表——幫助
。
磚unity-catalog目錄列表
輸出:
{“目錄”:({“名稱”:“主要”,“所有者”:“someone@example.com”,“評論”:“主目錄(自動創建)”,“metastore_id”:“十二a345b6張cd - 7890 - 1 - 3456 e789f0a12b34”,“created_at”:1656112029355,“created_by”:“someone@example.com”,“updated_at”:1656112029355,“updated_by”:“someone@example.com”,“catalog_type”:“MANAGED_CATALOG”},{“…”:“…”}]}
得到一個目錄的信息
顯示使用文檔,運行磚unity-catalog目錄得到——幫助
。
磚unity-catalog目錄得到——我的目錄名稱
輸出:
{“名稱”:“我的目錄”,“所有者”:“someone@example.com”,“metastore_id”:“十二a345b6張cd - 7890 - 1 - 3456 e789f0a12b34”,“created_at”:1656113178995,“created_by”:“someone@example.com”,“updated_at”:1656113178995,“updated_by”:“someone@example.com”,“catalog_type”:“MANAGED_CATALOG”}
模式
使用unity-catalog模式
子命令處理模式。
顯示使用文檔,運行磚unity-catalog模式——幫助
。
創建一個模式
顯示使用文檔,運行磚unity-catalog模式創建——幫助
。另請參閱創建一個模式。
磚unity-catalog模式創建的目錄名稱,我的目錄\——名字我模式
輸出:
{“名稱”:“我模式”,“catalog_name”:“我的目錄”,“所有者”:“someone@example.com”,“metastore_id”:“十二a345b6張cd - 7890 - 1 - 3456 e789f0a12b34”,“full_name”:“my-catalog.my-schema”,“created_at”:1656113607800,“created_by”:“someone@example.com”,“updated_at”:1656113607800,“updated_by”:“someone@example.com”}
改變模式的設置
顯示使用文檔,運行磚unity-catalog模式更新——幫助
。
磚unity-catalog模式更新,全名my-catalog.my-schema\——json文件update-schema.json
update-schema.json
:
{“名稱”:“my-schema-2”,“所有者”:“someone@example.com”}
輸出:
{“名稱”:“my-schema-2”,“catalog_name”:“我的目錄”,“所有者”:“someone@example.com”,“評論”:“默認模式(自動創建)”,“metastore_id”:“十二a345b6張cd - 7890 - 1 - 3456 e789f0a12b34”,“full_name”:“my-catalog.my-schema-2”,“created_at”:1656355967837,“created_by”:“someone@example.com”,“updated_at”:1656356592786,“updated_by”:“someone@example.com”}
列出可用的模式
顯示使用文檔,運行磚unity-catalog模式列表——幫助
。
磚unity-catalog模式——目錄名稱列表我的目錄
輸出:
{“模式”:({“名稱”:“默認”,“catalog_name”:“我的目錄”,“所有者”:“someone@example.com”,“評論”:“默認模式(自動創建)”,“metastore_id”:“十二a345b6張cd - 7890 - 1 - 3456 e789f0a12b34”,“full_name”:“my-catalog.default”,“created_at”:1656113178996,“created_by”:“someone@example.com”,“updated_at”:1656113178996,“updated_by”:“someone@example.com”},{“…”:“…”}]}
得到信息模式
顯示使用文檔,運行磚unity-catalog模式得到——幫助
。
磚unity-catalog模式得到,全名my-catalog.my-schema
輸出:
{“名稱”:“我模式”,“catalog_name”:“我的目錄”,“所有者”:“someone@example.com”,“metastore_id”:“十二a345b6張cd - 7890 - 1 - 3456 e789f0a12b34”,“full_name”:“my-catalog.my-schema”,“created_at”:1656113607800,“created_by”:“someone@example.com”,“updated_at”:1656113607800,“updated_by”:“someone@example.com”}
表
使用unity-catalog表
子命令處理表。
請注意
創建表和不支持統一編目CLI。創建表,請參閱創建表和創建您的第一個表和管理權限。
顯示使用文檔,運行磚unity-catalog表——幫助
。
列表總結可用的表
顯示使用文檔,運行磚unity-catalog表list-summaries——幫助
。
磚unity-catalog表list-summaries——主要目錄名稱
輸出:
{“表”:({“full_name”:“main.default.mytable”,“table_type”:“管理”},{“…”:“…”}]}
權限
使用unity-catalog權限
子命令的權限可獲得的對象。另請參閱統一目錄管理權限。
顯示使用文檔,運行磚unity-catalog權限——幫助
。
獲得一個可獲得的對象的權限信息
顯示使用文檔,運行磚unity-catalog權限得到——幫助
。另請參閱統一目錄權限和可獲得的對象。
表
磚unity-catalog main.default.mytable得到,表的權限
輸出:
{“privilege_assignments”:({“校長”:“用戶帳戶”,“特權”:(“選擇”]}]}
存儲憑證
磚unity-catalog權限得到,storage-credential my-storage-root-credential
輸出:
{“privilege_assignments”:({“校長”:“用戶帳戶”,“特權”:(“read_file”]}]}
外部位置
磚unity-catalog權限得到,外部位置的my-external-location
輸出:
{“privilege_assignments”:({“校長”:“用戶帳戶”,“特權”:(“read_file”]}]}
更新一個可獲得的對象的權限
顯示使用文檔,運行磚unity-catalog權限更新——幫助
。另請參閱統一目錄權限和可獲得的對象。
目錄
磚unity-catalog權限更新目錄\——json文件update-catalog-permissions.json
update-catalog-permissions.json
:
{“改變”:({“校長”:“用戶帳戶”,“添加”:(“使用目錄”),“刪除”:(“創建模式”]}]}
模式
磚unity-catalog權限更新模式\——json文件update-schema-permissions.json
update-schema-permissions.json
:
{“改變”:({“校長”:“用戶帳戶”,“添加”:(“使用模式”),“刪除”:(“CREATE TABLE”]},{“校長”:“管理團隊”,“添加”:(“CREATE TABLE”]}]}
表
磚unity-catalog權限更新表\——json文件update-table-permissions.json
update-table-permissions.json
:
{“改變”:({“校長”:“用戶帳戶”,“添加”:(“選擇”),“刪除”:(“修改”]},{“校長”:“管理團隊”,“添加”:(“所有”]}]}
存儲憑證
更新——storage-credential磚unity-catalog權限\——json文件update-storage-credential-permissions.json
update-storage-credential-permissions.json
:
{“改變”:({“校長”:“用戶帳戶”,“刪除”:(“讀文件”]},{“校長”:“存儲團隊”,“添加”:(“讀文件”,“寫文件”,“創建外部表”]},{“校長”:“管理團隊”,“添加”:(“所有”]}]}
外部位置
磚unity-catalog權限更新——外部位置的過程\——json文件update-external-location-permissions.json
update-external-location-permissions.json
:
{“改變”:({“校長”:“用戶帳戶”,“刪除”:(“讀文件”]},{“校長”:“存儲團隊”,“添加”:(“讀文件”,“寫文件”,“創建外部表”]},{“校長”:“管理團隊”,“添加”:(“所有”]}]}
收件人
使用unity-catalog收件人
子命令與數據接收者三角洲共享統一目錄metastores啟用。數據接收人或團體磚的磚用戶共享的數據與外部用戶的組織。看到創建和管理數據接收者三角洲共享。
顯示使用文檔,運行磚unity-catalog收件人——幫助
。
創建一個收件人
顯示使用文檔,運行磚unity-catalog收件人創建——幫助
。另請參閱創建和管理數據接收者三角洲共享。
生成一個新的激活接受者的URL,運行磚unity-catalog收件人rotate-token
。例如,看到的旋轉一個收件人的令牌。
磚unity-catalog my-recipient收件人創建——名稱
輸出:
{“名稱”:“my-recipient”,“created_at”:1656435288003,“created_by”:“someone@example.com”,“令牌”:({“id”:“十二a345b6張cd - 7890 - 1 - 3456 e789f0a12b34”,“created_at”:1656435288005,“created_by”:“someone@example.com”,“activation_url”:“https://example.com/delta_sharing/retrieve_config.html? <惟一的id >”,“expiration_time”:1656521688006,“updated_at”:1656435288006,“updated_by”:“someone@example.com”}),“authentication_type”:“令牌”,“updated_at”:1656435288003,“updated_by”:“someone@example.com”,“所有者”:“someone@example.com”}
改變一個收件人的設置
顯示使用文檔,運行磚unity-catalog收件人更新——幫助
。
磚unity-catalog my-recipient收件人更新——名稱\——json文件update-recipient-settings.json
update-recipient-settings.json
:
{“名稱”:“my-recipient-2”}
輸出:
{“名稱”:“my-recipient-2”,“created_at”:1656435288003,“created_by”:“someone@example.com”,“令牌”:({“id”:“十二a345b6張cd - 7890 - 1 - 3456 e789f0a12b34”,“created_at”:1656435288005,“created_by”:“someone@example.com”,“expiration_time”:1656436808507,“updated_at”:1656435908507,“updated_by”:“someone@example.com”},{“id”:“十二a345b6張cd - 7890 - 1 - 3456 e789f0a12b34”,“created_at”:1656435908509,“created_by”:“someone@example.com”,“activation_url”:“https://example.com/delta_sharing/retrieve_config.html? <惟一的id >”,“expiration_time”:1656522308510,“updated_at”:1656435908510,“updated_by”:“someone@example.com”}),“authentication_type”:“令牌”,“updated_at”:1656436740986,“updated_by”:“someone@example.com”,“所有者”:“someone@example.com”}
旋轉一個收件人的令牌
顯示使用文檔,運行磚unity-catalog收件人rotate-token——幫助
。另請參閱管理接受者令牌(開放共享)。
磚unity-catalog接受者rotate-token my-recipient——名稱\——existing-token-expire-in-seconds900年
輸出:
{“名稱”:“my-recipient”,“created_at”:1656435288003,“created_by”:“someone@example.com”,“令牌”:({“id”:“十二a345b6張cd - 7890 - 1 - 3456 e789f0a12b34”,“created_at”:1656435288005,“created_by”:“someone@example.com”,“expiration_time”:1656436808507,“updated_at”:1656435908507,“updated_by”:“someone@example.com”},{“id”:“十二a345b6張cd - 7890 - 1 - 3456 e789f0a12b34”,“created_at”:1656435908509,“created_by”:“someone@example.com”,“activation_url”:“https://example.com/delta_sharing/retrieve_config.html? <惟一的id >”,“expiration_time”:1656522308510,“updated_at”:1656435908510,“updated_by”:“someone@example.com”}),“authentication_type”:“令牌”,“updated_at”:1656435288003,“updated_by”:“someone@example.com”,“所有者”:“someone@example.com”}
列出可用的接受者
顯示使用文檔,運行磚unity-catalog收件人列表——幫助
。另請參閱查看收件人。
磚unity-catalog接收人列表
輸出:
{“收件人”:({“名稱”:“my-recipient”,“created_at”:1656435288003,“created_by”:“someone@example.com”,“令牌”:({“id”:“十二a345b6張cd - 7890 - 1 - 3456 e789f0a12b34”,“created_at”:1656435288005,“created_by”:“someone@example.com”,“activation_url”:“https://example.com/delta_sharing/retrieve_config.html? <惟一的id >”,“expiration_time”:1656521688006,“updated_at”:1656435288006,“updated_by”:“someone@example.com”}),“authentication_type”:“令牌”,“updated_at”:1656435288003,“updated_by”:“someone@example.com”,“所有者”:“someone@example.com”}]}
信息接收方
顯示使用文檔,運行磚unity-catalog收件人得到——幫助
。另請參閱查看收件人詳細信息。
磚unity-catalog my-recipient接受者得到,名稱
輸出:
{“名稱”:“my-recipient”,“created_at”:1656435288003,“created_by”:“someone@example.com”,“令牌”:({“id”:“十二a345b6張cd - 7890 - 1 - 3456 e789f0a12b34”,“created_at”:1656435288005,“created_by”:“someone@example.com”,“activation_url”:“https://example.com/delta_sharing/retrieve_config.html? <惟一的id >”,“expiration_time”:1656521688006,“updated_at”:1656435288006,“updated_by”:“someone@example.com”}),“authentication_type”:“令牌”,“updated_at”:1656435288003,“updated_by”:“someone@example.com”,“所有者”:“someone@example.com”}
供應商
如果你是一個三角洲共享共享數據接收者,使用unity-catalog供應商
子命令與三角洲共享數據提供者。看到管理三角洲共享供應商(數據接受者)。
顯示使用文檔,運行磚unity-catalog供應商——幫助
。
創建一個提供者
如果你是一個接收的數據共享使用開放共享協議和您使用的是一個磚工作區metastore附加到統一目錄,您可以創建一個供應商統一目錄metastore對象。然後您可以使用統一目錄管理訪問共享數據。
另請參閱磚:讀取共享數據使用統一目錄
創建一個提供者,您必須:
是一個metastore管理員或用戶
CREATE_PROVIDER
metastore特權。下載的證書文件。看到獲得在開放共享模型。
運行以下命令,取代我的供應者
與你想要的名字給提供者config.share
你下載的證書文件的路徑,叫配置。默認分享。
磚unity-catalog提供者創建的,名字我的供應者\——recipient-profile-json-file config.share