workspace 命令组

workspace CLI 中的命令组允许列出、导入、导出和删除工作区文件和文件夹。 请参阅什么是工作区文件？。

databricks 工作区删除

删除工作区对象。

删除对象或目录（并选择性地递归删除目录中的所有对象）。 如果路径不存在，此调用将返回错误 RESOURCE_DOES_NOT_EXIST。 如果路径为非空目录，且递归设置为 false，则此调用将返回错误 DIRECTORY_NOT_EMPTY。

对象删除不能撤消，以递归方式删除目录不是原子的。

databricks workspace delete PATH [flags]

论据

PATH

    笔记本或目录的绝对路径。

选项

--json JSON

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

--recursive

    指定是否以递归方式删除对象的标志。

全局标志

databricks 工作区导出

导出工作区对象或整个目录的内容。

如果路径不存在，此调用将返回错误 RESOURCE_DOES_NOT_EXIST。

如果导出的数据超出大小限制，则此调用将 MAX_NOTEBOOK_SIZE_EXCEEDED返回。 目前，此 API 不支持导出库。

databricks workspace export SOURCE_PATH [flags]

论据

PATH

    对象或目录的绝对路径。 仅 DBC、SOURCE 和 AUTO 格式支持导出目录。

选项

--file string

    用于保存导出文件的本地文件系统上的路径。

--format ExportFormat

    这指定导出的文件的格式。 支持的值：AUTO、、、DBCHTML、JUPYTERRAW、、 R_MARKDOWNSOURCE

全局标志

databricks 工作区导出目录

以递归方式将目录从 Databricks 工作区导出到本地文件系统。

databricks workspace export-dir SOURCE_PATH TARGET_PATH [flags]

论据

SOURCE_PATH

    工作区中的源目录路径

TARGET_PATH

    本地文件系统上的目标目录路径

选项

--overwrite

    覆盖现有本地文件

全局标志

databricks 工作区 获取状态

获取对象或目录的状态。 如果路径不存在，此调用将返回错误 RESOURCE_DOES_NOT_EXIST。

databricks workspace get-status PATH [flags]

论据

PATH

    笔记本或目录的绝对路径。

选项

全局标志

Databricks 工作区导入

导入工作区对象（例如笔记本或文件）或整个目录的内容。 如果路径已存在且覆盖设置为 false，则此调用将返回错误 RESOURCE_ALREADY_EXISTS。 要导入目录，可以使用DBC格式或未设置语言字段的SOURCE格式。 若要导入单个文件 SOURCE，必须设置语言字段。

databricks workspace import TARGET_PATH [flags]

论据

PATH

    对象或目录的绝对路径。 仅 DBC 和 SOURCE 格式支持导入目录。

选项

--content string

    base64 编码的内容。

--file string

    要导入的本地文件的路径

--format ImportFormat

    这指定要导入的文件的格式。 支持的值：AUTO、、、DBCHTML、JUPYTERRAW、、 R_MARKDOWNSOURCE

--json JSON

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

--language Language

    对象的语言。 支持的值：PYTHON、R、SCALA、SQL

--overwrite

    指定是否覆盖现有对象的标志。

全局标志

databricks 工作区 导入目录

以递归方式将目录从本地文件系统导入 Databricks 工作区。

笔记本的插件将被移除。

databricks workspace import-dir SOURCE_PATH TARGET_PATH [flags]

论据

SOURCE_PATH

    本地文件系统上的源目录路径

TARGET_PATH

    工作区中的目标目录路径

选项

--overwrite

    将现有工作区文件覆盖

全局标志

databricks 工作区列表

列出目录的内容，或对象（如果不是目录）。 如果输入路径不存在，此调用将返回错误 RESOURCE_DOES_NOT_EXIST。

databricks workspace list PATH [flags]

论据

PATH

    笔记本或目录的绝对路径。

选项

--notebooks-modified-after int

    UTC 时间戳（以毫秒为单位）。

全局标志

databricks 工作区 mkdirs

创建指定的目录（如果它们不存在）和必要的父目录。 如果输入路径的任何前缀处有对象（不是目录），则此调用将返回错误 RESOURCE_ALREADY_EXISTS。

请注意，如果此操作失败，则可能已经成功创建了一些必要的父目录。

databricks workspace mkdirs PATH [flags]

论据

PATH

    目录的绝对路径。 如果父目录不存在，它还会创建它们。 如果目录已存在，此命令不会执行任何操作并直接成功。

选项

--json JSON

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

全局标志

databricks 工作区 get-permission-levels

获取工作区对象权限级别。

databricks workspace get-permission-levels WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID [flags]

论据

WORKSPACE_OBJECT_TYPE

    要为其获取或管理权限的工作区对象类型。

WORKSPACE_OBJECT_ID

    要为其获取或管理权限的工作区对象。

选项

全局标志

databricks 工作区 获取权限

获取工作区对象的权限。 工作区对象可以从其父对象或根对象继承权限。

databricks workspace get-permissions WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID [flags]

论据

WORKSPACE_OBJECT_TYPE

    要为其获取或管理权限的工作区对象类型。

WORKSPACE_OBJECT_ID

    要为其获取或管理权限的工作区对象。

选项

全局标志

databricks 工作区设置权限

设置工作区对象权限。

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

databricks workspace set-permissions WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID [flags]

论据

WORKSPACE_OBJECT_TYPE

    要为其获取或管理权限的工作区对象类型。

WORKSPACE_OBJECT_ID

    要为其获取或管理权限的工作区对象。

选项

--json JSON

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

全局标志

databricks 工作区更新权限

更新工作区对象的权限。 工作区对象可以从其父对象或根对象继承权限。

databricks workspace update-permissions WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID [flags]

论据

WORKSPACE_OBJECT_TYPE

    要为其获取或管理权限的工作区对象类型。

WORKSPACE_OBJECT_ID

    要为其获取或管理权限的工作区对象。

选项

--json JSON

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

全局标志

全局标志

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

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