开始
加载和管理数据
处理数据
政府
引用和资源
2023年8月2日更新
给我们反馈
请注意
这个信息适用于砖CLI 0.200及以上版本,在公共预览。找到你的版本的砖CLI,运行砖- v。
砖- v
砖的命令行接口(也称为砖CLI)的效用,提供的砖,砖平台提供了一个易于使用的界面来自动化终端,命令提示符,或自动化脚本。bob体育客户端下载
所有可用的命令信息数据砖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.www.neidfyre.com。让你的实例名,明白了工作区实例名、url和id。
< workspace-url >
https://
https:// <前缀>。<随机数> .gcp.www.neidfyre.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的相关命令。