midway-fatcms 0.0.7 → 0.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (159) hide show
  1. package/.qoder/skills/midway-fatcms/01-quick-start.md +231 -0
  2. package/.qoder/skills/midway-fatcms/02-crud-quick.md +375 -0
  3. package/.qoder/skills/midway-fatcms/03-crud-sharding.md +489 -0
  4. package/.qoder/skills/midway-fatcms/04-condition-operators.md +93 -0
  5. package/.qoder/skills/midway-fatcms/05-configuration.md +290 -0
  6. package/.qoder/skills/midway-fatcms/06-builtin-functions.md +241 -0
  7. package/.qoder/skills/midway-fatcms/07-examples.md +504 -0
  8. package/.qoder/skills/midway-fatcms/SKILL.md +96 -0
  9. package/README.md +9 -9
  10. package/dist/configuration.d.ts +10 -0
  11. package/dist/configuration.js +26 -0
  12. package/dist/controller/base/BaseApiController.d.ts +1 -2
  13. package/dist/controller/base/BaseApiController.js +0 -4
  14. package/dist/controller/gateway/DocGatewayController.js +1 -1
  15. package/dist/controller/helpers.controller.d.ts +6 -0
  16. package/dist/controller/helpers.controller.js +19 -0
  17. package/dist/controller/manage/FlowConfigManageApi.js +4 -2
  18. package/dist/controller/manage/SysConfigMangeApi.js +6 -1
  19. package/dist/controller/manage/UserAccountManageApi.js +7 -2
  20. package/dist/index.d.ts +2 -2
  21. package/dist/index.js +2 -2
  22. package/dist/libs/crud-pro/CrudPro.d.ts +51 -3
  23. package/dist/libs/crud-pro/CrudPro.js +111 -4
  24. package/dist/libs/crud-pro/exceptions.d.ts +7 -0
  25. package/dist/libs/crud-pro/exceptions.js +7 -0
  26. package/dist/libs/crud-pro/interfaces.d.ts +83 -12
  27. package/dist/libs/crud-pro/models/CrudResult.d.ts +116 -0
  28. package/dist/libs/crud-pro/models/CrudResult.js +126 -0
  29. package/dist/libs/crud-pro/models/RequestModel.d.ts +2 -2
  30. package/dist/libs/crud-pro/models/ServiceHub.d.ts +2 -0
  31. package/dist/libs/crud-pro/services/CrudProDataTypeConvertService.d.ts +70 -2
  32. package/dist/libs/crud-pro/services/CrudProDataTypeConvertService.js +205 -13
  33. package/dist/libs/crud-pro/services/CrudProExecuteSqlService.js +36 -2
  34. package/dist/libs/crud-pro/services/CrudProGenSqlCondition.js +8 -4
  35. package/dist/libs/crud-pro/services/CrudProTableMetaService.d.ts +36 -0
  36. package/dist/libs/crud-pro/services/CrudProTableMetaService.js +97 -4
  37. package/dist/libs/crud-pro/services/CurdProServiceHub.d.ts +2 -0
  38. package/dist/libs/crud-pro/services/CurdProServiceHub.js +6 -0
  39. package/dist/libs/crud-pro-quick/CrudProQuick.d.ts +382 -0
  40. package/dist/libs/crud-pro-quick/CrudProQuick.js +689 -0
  41. package/dist/libs/crud-pro-quick/fixSoftDelete.d.ts +30 -0
  42. package/dist/{service/curd → libs/crud-pro-quick}/fixSoftDelete.js +3 -6
  43. package/dist/libs/crud-pro-quick/index.d.ts +36 -0
  44. package/dist/libs/crud-pro-quick/index.js +49 -0
  45. package/dist/libs/crud-pro-quick/models.d.ts +33 -0
  46. package/dist/libs/crud-pro-quick/models.js +2 -0
  47. package/dist/libs/crud-sharding/ShardingBase.d.ts +78 -0
  48. package/dist/libs/crud-sharding/ShardingBase.js +179 -0
  49. package/dist/libs/crud-sharding/ShardingByCustomCrud.d.ts +35 -0
  50. package/dist/libs/crud-sharding/ShardingByCustomCrud.js +297 -0
  51. package/dist/libs/crud-sharding/ShardingByHashCrud.d.ts +38 -0
  52. package/dist/libs/crud-sharding/ShardingByHashCrud.js +86 -0
  53. package/dist/libs/crud-sharding/ShardingByKeyCrud.d.ts +39 -0
  54. package/dist/libs/crud-sharding/ShardingByKeyCrud.js +74 -0
  55. package/dist/libs/crud-sharding/ShardingByTimeCrud.d.ts +66 -0
  56. package/dist/libs/crud-sharding/ShardingByTimeCrud.js +524 -0
  57. package/dist/libs/crud-sharding/ShardingConfig.d.ts +25 -10
  58. package/dist/libs/crud-sharding/ShardingConfig.js +5 -5
  59. package/dist/libs/crud-sharding/ShardingMerger.d.ts +10 -18
  60. package/dist/libs/crud-sharding/ShardingMerger.js +27 -44
  61. package/dist/libs/crud-sharding/ShardingResult.d.ts +33 -0
  62. package/dist/libs/crud-sharding/ShardingResult.js +16 -0
  63. package/dist/libs/crud-sharding/ShardingTableCreator.d.ts +21 -4
  64. package/dist/libs/crud-sharding/ShardingTableCreator.js +193 -59
  65. package/dist/libs/crud-sharding/ShardingUtils.d.ts +48 -0
  66. package/dist/libs/crud-sharding/ShardingUtils.js +122 -1
  67. package/dist/libs/crud-sharding/TIME_COLUMN_CLEAN_SPEC.md +488 -0
  68. package/dist/libs/crud-sharding/index.d.ts +13 -15
  69. package/dist/libs/crud-sharding/index.js +33 -17
  70. package/dist/models/RedisKeys.d.ts +1 -0
  71. package/dist/models/RedisKeys.js +1 -0
  72. package/dist/models/bizmodels.d.ts +2 -6
  73. package/dist/service/SysAppService.d.ts +2 -2
  74. package/dist/service/SysAppService.js +16 -5
  75. package/dist/service/SysConfigService.d.ts +1 -1
  76. package/dist/service/SysConfigService.js +7 -2
  77. package/dist/service/SysDictDataService.js +14 -4
  78. package/dist/service/SysMenuService.js +7 -2
  79. package/dist/service/TableMetaCacheRedisSubscriber.d.ts +31 -0
  80. package/dist/service/TableMetaCacheRedisSubscriber.js +98 -0
  81. package/dist/service/curd/CurdMixService.d.ts +6 -4
  82. package/dist/service/curd/CurdMixService.js +16 -2
  83. package/dist/service/curd/CurdProService.d.ts +149 -29
  84. package/dist/service/curd/CurdProService.js +157 -38
  85. package/dist/service/flow/FlowConfigService.js +7 -2
  86. package/dist/service/flow/FlowInstanceCrudService.js +22 -19
  87. package/package.json +1 -1
  88. package/src/configuration.ts +27 -0
  89. package/src/controller/base/BaseApiController.ts +0 -5
  90. package/src/controller/gateway/DocGatewayController.ts +1 -1
  91. package/src/controller/helpers.controller.ts +15 -0
  92. package/src/controller/manage/CrudStandardDesignApi.ts +4 -3
  93. package/src/controller/manage/FlowConfigManageApi.ts +4 -2
  94. package/src/controller/manage/SysConfigMangeApi.ts +6 -1
  95. package/src/controller/manage/UserAccountManageApi.ts +7 -2
  96. package/src/index.ts +2 -2
  97. package/src/libs/crud-pro/CrudPro.ts +134 -7
  98. package/src/libs/crud-pro/exceptions.ts +8 -0
  99. package/src/libs/crud-pro/interfaces.ts +111 -15
  100. package/src/libs/crud-pro/models/CrudResult.ts +178 -0
  101. package/src/libs/crud-pro/models/RequestModel.ts +2 -2
  102. package/src/libs/crud-pro/models/ServiceHub.ts +4 -0
  103. package/src/libs/crud-pro/services/CrudProDataTypeConvertService.ts +238 -15
  104. package/src/libs/crud-pro/services/CrudProExecuteSqlService.ts +41 -2
  105. package/src/libs/crud-pro/services/CrudProGenSqlCondition.ts +11 -7
  106. package/src/libs/crud-pro/services/CrudProTableMetaService.ts +110 -3
  107. package/src/libs/crud-pro/services/CurdProServiceHub.ts +8 -0
  108. package/src/libs/crud-pro-quick/CrudProQuick.ts +782 -0
  109. package/src/{service/curd → libs/crud-pro-quick}/fixSoftDelete.ts +23 -13
  110. package/src/libs/crud-pro-quick/index.ts +52 -0
  111. package/src/libs/crud-pro-quick/models.ts +35 -0
  112. package/src/libs/crud-sharding/ShardingBase.ts +256 -0
  113. package/src/libs/crud-sharding/ShardingByCustomCrud.ts +329 -0
  114. package/src/libs/crud-sharding/ShardingByHashCrud.ts +111 -0
  115. package/src/libs/crud-sharding/ShardingByKeyCrud.ts +97 -0
  116. package/src/libs/crud-sharding/ShardingByTimeCrud.ts +628 -0
  117. package/src/libs/crud-sharding/ShardingConfig.ts +28 -10
  118. package/src/libs/crud-sharding/ShardingMerger.ts +35 -63
  119. package/src/libs/crud-sharding/ShardingResult.ts +29 -0
  120. package/src/libs/crud-sharding/ShardingTableCreator.ts +214 -71
  121. package/src/libs/crud-sharding/ShardingUtils.ts +137 -0
  122. package/src/libs/crud-sharding/TIME_COLUMN_CLEAN_SPEC.md +488 -0
  123. package/src/libs/crud-sharding/index.ts +30 -16
  124. package/src/models/RedisKeys.ts +1 -0
  125. package/src/models/bizmodels.ts +4 -7
  126. package/src/service/SysAppService.ts +18 -7
  127. package/src/service/SysConfigService.ts +8 -3
  128. package/src/service/SysDictDataService.ts +14 -4
  129. package/src/service/SysMenuService.ts +7 -2
  130. package/src/service/TableMetaCacheRedisSubscriber.ts +105 -0
  131. package/src/service/crudstd/CrudStdService.ts +2 -2
  132. package/src/service/curd/CurdMixService.ts +26 -5
  133. package/src/service/curd/CurdProService.ts +186 -45
  134. package/src/service/flow/FlowConfigService.ts +7 -2
  135. package/src/service/flow/FlowInstanceCrudService.ts +23 -20
  136. package/.qoder/skills/midway-fatcms-crud/SKILL.md +0 -375
  137. package/.qoder/skills/midway-fatcms-crud/examples.md +0 -990
  138. package/.qoder/skills/midway-fatcms-crud/reference.md +0 -568
  139. package/dist/libs/crud-pro/README.md +0 -809
  140. package/dist/libs/crud-pro/README_FUNC.md +0 -193
  141. package/dist/libs/crud-sharding/ROUTING_LOGIC.md +0 -944
  142. package/dist/libs/crud-sharding/ShardingCrudPro.d.ts +0 -363
  143. package/dist/libs/crud-sharding/ShardingCrudPro.js +0 -675
  144. package/dist/libs/crud-sharding/ShardingRouter.d.ts +0 -69
  145. package/dist/libs/crud-sharding/ShardingRouter.js +0 -377
  146. package/dist/models/StandardColumns.d.ts +0 -71
  147. package/dist/models/StandardColumns.js +0 -28
  148. package/dist/service/curd/CrudProQuick.d.ts +0 -190
  149. package/dist/service/curd/CrudProQuick.js +0 -319
  150. package/dist/service/curd/README.md +0 -1100
  151. package/dist/service/curd/fixSoftDelete.d.ts +0 -20
  152. package/src/libs/crud-pro/README.md +0 -809
  153. package/src/libs/crud-pro/README_FUNC.md +0 -193
  154. package/src/libs/crud-sharding/ROUTING_LOGIC.md +0 -944
  155. package/src/libs/crud-sharding/ShardingCrudPro.ts +0 -835
  156. package/src/libs/crud-sharding/ShardingRouter.ts +0 -512
  157. package/src/models/StandardColumns.ts +0 -76
  158. package/src/service/curd/CrudProQuick.ts +0 -360
  159. package/src/service/curd/README.md +0 -1100
