@simplysm/orm-common 14.0.16 → 14.0.17

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 (75) hide show
  1. package/README.md +25 -19
  2. package/dist/db-context.d.ts +133 -0
  3. package/dist/db-context.d.ts.map +1 -0
  4. package/dist/db-context.js +325 -0
  5. package/dist/db-context.js.map +1 -0
  6. package/dist/ddl/initialize.d.ts +5 -3
  7. package/dist/ddl/initialize.d.ts.map +1 -1
  8. package/dist/ddl/initialize.js +39 -32
  9. package/dist/ddl/initialize.js.map +1 -1
  10. package/dist/exec/executable.js +1 -1
  11. package/dist/exec/executable.js.map +1 -1
  12. package/dist/exec/queryable.js +2 -2
  13. package/dist/exec/queryable.js.map +1 -1
  14. package/dist/exec/search-parser.d.ts.map +1 -1
  15. package/dist/exec/search-parser.js +2 -1
  16. package/dist/exec/search-parser.js.map +1 -1
  17. package/dist/expr/expr.d.ts +2 -2
  18. package/dist/expr/expr.js +2 -2
  19. package/dist/index.d.ts +1 -2
  20. package/dist/index.d.ts.map +1 -1
  21. package/dist/index.js +2 -3
  22. package/dist/index.js.map +1 -1
  23. package/dist/query-builder/mssql/mssql-expr-renderer.js +1 -1
  24. package/dist/query-builder/mssql/mssql-expr-renderer.js.map +1 -1
  25. package/dist/query-builder/mysql/mysql-expr-renderer.js +1 -1
  26. package/dist/query-builder/mysql/mysql-query-builder.js +1 -1
  27. package/dist/query-builder/mysql/mysql-query-builder.js.map +1 -1
  28. package/dist/query-builder/postgresql/postgresql-query-builder.d.ts +7 -0
  29. package/dist/query-builder/postgresql/postgresql-query-builder.d.ts.map +1 -1
  30. package/dist/query-builder/postgresql/postgresql-query-builder.js +86 -16
  31. package/dist/query-builder/postgresql/postgresql-query-builder.js.map +1 -1
  32. package/dist/schema/factory/relation-builder.d.ts +44 -67
  33. package/dist/schema/factory/relation-builder.d.ts.map +1 -1
  34. package/dist/schema/factory/relation-builder.js +37 -78
  35. package/dist/schema/factory/relation-builder.js.map +1 -1
  36. package/dist/schema/view-builder.d.ts +1 -1
  37. package/dist/schema/view-builder.d.ts.map +1 -1
  38. package/dist/schema/view-builder.js +0 -2
  39. package/dist/schema/view-builder.js.map +1 -1
  40. package/dist/types/column.js +1 -1
  41. package/dist/types/column.js.map +1 -1
  42. package/dist/types/db-context-def.d.ts +2 -42
  43. package/dist/types/db-context-def.d.ts.map +1 -1
  44. package/dist/utils/result-parser.js +31 -23
  45. package/dist/utils/result-parser.js.map +1 -1
  46. package/docs/core.md +110 -50
  47. package/docs/schema-builders.md +13 -19
  48. package/docs/types.md +2 -41
  49. package/package.json +3 -3
  50. package/src/db-context.ts +455 -0
  51. package/src/ddl/initialize.ts +49 -37
  52. package/src/exec/executable.ts +1 -1
  53. package/src/exec/queryable.ts +2 -2
  54. package/src/exec/search-parser.ts +2 -1
  55. package/src/expr/expr.ts +2 -2
  56. package/src/index.ts +2 -3
  57. package/src/query-builder/mssql/mssql-expr-renderer.ts +1 -1
  58. package/src/query-builder/mysql/mysql-expr-renderer.ts +1 -1
  59. package/src/query-builder/mysql/mysql-query-builder.ts +1 -1
  60. package/src/query-builder/postgresql/postgresql-query-builder.ts +93 -14
  61. package/src/schema/factory/relation-builder.ts +56 -87
  62. package/src/schema/view-builder.ts +1 -3
  63. package/src/types/column.ts +1 -1
  64. package/src/types/db-context-def.ts +2 -60
  65. package/src/utils/result-parser.ts +29 -22
  66. package/dist/create-db-context.d.ts +0 -34
  67. package/dist/create-db-context.d.ts.map +0 -1
  68. package/dist/create-db-context.js +0 -329
  69. package/dist/create-db-context.js.map +0 -1
  70. package/dist/define-db-context.d.ts +0 -15
  71. package/dist/define-db-context.d.ts.map +0 -1
  72. package/dist/define-db-context.js +0 -12
  73. package/dist/define-db-context.js.map +0 -1
  74. package/src/create-db-context.ts +0 -409
  75. package/src/define-db-context.ts +0 -28
