通过

warehouses 命令组

Note

此信息适用于 Databricks CLI 版本 0.205 及更高版本。 The Databricks CLI is in Public Preview.

Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.

The warehouses command group within the Databricks CLI allows you to manage SQL warehouses. SQL 仓库是一种计算资源，可用于对 Databricks SQL 中的数据对象运行 SQL 命令。 请参阅连接到 SQL 仓库。

databricks warehouses create

创建新的 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 文件的 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

Global flags

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 delete

删除 SQL 仓库。

databricks warehouses delete ID [flags]

Arguments

ID

    Required. SQL 仓库的 ID。

选项

Global flags

Examples

以下示例删除具有指定 ID 的仓库：

databricks warehouses delete 1234567890abcdef

databricks warehouses edit

更新仓库。 更新 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 文件的 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

    Warehouse type. 支持的值：CLASSIC、PRO、TYPE_UNSPECIFIED

Global flags

Examples

以下示例更新仓库以更改其群集大小和自动停止时间：

databricks warehouses edit 1234567890abcdef --cluster-size "Medium" --auto-stop-mins 30

以下示例为现有仓库启用 Photon：

databricks warehouses edit 1234567890abcdef --enable-photon

databricks warehouses get

获取单个 SQL 仓库的信息。

databricks warehouses get ID [flags]

Arguments

ID

    Required. SQL 仓库的 ID。

选项

Global flags

Examples

以下示例获取有关具有指定 ID 的仓库的信息：

databricks warehouses get 1234567890abcdef

databricks warehouses 列表

列出用户拥有管理权限的所有 SQL 仓库。

databricks warehouses list [flags]

Arguments

None

选项

--run-as-user-id int

    用于提取仓库列表的服务主体。

Global flags

Examples

以下示例列出所有仓库：

databricks warehouses list

以下示例使用特定服务主体列出仓库：

databricks warehouses list --run-as-user-id 123456789

databricks warehouses start

启动 SQL 仓库。

databricks warehouses start ID [flags]

Arguments

ID

    Required. SQL 仓库的 ID。

选项

--no-wait

    不要等待到达 RUNNING 状态

--timeout duration

    达到 RUNNING 状态的最大时间（默认为 20 毫秒）

Global flags

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 毫秒）

Global flags

Examples

以下示例停止具有指定 ID 的仓库：

databricks warehouses stop 1234567890abcdef

以下示例停止仓库，而无需等待它达到 STOPPED 状态：

databricks warehouses stop 1234567890abcdef --no-wait

databricks warehouses get-workspace-warehouse-config

获取工作区中所有 SQL 仓库共享的工作区级别配置。

databricks warehouses get-workspace-warehouse-config [flags]

Arguments

None

选项

Global flags

Examples

以下示例获取工作区仓库配置：

databricks warehouses get-workspace-warehouse-config

databricks warehouses set-workspace-warehouse-config

设置工作区中所有 SQL 仓库共享的工作区级别配置。

databricks warehouses set-workspace-warehouse-config [flags]

Arguments

None

选项

--google-service-account string

    仅限 GCP：用于传递给群集以访问 Google 云存储的 Google 服务帐户。

--instance-profile-arn string

    仅 AWS：用于将 IAM 角色传递给群集的实例配置文件。

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--security-policy SetWorkspaceWarehouseConfigRequestSecurityPolicy

    仓库的安全策略。 支持的值：DATA_ACCESS_CONTROL、NONE、PASSTHROUGH

Global flags

Examples

以下示例使用安全策略设置工作区仓库配置：

databricks warehouses set-workspace-warehouse-config --security-policy DATA_ACCESS_CONTROL

databricks warehouses get-permission-levels

获取 SQL 仓库权限级别。

databricks warehouses get-permission-levels WAREHOUSE_ID [flags]

Arguments

WAREHOUSE_ID

    要为其获取或管理权限的 SQL 仓库。

选项

Global flags

Examples

以下示例获取仓库的权限级别：

databricks warehouses get-permission-levels 1234567890abcdef

databricks warehouses get-permissions

获取 SQL 仓库的权限。 SQL 仓库可以从其根对象继承权限。

databricks warehouses get-permissions WAREHOUSE_ID [flags]

Arguments

WAREHOUSE_ID

    要为其获取或管理权限的 SQL 仓库。

选项

Global flags

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 文件的 JSON 文件。

Global flags

Examples

以下示例使用 JSON 文件设置仓库的权限：

databricks warehouses set-permissions 1234567890abcdef --json @permissions.json

databricks warehouses update-permissions

更新对 SQL 仓库的权限。 SQL 仓库可以从其根对象继承权限。

databricks warehouses update-permissions WAREHOUSE_ID [flags]

Arguments

WAREHOUSE_ID

    要为其获取或管理权限的 SQL 仓库。

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

Global flags

Examples

以下示例使用 JSON 文件更新仓库的权限：

databricks warehouses update-permissions 1234567890abcdef --json @permissions.json

Global flags

--debug

  是否启用调试日志记录。

-h 或 --help

    显示 Databricks CLI、相关命令组或相关命令的帮助。

--log-file 字符串

    一个字符串，表示要将输出日志写入到的文件。 如果未指定此标志，则默认会将输出日志写入到 stderr。

--log-format 格式

    日志格式类型或 textjson。 默认值是 text。

--log-level 字符串

    一个表示日志格式级别的字符串。 如果未指定，则禁用日志格式级别。

-o, --output 类型

    命令输出类型或 textjson。 默认值是 text。

-p, --profile 字符串

    用于运行命令的文件中配置文件 ~/.databrickscfg 的名称。 如果未指定此标志，则如果存在，则使用命名 DEFAULT 的配置文件。

--progress-format 格式

    显示进度日志的格式： default、 append、 inplace或 json

-t, --target 字符串

    如果适用，要使用的捆绑包目标