types.go 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647
  1. // Package migrate 把 VRTX 库与 MySQL / SQLite 库互相转换 (结构 + 数据 + 索引 + 主键)。
  2. //
  3. // 设计要点: 两端各实现 Source (读结构 + 流式读行) 与 Sink (建结构 + 批量写行),
  4. // 中间统一表示是「VRTX 的 FieldType」+ 一组按列序排列的 interface{} 值。于是任意
  5. // 方向都走同一条代码路径:
  6. //
  7. // VRTX → SQLite / MySQL 导出
  8. // SQLite / MySQL → VRTX 导入
  9. // VRTX → VRTX 顺带就是一个整库拷贝 / 压实工具
  10. //
  11. // 保真: 导出到 SQL 时会把原始结构写进一张 __vrtx_meta 表 (Options.EmbedMeta 可关)。
  12. // 带着它回来, 那些 SQL 方言表达不了的细节 —— 定长串的档位 (16/32/64/128/256 字节)、
  13. // 索引类型 (Hash/BTree/时序)、主键索引挂在哪个列上 —— 都能原样还原; 没有它则按 SQL
  14. // 列类型就近推断 (给外部库用)。
  15. package migrate
  16. import (
  17. "git.ycl.pub/yl32940/TsDB2/DB/core/page"
  18. "git.ycl.pub/yl32940/TsDB2/DB/core/types"
  19. "fmt"
  20. "log"
  21. "strings"
  22. "time"
  23. )
  24. // Kind 一端库的种类。
  25. type Kind string
  26. const (
  27. KindVRTX Kind = "vrtx"
  28. KindMySQL Kind = "mysql"
  29. KindSQLite Kind = "sqlite"
  30. )
  31. // Column 列定义 (中间表示)。
  32. //
  33. // 统一用 VRTX 的 FieldType 而不是中性类型: 它已经覆盖了这里需要的全部宽度档位
  34. // (1/2/4/8/16/32/64/128/256 字节定长 + 浮点 + 变长), SQL 侧的 varchar(n)/int/bigint
  35. // 都能无损映射进来。反向映射只能"就近取档", 这也是 __vrtx_meta 存在的理由。
  36. type Column struct {
  37. Name string
  38. Type types.FieldType
  39. // Param 列级类型参数, 按类型解释 (与 VRTX 的 Flag 低 5 位同源, 见 types.FieldSize):
  40. //
  41. // - Decimal: 小数位数 scale。它的保序编码把 scale 写进了行内字节, "同一列 scale
  42. // 必须一致"是它能被 memcmp 比较的前提 —— 所以 scale 必须跟着列走
  43. // (__vrtx_meta 里也要存), 不能只活在声明文本里, 否则导出再导入就丢了小数位。
  44. // - FieldType_String (与变长): 行内宽度码。maxlen 声明出来的列真实
  45. // 宽度由它决定, GetSize 只给类型默认档。
  46. // - 其余类型恒为 0 —— 由 ValidateColumnParam 强制。
  47. Param byte
  48. // TimeKind 这列在源 SQL 里的时间语义: "datetime" / "date" / "timestamp", 空即普通列。
  49. //
  50. // 为什么要单独记: VRTX 没有日期类型, 时间统一用 8 字节整数表达 (Unix 纳秒时间戳,
  51. // 时序键 _ts 就是这么存的), 所以 SQL 的 DATETIME 落到 VRTX 就是一列 uint64 ——
  52. // 光看 FieldType 分不出它是"时间戳"还是"恰好取值很大的整数"。带着这个标记,
  53. // 导回 SQL 时才能还原成 DATETIME 而不是 BIGINT。
  54. //
  55. // 标记放在哪, 以及它管不到哪一段: 目前只写进 SQL 侧的保真表 __vrtx_meta,
  56. // VRTX 的 schema 里【没有地方放它】——
  57. //
  58. // - types.FieldInfo 的 Flag 一个字节已经排满: 低 5 位是宽度码 / scale,
  59. // 5/6/7 位分别是 Unique / Nullable / Deleted;
  60. // - 借 Param 也不行, ValidateColumnParam 明确禁止非 Decimal、非字符串类型
  61. // 带列级参数 ("uint64 的 Param 恒为 0"), 改这条就是把一个格式不变量拆了。
  62. //
  63. // 所以: SQL → VRTX → SQL 能还原成时间列 (标记跟着 __vrtx_meta 往返),
  64. // 但【从 VRTX 直接导出】拿不到标记 —— 时间列会被声明成 BIGINT 而不是 DATETIME。
  65. // 要补上这一段, 得给 VRTX 侧一个正经的存放位置 (加 FieldType / 内部元数据表),
  66. // 那是一次格式版本决策, 不适合顺手做。
  67. //
  68. // 另外, 这个"退化成 BIGINT"其实比强转 DATETIME 更保守: uint64 里存的是纳秒,
  69. // 而 formatSQLTime 只能写到微秒 (MySQL DATETIME(6) 的上限), 转成时间文本会丢掉
  70. // 后三位 —— 类型还原和精度无损目前只能二选一。
  71. TimeKind string
  72. // Nullable 该列允许 NULL (VRTX 的 FlagNullable ⇄ SQL 的可空声明)。
  73. //
  74. // 两边都必须显式带上: 导出时可空列不能写 NOT NULL (否则 NULL 值根本插不进去,
  75. // 只能被改成 0/空串), 导入时 SQL 的可空性也要落到 VRTX 的 schema 上 ——
  76. // __vrtx_meta 里同样存一份, 因为 SQLite 的 PRAGMA 看得见 notnull 而
  77. // SQL 的 TEXT 保真表看不出"整数列能不能为空"。
  78. Nullable bool
  79. // Unique 该列声明了唯一约束 (VRTX 的 FlagUnique ⇄ SQL 的列级 UNIQUE)。
  80. //
  81. // 只是【声明】, 真正拦重复的是唯一索引 (见 IndexSchema.Unique) —— 与 VRTX 的
  82. // 分工一致: 列位告诉读者/工具"这列的意图", 约束由索引执行。往返时两个标记
  83. // 都要带, 否则导入 VRTX 后列上的声明就丢了 (索引还在, 但 ORM 反推时会看不出
  84. // 这列本该唯一)。
  85. //
  86. // 导出到 SQL 时【不】把它写成列级 UNIQUE: SQL 的 UNIQUE 会真的生成一条唯一
  87. // 索引, 也就是一个会拦写入的约束, 而这里的声明在 VRTX 侧什么都不拦 —— 写了
  88. // 等于凭空造约束, 再导回来还会多出一条索引。它只进 __vrtx_meta 保真表
  89. // (见 metaCol.Uniq), 纯导出时确实不落 DDL, 这是有意为之。
  90. Unique bool
  91. }
  92. // Flags 列上的可空/唯一声明, 拼成给人看的一小段后缀 (Describe / 日志用)。
  93. func (c Column) Flags() string {
  94. var s string
  95. if c.Nullable {
  96. s += " NULL"
  97. }
  98. if c.Unique {
  99. s += " UNIQUE"
  100. }
  101. return s
  102. }
  103. // IsTime 这列是否承载 SQL 的时间语义。
  104. func (c Column) IsTime() bool { return c.TimeKind != "" }
  105. // Size 列在 VRTX 行内的字节宽度 (变长列为堆引用宽度)。
  106. //
  107. // 走 FieldSize(c.Type, c.Param): 字符串列的真实宽度由列级宽度码决定, GetSize 只给
  108. // 类型默认档 (对 maxlen 声明出来的列会算窄)。
  109. func (c Column) Size() int { return int(types.FieldSize(c.Type, c.Param)) }
  110. // IsDynamic 变长列 (超过 MaxInlineColumnWidth 的字符串 / 二进制)。
  111. func (c Column) IsDynamic() bool { return types.IsDynamic(c.Type) }
  112. func (c Column) String() string {
  113. return fmt.Sprintf("%s %s%s", c.Name, columnTypeLabel(c), c.Flags())
  114. }
  115. // columnTypeLabel 列类型的可读名: Decimal 带上小数位 (decimal(2)), 其余用 TypeName。
  116. func columnTypeLabel(c Column) string {
  117. if c.Type == types.FieldType_Decimal {
  118. return fmt.Sprintf("decimal(%d)", c.Param)
  119. }
  120. return TypeName(c.Type)
  121. }
  122. // TypeName VRTX 类型的可读名字 (与 types 注册表里的名字同源; 写进 __vrtx_meta)。
  123. func TypeName(t types.FieldType) string {
  124. switch t {
  125. case types.FieldType_Bool:
  126. return "bool"
  127. case types.FieldType_Uint8:
  128. return "uint8"
  129. case types.FieldType_Int8:
  130. return "int8"
  131. case types.FieldType_Uint16:
  132. return "uint16"
  133. case types.FieldType_Int16:
  134. return "int16"
  135. case types.FieldType_Year:
  136. return "year"
  137. case types.FieldType_Uint32:
  138. return "uint32"
  139. case types.FieldType_Int32:
  140. return "int32"
  141. case types.FieldType_Float32:
  142. return "float32"
  143. case types.FieldType_Uint64:
  144. return "uint64"
  145. case types.FieldType_Int64:
  146. return "int64"
  147. case types.FieldType_Float64:
  148. return "float64"
  149. case types.FieldType_Int128:
  150. return "int128"
  151. case types.FieldType_UUID:
  152. return "uuid"
  153. case types.FieldType_Decimal:
  154. return "decimal"
  155. case types.FieldType_String:
  156. return "string"
  157. case types.FieldType_Dynamicbyte:
  158. return "dynamic"
  159. case types.FieldType_Blob:
  160. return "blob"
  161. }
  162. return fmt.Sprintf("unknown(%d)", byte(t))
  163. }
  164. // IndexSchema 索引定义。
  165. //
  166. // Type 直接用引擎的 page.IndexType, 不另造一套枚举: 跨库往返时 Hash / BTree / 时序
  167. // 的差异本来就要记 (SQL 侧只分"索引"), 记在 __vrtx_meta 里回来还原, 比自定义枚举
  168. // 少一层翻译。
  169. type IndexSchema struct {
  170. Name string
  171. Type page.IndexType
  172. Columns []string
  173. // Unique 唯一索引: 同一索引键只允许一行 (NULL 免除 —— 任一分量为 NULL 的
  174. // 行不进该索引, 与 core.IndexFlagUnique 的语义完全一致)。
  175. //
  176. // SQL 侧只有"唯一索引"这一个结构对应物, 不给它, 把 VRTX 的唯一约束导出到
  177. // SQL 就只剩一条普通索引: 重复值随便进, 再导回 VRTX 时约束已经悄悄没了 ——
  178. // 结构变了却没人报错, 所以这个标记必须往返 (__vrtx_meta 里也存一份)。
  179. Unique bool
  180. }
  181. // IsRowStore 是否承载行数据本身 (VRTX 的主键索引 / 时序索引), 即 SQL 侧的主键。
  182. func (i IndexSchema) IsRowStore() bool {
  183. return i.Type == page.IndexTypePrimary || i.Type == page.IndexTypeTime
  184. }
  185. // SameColumns 分量列表是否一致 (顺序敏感)。
  186. func (i IndexSchema) SameColumns(cols []string) bool {
  187. if len(i.Columns) != len(cols) {
  188. return false
  189. }
  190. for k := range cols {
  191. if i.Columns[k] != cols[k] {
  192. return false
  193. }
  194. }
  195. return true
  196. }
  197. func (i IndexSchema) String() string {
  198. kind := IndexTypeName(i.Type)
  199. if i.Unique {
  200. kind += " unique"
  201. }
  202. return fmt.Sprintf("%s(%s) [%s]", i.Name, strings.Join(i.Columns, ","), kind)
  203. }
  204. // IndexTypeName 索引类型的可读名字 (与 page.IndexType 对齐)。
  205. func IndexTypeName(t page.IndexType) string {
  206. switch t {
  207. case page.IndexTypeTime:
  208. return "time"
  209. case page.IndexTypePrimary:
  210. return "primary"
  211. case page.IndexTypeStr:
  212. return "str"
  213. case page.IndexTypeCompose:
  214. return "compose"
  215. case page.IndexTypeBTree:
  216. return "btree"
  217. case page.IndexTypeHash:
  218. return "hash"
  219. }
  220. return fmt.Sprintf("unknown(%d)", byte(t))
  221. }
  222. // TableSchema 一张表的完整结构。
  223. type TableSchema struct {
  224. Name string
  225. Columns []Column
  226. // PKColumn 主键列名。它同时是"行号列": VRTX 的行数据以 pkID 定位, 这个列就是
  227. // pkID 的镜像, 导出到 SQL 时充当 PRIMARY KEY。空表示源表没有主键 (SQL 侧无
  228. // PRIMARY KEY), 目标 VRTX 表只能由引擎分配行号。
  229. PKColumn string
  230. // Indexes 不含主键索引本身 (主键由 PKColumn + PKIndexType 表达)。
  231. Indexes []IndexSchema
  232. // PKIndexType 行存储索引在 VRTX 里的类型: primary (普通自增主键) 或 time (时序)。
  233. // 从 SQL 导入时按 primary 处理, 除非 __vrtx_meta 里记着 time。
  234. PKIndexType page.IndexType
  235. // RowStoreColumns 行存储索引的分量列 (VRTX 侧建索引时用)。
  236. //
  237. // 为空时就是 [PKColumn]; 只有时序索引会显式给出: 它的键是时间列, 既不能当
  238. // SQL 主键也不能承载行号, 于是 PKColumn 留空 (SQL 侧不设主键), 行存储索引
  239. // 靠这个字段记住要建在哪些列上。
  240. RowStoreColumns []string
  241. // PKIndexName 行存储索引名 (VRTX 侧默认 pk_<表名>)。SQL 侧主键索引固定叫 PRIMARY,
  242. // 这个名字只在"往 VRTX 建表"时用得上, 靠 __vrtx_meta 带回来。
  243. PKIndexName string
  244. // Rows 源表行数估计, 仅供计划展示 (以真实扫描计数为准)。
  245. Rows uint64
  246. // Synthetic 记录"源表里没有、由迁移过程补出来的列"。
  247. // 读端扫描时必须跳过它们 (SQL 上 SELECT 一个不存在的列会直接报错),
  248. // 写端则要在写入时给它们填值 (填行号)。
  249. Synthetic map[string]bool
  250. // SkippedIndexes 目标端建不出来的索引, 形如 "idx_ctime: 键列 ctime 是动态列"。
  251. // 由 Sink 建表时填: 源库里合法的索引在目标端可能无处安放 (VRTX 的行内只存
  252. // 动态列的堆引用, 不能拿它当索引键)。静默丢索引等于悄悄改结构, 所以记下来
  253. // 报给用户 —— 而不是让整张表跟着失败。
  254. SkippedIndexes []string
  255. // CappedColumns 源库里声明了超过 VRTX 单值上限 (types.MaxStringSize) 的列,
  256. // 形如 "Note: 声明容量 60000 字节超过单值上限 16360 字节 (...)"。
  257. //
  258. // 由读端填 (只有它拿得到 SQL 的声明原文, 见 capacityNote): 声明 varchar(60000)
  259. // 的列落到 VRTX 只能是动态列, 而动态列装不下那么多 —— 声明兑现不了。这与
  260. // SkippedIndexes 是同一条原则: 静默把容量改小等于悄悄改结构, 必须报出来,
  261. // 但也不该让整张表的数据陪葬 (超限只是"这一列的上限比声明的小", 大部分数据照样迁得动)。
  262. CappedColumns []string
  263. // DegradedColumns 源库里能建、但到 VRTX 只能【降级表达】因而语义变了的列,
  264. // 形如 "Amount: DECIMAL(65,30) 无法精确表达 (精度 65 超过上限 38), 已退化成 float64"。
  265. //
  266. // 与 CappedColumns 的分工: 那个是"类型不变、上限变小"; 这个是"类型都换了"。
  267. // 同样由读端填 (只有它拿得到 SQL 的声明原文, 见 degradeNote), 同样只报不拒 ——
  268. // 降级后的列照样装得下数据, 只是比较/聚合语义与原库不同 (定点 vs 浮点)。
  269. DegradedColumns []string
  270. // PKNote 源表有主键、但这个主键 VRTX 承载不了时的说明 (目前只有复合主键)。
  271. //
  272. // 读端在放弃 PKColumn 时必须填: "主键是哪几列"这个信息只存在于读端, 到了下游就只剩
  273. // 一个空的 PKColumn —— 再报"源表没有主键"就是假消息 (源表明明有主键, 只是多列)。
  274. PKNote string
  275. // SourcePKColumn 源库的主键列名 —— 仅在它【承载不了行号】、被降级成普通列时填
  276. // (见 run.go 的降级分支: MySQL 的 int(11) 主键只有 4 字节, VRTX 的行号是 8 字节)。
  277. //
  278. // 为什么非要单独存: 那种情况下 PKColumn 已经换成补出来的 _id, 而 _id 是引擎分配的行号,
  279. // 跟源库的行对不上号 —— 于是写失败时只能报"批内第 N 行", 用户还得自己回源库猜。原主键
  280. // 列虽然降成了普通列, 但它的值照样在行数据里, 记下这个列名就能把源库真认得的
  281. // "id = 12345" 报出来。降级说明 (DegradedColumns) 是给人看的散文, 这个字段是给代码用的。
  282. SourcePKColumn string
  283. }
  284. // MarkSynthetic 标记一列是迁移过程补出来的。
  285. func (s *TableSchema) MarkSynthetic(name string) {
  286. if s.Synthetic == nil {
  287. s.Synthetic = map[string]bool{}
  288. }
  289. s.Synthetic[name] = true
  290. }
  291. // IsSynthetic 该列是否为迁移过程补出来的。
  292. func (s *TableSchema) IsSynthetic(name string) bool {
  293. return s.Synthetic[name]
  294. }
  295. // ColumnIdx 按列名找下标 (大小写敏感 —— VRTX 列名就是 Go 字段名, 不做转换)。
  296. func (s *TableSchema) ColumnIdx(name string) (int, bool) {
  297. for i := range s.Columns {
  298. if s.Columns[i].Name == name {
  299. return i, true
  300. }
  301. }
  302. return -1, false
  303. }
  304. // HasColumn 列是否存在。
  305. func (s *TableSchema) HasColumn(name string) bool {
  306. _, ok := s.ColumnIdx(name)
  307. return ok
  308. }
  309. // Clone 深拷贝 (迁移过程中会往 schema 里补列, 不能污染调用方那份)。
  310. func (s *TableSchema) Clone() *TableSchema {
  311. c := *s
  312. c.Columns = append([]Column(nil), s.Columns...)
  313. c.RowStoreColumns = append([]string(nil), s.RowStoreColumns...)
  314. c.Indexes = make([]IndexSchema, len(s.Indexes))
  315. for i, idx := range s.Indexes {
  316. idx.Columns = append([]string(nil), idx.Columns...)
  317. c.Indexes[i] = idx
  318. }
  319. if s.Synthetic != nil {
  320. c.Synthetic = make(map[string]bool, len(s.Synthetic))
  321. for k, v := range s.Synthetic {
  322. c.Synthetic[k] = v
  323. }
  324. }
  325. c.SkippedIndexes = append([]string(nil), s.SkippedIndexes...)
  326. c.CappedColumns = append([]string(nil), s.CappedColumns...)
  327. c.DegradedColumns = append([]string(nil), s.DegradedColumns...)
  328. c.PKNote = s.PKNote
  329. return &c
  330. }
  331. // RowStore 行存储索引要建的列: 未显式指定时就是 [PKColumn]。
  332. func (s *TableSchema) RowStore() []string {
  333. if len(s.RowStoreColumns) > 0 {
  334. return s.RowStoreColumns
  335. }
  336. if s.PKColumn == "" {
  337. return nil
  338. }
  339. return []string{s.PKColumn}
  340. }
  341. // Describe 多行结构摘要 (CLI -list / 日志用)。
  342. func (s *TableSchema) Describe() string {
  343. var b strings.Builder
  344. fmt.Fprintf(&b, "表 %s (%d 列, 主键 %s[%s])\n", s.Name, len(s.Columns), orNone(s.PKColumn), IndexTypeName(s.PKIndexType))
  345. for _, c := range s.Columns {
  346. mark := " "
  347. if c.Name == s.PKColumn {
  348. mark = "PK"
  349. }
  350. fmt.Fprintf(&b, " %s %-28s %s%s\n", mark, c.Name, columnTypeLabel(c), c.Flags())
  351. }
  352. for _, idx := range s.Indexes {
  353. fmt.Fprintf(&b, " IDX %-27s %s\n", idx.String(), "")
  354. }
  355. return b.String()
  356. }
  357. func orNone(s string) string {
  358. if s == "" {
  359. return "<无>"
  360. }
  361. return s
  362. }
  363. // Row 一行数据。Values 与 TableSchema.Columns 同序同长。
  364. //
  365. // PK 是"行主键号": VRTX 侧就是 pkID, SQL 侧是主键列的整数值。HasPK=false 表示这行
  366. // 没有可用主键 (源表无主键, 或主键列为空), 目标侧自行分配。
  367. type Row struct {
  368. PK uint64
  369. HasPK bool
  370. Values []any
  371. }
  372. // Source 读端。
  373. type Source interface {
  374. Kind() Kind
  375. // Identity 唯一标识这个库 (路径 / DSN), 用于拦住 src==dst 的自杀式迁移。
  376. Identity() string
  377. // Tables 列出可迁移的表 (不含内部表)。
  378. Tables() ([]string, error)
  379. // Schema 读一张表的结构。
  380. Schema(table string) (*TableSchema, error)
  381. // Scan 流式扫描整表, 每行回调一次 (Row.Values 与 s.Columns 同序)。
  382. //
  383. // 用回调而不是 Next() 迭代器: core 的扫描本身就是回调式、无法中途暂停,
  384. // 而 SQL 侧 rows.Next() 也天然适配 —— 编排器在回调里攒够一批就写, 内存
  385. // 占用与表的大小无关。回调返回 error 会立刻中止扫描并原样返回。
  386. Scan(table string, s *TableSchema, fn func(Row) error) error
  387. Close() error
  388. }
  389. // Sink 写端。
  390. type Sink interface {
  391. Kind() Kind
  392. Identity() string
  393. // Exists 目标表是否已存在。
  394. Exists(table string) (bool, error)
  395. // CreateTable 建表 + 建索引 (含主键)。recreate=true 时先 DROP。
  396. CreateTable(s *TableSchema, recreate bool) error
  397. // Open 准备写入 (建 prepared statement / 开事务), 调用方负责 Close。
  398. Open(table string, s *TableSchema) (RowWriter, error)
  399. Close() error
  400. }
  401. // RowWriter 批量写入器。
  402. type RowWriter interface {
  403. // Write 写一批行 (行数由 Options.Batch 控制); 实现内部可自行分事务提交。
  404. Write(rows []Row) error
  405. // Close 落盘并结束 (VRTX 侧是 Commit, SQL 侧是提交事务)。
  406. Close() error
  407. }
  408. // Discarder 写入器的可选接口: 放弃尚未提交的内容 (出错路径专用)。
  409. //
  410. // 为什么需要它: Close 是【成功语义】(SQL 侧 flush 剩余缓冲 + Commit)。扫描中途失败
  411. // 或 flush 出错时再用 Close 收尾, 等于把半截数据当成功提交 —— 调用方拿到错误、以为
  412. // 这张表没进去, 库里却已经躺了半张表。实现 Discarder 后, 出错路径会走 Discard
  413. // (SQL 侧 Rollback), 缓冲区里那批行原样丢弃。
  414. //
  415. // 未实现的写入器 (如 VRTX) 仍退回 Close: 它的 Close 不提交 (提交由 Committer 在
  416. // 整表成功后单独调用), 所以没有这个问题。
  417. type Discarder interface {
  418. // Discard 丢弃当前事务与缓冲区里尚未提交的行。
  419. Discard() error
  420. }
  421. // Options 迁移选项。
  422. //
  423. // 用法约定: 从 DefaultOptions() 出发改自己关心的字段。
  424. //
  425. // opts := migrate.DefaultOptions()
  426. // opts.Recreate = true
  427. // migrate.Run(src, dst, opts)
  428. //
  429. // Run(src, dst, nil) 等价于传 DefaultOptions()。直接传裸 &Options{} 是"激进档":
  430. // 不建表、不写保真表、不做值校验 —— 给已经有目标表的批处理脚本用。
  431. type Options struct {
  432. // Tables 只迁这些表; 空 = 源库全部表。
  433. Tables []string
  434. // Create 目标表不存在时建表。
  435. Create bool
  436. // Recreate 目标表已存在时先 DROP 再建 (false: 复用已有表并追加数据)。
  437. Recreate bool
  438. // Batch 一次写入的行数, 也是 SQL 侧每次提交的行数 (<=0 取 500)。
  439. Batch int
  440. // EmbedMeta 向 SQL 侧写 __vrtx_meta 保真表 (回来时能还原定长档位与索引类型)。
  441. EmbedMeta bool
  442. // AutoPK 源表没有整数主键时, 让目标 VRTX 表按引擎自增号分配 (false: 报错)。
  443. AutoPK bool
  444. // ForceInspect VRTX 端打开时启用抢救模式: 头页校验失败仍只读打开 (写禁用)。
  445. // 只影响 vrtx: 源/目标, 供头页损坏后抢救数据。
  446. ForceInspect bool
  447. // Limit 每张表最多迁移多少行 (0 = 不限, 便于先试跑)。
  448. Limit uint64
  449. // StrictValue 值装不进目标列时报错 (false: 按 VRTX 语义静默截断, 会丢数据)。
  450. StrictValue bool
  451. // TruncateOversize 动态列的值超过【单值上限】(types.MaxStringSize, 即引擎的
  452. // core.MaxBlobSize, 当前 16360 字节) 时截到上限继续写, 并逐行报出截了什么。
  453. // false (默认) 时报错, 不丢一个字节。
  454. //
  455. // 与 StrictValue 的分工: StrictValue 管"值装不进这一列的宽度"(定长列声明多宽就多宽,
  456. // 截断后仍合原列的声明); 这个管"值超过引擎单个动态值能装的上限"。后者是引擎当下的
  457. // 能力边界: Dynamicbyte 的内容整块落进一个堆页, 多页分块存储尚未实现 —— 也就是说
  458. // 这跟源库怎么声明该列无关, 一个本来合法的值照样会卡在这里 (见 capacityNote 里那条
  459. // "容量封顶"的提示)。
  460. //
  461. // 只管 Dynamicbyte: blob 列 (FieldType_Blob) 的内容落在可跨页的链上 (单值约 4GB),
  462. // 不受这里的单堆页上限约束, 也不需要这个开关兜底。
  463. //
  464. // 这是【明确可选的数据丢失】, 所以默认关着: 打开之后每截一行报一行 (表 / 行标识 /
  465. // 列名 / 原长 / 截后长), 用户据此回源库补那一行的内容, 而不用满表翻。文本列会退到
  466. // UTF-8 字符边界再截, 不留半个汉字。
  467. TruncateOversize bool
  468. // DryRun 只读结构不搬数据。
  469. DryRun bool
  470. // ContinueOnError 单张表迁移失败时跳过它、继续迁其余表 (false: 第一个错误就整体中止)。
  471. // 失败的表会记进 TableReport.Error, 全部跑完后 Run 仍返回一个汇总错误 ——
  472. // 继续不等于吞掉错误。
  473. ContinueOnError bool
  474. // SchemaOnly 只同步结构 (建表 + 建索引), 不搬数据 —— 两阶段迁移的第一步。
  475. SchemaOnly bool
  476. // EachRow 每读到一行就回调一次 (表名, 该表累计行数, 该行)。
  477. // 给"看得见每一行在流动"的界面用; 开销随行数线性上涨, 大表慎用, nil 即关闭。
  478. EachRow func(table string, n uint64, row Row)
  479. // Verbose 打印每张表的进度。
  480. Verbose bool
  481. // Log 日志输出; nil 时用 log.Printf。
  482. Log func(format string, args ...any)
  483. // Progress 迁移中途的进度回调 (表名, 已写行数, 已用时), 按秒级节流地调。
  484. // 界面靠它原地刷一行 —— 否则百万行的表只有"开始"和"结束"两条日志,
  485. // 看起来和死锁没区别。nil 时退回 Verbose 文本 (CLI -v)。
  486. Progress func(table string, rows uint64, elapsed time.Duration)
  487. }
  488. // DefaultOptions 默认档: 建表 + 全表 + 批 500 + 写保真表 + 严格校验。
  489. func DefaultOptions() *Options {
  490. return &Options{
  491. Create: true,
  492. EmbedMeta: true,
  493. StrictValue: true,
  494. Batch: 500,
  495. }
  496. }
  497. // normalized 把 nil 当成 DefaultOptions() (Options 里的开关都是 bool, 没法在事后
  498. // 区分"没设过"和"显式设成 false", 所以只能在这一层兜底), 并补上 Batch 这类数值型
  499. // 默认值 —— 调用方显式设过的开关一律不动。
  500. func (o *Options) normalized() *Options {
  501. if o == nil {
  502. return DefaultOptions()
  503. }
  504. out := *o
  505. if out.Batch <= 0 {
  506. out.Batch = 500
  507. }
  508. return &out
  509. }
  510. // wants 表是否在本次迁移范围内。
  511. func (o *Options) wants(table string) bool {
  512. if len(o.Tables) == 0 {
  513. return true
  514. }
  515. for _, t := range o.Tables {
  516. if t == table {
  517. return true
  518. }
  519. }
  520. return false
  521. }
  522. // Wants 表是否在本次迁移范围内 (与内部同一套判断; 供 CLI / 调用方预筛表用)。
  523. func (o *Options) Wants(table string) bool { return o.wants(table) }
  524. func (o *Options) logf(format string, args ...any) {
  525. if o.Log != nil {
  526. o.Log(format, args...)
  527. return
  528. }
  529. log.Printf(format, args...)
  530. }
  531. // vlogf 只在 Verbose 打开时说话 (进度类信息, 默认安静)。
  532. func (o *Options) vlogf(format string, args ...any) {
  533. if o.Verbose {
  534. o.logf(format, args...)
  535. }
  536. }
  537. // progress 报一次"这张表迁到哪儿了"。结构化回调优先 —— 界面要原地刷新一行,
  538. // 不该去解析文本; 没有回调时退化成 Verbose 文本, CLI 开着 -v 照样看得见。
  539. func (o *Options) progress(table string, rows uint64, elapsed time.Duration) {
  540. if o.Progress != nil {
  541. o.Progress(table, rows, elapsed)
  542. return
  543. }
  544. o.vlogf("[migrate] 表 %s: 已写 %d 行 (%s)", table, rows, elapsed.Round(time.Millisecond))
  545. }
  546. // TableReport 单表迁移结果。
  547. type TableReport struct {
  548. Table string
  549. Rows uint64
  550. Indexes int
  551. Columns int
  552. Elapsed time.Duration
  553. Skipped bool
  554. Note string
  555. // Error 非空表示这张表失败了 (无论这趟是跳过它继续、还是就此中止, 原因都在)。
  556. // 此时 Rows 是失败前已经写进去的行数。
  557. Error string
  558. }
  559. // Report 整体结果。
  560. type Report struct {
  561. From Kind
  562. To Kind
  563. Tables []TableReport
  564. Rows uint64
  565. Elapsed time.Duration
  566. }
  567. // Line 单行摘要 (CLI 输出)。
  568. func (r *Report) Line(tr TableReport) string {
  569. s := fmt.Sprintf("%-24s %8d 行 %3d 列 %2d 索引 %8s", tr.Table, tr.Rows, tr.Columns, tr.Indexes, tr.Elapsed.Round(time.Millisecond))
  570. if tr.Skipped {
  571. s += " [跳过]"
  572. }
  573. if tr.Error != "" {
  574. s += " [失败] " + tr.Error
  575. }
  576. if tr.Note != "" {
  577. s += " " + tr.Note
  578. }
  579. return s
  580. }
  581. // Failed 报告里失败的表数 (用它快速判断这趟是否干净)。
  582. func (r *Report) Failed() int {
  583. n := 0
  584. for _, tr := range r.Tables {
  585. if tr.Error != "" {
  586. n++
  587. }
  588. }
  589. return n
  590. }
  591. // String 整份报告的文本形式 (逐表一行 + 汇总)。
  592. func (r *Report) String() string {
  593. var b strings.Builder
  594. for _, tr := range r.Tables {
  595. b.WriteString(r.Line(tr))
  596. b.WriteByte('\n')
  597. }
  598. fmt.Fprintf(&b, "%s → %s: %d 张表 / %d 行, 用时 %s",
  599. r.From, r.To, len(r.Tables), r.Rows, r.Elapsed.Round(time.Millisecond))
  600. if n := r.Failed(); n > 0 {
  601. fmt.Fprintf(&b, " (%d 张失败)", n)
  602. }
  603. return b.String()
  604. }