官网唯一权威地址是https://xorm.io,Docs页含完整目录;高频功能速查:①“Getting Started→Quick Start”验证环境,②“Struct Tags”定义字段tag规则,③“CRUD Operations”详解各方法参数与返回值,④“Conditions”说明条件拼接语法,⑤“Transactions”给出事务标准流程与错误处理。

想快速查清 XORM 框架中某个功能怎么写、某个 tag 怎么用、事务怎么回滚,又不想从头读完全部英文文档——直接定位官方文档里真正能解决问题的章节才是刚需。
确认官网与文档源
打开浏览器,访问 https://xorm.io ——这是唯一权威的 XORM 官网,所有功能说明、API 列表、示例代码均以该站为准。
点击页面顶部导航栏的 Docs,进入英文文档主页;右侧边栏即为完整目录树,无需翻页即可纵览全部结构。
中文文档已迁移至 Gitea:访问 https://gitea.com/xorm/xorm/src/branch/master/README_CN.md,注意该文件仅含基础介绍与快速上手,【不包含 API 详解、条件链式调用规则、缓存配置等核心章节】。
速查高频功能对应章节
以下按使用频率排序,标出官网 Docs 页面中对应的一级标题(H1)和关键子节(H2/H3),复制标题名到左侧目录可秒跳:
① “Getting Started” → “Quick Start”:5 行代码连 MySQL + Sync2 建表 + Insert 示例,适合 2 分钟验证环境是否跑通。
② “Struct Tags”:所有字段 tag 的权威定义,比如 xorm:"pk autoincr"、xorm:"updated"、xorm:"notnull unique" 的拼写、组合规则、生效前提全在这里。漏看这一节,【Sync2 不会创建主键或索引,后续 Insert 会报错】。
③ “CRUD Operations” → “Insert / Get / Find / Update / Delete”:每个方法单独一节,含参数类型(必须传指针)、返回值含义(如 affected, err := engine.Insert() 中 affected 是影响行数)、空值处理逻辑。
④ “Conditions”:Where / And / Or / In / Between / Like 等条件拼接的完整语法,特别注意 Where("id = ?", 123) 和 Where("id = ? and name = ?", 123, "tom") 的参数顺序必须严格匹配问号位置。
⑤ “Transactions”:Session 创建 → Begin → 多次 Update/Delete → Rollback/Commit 的标准流程图与错误处理模板,事务中未调用 session.Close() 会导致连接泄漏。
避开无效信息区域
方法一:直接忽略 “Benchmarks” 和 “Contributing” 页面——它们对日常开发无直接帮助,且内容常年未更新。
方法二:跳过 “Reverse” 工具文档,除非你正要把现有数据库表反向生成 Go 结构体;否则它的 CLI 参数和模板配置会干扰主线操作。
方法三:“Cacher” 章节只看开头两段即可,LRU 缓存启用只需 3 行代码,后面关于自定义 Store 的实现细节极少用到。











