codeDB Lens

codeDB Lens

看清数据库未向你展示的内容。
为 SQL Server 和 PostgreSQL 提供免费的只读健康检查。

网站 · English · 巴西葡萄牙语

_{在测试 SQL Server 上进行的真实运行（已更改主机名）。打开演示报告。}

---

v0.8：check（含执行摘要和用于分享的 --redact）、compare，以及用于监测实例最长 24 小时的 record + report（了解方法）。26 条规则，另有 8 条用于记录。常见问题及更多内容请访问网站。

codeDB Lens 使用只读登录连接到你的实例，运行一组基于证据的规则，并生成自包含的 HTML + JSON 报告，其中包含 A–F 评级和覆盖率标记（实际能够运行的规则占比）。数据库中的任何内容都不会离开你的计算机。

安装

适用平台	安装方式
Windows	安装程序（当前用户，无需管理员权限） 或便携版 .zip
Windows（Scoop）	scoop bucket add codedb https://github.com/codedb-io/codedb-lens，然后运行 scoop install codedb/codedb-lens
Linux	从最新版本获取 .deb / .rpm，或下载 x64 / arm64 tarball
Docker	docker run --rm -e PG_DSN -v "$PWD:/out" ghcr.io/codedb-io/codedb-lens check --engine pg --dsn-env PG_DSN --out /out

Windows 二进制文件是开源的，但目前尚未进行代码签名，因此 SmartScreen 可能会显示警告。 为何会出现警告，以及如何验证下载文件。

为什么还需要另一款工具？

• **看证据，不凭主观判断。**每项发现都会显示采集到的值、生成这些值的查询以及采集时间。
• **如实呈现可信度。**每项发现的状态为 已确认、提示 或 无数据。权限不足的规则绝不会显示为虚假的“正常”；它会降低覆盖率。
• **始终只读。**不执行 DDL 或 DML，不运行 Agent，也无需在服务器上安装任何内容。
• **规则即数据。**每条规则都是一个 YAML 文件和一条 SQL 查询。贡献规则无需修改引擎。
• 支持英语和巴西葡萄牙语，适用于应用、CLI 和报告。

检查内容

SQL Server	PostgreSQL
缺少备份或备份过旧	版本已停止支持
没有近期成功完成的 DBCC CHECKDB	pg_stat_statements 不可用
SQL Agent 作业失败	单个查询占用了大部分执行时间
磁盘或事务日志空间即将耗尽	长时间处于空闲状态的事务会话
占主导地位的等待，已转换为易读内容	会话当前正被锁阻塞
当前正被阻塞的会话	事务 ID 回卷风险
单个查询占用大部分 CPU	死元组堆积且 autovacuum 进度落后
实例设置仍为默认值	复制槽保留 WAL、副本延迟
TempDB 文件布局	连接数接近上限，且未使用连接池
版本已停止支持	未使用、重复及无效索引
影响较大的缺失索引	估算的表膨胀情况
未使用和重复索引	最大的表

每条规则都有一个文档页面，介绍检查内容、重要性、应采取的措施以及规则的局限性。

快速开始

在 Windows 上，从“开始”菜单打开 codeDB Lens。选择数据库引擎，输入服务器信息，然后运行诊断。 连接配置文件会保存；密码存储在 Windows Credential Manager 中。

命令行（Windows 和 Linux）：

codedb-lens check --engine mssql --server prod01 --auth windows
codedb-lens check --engine pg --dsn-env PG_DSN

命令行参数中绝不会接受密码。请使用集成身份验证、环境变量或已保存的配置文件。

与 AI 配合使用（MCP）

_{在测试数据库上运行的真实 Claude Code 会话；回答经过了精简。}

向 Claude、GitHub Copilot 或 Cursor 询问数据库相关问题。codedb-lens mcp 是一个只读 MCP 服务，由 AI 客户端在你的计算机上启动，并使用已保存的配置文件：

• 诊断：使用 Lens 的最低权限登录，AI 可运行健康检查、读取记录并说明需要修复的问题，而无需读取业务数据。
• 数据：使用可读取你所选表的登录，AI 会列出并描述这些表，并在行数和时间限制内，每次执行一个 SELECT 来回答问题。

codedb-lens mcp install --client claude-desktop --profile prod   # or vscode, cursor, claude-code

应用的 AI (MCP) 屏幕已备好可复制的命令。使用指南：lens.codedb.com.br/mcp。

最低权限要求

-- SQL Server
CREATE LOGIN codedb_lens WITH PASSWORD = '<strong password>';
GRANT VIEW SERVER STATE TO codedb_lens;
GRANT VIEW ANY DEFINITION TO codedb_lens;
GRANT CONNECT ANY DATABASE TO codedb_lens;   -- per-database rules (indexes); no data access
USE msdb;
CREATE USER codedb_lens FOR LOGIN codedb_lens;
ALTER ROLE db_datareader ADD MEMBER codedb_lens;
ALTER ROLE SQLAgentReaderRole ADD MEMBER codedb_lens;

-- PostgreSQL (repeat GRANT CONNECT for each database)
CREATE ROLE codedb_lens LOGIN PASSWORD '<strong password>';
GRANT pg_monitor TO codedb_lens;
GRANT CONNECT ON DATABASE app TO codedb_lens;

支持的版本

数据库引擎	支持	尽力支持
SQL Server	2017、2019、2022、2025（Windows 和 Linux）、Azure SQL Managed Instance、Amazon RDS	2016 及更早版本；Azure SQL Database（13 条规则中有 6 条适用，参见权限）
PostgreSQL	15、16、17、18、Amazon RDS、Aurora、Azure Flexible Server	14

隐私

不收集遥测数据。Lens 会进行两种网络请求：一种是可选的、每天一次的 GitHub Releases 版本检查，不会发送任何数据（使用 --no-update-check 或 CODEDB_LENS_NO_UPDATE=1 可将其关闭）；另一种仅在你申请免费密钥时发送一次注册请求，内容包括你输入的姓名和电子邮件（续订时则只发送当前密钥）。详见 SECURITY.md。

需要持续监控？

Lens 显示的是某个时间点的快照。codeDB 全天候监控你的 SQL Server 和 PostgreSQL 实例，并提供历史记录、基线以及 Teams、Slack 和电子邮件提醒。

Windows 代码签名

Windows 二进制文件由 GitHub Actions 从此存储库构建，目前尚未进行代码签名（证书需要付费，而这是一个免费项目）。详情、验证下载的方法以及无需警告的替代方案： Windows 为何会显示警告。

参与贡献

特别欢迎新增规则。规则由 YAML 文件和 SQL 查询组成，因此无需修改 Go 代码： 请参阅 CONTRIBUTING.md，或者直接提交 issue，提出规则建议。

许可证

Apache 2.0。codeDB SaaS 及其 API 是独立的闭源产品。