oak-db 3.3.12 → 3.3.14

package/lib/PostgreSQL/translator.d.ts

@@ -1,4 +1,4 @@
-import { EntityDict, Q_FullTextValue, RefOrExpression, Ref, StorageSchema } from "oak-domain/lib/types";
+import { EntityDict, Q_FullTextValue, RefOrExpression, Ref, StorageSchema, Attribute } from "oak-domain/lib/types";
 import { EntityDict as BaseEntityDict } from 'oak-domain/lib/base-app-domain';
 import { DataType } from "oak-domain/lib/types/schema/DataTypes";
 import { SqlOperateOption, SqlSelectOption, SqlTranslator } from "../sqlTranslator";
@@ -6,6 +6,12 @@ import { CreateEntityOption } from '../types/Translator';
 export interface PostgreSQLSelectOption extends SqlSelectOption {
 }
 export interface PostgreSQLOperateOption extends SqlOperateOption {
+    /**
+     * PostgreSQL RETURNING 子句的投影
+     * 仅在 update/remove 时有效
+     * 返回受影响的行
+     */
+    returning?: Record<string, any>;
 }
 export declare class PostgreSQLTranslator<ED extends EntityDict & BaseEntityDict> extends SqlTranslator<ED> {
     private getEnumTypeName;
@@ -63,16 +69,22 @@ export declare class PostgreSQLTranslator<ED extends EntityDict & BaseEntityDict
     protected translateExpression<T extends keyof ED>(entity: T, alias: string, expression: RefOrExpression<keyof ED[T]["OpSchema"]>, refDict: Record<string, [string, keyof ED]>): string;
     protected populateSelectStmt<T extends keyof ED>(projectionText: string, fromText: string, aliasDict: Record<string, string>, filterText: string, sorterText?: string, groupByText?: string, indexFrom?: number, count?: number, option?: PostgreSQLSelectOption): string;
     translateUpdate<T extends keyof ED, OP extends SqlOperateOption>(entity: T, operation: ED[T]['Update'], option?: OP): string;
-    translateRemove<T extends keyof ED, OP extends SqlOperateOption>(entity: T, operation: ED[T]['Remove'], option?: OP): string;
     /**
-     * PostgreSQL专用的结构化JOIN分析
-     * 返回结构化的JOIN信息，而不是拼接好的FROM字符串
+     * 将 projection 转换为 RETURNING 子句的列列表
+     * @param entity 实体名
+     * @param alias 表别名
+     * @param projection 投影定义
      */
-    private analyzeJoinStructured;
+    private buildReturningClause;
     /**
-     * 构建JOIN条件（用于UPDATE/DELETE的WHERE子句）
+     * 验证操作参数的合法性
      */
-    private buildJoinConditions;
+    private validateOperationParams;
+    /**
+     * 添加RETURNING子句
+     */
+    private appendReturningClause;
+    translateRemove<T extends keyof ED, OP extends SqlOperateOption>(entity: T, operation: ED[T]['Remove'], option?: OP): string;
     /**
      * 生成 PostgreSQL UPSERT 语句
      * INSERT ... ON CONFLICT (key) DO UPDATE SET ...
@@ -80,4 +92,24 @@ export declare class PostgreSQLTranslator<ED extends EntityDict & BaseEntityDict
     translateUpsert<T extends keyof ED>(entity: T, data: ED[T]['CreateMulti']['data'], conflictKeys: string[], updateAttrs?: string[]): string;
     protected populateUpdateStmt(updateText: string, fromText: string, aliasDict: Record<string, string>, filterText: string, sorterText?: string, indexFrom?: number, count?: number, option?: PostgreSQLOperateOption): string;
     protected populateRemoveStmt(updateText: string, fromText: string, aliasDict: Record<string, string>, filterText: string, sorterText?: string, indexFrom?: number, count?: number, option?: PostgreSQLOperateOption): string;
+    /**
+     * 将 PostgreSQL 返回的 Type 回译成 oak 的类型，是 populateDataTypeDef 的反函数
+     * @param type PostgreSQL 类型字符串
+     */
+    private reTranslateToAttribute;
+    /**
+     * 从 PostgreSQL 数据库读取当前的 schema 结构
+     */
+    readSchema(execFn: (sql: string) => Promise<any>): Promise<StorageSchema<ED>>;
+    /**
+     * 将属性定义转换为 PostgreSQL DDL 语句
+     * @param attr 属性名
+     * @param attrDef 属性定义
+     */
+    translateAttributeDef(attr: string, attrDef: Attribute): string;
+    /**
+     * 比较两个 SQL 语句是否等价（用于 schema diff）
+     * 忽略空格、大小写等格式差异
+     */
+    compareSql(sql1: string, sql2: string): boolean;
 }