统一目录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