通过

apps 命令组

Note

此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览阶段。

Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明，包括任何数据使用规定。

apps CLI 中的命令组允许管理应用。 应用直接在客户的 Databricks 实例上运行，与其数据集成，使用和扩展 Databricks 服务，并使用户能够通过单一登录进行交互。 请参阅 Databricks 应用。

databricks 应用创建

创新一个新应用。

databricks apps create NAME [flags]

Arguments

NAME

    应用的名称。 名称必须仅包含小写字母数字字符和连字符。 在工作区中，它必须是唯一的。

选项

--budget-policy-id string

    应用程序的预算策略 ID。

--description string

    应用的说明。

--json JSON

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

--no-compute

    如果为 true，则创建后不会启动应用。

--no-wait

    请勿等待进入“活动状态”。

--timeout duration

    达到活动状态的最大时间（默认为 20m0s）。

全局标志

Examples

以下示例创建基本应用：

databricks apps create my-analytics-app --description "Analytics dashboard app"

以下示例创建一个应用而不启动它：

databricks apps create my-data-app --description "Data processing app" --no-compute

以下示例创建具有自定义超时的应用：

databricks apps create my-ml-app --description "Machine learning app" --timeout 30m

databricks 应用删除

删除应用。

databricks apps delete NAME [flags]

Arguments

NAME

    应用的名称。

选项

全局标志

Examples

以下示例删除应用：

databricks apps delete my-analytics-app

databricks 应用部署

为具有提供名称的应用创建应用部署。

databricks apps deploy APP_NAME [flags]

Arguments

APP_NAME

    应用的名称。

选项

--deployment-id string

    部署的唯一 ID。

--json JSON

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

--mode AppDeploymentMode

    部署将管理源代码的模式。 支持的值：AUTO_SYNC、SNAPSHOT。

--no-wait

    不等待达到 SUCCEEDED 状态。

--source-code-path string

    用于创建应用部署的源代码的工作区文件系统路径。

--timeout duration

    达到 SUCCEEDED 状态的最长持续时间（默认为 20 分钟零 0 秒）。

全局标志

Examples

以下示例使用自动同步模式创建部署：

databricks apps deploy my-analytics-app --source-code-path /Workspace/Users/someone@example.com/my-app --mode AUTO_SYNC

以下示例使用快照模式创建部署：

databricks apps deploy my-data-app --source-code-path /Workspace/Users/someone@example.com/data-app --mode SNAPSHOT

以下示例使用自定义部署 ID 创建部署：

databricks apps deploy my-ml-app --deployment-id "v1.2.3" --source-code-path /Workspace/Users/someone@example.com/ml-app

databricks 应用获取

获取具有指定名称的应用程序的信息。

databricks apps get NAME [flags]

Arguments

NAME

    应用的名称。

选项

全局标志

Examples

下面的示例获取应用信息：

databricks apps get my-analytics-app

以下示例获取 JSON 格式的应用信息：

databricks apps get my-data-app --output json

以下示例使用特定配置文件获取应用信息：

databricks apps get my-ml-app --profile production

databricks 应用 get-deployment

使用提供的名称和部署 ID 获取应用部署的信息。

databricks apps get-deployment APP_NAME DEPLOYMENT_ID [flags]

Arguments

APP_NAME

    应用的名称。

DEPLOYMENT_ID

    部署的唯一 ID。

选项

全局标志

Examples

以下示例获取部署信息：

databricks apps get-deployment my-analytics-app v1.0.0

以下示例获取 JSON 格式的部署信息：

databricks apps get-deployment my-data-app v2.1.0 --output json

以下示例使用特定配置文件获取部署信息：

databricks apps get-deployment my-ml-app latest --profile production

databricks 应用列表

列出工作区中的所有应用。

databricks apps list [flags]

Arguments

None

选项

--page-size int

    返回项目的上限。

--page-token string

    用于跳转到下一页应用的分页令牌。

全局标志

Examples

以下示例列出所有应用：

databricks apps list

以下示例列出了具有特定页面大小的应用：

databricks apps list --page-size 10

以下示例列出具有分页的应用：

databricks apps list --page-token "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

databricks 应用列表部署

列出具有提供名称的应用的所有应用部署。

databricks apps list-deployments APP_NAME [flags]

Arguments

APP_NAME

    应用的名称。

