Table.go 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517
  1. package DB
  2. import (
  3. "git.ycl.pub/yl32940/TsDB2/DB/core"
  4. "git.ycl.pub/yl32940/TsDB2/DB/core/types"
  5. "encoding/binary"
  6. "fmt"
  7. "time"
  8. )
  9. // Table 泛型表封装。
  10. //
  11. // T 必须内嵌 DB.BaseModel / DB.PrimaryModel / DB.TimeSeriesModel —— 由 UseTable 在
  12. // 建表之前强制校验 (见 types.go 的 requireBase), 所以拿到一个 *Table[T] 就意味着
  13. // T 一定有对象头部的增删改查。
  14. //
  15. // db 是反向指针, ORM Insert/Update/Delete 自动开 tx (tx.BlobCommit) 时用来从 ORM 层
  16. // 拿 *core.Transaction。UseTable 在创建时填充, 之后只读。
  17. type Table[T any] struct {
  18. db *DB
  19. coreTable *core.Table
  20. model *ModelInfo
  21. name string // 表名
  22. activeColumns map[string]bool // 当前 DB schema 活跃列集合
  23. }
  24. // refreshActiveColumns 从 core table 刷新活跃列集合
  25. func (t *Table[T]) refreshActiveColumns() {
  26. t.activeColumns = make(map[string]bool)
  27. for _, name := range t.coreTable.GetActiveFieldNames() {
  28. t.activeColumns[name] = true
  29. }
  30. }
  31. // SchemaColumns 返回当前 DB 中的所有活跃列名
  32. func (t *Table[T]) SchemaColumns() []string {
  33. names := make([]string, 0, len(t.activeColumns))
  34. for name := range t.activeColumns {
  35. names = append(names, name)
  36. }
  37. return names
  38. }
  39. // Insert 插入一条记录
  40. //
  41. // 顺带把对象绑定到本表, 这样即使对象是外部构造的, 插完之后也能直接用头部的
  42. // Update / Delete / Reload (见 model.go); 同时把引擎分配的行号带回对象, 之后
  43. // obj.Update() / obj.Delete() 才能精确到"这一行"。
  44. //
  45. // Blob 列的落链由 t.db.coreDB (无事务版 BlobCommitter) 承接: 用户不需要手动开事务,
  46. // 写入的内容照样自动落链; 用户若已显式开事务, 链页会经 DB.NewPage 登记进该事务,
  47. // Rollback 整链回收。这里【不】自动 begin-tx + 立即 Commit —— tx.Commit 只要缓冲池
  48. // 里有脏页 (单行插入必然有) 就走完整 WAL + fsync (~37ms/行), 逐行插入会比防抖提交
  49. // 慢三个数量级, 且 SetCommitPreset 的批量策略被整体绕过 (a56b71d 的性能回退根因)。
  50. func (t *Table[T]) Insert(obj *T) error {
  51. t.bindModel(obj)
  52. // 主键显式给了就用它; 没给 (==0) 就向引擎要一个自增号。
  53. // 旧实现无条件用 TotalRows+1 覆盖: 一是调用方填的 _id 被改写 → "按 _id 插入的行
  54. // 按 _id 查不到"; 二是删除会让行数回退 → 号回退并撞上仍存活的 pkID (探针 T4)。
  55. // 现在号一律来自 core 的只增不减游标, 拿到号后再序列化, 保证主键列与 pkID 一致。
  56. // 主键字段可以是内嵌 BaseModel 的 ID, 也可以是用户用 vrtx:"pk" 指定的普通字段。
  57. //
  58. // 时序表是唯一的例外, 见下面 IsTimeSeries 分支。
  59. pkID := uint64(0)
  60. if t.model.IsTimeSeries {
  61. // 时间键不是行号, 两者必须分开: 同一个时间戳下允许有多行 (同一时刻的多个
  62. // 测点 / 多次事件), 这是时序数据的常态。若沿用"时间键即行号", 第二行会被
  63. // 当成重复主键拒掉 —— 数据直接丢, 而这正是引入行号要解决的问题。
  64. // 所以时序表永远向引擎要一个新行号, 时间键保持用户给的原值, 只当索引键用。
  65. pkID = t.coreTable.AllocPKID()
  66. if t.model.PKInStruct {
  67. ts, err := getPKValue(obj, t.model)
  68. if err != nil {
  69. return fmt.Errorf("tsdb: insert: %w", err)
  70. }
  71. if ts == 0 {
  72. // 完全没给时间键: 补一个"写入这一刻"的纳秒级时间戳。
  73. //
  74. // 时序键就是时间戳本身, 默认值必须与显式传入的时间戳同量纲 (纳秒),
  75. // 否则它会成为一个远小于真实时间戳的怪值, 顺序写入下立刻被判为乱序。
  76. // 同一纳秒内连插多行的 TS 会相同, 这是允许的 —— 同刻多行由行号区分。
  77. setPKValue(obj, t.model, uint64(time.Now().UnixNano()))
  78. }
  79. }
  80. } else if t.model.PKInStruct {
  81. var err error
  82. if pkID, err = getPKValue(obj, t.model); err != nil {
  83. return fmt.Errorf("tsdb: insert: %w", err)
  84. }
  85. if pkID == 0 {
  86. pkID = t.coreTable.AllocPKID()
  87. setPKValue(obj, t.model, pkID)
  88. }
  89. }
  90. fvs, err := structToFieldValues(obj, t.model, t.activeColumns, t.db.coreDB)
  91. if err != nil {
  92. return fmt.Errorf("tsdb: insert: %w", err)
  93. }
  94. // pkID == 0 (结构体没有主键字段) 时由 core 自行分配
  95. assigned, err := t.coreTable.InsertRowWithID(pkID, fvs)
  96. if err != nil {
  97. return fmt.Errorf("tsdb: insert: %w", err)
  98. }
  99. setRowIDOf(obj, assigned)
  100. backfillBlobRefs(obj, t.model, fvs)
  101. return nil
  102. }
  103. // BatchInsert 批量插入
  104. //
  105. // 真批量: 走 core 的 InsertRowsWithIDs —— 索引层按"排序灌叶"写入, 数据页/树页
  106. // 落盘按页摊销, saveTableInfo 与防抖提交通知只发一次。灌数吞吐相对逐行 Insert
  107. // 提升一个数量级 (逐行路径每行 4 棵树各下降一次 + 每次页保存整页回写)。
  108. //
  109. // 两种情形退回逐行 Insert, 语义与旧实现完全一致:
  110. // - 时序表: assertTimeOrder 逐行把关写入顺序;
  111. // - 任一对象显式携带主键: 逐行查重路径 (显式主键本身就是小众场景)。
  112. func (t *Table[T]) BatchInsert(objs []*T) error {
  113. if len(objs) == 0 {
  114. return nil
  115. }
  116. if t.model.IsTimeSeries {
  117. for _, obj := range objs {
  118. if err := t.Insert(obj); err != nil {
  119. return err
  120. }
  121. }
  122. return nil
  123. }
  124. // 先扫一遍: 有显式主键就整批退回逐行 (避免"半批半单"两条语义)
  125. if t.model.PKInStruct {
  126. anyExplicit := false
  127. for _, obj := range objs {
  128. t.bindModel(obj)
  129. if pkID, err := getPKValue(obj, t.model); err == nil && pkID != 0 {
  130. anyExplicit = true
  131. break
  132. }
  133. }
  134. if anyExplicit {
  135. for _, obj := range objs {
  136. if err := t.Insert(obj); err != nil {
  137. return err
  138. }
  139. }
  140. return nil
  141. }
  142. }
  143. pkIDs := make([]uint64, len(objs))
  144. fvs := make([][]types.FieldValue, len(objs))
  145. tx := t.db.BeginTransaction()
  146. for i, obj := range objs {
  147. t.bindModel(obj)
  148. // 号先拿到、填进对象再序列化: 行里存的 _id 与引擎行号才一致 (与单行同约定)
  149. pkID := t.coreTable.AllocPKID()
  150. if t.model.PKInStruct {
  151. setPKValue(obj, t.model, pkID)
  152. }
  153. pkIDs[i] = pkID
  154. fv, err := structToFieldValues(obj, t.model, t.activeColumns, tx)
  155. if err != nil {
  156. _ = tx.Rollback()
  157. return fmt.Errorf("tsdb: batch insert: %w", err)
  158. }
  159. fvs[i] = fv
  160. }
  161. // 号全部来自 AllocPKID 预留号段: 走 InsertRowsReserved 跳过逐行查重
  162. // (走 WithIDs 会被当显式主键逐行 rowStoreHasPK —— 正是单行注释里警告过的
  163. // O(N²) 退化, 5 万行实测多烧 1.2GB 分配)
  164. assigned, err := t.coreTable.InsertRowsReserved(pkIDs, fvs)
  165. if err != nil {
  166. _ = tx.Rollback()
  167. return fmt.Errorf("tsdb: batch insert: %w", err)
  168. }
  169. if cerr := tx.Commit(); cerr != nil {
  170. return fmt.Errorf("tsdb: batch insert: tx commit: %w", cerr)
  171. }
  172. for i, obj := range objs {
  173. setRowIDOf(obj, assigned[i])
  174. backfillBlobRefs(obj, t.model, fvs[i])
  175. }
  176. return nil
  177. }
  178. // Update 更新一条记录
  179. //
  180. // 优先按对象携带的引擎行号定位 (从表里读出来或插入过的对象都有), 这样同一时间戳
  181. // 下有多行时改的确实是"自己那一行"; 行号未知时退回按主键列定位 (旧行为)。
  182. //
  183. // Blob 列的落链与旧链回收都由引擎在 UpdateRow 内完成 (新链走 coreDB 的无事务
  184. // BlobCommitter, 旧链走 deferred free), 与 Insert 同一套边界 —— 不自动开 tx。
  185. func (t *Table[T]) Update(obj *T) error {
  186. t.bindModel(obj)
  187. fvs, err := structToFieldValues(obj, t.model, t.activeColumns, t.db.coreDB)
  188. if err != nil {
  189. return fmt.Errorf("tsdb: update: %w", err)
  190. }
  191. if id := rowIDOf(obj); id != 0 {
  192. if uerr := t.coreTable.UpdateRowByPK(id, fvs); uerr != nil {
  193. return fmt.Errorf("tsdb: update: %w", uerr)
  194. }
  195. backfillBlobRefs(obj, t.model, fvs)
  196. return nil
  197. }
  198. pk, err := getPKValue(obj, t.model)
  199. if err != nil {
  200. return fmt.Errorf("tsdb: update: %w", err)
  201. }
  202. if pk == 0 {
  203. return fmt.Errorf("tsdb: update: primary key is 0")
  204. }
  205. if uerr := t.coreTable.UpdateRow(t.pkIndexName(), encodePKKey(pk), fvs); uerr != nil {
  206. return fmt.Errorf("tsdb: update: %w", uerr)
  207. }
  208. backfillBlobRefs(obj, t.model, fvs)
  209. return nil
  210. }
  211. // Delete 按主键删除一条记录
  212. //
  213. // 引擎走 heapReleaseRow + releaseRowBlobRefs 回收堆块与 blob 链, 登记进 deferred
  214. // free 队列 (有活跃事务时随 tx, 无事务时由 Commit/Close 收尾) —— 不自动开 tx。
  215. func (t *Table[T]) Delete(id uint64) error {
  216. return t.coreTable.DeleteRow(t.pkIndexName(), encodePKKey(id))
  217. }
  218. // convertRow 反序列化一行 core 值 → *T, 并回写行号 + 绑定表。
  219. // Find / Scan / Select 三个入口共用。
  220. func (t *Table[T]) convertRow(pkID uint64, row []types.FieldValue) (*T, error) {
  221. obj := new(T)
  222. if err := fieldValuesToStruct(row, t.model, obj, t.coreTable); err != nil {
  223. return nil, err
  224. }
  225. setRowIDOf(obj, pkID)
  226. t.bindModel(obj)
  227. return obj, nil
  228. }
  229. // Find 按主键查找一条记录
  230. func (t *Table[T]) Find(id uint64) (*T, error) {
  231. // SearchByIndexWithPK 与 SearchByIndex 取的是同一行 (同一条索引键 → 同一次定位),
  232. // 只是额外把行的引擎行号带回来 —— 没有它就没法对同刻多行做精确的改 / 删。
  233. pkID, row, err := t.coreTable.SearchByIndexWithPK(t.pkIndexName(), encodePKKey(id))
  234. if err != nil {
  235. return nil, err
  236. }
  237. obj := new(T)
  238. if err := fieldValuesToStruct(row, t.model, obj, t.coreTable); err != nil {
  239. return nil, err
  240. }
  241. setRowIDOf(obj, pkID)
  242. t.bindModel(obj)
  243. return obj, nil
  244. }
  245. // FindAll 返回所有记录
  246. func (t *Table[T]) FindAll() ([]*T, error) {
  247. return t.Query().Find()
  248. }
  249. // Count 返回总行数
  250. func (t *Table[T]) Count() (int64, error) {
  251. return t.coreTable.Query().Count()
  252. }
  253. // Select 流式遍历所有记录
  254. func (t *Table[T]) Select(callback func(*T) bool) error {
  255. var convErr error
  256. err := t.coreTable.Query().ScanWithPKID(func(pkID uint64, row []types.FieldValue) bool {
  257. obj, err := t.convertRow(pkID, row)
  258. if err != nil {
  259. // 反序列化失败: 停止扫描并让 Select 返回错误, 不能静默跳过该行
  260. if convErr == nil {
  261. convErr = err
  262. }
  263. return false
  264. }
  265. return callback(obj)
  266. })
  267. if err != nil {
  268. return err
  269. }
  270. return convErr
  271. }
  272. // Where 开始条件查询
  273. func (t *Table[T]) Where(field string, op string, value interface{}) *Query[T] {
  274. q := &Query[T]{table: t}
  275. q.addWhere(field, op, value)
  276. return q
  277. }
  278. // OrderBy 排序
  279. func (t *Table[T]) OrderBy(field string, desc ...bool) *Query[T] {
  280. q := &Query[T]{table: t}
  281. q.OrderBy(field, desc...)
  282. return q
  283. }
  284. // Limit 限制返回行数
  285. func (t *Table[T]) Limit(n int) *Query[T] {
  286. q := &Query[T]{table: t}
  287. q.Limit(n)
  288. return q
  289. }
  290. // Offset 跳过行数
  291. func (t *Table[T]) Offset(n int) *Query[T] {
  292. q := &Query[T]{table: t}
  293. q.Offset(n)
  294. return q
  295. }
  296. // Query 创建一个新的查询构建器
  297. func (t *Table[T]) Query() *Query[T] {
  298. return &Query[T]{table: t}
  299. }
  300. // BlobReader 返回本表的 blob 读取入口 (core.Table, 实现了 types.BlobReader)。
  301. //
  302. // 用途: 流式载体 types.Blob 的读回 —— row.Body.Open(tbl.BlobReader()) 拿
  303. // io.ReadCloser, 按流消费 (io.Copy / 逐块), 不把内容整块拉进内存; 适合大对象。
  304. // []byte 载体不需要它 (ORM 读回时自动解链)。
  305. func (t *Table[T]) BlobReader() types.BlobReader {
  306. return t.coreTable
  307. }
  308. func (t *Table[T]) pkIndexName() string {
  309. return pkIndexPrefix + t.name
  310. }
  311. // ===== 模型绑定: 头部增删改查的入口 =====
  312. // Bind 把对象绑定到本表 —— 绑定之后才能用对象头部的 Insert / Update / Delete /
  313. // Save / Load / Reload。Insert / Update / Find / FindAll / Select / 条件查询的返回值
  314. // 都会自动绑定, 所以只有"外部手工构造、且第一件事就是 Update/Delete/Reload"的对象
  315. // 需要显式绑一次 (那种情况下用 New 更省事)。
  316. //
  317. // 注意: 绑定信息 (属于哪张表、外层对象是谁) 存在对象内部, 因此
  318. //
  319. // u2 := *u // 拷贝一个已绑定的对象
  320. // u2.Update() // 更新的是 u, 不是 u2
  321. //
  322. // 会更新原对象。需要一份独立的对象请用 Table.New + Load, 或 Table.Find。
  323. func (t *Table[T]) Bind(obj *T) error {
  324. if !t.bindModel(obj) {
  325. // UseTable 已经把没有基类的 T 挡在门外, 走到这里只可能是 T 的绑定器被特殊的
  326. // 嵌入方式挡住了 (例如把基类嵌在一个指针结构体里)。给同样的错误, 别让它静默失效。
  327. return fmt.Errorf("tsdb: %w: %T 需要内嵌 DB.BaseModel / DB.PrimaryModel / "+
  328. "DB.TimeSeriesModel 才能使用头部方法", ErrNotModel, obj)
  329. }
  330. return nil
  331. }
  332. // New 创建一个已经绑定到本表的新对象, 随后可以直接 obj.Load(pk) 读入。
  333. //
  334. // 与"手写 &T{} 再 Bind"的区别: 后者要先拿到 T 的类型; 在泛型代码里 (不知道 T 的具体
  335. // 类型时) 只有 Table 能造出 T, New 就是那个入口。
  336. func (t *Table[T]) New() *T {
  337. obj := new(T)
  338. t.bindModel(obj)
  339. return obj
  340. }
  341. // bindModel 把"这个对象属于哪张表"写回对象内嵌的表基类, 返回是否绑定成功。
  342. //
  343. // 走接口断言而不是反射: 每条被读写的记录都要过一遍, 反射在这里是白付的成本。
  344. // 内嵌的表基类会把 modelBinder 提升到 *T 上, 所以一次类型断言就够了。
  345. func (t *Table[T]) bindModel(obj *T) bool {
  346. b, ok := any(obj).(modelBinder)
  347. if !ok {
  348. return false
  349. }
  350. b.bindTo(t, obj)
  351. return true
  352. }
  353. // ===== session: Table[T] 的类型擦除视图 =====
  354. //
  355. // 模型基类不认识 T, 头部方法只能把请求交回这里; 这一层认识 T, 于是把参数断言回 *T。
  356. // 断言失败只可能是"把 A 表的对象交给了 B 表", 所以返回错误而不是 panic。
  357. // sessionObj 断言出 *T, 并顺手重新绑定 —— 对象可能是刚从一个临时副本拷过来的。
  358. func (t *Table[T]) sessionObj(op string, obj any) (*T, error) {
  359. o, ok := obj.(*T)
  360. if !ok {
  361. return nil, fmt.Errorf("tsdb: %s: 表 %s 收到了 %T, 类型不匹配", op, t.name, obj)
  362. }
  363. t.bindModel(o)
  364. return o, nil
  365. }
  366. func (t *Table[T]) insert(obj any) error {
  367. o, err := t.sessionObj("insert", obj)
  368. if err != nil {
  369. return err
  370. }
  371. return t.Insert(o)
  372. }
  373. func (t *Table[T]) update(obj any) error {
  374. o, err := t.sessionObj("update", obj)
  375. if err != nil {
  376. return err
  377. }
  378. return t.Update(o)
  379. }
  380. func (t *Table[T]) pkOf(obj any) (uint64, error) {
  381. o, err := t.sessionObj("pk", obj)
  382. if err != nil {
  383. return 0, err
  384. }
  385. return getPKValue(o, t.model)
  386. }
  387. // loadInto 把主键 pk 对应的整行读进 obj 指向的对象。
  388. //
  389. // 用 *o = *got 整块赋值而不是逐字段搬: 两边是同一个 T, 字段集合一致, 省掉一次反射。
  390. // 代价是 got 的绑定信息也被拷了过来 (self 还指着 got), 所以紧接着必须重新绑定到 o。
  391. func (t *Table[T]) loadInto(pk uint64, obj any) error {
  392. o, err := t.sessionObj("load", obj)
  393. if err != nil {
  394. return err
  395. }
  396. got, err := t.Find(pk)
  397. if err != nil {
  398. return err
  399. }
  400. *o = *got
  401. t.bindModel(o)
  402. return nil
  403. }
  404. // reload 重新读一遍 obj 所在的那一行。
  405. //
  406. // 行号已知 → 按行号读 (同刻多行也不会读串); 行号未知 → 退回按可见主键读。
  407. func (t *Table[T]) reload(obj any) error {
  408. o, err := t.sessionObj("reload", obj)
  409. if err != nil {
  410. return err
  411. }
  412. if id := rowIDOf(o); id != 0 {
  413. return t.loadByRowID(id, o)
  414. }
  415. pk, err := getPKValue(o, t.model)
  416. if err != nil {
  417. return fmt.Errorf("tsdb: reload: %w", err)
  418. }
  419. return t.loadInto(pk, o)
  420. }
  421. // loadByRowID 把行号 pkID 对应的整行读进 obj 指向的对象。
  422. func (t *Table[T]) loadByRowID(pkID uint64, obj any) error {
  423. o, err := t.sessionObj("load", obj)
  424. if err != nil {
  425. return err
  426. }
  427. got, err := t.findByRowID(pkID)
  428. if err != nil {
  429. return err
  430. }
  431. *o = *got
  432. t.bindModel(o)
  433. return nil
  434. }
  435. // findByRowID 按引擎行号读出一个新对象 (行号是内部句柄, 所以不对外暴露)。
  436. func (t *Table[T]) findByRowID(pkID uint64) (*T, error) {
  437. row, err := t.coreTable.FindByPK(pkID)
  438. if err != nil {
  439. return nil, err
  440. }
  441. obj := new(T)
  442. if err := fieldValuesToStruct(row, t.model, obj, t.coreTable); err != nil {
  443. return nil, err
  444. }
  445. setRowIDOf(obj, pkID)
  446. t.bindModel(obj)
  447. return obj, nil
  448. }
  449. func (t *Table[T]) deleteByPK(pk uint64) error { return t.Delete(pk) }
  450. // deleteByRowID 按引擎行号删除一行 —— 同刻多行时唯一能精确指认"这一行"的方式。
  451. //
  452. // 自动开 tx 与 Delete 同源: heapReleaseRow / releaseRowBlobRefs 都在 deferred.
  453. func (t *Table[T]) deleteByRowID(pkID uint64) error {
  454. tx := t.db.BeginTransaction()
  455. if err := t.coreTable.DeleteRowByPK(pkID); err != nil {
  456. _ = tx.Rollback()
  457. return err
  458. }
  459. if err := tx.Commit(); err != nil {
  460. return fmt.Errorf("tsdb: delete: tx commit: %w", err)
  461. }
  462. return nil
  463. }
  464. func (t *Table[T]) tableName() string { return t.name }
  465. func encodePKKey(pk uint64) []byte {
  466. buf := make([]byte, 8)
  467. binary.BigEndian.PutUint64(buf, pk)
  468. return buf
  469. }