Databricks CLI 命令

项目
11/22/2024

注意

此信息适用于 Databricks CLI 0.205 及更高版本，这些版本为公共预览版。若要查找你的 Databricks CLI 的版本，请运行 databricks -v。

本文介绍了有关可用的 Databricks CLI 命令的信息。此信息补充了命令行帮助。有关安装和使用 Databricks CLI 的更多信息，请参阅安装或更新 Databricks CLI 和什么是 Databricks CLI？。

Databricks CLI 包含下表中列出的命令组。命令组包含相关命令集，这些命令也可以包含子命令。若要输出命令组、单个命令或子命令的使用和语法信息，请使用以下语法：

databricks <command-group> -h
databricks <command-group> <command-name> -h
databricks <command-group> <command-name> <subcommand-name> -h

多数 CLI 命令所对应的操作均在 Azure Databricks REST API 参考文档中有所记录。

工作区命令

组	说明和命令
fs	用于管理文件和文件系统的命令： `cat`，`cp`，`ls`，`mkdir`，`rm`
`git-credentials`	用于为 Databricks 注册个人访问令牌以代表用户执行操作的命令： `create`，`delete`，`get`，`list`，`update`
`repos`	允许用户管理其 git 存储库的命令： `create`，`delete`，`get`，`list`，`update` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`
`secrets`	用于管理机密、机密范围和访问权限的命令： `create-scope`，`delete-acl`，`delete-scope`，`delete-secret`，`get-acl`，`get-secret`，`list-acls`，`list-scopes`，`list-secrets`，`put-acl`，`put-secret`
`workspace`	用于列出、导入、导出和删除工作区中的笔记本和文件夹的命令： `delete`，`export`，`export-dir`，`get-status`，`import`，`import-dir`，`list`，`mkdirs` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`

计算命令

组	说明和命令
`cluster-policies`	用于根据一组规则控制用户配置群集的能力的命令： `create`，`delete`，`edit`，`get`，`list` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`
`clusters`	用于创建、启动、编辑、列出、终止和删除群集的命令： `change-owner`，`create`，`delete`，`edit`，`events`，`get`，`list`，`list-node-types`，`list-zones`，`permanent-delete`,`pin`，`resize`，`restart`，`spark-versions`，`start`，`unpin` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`
`global-init-scripts`	使工作区管理员能够为其工作区配置全局初始化脚本的命令： `create`，`delete`，`get`，`list`，`update`
`instance-pools`	使用现成的云实例创建、编辑、删除和列出实例池的命令，从而缩短群集启动和自动扩展时间： `create`，`delete`，`edit`，`get`，`list` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`
`instance-profiles`	允许管理员添加、列出和删除用户可用来启动群集的实例配置文件的命令： `add`，`edit`，`list`，`remove`
`libraries`	用于在群集上安装、卸载和获取库状态的命令： `all-cluster-statuses`，`cluster-status`，`install`，`uninstall`
`policy-families`	用于查看可用策略系列的命令： `get`，`list`

作业命令

组	说明和命令
`jobs`	用于管理作业的命令： `cancel-all-runs`，`cancel-run`，`create`，`delete`，`delete-run`，`export-run`，`get`，`get-run`，`get-run-output`，`list`，`list-runs`，`repair-run`，`reset`，`run-now`，`submit`，`update` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`

Delta Live Tables 命令

