通过

database 命令组

注释

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

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

database Databricks CLI 中的命令组包含用于管理数据库实例的命令。 数据库实例管理存储和计算资源，并提供用户连接到的终结点。

请参阅什么是数据库实例？

databricks 数据库 create-database-catalog

创建数据库目录。

databricks database create-database-catalog NAME DATABASE_INSTANCE_NAME DATABASE_NAME [flags]

论据

NAME

    Unity 目录中目录的名称。

DATABASE_INSTANCE_NAME

    DatabaseInstance 包含数据库的名称。

DATABASE_NAME

    与目录关联的数据库（实例中）的名称。

选项

--create-database-if-not-exists

    创建数据库（如果不存在）。

--json JSON

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

全局标志

例子

以下示例创建数据库目录：

databricks database create-database-catalog my-catalog my-instance my-database

databricks 数据库 create-database-instance

创建数据库实例。

databricks database create-database-instance NAME [flags]

论据

NAME

    实例的名称。 这是实例的唯一标识符。

选项

--capacity string

    实例的 SKU。

--json JSON

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

--stopped

    实例是否已停止。

全局标志

例子

以下示例创建数据库实例：

databricks database create-database-instance my-instance --capacity small

databricks 数据库 create-database-table

创建数据库表。

databricks database create-database-table NAME [flags]

论据

NAME

    表的完整三部分（目录、架构、表）名称。

选项

--database-instance-name string

    目标数据库实例的名称。

--json JSON

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

--logical-database-name string

    此表的目标 Postgres 数据库对象（逻辑数据库）名称。

全局标志

例子

以下示例创建数据库表：

databricks database create-database-table catalog.schema.table --database-instance-name my-instance

databricks 数据库 create-synced-database-table

创建同步的数据库表。

databricks database create-synced-database-table NAME [flags]

论据

NAME

    表的完整三部分（目录、架构、表）名称。

选项

--database-instance-name string

    目标数据库实例的名称。

--json JSON

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

--logical-database-name string

    此表的目标 Postgres 数据库对象（逻辑数据库）名称。

全局标志

例子

以下示例创建同步的数据库表：

databricks database create-synced-database-table catalog.schema.table --database-instance-name my-instance

databricks 数据库 delete-database-catalog

删除数据库目录。

databricks database delete-database-catalog NAME [flags]

论据

NAME

    要删除的目录的名称。

选项

全局标志

例子

以下示例删除数据库目录：

databricks database delete-database-catalog my-catalog

databricks 数据库 delete-database-instance

删除数据库实例。

databricks database delete-database-instance NAME [flags]

论据

NAME

    要删除的实例的名称。

选项

--force

    默认情况下，如果实例具有通过 PITR 创建的后代实例，则无法删除该实例。

--purge

    注意 purge=false 在开发中。

全局标志

例子

以下示例删除数据库实例：

databricks database delete-database-instance my-instance --force

databricks 数据库 delete-database-table

删除数据库表。

databricks database delete-database-table NAME [flags]

论据

NAME

    要删除的表的完整三部分（目录、架构、表）名称。

选项

全局标志

例子

以下示例删除数据库表：

databricks database delete-database-table catalog.schema.table

databricks 数据库 delete-synced-database-table

删除同步的数据库表。

databricks database delete-synced-database-table NAME [flags]

论据

NAME

    要删除的已同步表的完整三部分（目录、架构、表）名称。

选项

全局标志

例子

以下示例删除同步的数据库表：

databricks database delete-synced-database-table catalog.schema.table

databricks 数据库 find-database-instance-by-uid

通过 uid 查找数据库实例。

databricks database find-database-instance-by-uid [flags]

选项

--uid string

    要获取的群集的 UID。

全局标志

例子

以下示例按 UID 查找数据库实例：

databricks database find-database-instance-by-uid --uid 12345-abcdef-67890

databricks 数据库 generate-database-credential

生成可用于访问数据库实例的凭据。

databricks database generate-database-credential [flags]

选项

--json JSON

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

--request-id string

    凭据生成的请求 ID。

全局标志

例子

以下示例生成数据库凭据：

databricks database generate-database-credential --request-id my-request-123

databricks 数据库 get-database-catalog

获取数据库目录。

databricks database get-database-catalog NAME [flags]

论据

NAME

    要获取的目录的名称。

选项

全局标志

例子

以下示例获取有关数据库目录的信息：

databricks database get-database-catalog my-catalog

databricks 数据库 get-database-instance

获取数据库实例。

databricks database get-database-instance NAME [flags]

论据

NAME

    要获取的群集的名称。

选项

全局标志

例子

以下示例获取有关数据库实例的信息：

databricks database get-database-instance my-instance

databricks 数据库 get-database-table

获取数据库表。

databricks database get-database-table NAME [flags]

论据

NAME

    要获取的表的完整三部分（目录、架构、表）名称。

选项

全局标志

例子

以下示例获取有关数据库表的信息：

databricks database get-database-table catalog.schema.table

databricks 数据库 get-synced-database-table

获取同步的数据库表。

databricks database get-synced-database-table NAME [flags]

论据

NAME

    要获取的同步表的完整三部分（目录、架构、表）名称。

选项

全局标志

例子

以下示例获取有关同步数据库表的信息：

databricks database get-synced-database-table catalog.schema.table

databricks 数据库 list-database-instances

列出数据库实例。

databricks database list-database-instances [flags]

选项

--page-size int

    返回的项的上限。

--page-token string

    分页令牌转到数据库实例的下一页。

全局标志

例子

以下示例列出所有数据库实例：

databricks database list-database-instances

以下示例列出具有分页的数据库实例：

databricks database list-database-instances --page-size 10

databricks 数据库 update-database-instance

更新数据库实例。

databricks database update-database-instance NAME [flags]

论据

NAME

    实例的名称。 这是实例的唯一标识符。

选项

--capacity string

    实例的 SKU。

--json JSON

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

--stopped

    实例是否已停止。

全局标志

例子

以下示例更新数据库实例容量：

databricks database update-database-instance my-instance --capacity large

以下示例停止数据库实例：

databricks database update-database-instance my-instance --stopped

全局标志

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

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