@simplysm/orm-common 13.0.100 → 14.0.4

package/src/types/query-def.ts

@@ -4,12 +4,12 @@ import type { Expr, WhereExpr } from "./expr";
 //#region ========== Common ==========
 
 /**
- * DB object name (table, View, Procedure, etc.)
+ * DB 객체 이름 (table, View, Procedure 등)
  *
- * DBMS-specific namespaces:
- * - MySQL: `database.name` (schema ignored)
- * - MSSQL: `database.schema.name` (schema defaults to dbo)
- * - PostgreSQL: `schema.name` (database is for connection only)
+ * DBMS별 네임스페이스:
+ * - MySQL: `database.name` (schema 무시)
+ * - MSSQL: `database.schema.name` (schema 기본값 dbo)
+ * - PostgreSQL: `schema.name` (database는 연결용)
  */
 export interface QueryDefObjectName {
   database?: string;
@@ -22,9 +22,9 @@ export interface QueryDefObjectName {
 //#region ========== DML ==========
 
 /**
- * CUD query OUTPUT clause definition
+ * CUD query OUTPUT 절 정의
  *
- * Define return values after INSERT/UPDATE/DELETE
+ * INSERT/UPDATE/DELETE 후 반환값 정의
  */
 export interface CudOutputDef {
   columns: string[];
@@ -33,22 +33,22 @@ export interface CudOutputDef {
 }
 
 /**
- * SELECT Query definition
+ * SELECT query 정의
  *
- * @property type - Query type ("select")
- * @property from - FROM clause (table/Subquery)
+ * @property type - Query 타입 ("select")
+ * @property from - FROM 절 (table/subquery)
  * @property as - Table alias
- * @property select - SELECT clause column mapping
- * @property distinct - Whether DISTINCT
+ * @property select - SELECT 절 column 매핑
+ * @property distinct - DISTINCT 여부
  * @property top - TOP N (MSSQL)
- * @property lock - Whether to lock
- * @property where - WHERE condition array
- * @property joins - JOIN definition array
- * @property orderBy - ORDER BY [column, direction] array
+ * @property lock - 잠금 여부
+ * @property where - WHERE 조건 배열
+ * @property joins - JOIN 정의 배열
+ * @property orderBy - ORDER BY [column, direction] 배열
  * @property limit - LIMIT [offset, count]
- * @property groupBy - GROUP BY expression array
- * @property having - HAVING condition array
- * @property with - Recursive CTE definition
+ * @property groupBy - GROUP BY expression 배열
+ * @property having - HAVING 조건 배열
+ * @property with - 재귀 CTE 정의
  */
 export interface SelectQueryDef {
   type: "select";
@@ -68,21 +68,21 @@ export interface SelectQueryDef {
 }
 
 /**
- * JOIN Query definition
+ * JOIN query 정의
  *
- * SelectQueryDef extension + isSingle flag
+ * SelectQueryDef 확장 + isSingle 플래그
  */
 export interface SelectQueryDefJoin extends SelectQueryDef {
-  /** Whether single result (1:1 relation) */
+  /** 단일 결과 여부 (1:1 관계) */
   isSingle?: boolean;
 }
 
 /**
- * INSERT Query definition
+ * INSERT query 정의
  *
- * @property records - Record array to insert
- * @property overrideIdentity - Whether to enable IDENTITY_INSERT
- * @property output - OUTPUT clause definition
+ * @property records - 삽입할 레코드 배열
+ * @property overrideIdentity - IDENTITY_INSERT 활성화 여부
+ * @property output - OUTPUT 절 정의
  */
 export interface InsertQueryDef {
   type: "insert";
@@ -93,9 +93,9 @@ export interface InsertQueryDef {
 }
 
 /**
- * Conditional INSERT Query definition
+ * 조건부 INSERT query 정의
  *
- * Insert only if not exists
+ * 존재하지 않을 때만 삽입
  */
 export interface InsertIfNotExistsQueryDef {
   type: "insertIfNotExists";
@@ -107,9 +107,9 @@ export interface InsertIfNotExistsQueryDef {
 }
 
 /**
- * INSERT INTO SELECT Query definition
+ * INSERT INTO SELECT query 정의
  *
- * Insert subquery results
+ * Subquery 결과를 삽입
  */
 export interface InsertIntoQueryDef {
   type: "insertInto";
@@ -120,10 +120,10 @@ export interface InsertIntoQueryDef {
 }
 
 /**
- * UPDATE Query definition
+ * UPDATE query 정의
  *
- * @property record - Column/value mapping to update
- * @property joins - UPDATE JOIN (when supported)
+ * @property record - 갱신할 column/값 매핑
+ * @property joins - UPDATE JOIN (지원 시)
  */
 export interface UpdateQueryDef {
   type: "update";
@@ -138,7 +138,7 @@ export interface UpdateQueryDef {
 }
 
 /**
- * DELETE Query definition
+ * DELETE query 정의
  */
 export interface DeleteQueryDef {
   type: "delete";
@@ -152,9 +152,9 @@ export interface DeleteQueryDef {
 }
 
 /**
- * UPSERT Query definition
+ * UPSERT query 정의
  *
- * INSERT or UPDATE (MERGE Pattern)
+ * INSERT 또는 UPDATE (MERGE 패턴)
  */
 export interface UpsertQueryDef {
   type: "upsert";
@@ -170,7 +170,7 @@ export interface UpsertQueryDef {
 
 //#region ========== Utils ==========
 
-/** FK constraint enable/disable */
+/** FK 제약조건 활성화/비활성화 */
 export interface SwitchFkQueryDef {
   type: "switchFk";
   table: QueryDefObjectName;
@@ -181,7 +181,7 @@ export interface SwitchFkQueryDef {
 
 //#region ========== DDL - Schema ==========
 
-/** Clear schema (delete all objects) */
+/** Schema 초기화 (모든 객체 삭제) */
 export interface ClearSchemaQueryDef {
   type: "clearSchema";
   database: string;
@@ -249,7 +249,7 @@ export interface DropColumnQueryDef {
   column: string;
 }
 
-/** MODIFY COLUMN (type/property change) */
+/** MODIFY COLUMN (타입/속성 변경) */
 export interface ModifyColumnQueryDef {
   type: "modifyColumn";
   table: QueryDefObjectName;
@@ -376,7 +376,7 @@ export interface ExecProcQueryDef {
 
 //#region ========== Meta ==========
 
-/** Check schema existence */
+/** Schema 존재 여부 확인 */
 export interface SchemaExistsQueryDef {
   type: "schemaExists";
   database: string;
@@ -385,13 +385,13 @@ export interface SchemaExistsQueryDef {
 
 //#endregion
 
-//#region ========== DDL type constants ==========
+//#region ========== DDL 타입 상수 ==========
 
 /**
- * DDL QueryDef union (for compile-time validation)
+ * DDL QueryDef union (컴파일 타임 검증용)
  *
  * @remarks
- * switchFk is excluded because it is not DDL (can be used within transactions)
+ * switchFk는 DDL이 아니므로 제외 (트랜잭션 내에서 사용 가능)
  */
 type DdlQueryDef =
   | ClearSchemaQueryDef
@@ -415,13 +415,13 @@ type DdlQueryDef =
   | DropProcQueryDef;
 
 /**
- * DDL (Data Definition Language) type constants
+ * DDL (Data Definition Language) 타입 상수
  *
- * Used for blocking DDL within transactions and DDL type validation
- * Uses satisfies keyword for compile-time synchronization with DdlQueryDef
+ * 트랜잭션 내 DDL 차단 및 DDL 타입 검증에 사용
+ * DdlQueryDef와의 컴파일 타임 동기화를 위해 satisfies 키워드 사용
  *
  * @remarks
- * switchFk is excluded because it is not DDL (can be used within transactions)
+ * switchFk는 DDL이 아니므로 제외 (트랜잭션 내에서 사용 가능)
  */
 export const DDL_TYPES = [
   "clearSchema",
@@ -445,15 +445,15 @@ export const DDL_TYPES = [
   "dropProc",
 ] as const satisfies readonly DdlQueryDef["type"][];
 
-/** DDL type union */
+/** DDL 타입 union */
 export type DdlType = (typeof DDL_TYPES)[number];
 
 //#endregion
 
-//#region ========== Combined Union Type ==========
+//#region ========== 결합 Union 타입 ==========
 
 /**
- * All Query definition union type
+ * 전체 query 정의 union 타입
  *
  * DML (SELECT/INSERT/UPDATE/DELETE/UPSERT) +
  * DDL (Table/Column/PK/FK/Index/View/Procedure) +