组	说明和命令
`pipelines`	用于创建、编辑、删除、启动和查看管道详细信息的命令： `create`，`delete`，`get`，`get-update`，`list-pipeline-events`，`list-pipelines`，`list-updates`，`start-update`，`stop`，`update` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`

机器学习命令

组说明和命令

experiments 用于与试验交互的命令，这些试验是 MLflow 中组织的主要单元，所有 MLflow 运行都属于试验：

create-experiment，create-run，delete-experiment，delete-run，delete-runs，delete-tag，get-by-name，get-experiment，get-history，get-runGet，list-artifacts，list-experiments，log-batch，log-inputs，log-metric，log-model，log-param，restore-experiment，restore-run，restore-runs，search-experiments，search-runs，set-experiment-tag，set-tag，update-experiment，update-run

get-permission-levels，get-permissions，set-permissions，update-permissions

model-registry 用于工作区模型注册表的命令：

approve-transition-request，create-comment，create-model，create-model-version，create-transition-request，create-webhook，delete-comment，delete-model，delete-model-tag，delete-model-version，delete-model-version-tag，delete-transition-request，delete-webhook，get-latest-versions，get-model，get-model-version,get-model-version-download-uri，list-models，list-transition-requests，list-webhooks，reject-transition-request，rename-model，search-model-versions，search-models，set-model-tag，set-model-version-tag，test-registry-webhook，transition-stage，update-comment，update-model，update-model-version，update-webhook

get-permission-levels，get-permissions，set-permissions，update-permissions

组	说明和命令
`experiments`	用于与试验交互的命令，这些试验是 MLflow 中组织的主要单元，所有 MLflow 运行都属于试验： `create-experiment`，`create-run`，`delete-experiment`，`delete-run`，`delete-runs`，`delete-tag`，`get-by-name`，`get-experiment`，`get-history`，`get-runGet`，`list-artifacts`，`list-experiments`，`log-batch`，`log-inputs`，`log-metric`，`log-model`，`log-param`，`restore-experiment`，`restore-run`，`restore-runs`，`search-experiments`，`search-runs`，`set-experiment-tag`，`set-tag`，`update-experiment`，`update-run` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`
`model-registry`	用于工作区模型注册表的命令： `approve-transition-request`，`create-comment`，`create-model`，`create-model-version`，`create-transition-request`，`create-webhook`，`delete-comment`，`delete-model`，`delete-model-tag`，`delete-model-version`，`delete-model-version-tag`，`delete-transition-request`，`delete-webhook`，`get-latest-versions`，`get-model`，`get-model-version`,`get-model-version-download-uri`，`list-models`，`list-transition-requests`，`list-webhooks`，`reject-transition-request`，`rename-model`，`search-model-versions`，`search-models`，`set-model-tag`，`set-model-version-tag`，`test-registry-webhook`，`transition-stage`，`update-comment`，`update-model`，`update-model-version`，`update-webhook` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`

实时服务命令

组	说明和命令
`serving-endpoints`	用于创建、更新和删除模型服务终结点的命令： `build-logs`，`create`，`delete`，`export-metrics`，`get`，`list`，`logs`，`patch`，`put`，`query`，`update-config` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`

身份验证和访问控制管理命令

组	说明和命令
`account`	用于管理 Databricks 帐户的命令： - 身份验证和访问控制：`access-control`、`groups`、`service-principals`、`users`、`workspace-assignment` - Unity Catalog：`metastore-assignments`、`metastores`、`storage-credentials` - 设置：`ip-access-lists`、`network-connectivity`、`settings` - 预配：`credentials`、`encryption-keys`、`networks`、`private-access`、`storage`、`vpc-endpoints`、`workspaces` - 计费：`billable-usage`、`log-delivery` - OAuth：`custom-app-integration`、`o-auth-published-apps`、`published-app-integration`、`service-principal-secrets`
auth	用于身份验证的命令： `describe`，`env`，`login`，`profiles`，`token`
`current-user`	用于检索有关当前经过身份验证的用户或服务主体的信息的命令： `me`
`groups`	针对简化标识管理的组的命令，使分配对 Databricks 工作区、数据和其他安全对象的访问权限变得更加容易： `create`，`delete`，`get`，`list`，`patch`，`update`
`permissions`	为不同对象和终结点上的不同用户创建读取、写入、编辑、更新和管理访问权限的命令： `get`，`set`，`update` `get-permission-levels`
`service-principals`	针对作业、自动化工具和系统（例如脚本、应用程序和 CI/CD 平台）的标识的命令： `create`，`delete`，`get`，`list`，`patch`，`update`
`users`	针对由 Databricks 识别并由电子邮件地址表示的用户标识的命令： `create`，`delete`，`get`，`list`，`patch`，`update` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`

组	说明和命令
`alerts`	用于对警报执行操作的命令： `create`，`delete`，`get`，`list`，`update`
`data-sources`	创建新查询对象的命令： `list`
`queries`	对查询定义执行操作的命令： `create`，`delete`，`get`，`list`，`restore`，`update`
`query-history`	通过 SQL 仓库访问查询历史记录的命令： `list`
`warehouses`	用于管理 SQL 仓库的命令，SQL 仓库是一种计算资源，可让你在 Databricks SQL 中的数据对象上运行 SQL 命令： `create`，`delete`，`edit`，`get`，`get-workspace-warehouse-config`，`list`，`set-workspace-warehouse-config`，`start`，`stop` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`