选项

--page-size int

    返回项目的上限。

--page-token string

    用于跳转到下一页应用的分页令牌。

全局标志

Examples

以下示例列出了应用的所有部署：

databricks apps list-deployments my-analytics-app

以下示例列出以指定页面大小进行的部署：

databricks apps list-deployments my-data-app --page-size 10

databricks 应用本地运行

在本地启动应用。

databricks apps run-local [flags]

Arguments

None

选项

--app-port int

    运行应用（默认为 8000）的端口。

--debug

    启用调试模式。

--debug-port string

    运行调试器的端口。

--entry-point string

    使用配置（.yml 文件）为应用指定自定义入口点。 默认为 app.yml。

--env strings

    设置环境变量。

--port int

    运行应用代理的端口（默认为 8001）。

--prepare-environment

    准备用于运行应用的环境。 需要安装 uv。

全局标志

Examples

以下示例使用默认设置在本地运行应用：

databricks apps run-local

以下示例在特定端口本地运行应用：

databricks apps run-local --app-port 9000 --port 9001

databricks 应用程序启动

在工作区中启动该应用程序的最近一次活动部署。

databricks apps start NAME [flags]

Arguments

NAME

    应用的名称。

选项

--no-wait

    请勿等待进入“活动状态”。

--timeout duration

    达到活动状态的最大时间（默认为 20m0s）。

全局标志

Examples

以下示例启动应用：

databricks apps start my-analytics-app

以下示例在不等待的情况下启动应用：

databricks apps start my-data-app --no-wait

以下示例启动具有自定义超时的应用：

databricks apps start my-ml-app --timeout 30m

databricks 应用停止运行

停止工作区中应用的活动部署。

databricks apps stop NAME [flags]

Arguments

NAME

    应用的名称。

选项

--no-wait

    不等待达到 STOPPED 状态。

--timeout duration

    达到 STOPPED 状态的最大时间（默认为 20m0s）。

全局标志

Examples

以下示例停止应用：

databricks apps stop my-analytics-app

以下示例在不等待的情况下停止应用：

databricks apps stop my-data-app --no-wait

以下示例停止具有自定义超时的应用：

databricks apps stop my-ml-app --timeout 30m

databricks 应用更新

使用提供的名称来更新应用程序。

databricks apps update NAME [flags]

Arguments

NAME

    应用的名称。 名称必须仅包含小写字母数字字符和连字符。 在工作区中，它必须是唯一的。

选项

--budget-policy-id string

    应用程序的预算策略 ID。

--description string

    应用的说明。

--json JSON

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

全局标志

Examples

以下示例更新应用的说明：

databricks apps update my-analytics-app --description "Updated analytics dashboard"

Databricks 应用程序 获取权限级别

获取应用权限级别。

databricks apps get-permission-levels APP_NAME [flags]

Arguments

APP_NAME

    获取或管理权限的应用程序。

选项

全局标志

Examples

以下示例获取应用的权限级别：

databricks apps get-permission-levels my-analytics-app

databricks 应用 获取权限

获取应用的权限。 应用可以从其根对象继承权限。

databricks apps get-permissions APP_NAME [flags]

Arguments

APP_NAME

    获取或管理权限的应用程序。

选项

全局标志

Examples

以下示例获取应用的权限：

databricks apps get-permissions my-analytics-app

以下示例使用特定配置文件获取权限：

databricks apps get-permissions my-ml-app --profile production

databricks 应用设置权限

设置应用权限。

设置对象的权限，替换现有权限（如果存在）。 如果未指定任何权限，则删除所有直接权限。 对象可以从其根对象继承权限。

databricks apps set-permissions APP_NAME [flags]

Arguments

APP_NAME

    获取或管理权限的应用程序。

选项

--json JSON

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

全局标志

Examples

以下示例使用 JSON 配置设置权限：

databricks apps set-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_USE"}]}'

databricks 应用程序更新权限

更新对应用的权限。 应用可以从其根对象继承权限。

databricks apps update-permissions APP_NAME [flags]

Arguments

APP_NAME

    获取或管理权限的应用程序。

选项

--json JSON

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

全局标志

Examples

以下示例使用 JSON 配置更新权限：

databricks apps update-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_MANAGE"}]}'

全局标志

--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 字符串

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

  • Last updated on