From 51b8b9344f0b6841d31333bd07eadfa83b8700b2 Mon Sep 17 00:00:00 2001
From: t8y2 <1156263951@qq.com>
Date: Sat, 9 May 2026 13:19:39 +0800
Subject: [PATCH] docs: update static docs for v0.5.0 new features
Add documentation for cell detail panel, ORDER BY filter, auto-fit
columns, Copy as INSERT, Redis browser overhaul, create/drop database
and schema, CROSS APPLY/OUTER APPLY completion, OceanBase Oracle mode
detection, and default database setting.
---
docs/content/docs/data-grid.cn.mdx | 12 +++++++++++-
docs/content/docs/data-grid.mdx | 12 +++++++++++-
docs/content/docs/databases.cn.mdx | 4 +++-
docs/content/docs/databases.mdx | 4 +++-
docs/content/docs/getting-started.cn.mdx | 2 +-
docs/content/docs/getting-started.mdx | 2 +-
docs/content/docs/query-editor.cn.mdx | 1 +
docs/content/docs/query-editor.mdx | 1 +
docs/content/docs/schema-browser.cn.mdx | 13 ++++++++++++-
docs/content/docs/schema-browser.mdx | 13 ++++++++++++-
docs/content/docs/what-is-dbx.cn.mdx | 4 ++--
docs/content/docs/what-is-dbx.mdx | 4 ++--
12 files changed, 60 insertions(+), 12 deletions(-)
diff --git a/docs/content/docs/data-grid.cn.mdx b/docs/content/docs/data-grid.cn.mdx
index 3a5b884619..11fe1de47f 100644
--- a/docs/content/docs/data-grid.cn.mdx
+++ b/docs/content/docs/data-grid.cn.mdx
@@ -29,15 +29,24 @@ description: 虚拟滚动浏览大数据量，行内编辑，SQL 预览，多格
这样可以避免误操作对数据造成不可逆的影响。
+## 单元格详情面板
+
+点击单元格可在右侧打开详情面板，提供以下功能：
+
+- **值编辑器** — 在更大的编辑区域中编辑长文本、JSON 等复杂值
+- **设为 NULL** — 一键将单元格值设为 `NULL`
+
## 排序与过滤
-- **排序** — 点击列头可按该列升序或降序排列
+- **排序** — 点击列头可按该列升序或降序排列，鼠标悬浮在列头时会显示排序方向提示图标
- **搜索** — 使用搜索框快速查找包含指定文本的行
- **WHERE 过滤** — 输入自定义的 `WHERE` 条件，在数据库层面精确筛选，大表场景比客户端搜索更高效
+- **ORDER BY** — 独立的 `ORDER BY` 输入框，在数据库层面控制排序，与 WHERE 过滤互不干扰
## 列宽调整与行号
- 拖拽列头边缘可以调整列宽
+- **自适应列宽** — 双击列头边缘，自动根据表头和数据内容调整列宽
- 表格左侧显示行号，方便定位
## 数据导出
@@ -47,3 +56,4 @@ description: 虚拟滚动浏览大数据量，行内编辑，SQL 预览，多格
| CSV | 逗号分隔的文本文件，适合导入 Excel 或其他工具 |
| JSON | JSON 数组格式，适合程序处理 |
| Markdown | Markdown 表格格式，适合粘贴到文档中 |
+| 复制为 INSERT | 右键选中的行，可复制为 `INSERT` 语句，方便粘贴到其他数据库执行 |
diff --git a/docs/content/docs/data-grid.mdx b/docs/content/docs/data-grid.mdx
index 4f05c6b6f3..a93dbec951 100644
--- a/docs/content/docs/data-grid.mdx
+++ b/docs/content/docs/data-grid.mdx
@@ -29,15 +29,24 @@ Before saving, DBX shows a preview of the exact `UPDATE`, `INSERT`, or `DELETE`
This prevents accidental data modifications and gives you full visibility into what will change.
+## Cell Detail Panel
+
+Click a cell to open its detail panel on the right side. The panel provides:
+
+- **Value Editor** — Edit long text, JSON, or other complex values in a larger, more comfortable editor
+- **Set NULL** — Explicitly set a cell value to `NULL` with one click
+
## Sorting and Filtering
-- **Sort** — Click a column header to sort ascending or descending
+- **Sort** — Click a column header to sort ascending or descending. A sort hint icon appears when you hover over the column header
- **Search** — Use the search bar to find text across all visible columns
- **WHERE Filter** — Apply a custom `WHERE` clause for database-level filtering. More efficient than client-side search for large tables
+- **ORDER BY** — Use the dedicated `ORDER BY` input to control the sort order at the database level, independent of the WHERE filter
## Column Resize and Row Numbers
- Drag column borders to resize columns
+- **Auto-fit** — Double-click a column border to automatically fit the column width based on header and data content
- Row numbers are displayed in the leftmost column
## Export
@@ -47,3 +56,4 @@ This prevents accidental data modifications and gives you full visibility into w
| CSV | Comma-separated values, compatible with Excel and spreadsheet tools |
| JSON | Array of objects, suitable for use in code or APIs |
| Markdown | Markdown table, useful for pasting into documentation or chat |
+| Copy as INSERT | Right-click selected rows to copy them as `INSERT` statements, ready to paste and execute in another database |
diff --git a/docs/content/docs/databases.cn.mdx b/docs/content/docs/databases.cn.mdx
index ef8431fd87..14a7c77770 100644
--- a/docs/content/docs/databases.cn.mdx
+++ b/docs/content/docs/databases.cn.mdx
@@ -39,7 +39,9 @@ Rust 原生驱动，不依赖 JDBC。MySQL / PostgreSQL 兼容数据库开箱即
| StarRocks | 9030 |
| TDengine | 6030 |
-## PostgreSQL 兼容
+
+OceanBase 支持自动检测 Oracle 模式 — 当连接的 OceanBase 实例运行在 Oracle 模式下时，DBX 会自动切换为 Oracle 风格的 Schema 查询。
+
以下数据库使用 PostgreSQL 协议，通过 PostgreSQL 驱动连接：
diff --git a/docs/content/docs/databases.mdx b/docs/content/docs/databases.mdx
index 4bf1dac3a5..8eb201ee00 100644
--- a/docs/content/docs/databases.mdx
+++ b/docs/content/docs/databases.mdx
@@ -39,7 +39,9 @@ These databases use MySQL protocol and work with the MySQL driver out of the box
| StarRocks | 9030 |
| TDengine | 6030 |
-## PostgreSQL Compatible
+
+OceanBase supports automatic Oracle mode detection — when connected to an OceanBase instance running in Oracle mode, DBX automatically switches to Oracle-style schema queries.
+
These databases use PostgreSQL protocol and work with the PostgreSQL driver:
diff --git a/docs/content/docs/getting-started.cn.mdx b/docs/content/docs/getting-started.cn.mdx
index d22ab0fde8..4b7f82b17b 100644
--- a/docs/content/docs/getting-started.cn.mdx
+++ b/docs/content/docs/getting-started.cn.mdx
@@ -78,7 +78,7 @@ description: 安装 DBX 并创建你的第一个数据库连接。
### 填写连接信息
- 填写主机、端口、用户名、密码。如需通过跳板机连接，可启用 [SSH 隧道](/cn/docs/ssh-tunnel)。
+ 填写主机、端口、用户名、密码。可选设置**默认数据库**，连接后自动切换到指定数据库。如需通过跳板机连接，可启用 [SSH 隧道](/cn/docs/ssh-tunnel)。
### 测试并保存
diff --git a/docs/content/docs/getting-started.mdx b/docs/content/docs/getting-started.mdx
index 813d6969aa..b9a07fecc2 100644
--- a/docs/content/docs/getting-started.mdx
+++ b/docs/content/docs/getting-started.mdx
@@ -78,7 +78,7 @@ description: Install DBX and create your first database connection.
### Enter Connection Details
- Fill in host, port, username, and password. For databases behind a firewall, enable the [SSH Tunnel](/en/docs/ssh-tunnel).
+ Fill in host, port, username, and password. Optionally set a **default database** to connect to a specific database automatically. For databases behind a firewall, enable the [SSH Tunnel](/en/docs/ssh-tunnel).
### Test and Save
diff --git a/docs/content/docs/query-editor.cn.mdx b/docs/content/docs/query-editor.cn.mdx
index de78555be6..4b6ae451ad 100644
--- a/docs/content/docs/query-editor.cn.mdx
+++ b/docs/content/docs/query-editor.cn.mdx
@@ -19,6 +19,7 @@ description: 基于 CodeMirror 6 的 SQL 编辑器，语法高亮、智能补全
- **表名** — 当前数据库中的所有表和视图
- **字段名** — 根据已输入的表名，自动补全对应的字段
- **JOIN 补全** — 输入 `JOIN` 后，自动建议可关联的表及基于外键的关联条件
+- **APPLY 子句** — SQL Server 连接下，自动补全 `CROSS APPLY` 和 `OUTER APPLY`
补全列表会随着输入内容实时过滤，按 `Tab` 或 `Enter` 即可确认选择。
diff --git a/docs/content/docs/query-editor.mdx b/docs/content/docs/query-editor.mdx
index 0df2d332a7..a0c9e12ffb 100644
--- a/docs/content/docs/query-editor.mdx
+++ b/docs/content/docs/query-editor.mdx
@@ -19,6 +19,7 @@ As you type, the editor suggests completions drawn from your actual database met
- **Table names** — all tables and views visible in the current connection
- **Column names** — columns scoped to the tables referenced in your query
- **JOIN suggestions** — when typing a `JOIN` clause, the editor suggests related tables and join conditions based on foreign key relationships
+- **APPLY clauses** — for SQL Server, the editor suggests `CROSS APPLY` and `OUTER APPLY` completions
Completions appear automatically and can also be triggered manually with the platform shortcut.
diff --git a/docs/content/docs/schema-browser.cn.mdx b/docs/content/docs/schema-browser.cn.mdx
index 833d100a1f..7bf3127d17 100644
--- a/docs/content/docs/schema-browser.cn.mdx
+++ b/docs/content/docs/schema-browser.cn.mdx
@@ -30,9 +30,11 @@ description: 树形结构浏览器，搜索、置顶、右键菜单、字段注
右键点击节点，根据类型提供不同操作：
+- **连接** — 刷新元数据、复制连接、断开连接
+- **数据库** — 创建数据库、删除数据库
+- **Schema** — 创建 Schema、删除 Schema
- **表** — 打开数据、查看结构、复制表名、删除表
- **字段** — 复制字段名
-- **连接** — 刷新元数据、断开连接
## 字段注释显示
@@ -45,3 +47,12 @@ description: 树形结构浏览器，搜索、置顶、右键菜单、字段注
颜色显示在侧边栏的连接名称旁和标签页中，多连接场景下尤其实用。
+
+## Redis 浏览器
+
+Redis 浏览器为 Redis 数据管理提供了专门的交互界面：
+
+- **表格视图** — 键值以 Navicat 风格的表格形式展示，便于浏览和管理
+- **行内编辑** — 直接在浏览器中编辑键值，无需切换到独立编辑器
+- **分页浏览** — 内置分页功能，浏览大量键时不会因一次性加载所有键而卡顿
+- **全类型支持** — 完整支持 String、Hash、List、Set、Sorted Set (ZSet) 和 Stream
diff --git a/docs/content/docs/schema-browser.mdx b/docs/content/docs/schema-browser.mdx
index eece25022c..7588c66032 100644
--- a/docs/content/docs/schema-browser.mdx
+++ b/docs/content/docs/schema-browser.mdx
@@ -30,9 +30,11 @@ Expand any node to drill down. Click a table name to open it in the Data Grid. C
Right-click any node for context-specific actions:
+- **Connection** — Refresh metadata, duplicate connection, disconnect
+- **Database** — Create database, drop database
+- **Schema** — Create schema, drop schema
- **Table** — Open data, open structure, copy table name, drop table
- **Column** — Copy column name
-- **Connection** — Refresh metadata, disconnect
## Column Comments
@@ -45,3 +47,12 @@ Assign colors to connections — green for dev, red for production — to tell t
Colors appear next to connection names in the sidebar and in tabs, especially useful when working with multiple connections.
+
+## Redis Browser
+
+The Redis browser provides a dedicated interface for browsing and managing Redis data:
+
+- **Table View** — Keys are displayed in a Navicat-style table layout for easier scanning and management
+- **Inline Editing** — Edit key values directly in the browser without switching to a separate editor
+- **Pagination** — Browse large keyspaces with built-in pagination, avoiding performance issues from loading all keys at once
+- **All Data Types** — Full support for String, Hash, List, Set, Sorted Set (ZSet), and Stream
diff --git a/docs/content/docs/what-is-dbx.cn.mdx b/docs/content/docs/what-is-dbx.cn.mdx
index ad28cbf4ae..7469a9f82e 100644
--- a/docs/content/docs/what-is-dbx.cn.mdx
+++ b/docs/content/docs/what-is-dbx.cn.mdx
@@ -35,10 +35,10 @@ DBX 是一款开源、轻量、跨平台的数据库管理工具，基于 [Tauri
CodeMirror 6 驱动，语法高亮、智能补全、JOIN 建议、查询历史。
- 虚拟滚动 10 万行不卡顿，行内编辑，保存前预览 SQL。
+ 虚拟滚动 10 万行不卡顿，行内编辑，WHERE/ORDER BY 过滤，复制为 INSERT，保存前预览 SQL。
- 树形视图，搜索、置顶、右键菜单、字段注释、连接颜色标记。
+ 树形视图，搜索、置顶、右键菜单、创建/删除数据库和 Schema、字段注释、连接颜色标记。
跨数据库结构对比，自动生成同步 SQL，开发 vs 生产一键对齐。
diff --git a/docs/content/docs/what-is-dbx.mdx b/docs/content/docs/what-is-dbx.mdx
index bb4c6d63d3..04c9ff2452 100644
--- a/docs/content/docs/what-is-dbx.mdx
+++ b/docs/content/docs/what-is-dbx.mdx
@@ -35,10 +35,10 @@ DBX is an open-source, lightweight, cross-platform database management tool buil
Powered by CodeMirror 6. Syntax highlighting, smart autocomplete, JOIN suggestions, query history.
- Virtual scrolling for 100K+ rows. Inline editing with SQL preview before saving.
+ Virtual scrolling for 100K+ rows. Inline editing, WHERE/ORDER BY filtering, Copy as INSERT, SQL preview before saving.
- Tree view with search, pin, context menus, column comments, and connection colors.
+ Tree view with search, pin, context menus, create/drop databases and schemas, column comments, and connection colors.
Compare schemas across databases and generate sync SQL. Dev vs Production in one click.