Unity Catalog 命令

组	说明和命令
`artifact-allowlists`	用于管理项目允许列表的命令。在 Databricks Runtime 13.3 及更高版本中，可以将库和初始化脚本添加到 UC 中的允许列表中，以便用户可以在配置了共享访问模式的计算上利用这些项目： `get`，`update`
`catalogs`	用于管理目录（Unity Catalog 的三级命名空间的第一层）的命令： `create`，`delete`，`get`，`list`，`update`
`connections`	用于创建与外部数据源的连接的命令： `create`，`delete`，`get`，`list`，`update`
`external-locations`	用于管理外部位置的命令，外部位置将云存储路径与授权访问云存储路径的存储凭据相结合： `create`，`delete`，`get`，`list`，`update`
`functions`	用于管理 Unity Catalog 中的用户定义函数 (UDF) 的命令： `create`，`delete`，`get`，`list`，`update`
`grants`	用于授予对 Unity Catalog 中数据的访问权限的命令： `get`，`get-effective`，`update`
`metastores`	用于管理元存储的命令，元存储是 Unity Catalog 中对象的顶级容器： `assign`，`create`，`current`，`delete`，`get`，`list`，`summary`，`unassign`，`update`，`update-assignment`
`model-versions`	用于管理模型版本的命令。 Databricks 提供 Unity Catalog 中的 MLflow 模型注册表的托管版本。 `delete`，`get`，`get-by-alias`，`list`，`update`
`online-tables`	用于管理联机表的命令，通过使用这些表，可在访问 Delta 表中的数据时获享更低延迟和更高的 QPS： `create`，`delete`，`get`
`quality-monitors`	用于管理监视器的命令，这些监视器会计算和监视表随时间变化的数据或模型质量指标： `create`，`delete`，`get`，`get-refresh`，`list-refreshes`，`run-refresh`，`update`
`registered-models`	用于管理已注册模型的命令。 Databricks 提供 Unity Catalog 中的 MLflow 模型注册表的托管版本。 `create`，`delete`，`delete-alias`，`get`，`list`，`set-alias`，`update`
`schemas`	用于管理架构（Unity Catalog 三级命名空间的第二层）的命令： `create`，`delete`，`get`，`list`，`update`
`storage-credentials`	用于管理存储凭据的命令，存储凭据是用于访问云租户上存储的数据的身份验证和授权机制： `create`，`delete`，`get`，`list`，`update`，`validate`
`system-schemas`	用于管理系统架构的命令，系统架构系统目录应用的架构： `disable`，`enable`，`list`
`table-constraints`	用于管理主键和外键约束的命令，这些约束会对表中字段之间的关系进行编码： `create`，`delete`
`tables`	用于管理表（驻留在 Unity Catalog 的三级命名空间的第三层）的命令： `delete`，`exists`，`get`，`list`，`list-summaries`
`volumes`	用于管理卷的命令，卷是 Unity Catalog (UC) 用于访问、存储、管理、组织和处理文件的功能： `create`，`delete`，`list`，`read`，`update`
`workspace-bindings`	用于管理安全工作区绑定的命令。可以将 Databricks 中的安全对象配置为 `OPEN` 或 `ISOLATED`。 `get`，`get-bindings`，`update`，`update-bindings`

组	说明和命令
`providers`	用于管理数据提供程序的命令，这些提供程序表示共享数据的组织： `create`，`delete`，`get`，`list`，`list-shares`，`update`
`recipient-activation`	管理接收者激活的命令，仅适用于对接收者对象采用 TOKEN 身份验证类型的开放共享模型： `get-activation-url-info`，`retrieve-token`
`recipients`	管理接收者的命令，你可以使用 `:method:recipients/create` 创建这些接收者，用其来代表你想要允许访问共享内容的组织： `create`，`delete`，`get`，`list`，`rotate-token`，`update` `share-permissions`
`shares`	用于管理共享的命令，这些共享是使用 `:method:shares/create` 实例化的容器： `create`，`delete`，`get`，`list`，`update` `share-permissions`，`update-permissions`

