Files
dbx/docs/content/docs/schema-browser.cn.mdx
T

154 lines
7.5 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
title: 结构浏览与对象树
description: 使用 DBX 侧边栏组织连接、搜索数据库对象、打开数据与结构,并执行数据库专属操作。
---
对象树是 DBX 的主要导航入口。它不仅展示数据库、Schema、表和字段,还负责连接分组、可见范围、对象搜索、固定、复制粘贴、结构操作、专项工作台和管理视图。
## 连接与对象层级
典型关系型结构如下:
```text
连接分组
└── 连接
└── Catalog / 数据库
└── Schema
└── 表 / 视图 / 例程 / 其他对象
└── 字段 / 索引 / 外键 / 触发器
```
实际层级由数据库模型决定:
| 类型 | 树结构示例 |
| --- | --- |
| MySQL 兼容 | 连接 → 数据库 → 表/视图 → 字段/索引/外键/触发器 |
| PostgreSQL、Oracle、SQL Server 等 | 连接 → 数据库或服务 → Schema → 对象 |
| Doris / StarRocks | 可在多 Catalog 时显示 Catalog → 数据库 → 表;只有 `internal` 时保持扁平 |
| Redis | 连接 → Redis DB;Key 在专用浏览器中分页展示 |
| MongoDB | 连接 → 数据库 → 集合、索引和 GridFS Bucket |
| Elasticsearch / Easysearch / Meilisearch | 连接 → 索引等文档对象 |
| HBase、向量、消息队列、etcd、ZooKeeper、Nacos | 展示系统对应对象,并打开 [专项工作台](/cn/docs/specialized-workspaces) |
## 连接分组与批量管理
- 创建嵌套分组和自定义子组名称
- 把连接拖入分组,或使用复制/粘贴和批量移动
- 多选连接后使用工具栏执行分组、复制、断开或其他批量操作
- 为连接设置颜色、备注、置顶、只读和生产环境范围
- 复制连接名称或复制整个连接配置作为新连接
- 在连接提示中查看主机、端口、数据库类型和其他摘要
导入连接时,支持的来源可以保留分组信息。跨设备迁移侧边栏布局时,DBX 会重新映射连接 ID。
## 展开、折叠与固定
- 单击节点展开或折叠
- 使用**展开全部**或**折叠全部**处理当前树范围
- 固定常用连接、数据库、Schema、表或 Nacos Namespace
- 长列表滚动时,当前数据库或关键行可以保持可见
- 打开的标签页会反向选中或定位对应对象
固定用于提高访问效率,不代表生产保护。生产连接应单独启用 [生产环境与写入安全](/cn/docs/production-safety) 中的只读和生产标记。
## 搜索与过滤
对象树搜索可以匹配:
- 连接、分组、数据库、Catalog 和 Schema
- 表、视图、字段、索引和部分数据库专属对象
- 对象路径、字段注释和表注释
- 已加载元数据和支持服务端过滤的表列表
部分搜索会把关键词传给驱动并延迟请求,避免先加载全部表。也可以按节点类型缩小搜索范围,或在当前数据库中使用本地表搜索。
可见范围设置可以隐藏不需要的数据库、Schema、系统 Schema 或带特定前缀的表。新增数据库或 Schema 后,可以按设置自动加入可见列表。
<Callout type="info">搜索结果依赖当前账号可见权限和已加载元数据。刚创建、删除或重命名对象后,刷新对应节点再搜索。</Callout>
## 元数据显示
根据数据库和设置,对象树可以显示:
- 表和字段注释
- 字段类型、可空、默认值和约束摘要
- 对象数量或加载状态
- 表类型、Catalog、Schema 和数据库路径
- MongoDB Collection 元数据
- 数据库专属对象类型和状态
对象元数据显示方式可以在设置中调整。大型 Schema 建议只展示真正需要的附加信息,减少视觉噪声和元数据请求。
## 打开数据、结构与源码
| 操作 | 结果 |
| --- | --- |
| 打开表 | 进入 [数据表格](/cn/docs/data-grid) |
| 查看结构 | 打开字段、索引、外键、触发器和 DDL 标签 |
| 编辑表结构 | 进入 [表结构编辑器](/cn/docs/table-structure) |
| 查看 DDL | 读取数据库生成或驱动生成的对象定义 |
| 打开源码 | 在侧边面板或编辑器查看视图、过程、函数、触发器等源码 |
| 定位查询对象 | 从编辑器光标定位当前表,或从对象树拖字段/表引用到 SQL 编辑器 |
| 打开专项对象 | 进入 Redis、MongoDB、向量、HBase、MQ、etcd、ZooKeeper 或 Nacos 工作台 |
表、对象和数据标签使用不同身份,避免同名对象与表数据标签错误复用。
## 右键菜单与批量操作
上下文菜单按节点类型和数据库 capability 动态生成。常见操作包括:
- 创建、重命名、删除数据库或 Schema,并编辑支持的注释、字符集和排序规则
- 创建、复制、粘贴、重命名、清空或删除表
- 跨数据库复制/粘贴表数据或表结构(目标驱动支持时)
- 打开数据、结构、DDL、源码、ER 图、字段血缘、Schema 对比和数据库搜索
- 导入数据、传输数据、执行 SQL 文件、导出数据库或备份支持的文件型数据库
- 生成 `SELECT`、`INSERT`、`UPDATE`、`DELETE` 或其他模板 SQL
- 管理索引、触发器、例程、扩展、用户、任务和数据库专属对象
- 打开 Dashboard、进程/会话或专项管理页面
破坏性操作会整理到更明确的菜单层级,并按只读、生产环境和数据库能力决定是否显示或要求确认。
## 复制、粘贴与拖拽
- 复制连接、数据库、Schema、表、字段或所选表名
- 选择是否带数据库/Schema 限定和标识符引号
- 把表或字段拖入 SQL 编辑器生成引用
- 复制表后在兼容目标数据库中粘贴,实现表结构或数据传输入口
- 本地文件数据库可以从对象树在系统文件管理器中显示文件
跨数据库复制涉及类型映射、默认值、约束和自增语义。执行前查看 [数据传输](/cn/docs/data-transfer) 和生成 SQL。
## 数据库专属层级
DBX 不会把所有系统强制映射成关系型树。例如:
- SQL Server 可以浏览 Linked Server 和数据库对象
- Doris / StarRocks 支持外部 Catalog,外部 Catalog 表使用三段式名称
- MongoDB 展示 Collection、索引和 GridFS
- Elasticsearch / Easysearch / Meilisearch 将索引作为一等对象
- 达梦、Oracle、PostgreSQL 等可以展示更多例程、任务、扩展或管理对象
- etcd、Nacos、消息队列和向量数据库从树节点进入专用工作台
## 安全与性能边界
- 对象树只展示当前账号有权限读取的对象;看不到对象时先检查数据库权限
- 大型 Schema 使用按需加载、缓存和服务端过滤,不建议无目的展开全部节点
- 系统 Schema、对象数量和额外元数据会增加请求量,可以在设置中关闭
- 删除、清空、跨库粘贴和管理操作可能不可恢复,生产环境先确认备份和影响范围
- 只读连接会隐藏或拒绝多个修改入口,但数据库账号权限仍是最终边界
<Cards>
<Card title="浏览所有对象" href="/cn/docs/object-browser">
使用列表或网格集中查看表、视图、例程和统计信息。
</Card>
<Card title="编辑表结构" href="/cn/docs/table-structure">
修改字段和索引,并在执行前检查 DDL。
</Card>
<Card title="搜索数据库" href="/cn/docs/object-browser">
在大型数据库中按对象类型、名称和元数据定位对象。
</Card>
<Card title="管理专项系统" href="/cn/docs/specialized-workspaces">
查看 Redis、MongoDB、向量、MQ、etcd、ZooKeeper 和 Nacos 入口。
</Card>
</Cards>