@@ -1,409 +0,0 @@
1
- import type {
2
- DbContextDef,
3
- DbContextBase,
4
- DbContextStatus,
5
- DbContextInstance,
6
- } from "./types/db-context-def";
7
- import type { DataRecord, DbContextExecutor, IsolationLevel, ResultMeta } from "./types/db";
8
- import type { QueryDef, QueryDefObjectName } from "./types/query-def";
9
- import { DDL_TYPES } from "./types/query-def";
10
- import { DbErrorCode, DbTransactionError } from "./errors/db-transaction-error";
11
- import { TableBuilder } from "./schema/table-builder";
12
- import { ViewBuilder } from "./schema/view-builder";
13
- import type { ProcedureBuilder } from "./schema/procedure-builder";
14
- import { queryable } from "./exec/queryable";
15
- import { executable } from "./exec/executable";
16
- import { obj } from "@simplysm/core-common";
17
-
18
- // DDL import
19
- import * as tableDdl from "./ddl/table-ddl";
20
- import * as columnDdl from "./ddl/column-ddl";
21
- import * as relationDdl from "./ddl/relation-ddl";
22
- import * as schemaDdl from "./ddl/schema-ddl";
23
- import {
24
- initialize as initializeImpl,
25
- validateRelations as validateRelationsImpl,
26
- } from "./ddl/initialize";
27
-
28
- import type { ColumnBuilder } from "./schema/factory/column-builder";
29
- import type { ForeignKeyBuilder } from "./schema/factory/relation-builder";
30
- import type { IndexBuilder } from "./schema/factory/index-builder";
31
-
32
- /**
33
- * DbContext 인스턴스 팩토리
34
- *
35
- * DbContextDef (정의)와 DbContextExecutor (실행기)를 받아
36
- * queryable 접근자, DDL 메서드, 연결/트랜잭션 관리를 포함한
37
- * 완전한 DbContext 인스턴스를 생성한다
38
- *
39
- * @param def - defineDbContext()로 생성된 정의 객체
40
- * @param executor - 쿼리 실행기 (NodeDbContextExecutor, ServiceDbContextExecutor 등)
41
- * @param opt - 데이터베이스 옵션
42
- * @param opt.database - 데이터베이스 이름
43
- * @param opt.schema - schema 이름 (MSSQL: dbo, PostgreSQL: public)
44
- * @returns 완전한 DbContext 인스턴스
45
- *
46
- * @example
47
- * ```typescript
48
- * const MyDb = defineDbContext({
49
- * tables: { user: User, post: Post },
50
- * });
51
- *
52
- * const db = createDbContext(MyDb, executor, { database: "mydb" });
53
- *
54
- * await db.connect(async () => {
55
- * const users = await db.user().execute();
56
- * });
57
- * ```
58
- */
59
- export function createDbContext<TDef extends DbContextDef<any, any, any>>(
60
- def: TDef,
61
- executor: DbContextExecutor,
62
- opt: { database: string; schema?: string },
63
- ): DbContextInstance<TDef> {
64
- // ── 내부 상태 (클로저) ──
65
- let aliasCounter = 0;
66
- let status: DbContextStatus = "ready";
67
- let relationsValidated = false;
68
-
69
- // ── DbContextBase 구현 ──
70
- const base: DbContextBase = {
71
- get status() {
72
- return status;
73
- },
74
- set status(v: DbContextStatus) {
75
- status = v;
76
- },
77
- get database() {
78
- return opt.database;
79
- },
80
- get schema() {
81
- return opt.schema;
82
- },
83
- getNextAlias() {
84
- return `T${++aliasCounter}`;
85
- },
86
- resetAliasCounter() {
87
- aliasCounter = 0;
88
- },
89
- executeDefs<T = DataRecord>(
90
- defs: QueryDef[],
91
- resultMetas?: (ResultMeta | undefined)[],
92
- ): Promise<T[][]> {
93
- if (
94
- status === "transact" &&
95
- defs.some((d) => (DDL_TYPES as readonly string[]).includes(d.type))
96
- ) {
97
- throw new Error("TRANSACTION 상태에서는 DDL을 실행할 수 없습니다.");
98
- }
99
- return executor.executeDefs(defs, resultMetas);
100
- },
101
- getQueryDefObjectName(
102
- tableOrView: TableBuilder<any, any> | ViewBuilder<any, any, any>,
103
- ): QueryDefObjectName {
104
- return obj.clearUndefined({
105
- database: tableOrView.meta.database ?? opt.database,
106
- schema: tableOrView.meta.schema ?? opt.schema,
107
- name: tableOrView.meta.name,
108
- });
109
- },
110
- async switchFk(table: QueryDefObjectName, enabled: boolean): Promise<void> {
111
- await base.executeDefs([schemaDdl.getSwitchFkQueryDef(table, enabled)]);
112
- },
113
- };
114
-
115
- // ── 모든 요소를 하나의 객체로 합성 ──
116
- const db = {
117
- // base 속성 전개 (getter/setter는 별도 처리 필요)
118
- get status() {
119
- return base.status;
120
- },
121
- set status(v: DbContextStatus) {
122
- base.status = v;
123
- },
124
- get database() {
125
- return base.database;
126
- },
127
- get schema() {
128
- return base.schema;
129
- },
130
- getNextAlias: base.getNextAlias,
131
- resetAliasCounter: base.resetAliasCounter,
132
- executeDefs: base.executeDefs,
133
- getQueryDefObjectName: base.getQueryDefObjectName,
134
-
135
- //#region ========== 연결 관리 ==========
136
-
137
- /**
138
- * 트랜잭션 내에서 콜백 실행 (자동 커밋/롤백)
139
- *
140
- * 연결 -> 트랜잭션 시작 -> 콜백 실행 -> 커밋 -> 연결 종료
141
- * 오류 발생 시 자동으로 롤백 후 연결 종료
142
- */
143
- async connect<TResult>(
144
- fn: () => Promise<TResult>,
145
- isolationLevel?: IsolationLevel,
146
- ): Promise<TResult> {
147
- if (!relationsValidated) {
148
- validateRelationsImpl(def);
149
- relationsValidated = true;
150
- }
151
- base.resetAliasCounter();
152
-
153
- await executor.connect();
154
- status = "connect";
155
-
156
- await executor.beginTransaction(isolationLevel);
157
- status = "transact";
158
-
159
- let result: TResult;
160
- try {
161
- result = await fn();
162
-
163
- await executor.commitTransaction();
164
- status = "connect";
165
- } catch (err) {
166
- try {
167
- await executor.rollbackTransaction();
168
- status = "connect";
169
- } catch (err1) {
170
- if (err1 instanceof DbTransactionError) {
171
- if (err1.code !== DbErrorCode.NO_ACTIVE_TRANSACTION) {
172
- await executor.close();
173
- status = "ready";
174
- throw err1;
175
- }
176
- } else {
177
- await executor.close();
178
- status = "ready";
179
- throw err1;
180
- }
181
- }
182
-
183
- await executor.close();
184
- status = "ready";
185
- throw err;
186
- }
187
-
188
- await executor.close();
189
- status = "ready";
190
- return result;
191
- },
192
-
193
- /**
194
- * 트랜잭션 없이 연결 후 콜백 실행, 자동 종료
195
- *
196
- * 트랜잭션이 필요 없는 DDL 작업이나 읽기 작업에 사용
197
- */
198
- async connectWithoutTransaction<TResult>(callback: () => Promise<TResult>): Promise<TResult> {
199
- if (!relationsValidated) {
200
- validateRelationsImpl(def);
201
- relationsValidated = true;
202
- }
203
- base.resetAliasCounter();
204
-
205
- await executor.connect();
206
- status = "connect";
207
-
208
- let result: TResult;
209
- try {
210
- result = await callback();
211
- } catch (err) {
212
- await executor.close();
213
- status = "ready";
214
- throw err;
215
- }
216
-
217
- await executor.close();
218
- status = "ready";
219
- return result;
220
- },
221
-
222
- /**
223
- * 이미 연결된 상태에서 트랜잭션 시작 (자동 커밋/롤백)
224
- *
225
- * connectWithoutTransaction 내에서 부분적으로 트랜잭션이 필요할 때 사용
226
- */
227
- async transaction<TResult>(
228
- fn: () => Promise<TResult>,
229
- isolationLevel?: IsolationLevel,
230
- ): Promise<TResult> {
231
- if (status === "transact") {
232
- throw new Error("이미 TRANSACTION 상태입니다.");
233
- }
234
-
235
- await executor.beginTransaction(isolationLevel);
236
- status = "transact";
237
-
238
- let result: TResult;
239
- try {
240
- result = await fn();
241
-
242
- await executor.commitTransaction();
243
- status = "connect";
244
- } catch (err) {
245
- try {
246
- await executor.rollbackTransaction();
247
- status = "connect";
248
- } catch (err1) {
249
- if (err1 instanceof DbTransactionError) {
250
- if (err1.code !== DbErrorCode.NO_ACTIVE_TRANSACTION) {
251
- throw err1;
252
- }
253
- } else {
254
- throw err1;
255
- }
256
- // NO_ACTIVE_TRANSACTION 오류이면 무시하고 원래 오류를 던짐
257
- status = "connect";
258
- }
259
- throw err;
260
- }
261
-
262
- return result;
263
- },
264
-
265
- //#endregion
266
-
267
- //#region ========== DDL 실행 메서드 ==========
268
-
269
- async createTable(table: TableBuilder<any, any>): Promise<void> {
270
- await base.executeDefs([tableDdl.getCreateTableQueryDef(base, table)]);
271
- },
272
- async dropTable(table: QueryDefObjectName): Promise<void> {
273
- await base.executeDefs([tableDdl.getDropTableQueryDef(table)]);
274
- },
275
- async renameTable(table: QueryDefObjectName, newName: string): Promise<void> {
276
- await base.executeDefs([tableDdl.getRenameTableQueryDef(table, newName)]);
277
- },
278
- async createView(view: ViewBuilder<any, any, any>): Promise<void> {
279
- await base.executeDefs([tableDdl.getCreateViewQueryDef(db as any, view)]);
280
- },
281
- async dropView(view: QueryDefObjectName): Promise<void> {
282
- await base.executeDefs([tableDdl.getDropViewQueryDef(view)]);
283
- },
284
- async createProc(procedure: ProcedureBuilder<any, any>): Promise<void> {
285
- await base.executeDefs([tableDdl.getCreateProcQueryDef(base, procedure)]);
286
- },
287
- async dropProc(procedure: QueryDefObjectName): Promise<void> {
288
- await base.executeDefs([tableDdl.getDropProcQueryDef(procedure)]);
289
- },
290
- async addColumn(
291
- table: QueryDefObjectName,
292
- columnName: string,
293
- column: ColumnBuilder<any, any>,
294
- ): Promise<void> {
295
- await base.executeDefs([columnDdl.getAddColumnQueryDef(table, columnName, column)]);
296
- },
297
- async dropColumn(table: QueryDefObjectName, column: string): Promise<void> {
298
- await base.executeDefs([columnDdl.getDropColumnQueryDef(table, column)]);
299
- },
300
- async modifyColumn(
301
- table: QueryDefObjectName,
302
- columnName: string,
303
- column: ColumnBuilder<any, any>,
304
- ): Promise<void> {
305
- await base.executeDefs([columnDdl.getModifyColumnQueryDef(table, columnName, column)]);
306
- },
307
- async renameColumn(table: QueryDefObjectName, column: string, newName: string): Promise<void> {
308
- await base.executeDefs([columnDdl.getRenameColumnQueryDef(table, column, newName)]);
309
- },
310
- async addPrimaryKey(table: QueryDefObjectName, columns: string[]): Promise<void> {
311
- await base.executeDefs([relationDdl.getAddPrimaryKeyQueryDef(table, columns)]);
312
- },
313
- async dropPrimaryKey(table: QueryDefObjectName): Promise<void> {
314
- await base.executeDefs([relationDdl.getDropPrimaryKeyQueryDef(table)]);
315
- },
316
- async addForeignKey(
317
- table: QueryDefObjectName,
318
- relationName: string,
319
- relationDef: ForeignKeyBuilder<any, any>,
320
- ): Promise<void> {
321
- await base.executeDefs([
322
- relationDdl.getAddForeignKeyQueryDef(base, table, relationName, relationDef),
323
- ]);
324
- },
325
- async addIndex(table: QueryDefObjectName, indexBuilder: IndexBuilder<string[]>): Promise<void> {
326
- await base.executeDefs([relationDdl.getAddIndexQueryDef(table, indexBuilder)]);
327
- },
328
- async dropForeignKey(table: QueryDefObjectName, relationName: string): Promise<void> {
329
- await base.executeDefs([relationDdl.getDropForeignKeyQueryDef(table, relationName)]);
330
- },
331
- async dropIndex(table: QueryDefObjectName, columns: string[]): Promise<void> {
332
- await base.executeDefs([relationDdl.getDropIndexQueryDef(table, columns)]);
333
- },
334
- async clearSchema(params: { database: string; schema?: string }): Promise<void> {
335
- await base.executeDefs([schemaDdl.getClearSchemaQueryDef(params)]);
336
- },
337
- async schemaExists(database: string, schema?: string): Promise<boolean> {
338
- const result = await base.executeDefs([schemaDdl.getSchemaExistsQueryDef(database, schema)]);
339
- return result[0].length > 0;
340
- },
341
- async truncate(table: QueryDefObjectName): Promise<void> {
342
- await base.executeDefs([schemaDdl.getTruncateQueryDef(table)]);
343
- },
344
- async switchFk(table: QueryDefObjectName, enabled: boolean): Promise<void> {
345
- await base.executeDefs([schemaDdl.getSwitchFkQueryDef(table, enabled)]);
346
- },
347
-
348
- //#endregion
349
-
350
- //#region ========== DDL QueryDef 생성기 ==========
351
-
352
- getCreateTableQueryDef: (table: TableBuilder<any, any>) =>
353
- tableDdl.getCreateTableQueryDef(base, table),
354
- getCreateViewQueryDef: (view: ViewBuilder<any, any, any>) =>
355
- tableDdl.getCreateViewQueryDef(db as any, view),
356
- getCreateProcQueryDef: (procedure: ProcedureBuilder<any, any>) =>
357
- tableDdl.getCreateProcQueryDef(base, procedure),
358
- getCreateObjectQueryDef: (
359
- builder: TableBuilder<any, any> | ViewBuilder<any, any, any> | ProcedureBuilder<any, any>,
360
- ) => tableDdl.getCreateObjectQueryDef(db as any, builder),
361
- getDropTableQueryDef: tableDdl.getDropTableQueryDef,
362
- getRenameTableQueryDef: tableDdl.getRenameTableQueryDef,
363
- getDropViewQueryDef: tableDdl.getDropViewQueryDef,
364
- getDropProcQueryDef: tableDdl.getDropProcQueryDef,
365
- getAddColumnQueryDef: columnDdl.getAddColumnQueryDef,
366
- getDropColumnQueryDef: columnDdl.getDropColumnQueryDef,
367
- getModifyColumnQueryDef: columnDdl.getModifyColumnQueryDef,
368
- getRenameColumnQueryDef: columnDdl.getRenameColumnQueryDef,
369
- getAddPrimaryKeyQueryDef: relationDdl.getAddPrimaryKeyQueryDef,
370
- getDropPrimaryKeyQueryDef: relationDdl.getDropPrimaryKeyQueryDef,
371
- getAddForeignKeyQueryDef: (
372
- table: QueryDefObjectName,
373
- relationName: string,
374
- relationDef: ForeignKeyBuilder<any, any>,
375
- ) => relationDdl.getAddForeignKeyQueryDef(base, table, relationName, relationDef),
376
- getAddIndexQueryDef: relationDdl.getAddIndexQueryDef,
377
- getDropForeignKeyQueryDef: relationDdl.getDropForeignKeyQueryDef,
378
- getDropIndexQueryDef: relationDdl.getDropIndexQueryDef,
379
- getClearSchemaQueryDef: schemaDdl.getClearSchemaQueryDef,
380
- getSchemaExistsQueryDef: schemaDdl.getSchemaExistsQueryDef,
381
- getTruncateQueryDef: schemaDdl.getTruncateQueryDef,
382
- getSwitchFkQueryDef: schemaDdl.getSwitchFkQueryDef,
383
-
384
- //#endregion
385
-
386
- //#region ========== 초기화 ==========
387
-
388
- async initialize(options?: { dbs?: string[]; force?: boolean }): Promise<void> {
389
- await initializeImpl(db as any, def, options);
390
- },
391
-
392
- //#endregion
393
- };
394
-
395
- // ── Queryable 접근자 추가 ──
396
- for (const [key, tableOrView] of Object.entries(def.meta.tables)) {
397
- (db as any)[key] = queryable(db as any, tableOrView as TableBuilder<any, any>);
398
- }
399
- for (const [key, view] of Object.entries(def.meta.views)) {
400
- (db as any)[key] = queryable(db as any, view as ViewBuilder<any, any, any>);
401
- }
402
-
403
- // ── Executable 접근자 추가 ──
404
- for (const [key, proc] of Object.entries(def.meta.procedures)) {
405
- (db as any)[key] = executable(base, proc as ProcedureBuilder<any, any>);
406
- }
407
-
408
- return db as DbContextInstance<TDef>;
409
- }
@@ -1,28 +0,0 @@
1
- import type { TableBuilder } from "./schema/table-builder";
2
- import type { ViewBuilder } from "./schema/view-builder";
3
- import type { ProcedureBuilder } from "./schema/procedure-builder";
4
- import type { Migration } from "./types/db";
5
- import type { DbContextDef } from "./types/db-context-def";
6
- import { _Migration } from "./models/system-migration";
7
-
8
- export function defineDbContext<
9
- TTables extends Record<string, TableBuilder<any, any>> = {},
10
- TViews extends Record<string, ViewBuilder<any, any, any>> = {},
11
- TProcedures extends Record<string, ProcedureBuilder<any, any>> = {},
12
- >(config: {
13
- tables?: TTables;
14
- views?: TViews;
15
- procedures?: TProcedures;
16
- migrations?: Migration[];
17
- }): DbContextDef<TTables & { _migration: typeof _Migration }, TViews, TProcedures> {
18
- return {
19
- meta: {
20
- tables: { ...(config.tables ?? {}), _migration: _Migration } as TTables & {
21
- _migration: typeof _Migration;
22
- },
23
- views: (config.views ?? {}) as TViews,
24
- procedures: (config.procedures ?? {}) as TProcedures,
25
- migrations: config.migrations ?? [],
26
- },
27
- };
28
- }