Note
此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览阶段。
Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明，包括任何数据使用规定。
warehouses
CLI 中的命令组允许管理 SQL 仓库。 SQL 仓库是一种计算资源，可用于对 Databricks SQL 中的数据对象运行 SQL 命令。 请参阅连接到 SQL 仓库。
databricks 仓库创建
创建新的 SQL 仓库。
databricks warehouses create [flags]
Arguments
None
选项
--auto-stop-mins int
SQL 仓库在自动停止之前必须处于空闲状态（换句话说，无 RUNNING 查询）的时间（以分钟为单位）。
--cluster-size string
此仓库分配的集群大小。
--creator-name string
仓库创建者名称。
--enable-photon
配置仓库是否应使用 Photon 优化群集。
--enable-serverless-compute
配置仓库是否应使用无服务器计算。
--instance-profile-arn string
Deprecated.
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。
--max-num-clusters int
自动缩放程序将创建的群集的最大数目，用于处理并发查询。
--min-num-clusters int
将为此 SQL 仓库维护的可用群集的最小数量。
--name string
群集的逻辑名称。
--no-wait
不要等待达到“运行”状态
--spot-instance-policy SpotInstancePolicy
仓库是否应使用现成实例的配置。 支持的值：COST_OPTIMIZED、POLICY_UNSPECIFIED、RELIABILITY_OPTIMIZED
--timeout duration
达到 RUNNING 状态的最大时间（默认为 20 毫秒）
--warehouse-type CreateWarehouseRequestWarehouseType
仓库类型：PRO 或 CLASSIC。 支持的值：CLASSIC、PRO、TYPE_UNSPECIFIED
Examples
以下示例使用基本配置创建新的 SQL 仓库：
databricks warehouses create --name "my-warehouse" --cluster-size "Small" --min-num-clusters 1 --max-num-clusters 10 --auto-stop-mins 60
以下示例创建启用了 Photon 的无服务器仓库：
databricks warehouses create --name "serverless-warehouse" --enable-serverless-compute --enable-photon --warehouse-type PRO
databricks warehouses create-default-warehouse-override
为用户创建默认仓库替代。 用户可以创建自己的替代。 管理员可以为任何用户创建替代。
databricks warehouses create-default-warehouse-override DEFAULT_WAREHOUSE_OVERRIDE_ID TYPE [flags]
Arguments
DEFAULT_WAREHOUSE_OVERRIDE_ID
重写的 ID。 使用当前用户的数值用户 ID 或文本字符串 me 。
TYPE
替代行为的类型。 支持的值：CUSTOM、LAST_SELECTED。
选项
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。
--name string
默认仓库替代的资源名称。
--warehouse-id string
类型 CUSTOM为时的特定仓库 ID。
Examples
以下示例为当前用户创建自定义仓库替代：
databricks warehouses create-default-warehouse-override me CUSTOM --warehouse-id 1234567890abcdef
Databricks 仓库删除
删除 SQL 仓库。
databricks warehouses delete ID [flags]
Arguments
ID
Required. SQL 仓库的 ID。
选项
Examples
以下示例删除具有指定 ID 的仓库：
databricks warehouses delete 1234567890abcdef
databricks warehouses delete-default-warehouse-override
删除用户的默认仓库替代。 用户可以删除自己的替代。 管理员可以删除任何用户的替代。 删除后，将使用工作区默认仓库。
databricks warehouses delete-default-warehouse-override NAME [flags]
Arguments
NAME
要删除的默认仓库替代的资源名称。 格式：default-warehouse-overrides/{default_warehouse_override_id}。 ID 可以是当前用户的数值用户 ID 或文本字符串 me 。
选项
Examples
以下示例删除当前用户的默认仓库替代：
databricks warehouses delete-default-warehouse-override default-warehouse-overrides/me
编辑Databricks仓库
更新仓库。 更新 SQL 仓库的配置。
databricks warehouses edit ID [flags]
Arguments
ID
Required. 要配置的仓库的 ID。
选项
--auto-stop-mins int
SQL 仓库在自动停止之前必须处于空闲状态（换句话说，无 RUNNING 查询）的时间（以分钟为单位）。
--cluster-size string
此仓库分配的集群大小。
--creator-name string
仓库创建者名称。
--enable-photon
配置仓库是否应使用 Photon 优化群集。
--enable-serverless-compute
配置仓库是否应使用无服务器计算。
--instance-profile-arn string
Deprecated.
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。
--max-num-clusters int
自动缩放程序将创建的群集的最大数目，用于处理并发查询。
--min-num-clusters int
将为此 SQL 仓库维护的可用群集的最小数量。
--name string
群集的逻辑名称。
--no-wait
不等待达到 RUNNING 状态
--spot-instance-policy SpotInstancePolicy
仓库是否应使用现成实例的配置。 支持的值：COST_OPTIMIZED、POLICY_UNSPECIFIED、RELIABILITY_OPTIMIZED
--timeout duration
达到 RUNNING 状态的最大时间（默认为 20 毫秒）
--warehouse-type EditWarehouseRequestWarehouseType
仓库类型。 支持的值：CLASSIC、PRO、TYPE_UNSPECIFIED
Examples
以下示例更新仓库以更改其群集大小和自动停止时间：
databricks warehouses edit 1234567890abcdef --cluster-size "Medium" --auto-stop-mins 30
以下示例为现有仓库启用 Photon：
databricks warehouses edit 1234567890abcdef --enable-photon
databricks 数据仓库获取
获取单个 SQL 仓库的信息。
databricks warehouses get ID [flags]
Arguments
ID
Required. SQL 仓库的 ID。
选项
Examples
以下示例获取有关具有指定 ID 的仓库的信息：
databricks warehouses get 1234567890abcdef
databricks warehouses get-default-warehouse-override
获取用户的默认仓库替代。 用户可以提取自己的替代。 管理员可以提取任何用户的替代。 如果不存在替代，则使用工作区默认仓库。
databricks warehouses get-default-warehouse-override NAME [flags]
Arguments
NAME
要检索的默认仓库替代的资源名称。 格式：default-warehouse-overrides/{default_warehouse_override_id}。 ID 可以是当前用户的数值用户 ID 或文本字符串 me 。
选项
Examples
以下示例获取当前用户的默认仓库替代：
databricks warehouses get-default-warehouse-override default-warehouse-overrides/me
Databricks 仓库 获取工作区仓库配置
获取工作区中所有 SQL 仓库共享的工作区级别配置。
databricks warehouses get-workspace-warehouse-config [flags]
Arguments
None
选项
Examples
以下示例演示如何获取工作区仓库配置：
databricks warehouses get-workspace-warehouse-config
databricks 仓库列表
列出用户拥有管理权限的所有 SQL 仓库。
databricks warehouses list [flags]
Arguments
None
选项
--run-as-user-id int
用于获取仓库列表的服务主体。
Examples
以下示例列出所有仓库：
databricks warehouses list
以下示例使用特定服务主体列出仓库：
databricks warehouses list --run-as-user-id 123456789
databricks warehouses list-default-warehouse-overrides
列出工作区中的所有默认仓库替代。 只有工作区管理员可以列出所有替代。
databricks warehouses list-default-warehouse-overrides [flags]
选项
--page-size int
要返回的最大替代数。
--page-token string
从上 list-default-warehouse-overrides 一次调用收到的页令牌。
Examples
以下示例列出了所有默认仓库替代：
databricks warehouses list-default-warehouse-overrides
databricks 仓库 设置工作区仓库配置
设置工作区中所有 SQL 仓库共享的工作区级别配置。
databricks warehouses set-workspace-warehouse-config [flags]
Arguments
None
选项
--google-service-account string
仅 GCP：用于传递到群集以访问 Google Cloud Storage 的 Google 服务帐户。
--instance-profile-arn string
仅 AWS：用于将 IAM 角色传递到群集的实例配置文件。
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。
--security-policy SetWorkspaceWarehouseConfigRequestSecurityPolicy
仓库的安全策略。 支持的值：DATA_ACCESS_CONTROL、NONE、PASSTHROUGH
Examples
以下示例使用安全策略设置工作区仓库配置：
databricks warehouses set-workspace-warehouse-config --security-policy DATA_ACCESS_CONTROL
databricks 仓库启动
启动 SQL 仓库。
databricks warehouses start ID [flags]
Arguments
ID
Required. SQL 仓库的 ID。
选项
--no-wait
不等待达到 RUNNING 状态
--timeout duration
达到 RUNNING 状态的最大时间（默认为 20 毫秒）
Examples
以下示例启动具有指定 ID 的仓库：
databricks warehouses start 1234567890abcdef
以下示例启动一个仓库，而无需等待它达到 RUNNING 状态：
databricks warehouses start 1234567890abcdef --no-wait
databricks 仓库关闭
停止 SQL 仓库。
databricks warehouses stop ID [flags]
Arguments
ID
Required. SQL 仓库的 ID。
选项
--no-wait
不等待达到 STOPPED 状态
--timeout duration
达到 STOPPED 状态的最大时间（默认为 20 毫秒）
Examples
以下示例停止具有指定 ID 的仓库：
databricks warehouses stop 1234567890abcdef
以下示例停止仓库，而无需等待它达到 STOPPED 状态：
databricks warehouses stop 1234567890abcdef --no-wait
databricks warehouses update-default-warehouse-override
更新用户的现有默认仓库替代。 用户可以更新自己的替代。 管理员可以更新任何用户的替代。
databricks warehouses update-default-warehouse-override NAME UPDATE_MASK TYPE [flags]
Arguments
NAME
默认仓库替代的资源名称。 格式：default-warehouse-overrides/{default_warehouse_override_id}。
UPDATE_MASK
用于指定要更新的字段的字段掩码。 用于 * 更新所有字段。 设置时 --allow-missing ，将忽略此字段并应用所有字段。
TYPE
替代行为的类型。 支持的值：CUSTOM、LAST_SELECTED。
选项
--allow-missing
如果未找到设置和替代，请改为创建新的替代。
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。
--name string
默认仓库替代的资源名称。
--warehouse-id string
类型 CUSTOM为时的特定仓库 ID。
Examples
以下示例将当前用户的替代更新为特定仓库：
databricks warehouses update-default-warehouse-override default-warehouse-overrides/me warehouse_id CUSTOM --warehouse-id 1234567890abcdef
Databricks 仓库获取权限级别
获取 SQL 仓库权限级别。
databricks warehouses get-permission-levels WAREHOUSE_ID [flags]
Arguments
WAREHOUSE_ID
要获取或管理权限的 SQL 仓库。
选项
Examples
以下示例获取仓库的访问权限级别：
databricks warehouses get-permission-levels 1234567890abcdef
databricks warehouses 获取权限
获取 SQL 仓库的权限。 SQL 仓库可以从其根对象继承权限。
databricks warehouses get-permissions WAREHOUSE_ID [flags]
Arguments
WAREHOUSE_ID
要获取或管理权限的 SQL 仓库。
选项
Examples
以下是获取仓库权限的示例：
databricks warehouses get-permissions 1234567890abcdef
databricks warehouses set-permissions（设置权限）
设置 SQL 仓库权限。 在对象上设置权限，如果存在现有权限则替换它们。 如果未指定任何权限，则删除所有直接权限。 对象可以从其根对象继承权限。
databricks warehouses set-permissions WAREHOUSE_ID [flags]
Arguments
WAREHOUSE_ID
要获取或管理权限的 SQL 仓库。
选项
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。
Examples
以下示例使用 JSON 文件设置仓库的权限：
databricks warehouses set-permissions 1234567890abcdef --json @permissions.json
databricks 数据仓库更新权限
更新对 SQL 仓库的权限。 SQL 仓库可以从其根对象继承权限。
databricks warehouses update-permissions WAREHOUSE_ID [flags]
Arguments
WAREHOUSE_ID
要获取或管理权限的 SQL 仓库。
选项
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。
Examples
以下示例使用 JSON 文件更新仓库的权限：
databricks warehouses update-permissions 1234567890abcdef --json @permissions.json
全局标志
--debug
是否启用调试日志记录。
-h 或 --help
显示 Databricks CLI、相关命令组或相关命令的帮助。
--log-file 字符串
一个字符串，表示要将输出日志写入到的文件。 如果未指定此标志，则默认会将输出日志写入到 stderr。
--log-format 格式
日志格式类型，text 或 json。 默认值是 text。
--log-level 字符串
一个表示日志格式级别的字符串。 如果未指定，则禁用日志格式级别。
-o, --output 类型
命令输出类型，text 或 json。 默认值是 text。
-p, --profile 字符串
~/.databrickscfg 文件中用于运行命令的配置文件的名称。 如果未指定此标志，则如果存在，将使用名为 DEFAULT 的配置文件。
--progress-format 格式
显示进度日志的格式：default、append、inplace 或 json
-t, --target 字符串
如适用，要使用的捆绑包目标