@@ -1,835 +0,0 @@
1
- import { CrudPro } from '@/libs/crud-pro/CrudPro';
2
- import { IRequestModel, IRequestCfgModel } from '@/libs/crud-pro/interfaces';
3
- import { OrderByUtils } from '@/libs/crud-pro/utils/OrderByUtils';
4
- import { ExecuteContext } from '@/libs/crud-pro/models/ExecuteContext';
5
- import { KeysOfSimpleSQL } from '@/libs/crud-pro/models/keys';
6
- import { ShardingType, IShardingConfig, IShardingRouterContext } from './ShardingConfig';
7
- import { ShardingRouter, ITableInfoProvider } from './ShardingRouter';
8
- import { ShardingMerger, IShardingPageQueryResult } from './ShardingMerger';
9
- import { ShardingTableCreator } from './ShardingTableCreator';
10
- import { ShardingCountCache } from './ShardingCountCache';
11
-
12
- /**
13
- * 智能批量插入结果
14
- */
15
- export interface IShardingSmartBatchInsertResult {
16
- /** 总插入条数 */
17
- totalAffected: number;
18
- /** 各分表插入结果 */
19
- tableResults: Array<{
20
- table: string;
21
- affected: number;
22
- rowCount: number;
23
- }>;
24
- /** 涉及的分表数量 */
25
- tableCount: number;
26
- /** 是否全部成功 */
27
- success: boolean;
28
- /** 错误信息(如果有) */
29
- errors: Array<{ table: string; error: Error }>;
30
- }
31
-
32
- /**
33
- * 分表 CRUD 操作封装器
34
- *
35
- * 在 CrudPro 之上封装分表功能,不修改 CrudPro 内部代码。
36
- * 提供透明的分表路由和多表查询结果合并能力。
37
- *
38
- * 支持的分表策略:
39
- * - YEAR: 按年分表,如 order_2024, order_2025
40
- * - MONTH: 按月分表,如 order_202401, order_202402
41
- * - DAY: 按日分表,如 order_20240101
42
- * - RANGE: 按范围分表,如 user_0 ~ user_99
43
- * - HASH: 按哈希分表,如 order_01 ~ order_16
44
- * - CUSTOM: 自定义分表规则
45
- *
46
- * @example
47
- * // 按月分表
48
- * const sharding = new ShardingCrudPro(crudPro, {
49
- * type: ShardingType.MONTH,
50
- * baseTable: 't_order',
51
- * timeColumn: 'created_at',
52
- * });
53
- *
54
- * // 插入数据(自动路由到正确分表)
55
- * await sharding.insert({ data: { order_id: '001', amount: 100, created_at: '2024-03-15' } });
56
- *
57
- * // 分页查询(自动合并多表结果)
58
- * const result = await sharding.queryPage({
59
- * condition: { created_at: { $gte: '2024-01-01', $lte: '2024-03-31' } },
60
- * pageNo: 1,
61
- * pageSize: 10,
62
- * });
63
- */
64
- export class ShardingCrudPro {
65
- private readonly crudPro: CrudPro;
66
- private readonly config: IShardingConfig;
67
- private readonly router: ShardingRouter;
68
- private readonly merger: ShardingMerger;
69
- private readonly tableCreator: ShardingTableCreator;
70
-
71
- private baseCfg: Partial<IRequestCfgModel> = {};
72
-
73
- constructor(crudPro: CrudPro, config: IShardingConfig) {
74
- this.crudPro = crudPro;
75
- this.config = config;
76
-
77
- // 时间分表必须显式指定 timeColumn
78
- if ([ShardingType.YEAR, ShardingType.MONTH, ShardingType.DAY].includes(config.type)) {
79
- if (!config.timeColumn) {
80
- throw new Error('[ShardingCrudPro] 时间分表(YEAR/MONTH/DAY)必须显式指定 timeColumn 字段');
81
- }
82
- }
83
-
84
- this.router = new ShardingRouter();
85
- this.merger = new ShardingMerger();
86
- this.tableCreator = new ShardingTableCreator(crudPro, config);
87
-
88
- // 初始化 COUNT 缓存(如果配置了)
89
- if (config.countCache) {
90
- const countCache = new ShardingCountCache(
91
- config.type,
92
- config.baseTable,
93
- config.countCache.ttlSeconds,
94
- config.countCache.maxSize
95
- );
96
- this.merger.setCountCache(countCache);
97
- }
98
- }
99
-
100
- // ============ 配置方法 ============
101
-
102
- /**
103
- * 设置基础配置(会应用到所有操作)
104
- *
105
- * @param cfg 配置项,如 sqlDatabase、sqlDbType 等
106
- * @returns this,支持链式调用
107
- *
108
- * @example
109
- * sharding.setBaseCfg({
110
- * sqlDatabase: 'mydb',
111
- * sqlDbType: SqlDbType.mysql,
112
- * });
113
- */
114
- public setBaseCfg(cfg: Partial<IRequestCfgModel>): this {
115
- this.baseCfg = { ...this.baseCfg, ...cfg };
116
- return this;
117
- }
118
-
119
- /**
120
- * 获取分表配置
121
- */
122
- public getConfig(): IShardingConfig {
123
- return this.config;
124
- }
125
-
126
- // ============ 写操作(单表路由) ============
127
-
128
- /**
129
- * 插入数据
130
- *
131
- * 根据分表规则自动路由到目标分表。
132
- * 对于时间分表,需要确保 data 中包含时间字段。
133
- * 对于哈希/范围分表,需要确保 data 中包含分表字段。
134
- *
135
- * 如果目标分表不存在且配置了 autoCreateTable,会自动创建分表。
136
- *
137
- * @param reqJson 请求参数,data 为要插入的数据
138
- * @returns 执行上下文
139
- *
140
- * @example
141
- * await sharding.insert({
142
- * data: {
143
- * order_id: 'ORD001',
144
- * amount: 100,
145
- * created_at: '2024-03-15 10:00:00',
146
- * },
147
- * });
148
- */
149
- public async insert(reqJson: IRequestModel): Promise<ExecuteContext> {
150
- const targetTable = this.resolveSingleTable(reqJson, 'insert');
151
-
152
- // 确保分表存在(根据配置决定是否自动创建)
153
- await this.createShardingTableIfNeeded(targetTable);
154
-
155
- return this.executeOnTable(targetTable, reqJson, KeysOfSimpleSQL.SIMPLE_INSERT);
156
- }
157
-
158
- /**
159
- * 批量插入数据(支持跨分表)
160
- *
161
- * 自动将数据按分表分组,并行插入到对应的分表。
162
- *
163
- * @param reqJson 请求参数,data 为要插入的数据数组
164
- * @returns 批量插入结果
165
- *
166
- * 执行流程:
167
- * 1. 遍历所有数据,根据分表字段计算目标分表
168
- * 2. 将数据按分表分组
169
- * 3. 并行执行各分表的批量插入
170
- * 4. 汇总结果返回
171
- *
172
- * @example
173
- * // 数据分布在不同月份的分表
174
- * const result = await sharding.batchInsert({
175
- * data: [
176
- * { order_id: '001', amount: 100, created_at: '2024-01-15' }, // -> t_order_202401
177
- * { order_id: '002', amount: 200, created_at: '2024-01-20' }, // -> t_order_202401
178
- * { order_id: '003', amount: 150, created_at: '2024-02-10' }, // -> t_order_202402
179
- * { order_id: '004', amount: 300, created_at: '2024-03-05' }, // -> t_order_202403
180
- * ],
181
- * });
182
- *
183
- * console.log(result.totalAffected); // 4
184
- * console.log(result.tableCount); // 3
185
- * console.log(result.tableResults);
186
- * // [
187
- * // { table: 't_order_202401', affected: 2, rowCount: 2 },
188
- * // { table: 't_order_202402', affected: 1, rowCount: 1 },
189
- * // { table: 't_order_202403', affected: 1, rowCount: 1 },
190
- * // ]
191
- */
192
- public async batchInsert(reqJson: IRequestModel): Promise<IShardingSmartBatchInsertResult> {
193
- const dataArray = reqJson.data as Record<string, any>[];
194
-
195
- if (!Array.isArray(dataArray) || dataArray.length === 0) {
196
- return {
197
- totalAffected: 0,
198
- tableResults: [],
199
- tableCount: 0,
200
- success: true,
201
- errors: [],
202
- };
203
- }
204
-
205
- // 按分表分组
206
- const groupedData = this.batchInsertGroupDataByTable(dataArray);
207
-
208
- // 确保所有目标分表存在(根据配置决定是否自动创建)
209
- const tableNames = Array.from(groupedData.keys());
210
- for (let i = 0; i < tableNames.length; i++) {
211
- await this.createShardingTableIfNeeded(tableNames[i]);
212
- }
213
-
214
- // 并行执行各分表的批量插入
215
- const insertPromises = Array.from(groupedData.entries()).map(async ([table, items]) => {
216
- try {
217
- const ctx = await this.executeOnTable(table, { data: items }, KeysOfSimpleSQL.SIMPLE_BATCH_INSERT);
218
- return {
219
- table,
220
- affected: ctx.getResModelItem('affected') || items.length,
221
- rowCount: items.length,
222
- error: null as Error | null,
223
- };
224
- } catch (e) {
225
- return {
226
- table,
227
- affected: 0,
228
- rowCount: items.length,
229
- error: e as Error,
230
- };
231
- }
232
- });
233
-
234
- const results = await Promise.all(insertPromises);
235
-
236
- // 汇总结果
237
- const tableResults = results.map(r => ({
238
- table: r.table,
239
- affected: r.affected,
240
- rowCount: r.rowCount,
241
- }));
242
-
243
- const errors = results
244
- .filter(r => r.error !== null)
245
- .map(r => ({ table: r.table, error: r.error! }));
246
-
247
- const totalAffected = results.reduce((sum, r) => sum + r.affected, 0);
248
-
249
- return {
250
- totalAffected,
251
- tableResults,
252
- tableCount: groupedData.size,
253
- success: errors.length === 0,
254
- errors,
255
- };
256
- }
257
-
258
- /**
259
- * 更新数据
260
- *
261
- * 根据条件中的分表字段自动路由到目标分表。
262
- *
263
- * @param reqJson 请求参数,condition 为更新条件,data 为更新数据
264
- * @returns 执行上下文
265
- *
266
- * @example
267
- * await sharding.update({
268
- * condition: { order_id: 'ORD001', created_at: '2024-03-15' },
269
- * data: { amount: 200 },
270
- * });
271
- */
272
- public async update(reqJson: IRequestModel): Promise<ExecuteContext> {
273
- const targetTable = this.resolveSingleTable(reqJson, 'update');
274
- return this.executeOnTable(targetTable, reqJson, KeysOfSimpleSQL.SIMPLE_UPDATE);
275
- }
276
-
277
- /**
278
- * 删除数据
279
- *
280
- * 根据条件中的分表字段自动路由到目标分表。
281
- *
282
- * @param reqJson 请求参数,condition 为删除条件
283
- * @returns 执行上下文
284
- */
285
- public async delete(reqJson: IRequestModel): Promise<ExecuteContext> {
286
- const targetTable = this.resolveSingleTable(reqJson, 'delete');
287
- return this.executeOnTable(targetTable, reqJson, KeysOfSimpleSQL.SIMPLE_DELETE);
288
- }
289
-
290
- /**
291
- * 插入或更新(存在则更新,不存在则插入)
292
- *
293
- * 路由逻辑:根据 condition 路由(先查询是否存在)
294
- *
295
- * @param reqJson 请求参数
296
- * @returns 执行上下文
297
- */
298
- public async insertOrUpdate(reqJson: IRequestModel): Promise<ExecuteContext> {
299
- const targetTable = this.resolveSingleTable(reqJson, 'update'); // 使用 condition 路由
300
- return this.executeOnTable(targetTable, reqJson, KeysOfSimpleSQL.SIMPLE_INSERT_OR_UPDATE);
301
- }
302
-
303
- /**
304
- * 插入或更新(ON DUPLICATE KEY UPDATE)
305
- *
306
- * 路由逻辑:根据 condition 路由(先查询是否存在)
307
- *
308
- * @param reqJson 请求参数
309
- * @returns 执行上下文
310
- */
311
- public async insertOnDuplicateUpdate(reqJson: IRequestModel): Promise<ExecuteContext> {
312
- const targetTable = this.resolveSingleTable(reqJson, 'update'); // 使用 condition 路由
313
- return this.executeOnTable(targetTable, reqJson, KeysOfSimpleSQL.SIMPLE_INSERT_ON_DUPLICATE_UPDATE);
314
- }
315
-
316
- // ============ 查询操作(可能多表) ============
317
-
318
- /**
319
- * 查询单条记录
320
- *
321
- * 如果能根据条件确定单一分表,则查询单表;
322
- * 否则按顺序查询各分表,返回第一条匹配记录。
323
- *
324
- * @param reqJson 请求参数,condition 为查询条件
325
- * @returns 单条记录,未找到返回 null
326
- *
327
- * @example
328
- * const order = await sharding.queryOne({
329
- * condition: { order_id: 'ORD001' },
330
- * });
331
- */
332
- public async queryOne(reqJson: IRequestModel): Promise<any> {
333
- const targetTables = await this.resolveQueryTables(reqJson);
334
-
335
- if (targetTables.length === 0) {
336
- return null; // 无匹配表
337
- }
338
-
339
- // 多表:顺序查询,找到即返回
340
- for (const table of targetTables) {
341
- const result = await this.queryOneFromTable(table, reqJson);
342
- if (result) return result;
343
- }
344
- return null;
345
- }
346
-
347
- /**
348
- * 查询列表
349
- *
350
- * 可能涉及多个分表,结果会自动合并。
351
- *
352
- * 使用约束:
353
- * - 必须传 orderBy 参数
354
- * - orderBy 必须为 timeColumn DESC 或 timeColumn ASC(如 'created_at DESC' / 'created_at ASC')
355
- *
356
- * @param reqJson 请求参数
357
- * @returns 数据列表
358
- *
359
- * @example
360
- * const orders = await sharding.query({
361
- * condition: { created_at: { $gte: '2024-01-01', $lte: '2024-03-31' } },
362
- * orderBy: 'created_at DESC', // 或 'created_at ASC'
363
- * });
364
- */
365
- public async query(reqJson: IRequestModel): Promise<any[]> {
366
-
367
-
368
- const targetTables = await this.resolveQueryTables(reqJson);
369
-
370
- if (targetTables.length === 0) {
371
- return []; // 无匹配表,返回空结果
372
- }
373
-
374
- if (targetTables.length === 1) {
375
- const ctx = await this.executeOnTable(targetTables[0], reqJson, KeysOfSimpleSQL.SIMPLE_QUERY);
376
- return ctx.getResRows();
377
- }
378
-
379
- // 多表查询时,需要参数校验
380
- this.validateQueryOrderBy(reqJson);
381
-
382
- // 根据排序方向确定表顺序:DESC 新→旧,ASC 旧→新
383
- const tablesForMerge = this.sortTablesForOrderBy(targetTables, reqJson);
384
-
385
- // 多表查询合并
386
- return this.merger.mergeQuery(
387
- this.crudPro,
388
- tablesForMerge,
389
- reqJson,
390
- this.buildCfg(KeysOfSimpleSQL.SIMPLE_QUERY)
391
- );
392
- }
393
-
394
- /**
395
- * 分页查询
396
- *
397
- * 自动处理跨分表的分页:
398
- * 1. 顺序累计查询各分表
399
- * 2. 截取目标数据(无需排序)
400
- *
401
- * 使用约束:
402
- * - 必须传 orderBy 参数
403
- * - orderBy 必须为 timeColumn DESC 或 timeColumn ASC(如 'created_at DESC' / 'created_at ASC')
404
- *
405
- * @param reqJson 请求参数,包含 pageNo、pageSize 和 orderBy
406
- * @returns 分页结果,包含 rows 和 total_count
407
- *
408
- * @example
409
- * const result = await sharding.queryPage({
410
- * condition: { created_at: { $gte: '2024-01-01', $lte: '2024-03-31' } },
411
- * pageNo: 1,
412
- * pageSize: 10,
413
- * orderBy: 'created_at DESC', // 或 'created_at ASC'
414
- * });
415
- * console.log(result.rows, result.total_count);
416
- */
417
- public async queryPage(reqJson: IRequestModel): Promise<IShardingPageQueryResult> {
418
-
419
- const targetTables = await this.resolveQueryTables(reqJson);
420
-
421
- if (targetTables.length === 0) {
422
- return { rows: [], total_count: 0 }; // 无匹配表
423
- }
424
-
425
- if (targetTables.length === 1) {
426
- const ctx = await this.executeOnTable(targetTables[0], reqJson, KeysOfSimpleSQL.SIMPLE_QUERY_PAGE);
427
- return ctx.getResModelForQueryPage();
428
- }
429
-
430
- // 多表查询时,需要参数校验
431
- this.validateQueryOrderBy(reqJson);
432
-
433
- // 根据排序方向确定表顺序:DESC 新→旧,ASC 旧→新
434
- const tablesForMerge = this.sortTablesForOrderBy(targetTables, reqJson);
435
-
436
- // 多表分页查询:顺序累计
437
- return this.merger.mergePageQuery(
438
- this.crudPro,
439
- tablesForMerge,
440
- reqJson,
441
- this.buildCfg(KeysOfSimpleSQL.SIMPLE_QUERY_PAGE)
442
- );
443
- }
444
-
445
- /**
446
- * 查询记录总数
447
- *
448
- * 如果涉及多个分表,会并行查询各分表并汇总。
449
- *
450
- * @param reqJson 请求参数
451
- * @returns 记录总数
452
- */
453
- public async queryCount(reqJson: IRequestModel): Promise<number> {
454
- const targetTables = await this.resolveQueryTables(reqJson);
455
-
456
- if (targetTables.length === 0) {
457
- return 0; // 无匹配表
458
- }
459
-
460
- if (targetTables.length === 1) {
461
- const ctx = await this.executeOnTable(targetTables[0], reqJson, KeysOfSimpleSQL.SIMPLE_QUERY_COUNT);
462
- return ctx.getResModelItem('total_count') || 0;
463
- }
464
-
465
- // 多表统计:并行查询后求和
466
- const countPromises = targetTables.map(table =>
467
- this.queryCountFromTable(table, reqJson)
468
- );
469
- const counts = await Promise.all(countPromises);
470
- return counts.reduce((sum, c) => sum + c, 0);
471
- }
472
-
473
- /**
474
- * 判断记录是否存在
475
- *
476
- * 如果涉及多个分表,会并行查询,任一分表存在即返回 true。
477
- *
478
- * @param reqJson 请求参数
479
- * @returns 是否存在
480
- */
481
- public async isExist(reqJson: IRequestModel): Promise<boolean> {
482
- const targetTables = await this.resolveQueryTables(reqJson);
483
-
484
- if (targetTables.length === 0) {
485
- return false; // 无匹配表
486
- }
487
-
488
- if (targetTables.length === 1) {
489
- const ctx = await this.executeOnTable(targetTables[0], reqJson, KeysOfSimpleSQL.SIMPLE_QUERY_EXIST);
490
- return ctx.getResModelItem('is_exist') === true;
491
- }
492
-
493
- // 多表判断:任一表存在即返回 true
494
- const promises = targetTables.map(table =>
495
- this.isExistInTable(table, reqJson)
496
- );
497
- const results = await Promise.all(promises);
498
- return results.some(exists => exists);
499
- }
500
-
501
- // ============ 私有方法:分表路由 ============
502
-
503
- /**
504
- * 【batchInsert 专用】按分表对数据进行分组
505
- *
506
- * 仅用于 batchInsert 方法,遍历所有数据项,
507
- * 根据分表规则计算每条数据的目标分表,将相同分表的数据归为一组。
508
- *
509
- * @param dataArray 数据数组
510
- * @returns 分表 -> 数据列表 的映射
511
- */
512
- private batchInsertGroupDataByTable(dataArray: Record<string, any>[]): Map<string, Record<string, any>[]> {
513
- const groupedData = new Map<string, Record<string, any>[]>();
514
-
515
- for (const item of dataArray) {
516
- const targetTable = this.batchInsertResolveTableForData(item);
517
-
518
- if (!groupedData.has(targetTable)) {
519
- groupedData.set(targetTable, []);
520
- }
521
- groupedData.get(targetTable)!.push(item);
522
- }
523
-
524
- return groupedData;
525
- }
526
-
527
- private batchInsertResolveTableForData(item: Record<string, any>): string {
528
- const context: IShardingRouterContext = {
529
- config: this.config,
530
- data: item,
531
- };
532
-
533
- // 批量插入使用 resolveForInsert,确保返回单一表名
534
- return this.router.resolveForInsert(this.config, context);
535
- }
536
-
537
- /**
538
- * 解析单个目标表
539
- *
540
- * 写操作必须确定单一目标表,否则抛出异常。
541
- */
542
- private resolveSingleTable(
543
- reqJson: IRequestModel,
544
- operation: 'insert' | 'update' | 'delete'
545
- ): string {
546
- // insert 操作使用 resolveForInsert(从 data 提取字段)
547
- if (operation === 'insert') {
548
- const context: IShardingRouterContext = {
549
- config: this.config,
550
- data: reqJson.data as Record<string, any>,
551
- };
552
- return this.router.resolveForInsert(this.config, context);
553
- }
554
-
555
- // 其他操作使用 resolveForCondition(从 condition 提取字段)
556
- const context: IShardingRouterContext = {
557
- config: this.config,
558
- condition: reqJson.condition,
559
- };
560
- const result = this.router.resolveForCondition(this.config, context);
561
-
562
- if (Array.isArray(result)) {
563
- throw new Error(
564
- `[ShardingCrudPro] ${operation} 操作必须能确定单一目标表,` +
565
- `但分表规则返回了多个表: ${result.slice(0, 5).join(', ')}${result.length > 5 ? '...' : ''}。` +
566
- `请检查 condition 中是否包含分表字段(${this.getShardingColumnHint()})。`
567
- );
568
- }
569
-
570
- return result;
571
- }
572
-
573
- /**
574
- * 获取分表字段提示
575
- */
576
- private getShardingColumnHint(): string {
577
- if (this.config.type === ShardingType.RANGE || this.config.type === ShardingType.HASH) {
578
- return this.config.shardingColumn || '分表字段';
579
- }
580
- if ([ShardingType.YEAR, ShardingType.MONTH, ShardingType.DAY].includes(this.config.type)) {
581
- return this.config.timeColumn || 'created_at';
582
- }
583
- return '分表字段';
584
- }
585
-
586
- // ============ 私有方法:配置构建 ============
587
-
588
- /**
589
- * 构建配置
590
- */
591
- private buildCfg(sqlSimpleName: KeysOfSimpleSQL): IRequestCfgModel {
592
- return {
593
- ...this.baseCfg,
594
- sqlTable: this.config.baseTable,
595
- sqlSimpleName,
596
- };
597
- }
598
-
599
- // ============ 私有方法:执行操作 ============
600
-
601
- /**
602
- * 在指定表上执行操作
603
- */
604
- private async executeOnTable(
605
- table: string,
606
- reqJson: IRequestModel,
607
- sqlSimpleName: KeysOfSimpleSQL
608
- ): Promise<ExecuteContext> {
609
- const cfg = this.buildCfg(sqlSimpleName);
610
- cfg.sqlTable = table; // 替换为实际分表名
611
-
612
- return this.crudPro.executeCrudByCfg(reqJson, cfg);
613
- }
614
-
615
- /**
616
- * 从指定表查询单条
617
- */
618
- private async queryOneFromTable(table: string, reqJson: IRequestModel): Promise<any> {
619
- try {
620
- const ctx = await this.executeOnTable(table, reqJson, KeysOfSimpleSQL.SIMPLE_QUERY_ONE);
621
- return ctx.getOneObj();
622
- } catch (e) {
623
- // 表不存在时返回 null
624
- return null;
625
- }
626
- }
627
-
628
- /**
629
- * 从指定表查询数量
630
- */
631
- private async queryCountFromTable(table: string, reqJson: IRequestModel): Promise<number> {
632
- try {
633
- const ctx = await this.executeOnTable(table, reqJson, KeysOfSimpleSQL.SIMPLE_QUERY_COUNT);
634
- return ctx.getResModelItem('total_count') || 0;
635
- } catch (e) {
636
- // 表不存在时返回 0
637
- return 0;
638
- }
639
- }
640
-
641
- /**
642
- * 判断指定表中是否存在记录
643
- */
644
- private async isExistInTable(table: string, reqJson: IRequestModel): Promise<boolean> {
645
- try {
646
- const ctx = await this.executeOnTable(table, reqJson, KeysOfSimpleSQL.SIMPLE_QUERY_EXIST);
647
- return ctx.getResModelItem('is_exist') === true;
648
- } catch (e) {
649
- // 表不存在时返回 false
650
- return false;
651
- }
652
- }
653
-
654
- // ============ 表存在性检查和自动创建 ============
655
-
656
- /**
657
- * 获取数据库中真实存在的表名集合
658
- */
659
- private async getExistingTablesSet(): Promise<Set<string>> {
660
- const { sqlDatabase, sqlDbType } = this.baseCfg;
661
-
662
- if (!sqlDatabase || !sqlDbType) {
663
- throw new Error('[ShardingCrudPro] 未配置 sqlDatabase 或 sqlDbType');
664
- }
665
-
666
- const { tables } = await this.crudPro.getAllTableInfos({
667
- sqlDatabase,
668
- sqlDbType: sqlDbType as any,
669
- });
670
-
671
- return new Set(tables.map(t => t.name));
672
- }
673
-
674
- /**
675
- * 检查表是否存在
676
- */
677
- private async isTableExists(tableName: string): Promise<boolean> {
678
- const existingSet = await this.getExistingTablesSet();
679
- return existingSet.has(tableName);
680
- }
681
-
682
- /**
683
- * 创建分表(如果需要)
684
- *
685
- * 根据配置检查分表是否存在:
686
- * - 如果分表已存在,直接返回
687
- * - 如果分表不存在且 autoCreateTable=true,自动创建
688
- * - 如果分表不存在且 autoCreateTable=false,抛出异常
689
- *
690
- * @param tableName 目标分表名
691
- */
692
- private async createShardingTableIfNeeded(tableName: string): Promise<void> {
693
- // 检查表是否已存在
694
- if (await this.isTableExists(tableName)) {
695
- return;
696
- }
697
-
698
- // 根据配置决定是否自动创建
699
- if (!this.config.autoCreateTable) {
700
- throw new Error(`[ShardingCrudPro] 分表 ${tableName} 不存在。请先创建分表,或设置 autoCreateTable: true 自动创建`);
701
- }
702
-
703
- // 检查数据库配置
704
- if (!this.baseCfg.sqlDatabase || !this.baseCfg.sqlDbType) {
705
- throw new Error('[ShardingCrudPro] 请先调用 setBaseCfg 设置数据库配置');
706
- }
707
-
708
- // 执行创建
709
- const result = await this.tableCreator.createTableIfNeeded(
710
- tableName,
711
- {
712
- sqlDatabase: this.baseCfg.sqlDatabase,
713
- sqlDbType: this.baseCfg.sqlDbType,
714
- },
715
- this.config.tableCreateOptions
716
- );
717
-
718
- if (!result.success) {
719
- throw result.error || new Error(`[ShardingCrudPro] 创建分表 ${tableName} 失败`);
720
- }
721
- }
722
-
723
- // ============ 参数校验 ============
724
-
725
- /**
726
- * 校验查询参数的 orderBy 是否符合约束
727
- *
728
- * 约束条件:
729
- * - 必须传 orderBy 参数
730
- * - orderBy 必须为 timeColumn DESC 或 timeColumn ASC(如 'created_at DESC' / 'created_at ASC')
731
- *
732
- * 这是时间分表查询的核心约束:
733
- * - 排序字段必须是分表字段(timeColumn),不允许其他字段
734
- * - DESC 时表顺序为 新→旧,ASC 时表顺序为 旧→新(由调用方反转)
735
- * - 这样无需内存排序,直接按表顺序拼接即可
736
- *
737
- * @param reqJson 请求参数
738
- */
739
- private validateQueryOrderBy(reqJson: IRequestModel): void {
740
- // 非时间分表不强制 orderBy 约束(多表合并排序由调用方自行保证)
741
- const timeColumn = this.config.timeColumn;
742
- if (!timeColumn) {
743
- return;
744
- }
745
-
746
- const orderBy = reqJson.orderBy;
747
-
748
- // 1. 必须传 orderBy
749
- if (!orderBy) {
750
- throw new Error(
751
- `[ShardingCrudPro] 查询操作必须传 orderBy 参数。` +
752
- `期望值: '${timeColumn} DESC' 或 '${timeColumn} ASC'`
753
- );
754
- }
755
-
756
- // 2. 使用工具类解析并校验首个排序字段是否为 timeColumn
757
- const firstOrderBy = OrderByUtils.getFirstOrderBy(orderBy);
758
-
759
- if (!firstOrderBy) {
760
- throw new Error(
761
- `[ShardingCrudPro] orderBy 参数格式错误,无法解析。` +
762
- `期望值: '${timeColumn} DESC' 或 '${timeColumn} ASC'`
763
- );
764
- }
765
-
766
- if (firstOrderBy.fieldName !== timeColumn) {
767
- throw new Error(
768
- `[ShardingCrudPro] orderBy 首个排序字段必须为 '${timeColumn}',` +
769
- `当前值: '${firstOrderBy.fieldName}'`
770
- );
771
- }
772
-
773
- // 校验排序方向是否为 ASC 或 DESC
774
- const orderType = firstOrderBy.orderType.toUpperCase();
775
- if (orderType !== 'ASC' && orderType !== 'DESC') {
776
- throw new Error(
777
- `[ShardingCrudPro] orderBy 排序方向必须是 'ASC' 或 'DESC',` +
778
- `当前值: '${firstOrderBy.orderType}'`
779
- );
780
- }
781
- }
782
-
783
- /**
784
- * 判断 orderBy 是否为 ASC 方向
785
- *
786
- * 前提:validateQueryOrderBy 已通过校验,orderBy 格式合法
787
- *
788
- * @param reqJson 请求参数
789
- * @returns true 表示 ASC,false 表示 DESC
790
- */
791
- private isAscOrderBy(reqJson: IRequestModel): boolean {
792
- return OrderByUtils.isFirstOrderByAsc(reqJson.orderBy);
793
- }
794
-
795
- /**
796
- * 根据排序方向对分表列表进行排序
797
- *
798
- * 分表名后缀为时间格式(如 202403、20240101),字典序即时间序。
799
- * - DESC:降序排列(新→旧)
800
- * - ASC:升序排列(旧→新)
801
- *
802
- * @param tables 分表列表
803
- * @param reqJson 请求参数
804
- * @returns 排序后的分表列表(新数组,不修改原数组)
805
- */
806
- private sortTablesForOrderBy(tables: string[], reqJson: IRequestModel): string[] {
807
- const isAsc = this.isAscOrderBy(reqJson);
808
- return [...tables].sort((a, b) =>
809
- isAsc ? a.localeCompare(b) : b.localeCompare(a)
810
- );
811
- }
812
-
813
- // ============ 查询表解析(委托给 ShardingRouter) ============
814
-
815
- /**
816
- * 解析查询表(带真实表过滤)
817
- *
818
- * 将查询路由委托给 ShardingRouter.resolveQuery,
819
- * 由 ShardingRouter 统一处理所有查询路由逻辑。
820
- */
821
- private async resolveQueryTables(reqJson: IRequestModel): Promise<string[]> {
822
- const context: IShardingRouterContext = {
823
- config: this.config,
824
- condition: reqJson.condition,
825
- };
826
-
827
- // 创建表信息提供者
828
- const tableInfoProvider: ITableInfoProvider = {
829
- getExistingTables: () => this.getExistingTablesSet(),
830
- };
831
-
832
- // 委托给 ShardingRouter 处理查询路由
833
- return this.router.resolveQuery(this.config, context, tableInfoProvider);
834
- }
835
- }