navicat协同功能不能生成操作手册,但可确保手册每一步可验证、可复现、可追溯;它同步连接配置、sql脚本、计划任务等原子单元,并按灾备流程阶段组织虚拟组,作为手册落地的“校验层”。

不能只靠 Navicat 协同功能生成操作手册——它不提供文档编写或流程编排能力,但能确保手册里每一步都可验证、可复现、可追溯。
Navicat 协同合作本身不支持写手册,但它是手册落地的“校验层”
Navicat 协同合作(Collaboration)本质是同步连接配置、查询、代码段、虚拟组和 BI 模型工作区,不是文档协作平台。你无法在 Navicat 里新建一个 Markdown 文件并多人编辑“灾备切换 SOP”。但它能强制让手册中涉及的所有数据库对象、连接参数、SQL 脚本、备份任务,在所有成员本地环境里保持完全一致——这才是操作手册真正生效的前提。
- 手册里写的“连接名为
prod_master”,所有成员的 Navicat 连接列表中必须真实存在且配置一致(Host/Port/User/SSL 设置等),否则第一步就失败 - 手册中引用的“切换前校验脚本”,必须以
Query形式保存在协同项目中,而非粘贴在 Word 里;成员双击即可执行,避免复制漏字符 - 手册要求“执行
backup_database计划任务”,该任务必须已在协同项目中注册并启用,且路径、压缩、DEFINER 处理等选项全部统一
把灾备切换步骤拆成 Navicat 可托管的原子单元
操作手册失效,往往因为步骤太笼统(如“检查主从状态”)。Navicat 协同能承载的是具体、可执行、带上下文的最小单元。你需要把每个动作映射为一个 Navicat 内置对象:
-
Query:用于状态检查与验证,例如:SHOW SLAVE STATUS\G、SELECT @@read_only、SELECT COUNT(*) FROM heartbeat -
Connection:明确区分prod_master、prod_slave、dr_standby等连接,图标颜色/分组标签需统一约定(如红色=生产主库,蓝色=灾备库) -
Scheduled Task:灾备切换前的最终一致性快照,应封装为一个启用的计划任务,名称如dr_pre_switch_snapshot,导出路径固定为/shared_backups/dr_switch_20260907.sql -
Data Modeler模型文件:若切换涉及表结构变更(如新增灾备专用字段),ER 图和 DDL 必须作为协同项目的一部分,而非口头约定
协同项目结构要匹配灾备流程阶段
Navicat 协同项目的虚拟组(Virtual Group)不是用来分类“MySQL”“PostgreSQL”的,而是按操作生命周期组织。建议按以下方式建组,直接对应手册章节:
-
dr-precheck:含所有连接测试 Query、网络连通性脚本、磁盘空间检查命令(通过Query调用SELECT或系统函数模拟) -
dr-switch:含主从角色切换 SQL(STOP SLAVE; RESET SLAVE ALL;等)、只读开关语句、应用配置更新提示(纯文本注释) -
dr-postverify:含写入测试、延迟比对、关键业务表 COUNT 校验等 Query,全部设为“运行后自动保存结果到日志”
注意:Virtual Group 名称本身会出现在 Navicat 左侧导航栏,成员一眼就能定位当前操作阶段——这比翻 PDF 手册快得多。
最容易被忽略的坑:协同权限 ≠ 操作权限
你在协同项目里能看到 dr_switch.sql,不代表你能在 prod_master 连接上执行它。Navicat 协同只同步“定义”,不代理“权限”。这意味着:
- 所有参与灾备切换的成员,其各自连接使用的数据库账号,必须提前拥有
REPLICATION CLIENT、SUPER、PROCESS等必要权限(MySQL);Navicat 不会帮你检查这个 - 协同项目中保存的
Query若含敏感信息(如临时密码、密钥),会被所有人可见——不要在 Query 文本里硬编码,改用 Navicat 的Variables功能或外部参数注入 - Windows 下若用任务计划调用
navicat.exe --run-query执行切换脚本,该计划任务必须以具备数据库权限的系统账户运行,而非当前登录用户
真正的操作手册,是你把上述所有 Navicat 协同对象 + 权限清单 + 失败回滚 checklist + 通讯联络表,打包进一个共享网盘链接。Navicat 协同不是手册本身,而是让手册里每一行字,都能在三秒内被任何人点一下就跑起来的那层底座。











