管理目录、数据库和表

在目标工作区中浏览、创建和维护目录、数据库与表。卷和文件由管理文件存储处理。

前提条件

有关通用调用规则,请先阅读调用前准备

准备目标工作区的访问条件。创建数据库前需要目标目录;创建表前需要目标数据库。开始操作前,通过下方的浏览和详情动作取得所需资源标识。

调用顺序

  1. 先浏览可访问的目录、数据库和表,确定使用已有层级还是创建新资源,并保存后续操作需要的标识;需要读取系统数据库、数据库中的表、表概览或完整路径时,使用相应查看动作补充确认。

  2. 创建新层级时,先创建目录,再在该目录中创建数据库,最后在目标数据库中创建表。

  3. 需要读取或核对数据时,先查询表信息,再按目的预览或读取数据。

  4. 更新后查询相应详情确认当前信息。清空或删除前先确认目标对象;完成后重新查询对象或数据确认结果。

API 操作

浏览资源层级

要完成的事

API 操作

何时使用

浏览目录、数据库、卷和表

查看资源目录

选择已有资源或创建新资源前使用。

查询目录列表

查看 Catalog 列表

选择目标目录时使用。

查询目录详情

查看 Catalog 详情

确认目标目录的当前信息时使用。

查询数据库列表

查看数据库列表

选择目标数据库时使用。

查询数据库详情

查看数据库详情

确认目标数据库时使用。

查询数据库中的对象

查看数据库中的对象

浏览数据库中的卷、表和算子时使用。

查看系统数据库

查看系统数据库

需要读取系统数据库及其层级时使用。

查看数据库中的表

查看数据库中的表

需要获取指定数据库下的表时使用。

创建和维护目录、数据库

要完成的事

API 操作

何时使用

创建目录

创建 Catalog

创建新的父目录,并为后续数据库创建准备标识时使用。

更新目录

更新 Catalog

修改已有目录时使用。

删除目录

删除 Catalog

已处理下级对象后使用。

查看目录引用

查看 Catalog 引用

调整或删除目录前检查引用关系时使用。

创建数据库

创建数据库

已确定父目录后使用。

更新数据库

更新数据库

修改已有数据库时使用。

删除数据库

删除数据库

确认数据库未被发布或订阅使用后使用。

管理表和表数据

要完成的事

API 操作

何时使用

检查表是否存在

检查表是否存在

创建或引用表前确认目标表。

创建表

创建表

已确定目标数据库后使用。

查询表信息

查看表信息

确认表定义和当前信息时使用。

批量查看表信息

批量查看表信息

需要一次读取多个已知表的信息时使用。

查看表概览

查看表概览

需要汇总查看表的当前概览时使用。

查看表完整路径

查看表完整路径

需要确认表在资源层级中的完整路径时使用。

查询表数据

查看表数据

读取表的抽样数据时使用。

预览表数据

预览表数据

先检查表数据时使用。

下载表数据

下载表数据

需要取得表数据下载结果时使用。

运行 NL2SQL

运行 NL2SQL

需要将自然语言请求转换为 SQL 并执行时使用。

清空表

清空表

确认目标表后删除全部数据并保留表定义。

删除表

删除表

确认目标表后删除表及其数据。

查询表引用

查询表引用

调整或删除表前检查引用关系时使用。

结果确认

创建或更新后,查询对应目录、数据库或表的详情,确认后续操作使用的对象。读取数据前可使用预览或抽样查询;清空后重新查询表数据确认内容已清除,删除后通过层级或对象列表确认目标不再出现。

限制和注意事项

  • 删除目录不可逆;应先处理下级对象。

  • 删除数据库前,确认数据库未被发布或订阅使用。

  • 清空表会删除全部数据但保留表定义,且不可逆;删除表会删除表及其数据。

  • 查询表数据未显式指定行数时,默认返回 100 行。

下一步

最后更新于