Table.go 16 KB

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