设置命令

组	说明和命令
`ip-access-lists`	用于使管理员能够配置 IP 访问列表的命令： `create`，`delete`，`get`，`list`，`replace`，`update`
`settings`	用于允许用户在工作区级别管理设置的命令： `automatic-cluster-update`，`csp-enablement`，`default-namespace`，`esm-enablement`，`restrict-workspace-admins`
`token-management`	允许管理员获取所有令牌并删除其他用户的令牌的命令： `create-obo-token`，`delete`，`get`，`list` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`
`tokens`	用于创建、列出和撤销令牌的命令，这些令牌可用于对 Databricks REST API 进行身份验证和访问： `create`，`delete`，`list`
`workspace-conf`	用于更新工作区设置的命令： `get-status`，`set-status`

开发人员工具命令

组	说明和命令
bundle	用于管理 Databricks 资产捆绑包的命令，通过使用捆绑包，你能够以代码形式表示 Databricks 项目： `deploy`，`deployment`，`destroy`，`generate`，`init`，`run`，`schema`，`sync`，`validate`
sync	将本地目录同步到工作区目录。

矢量搜索命令

组	说明和命令
`vector-search-endpoints`	用于管理矢量搜索终结点的命令，这些终结点表示用于托管矢量搜索索引的计算资源： `create-endpoint`，`delete-endpoint`，`get-endpoint`，`list-endpoints`
`vector-search-indexes`	用于管理矢量搜索索引的命令，矢量搜索索引是嵌入矢量的有效表示形式，支持实时高效的接近最近的邻域 (ANN) 搜索查询： `create-index`，`delete-data-vector-index`，`delete-index`，`get-index`，`list-indexes`，`query-index`，`sync-index`，`upsert-data-vector-index`

仪表板命令

组	说明和命令
`dashboards`	用于修改仪表板的命令： `create`，`delete`，`get`，`list`，`restore`，`update`
`lakeview`	为 AI/BI 仪表板提供特定管理操作的命令： `create`，`get`，`get-published`，`migrate`，`publish`，`trash`，`unpublish`，`update`

其他命令

组	说明和命令
api	用于向 Databricks REST API 发出请求的命令： `delete`，`get`，`head`，`patch`，`post`，`put`
completion	用于为指定的 shell 生成自动补全脚本的命令： `bash`，`fish`，`powershell`，`zsh`
configure	配置 Databricks CLI。
`help`	输出任何命令的使用情况信息。
实验室	用于管理 Databricks Labs 安装的命令： `clear-cache`，`install`，`installed`，`list`，`show`，`uninstall`，`upgrade`
`version`	检索当前使用的 CLI 版本。

全局标志

以下标志可用于所有 Databricks CLI 命令。请注意，某些标志不适用于某些命令。有关特定命令及其标记的详细信息，请参阅命令行帮助。

标记	描述
`-h` 或 `--help`	显示 Databricks CLI、相关命令组或相关命令的帮助。
`-e` 或 `--environment string`	一个字符串，表示要使用的捆绑环境（如果适用于相关命令）。
`--log-file`	一个字符串，表示要将输出日志写入到的位置。如果未指定此标志，则默认会将输出日志写入到 stderr。
`--log-format`	如果设置为 `text`，则以文本格式写入输出日志；如果设置为 `json`，则以 JSON 格式写入输出日志。如果未指定此标志，则以文本格式写入输出日志。
`--log-level`	一个表示日志格式级别的字符串。如果未指定，则禁用日志格式级别。
`-o` 或 `--output`	如果设置为 `text`，则以文本格式写入输出；如果设置为 `json`，则以 JSON 格式写入输出。如果未指定此标志，则以文本格式写入输出。
`-p` 或 `--profile`	一个字符串，表示要在 `.databrickscfg` 文件中使用的命名配置文件。如果未指定此标志，则使用 `DEFAULT` 命名配置文件（如果存在）。可以在 `--profile` 或 `-p` 之后按 `Tab` 以显示可供选择的现有可用配置文件的列表，而不是手动输入配置文件名称。
`--progress-format`	要显示的进度日志的格式（`default`（默认值）、`append`、`inplace` 或 `json`）。

通过