befly 3.10.18 → 3.11.1

package/dist/lib/sqlBuilder.d.ts

@@ -0,0 +1,160 @@
+/**
+ * SQL 构造器 - TypeScript 版本
+ * 提供链式 API 构建 SQL 查询
+ */
+import type { WhereConditions, SqlQuery, InsertData, UpdateData, SqlValue } from "../types/common";
+/**
+ * SQL 构建器类
+ */
+export declare class SqlBuilder {
+    private _select;
+    private _from;
+    private _where;
+    private _joins;
+    private _orderBy;
+    private _groupBy;
+    private _having;
+    private _limit;
+    private _offset;
+    private _params;
+    private _quoteIdent;
+    constructor(options?: {
+        quoteIdent?: (identifier: string) => string;
+    });
+    private _isQuotedIdent;
+    private _startsWithQuote;
+    /**
+     * 重置构建器状态
+     */
+    reset(): this;
+    /**
+     * 转义字段名
+     */
+    private _escapeField;
+    private _validateIdentifierPart;
+    /**
+     * 转义表名
+     */
+    private _escapeTable;
+    /**
+     * 验证参数
+     */
+    private _validateParam;
+    /**
+     * 处理单个操作符条件
+     */
+    private _applyOperator;
+    /**
+     * 处理复杂的 WHERE 条件对象
+     */
+    private _processWhereConditions;
+    /**
+     * 获取 WHERE 条件（供 DbHelper 使用）
+     */
+    getWhereConditions(): {
+        sql: string;
+        params: SqlValue[];
+    };
+    /**
+     * SELECT 字段
+     */
+    select(fields?: string | string[]): this;
+    /**
+     * SELECT 原始表达式（不做转义）
+     */
+    selectRaw(expr: string): this;
+    /**
+     * FROM 表名
+     */
+    from(table: string): this;
+    /**
+     * FROM 原始表达式（不做转义）
+     */
+    fromRaw(tableExpr: string): this;
+    /**
+     * WHERE 条件
+     */
+    where(condition: WhereConditions): this;
+    where(field: string, value: SqlValue): this;
+    /**
+     * WHERE 原始片段（不做转义），可附带参数。
+     */
+    whereRaw(sql: string, params?: SqlValue[]): this;
+    /**
+     * LEFT JOIN
+     */
+    leftJoin(table: string, on: string): this;
+    /**
+     * RIGHT JOIN
+     */
+    rightJoin(table: string, on: string): this;
+    /**
+     * INNER JOIN
+     */
+    innerJoin(table: string, on: string): this;
+    /**
+     * ORDER BY
+     * @param fields - 格式为 ["field#ASC", "field2#DESC"]
+     */
+    orderBy(fields: string[]): this;
+    /**
+     * GROUP BY
+     */
+    groupBy(field: string | string[]): this;
+    /**
+     * HAVING
+     */
+    having(condition: string): this;
+    /**
+     * LIMIT
+     */
+    limit(count: number, offset?: number): this;
+    /**
+     * OFFSET
+     */
+    offset(count: number): this;
+    /**
+     * 构建 SELECT 查询
+     */
+    toSelectSql(): SqlQuery;
+    /**
+     * 构建 INSERT 查询
+     */
+    toInsertSql(table: string, data: InsertData): SqlQuery;
+    /**
+     * 构建 UPDATE 查询
+     */
+    toUpdateSql(table: string, data: UpdateData): SqlQuery;
+    /**
+     * 构建 DELETE 查询
+     */
+    toDeleteSql(table: string): SqlQuery;
+    /**
+     * 构建 COUNT 查询
+     */
+    toCountSql(): SqlQuery;
+    static toDeleteInSql(options: {
+        table: string;
+        idField: string;
+        ids: SqlValue[];
+        quoteIdent: (identifier: string) => string;
+    }): SqlQuery;
+    static toUpdateCaseByIdSql(options: {
+        table: string;
+        idField: string;
+        rows: Array<{
+            id: SqlValue;
+            data: Record<string, SqlValue>;
+        }>;
+        fields: string[];
+        quoteIdent: (identifier: string) => string;
+        updatedAtField: string;
+        updatedAtValue: SqlValue;
+        stateField?: string;
+        stateGtZero?: boolean;
+    }): SqlQuery;
+}
+/**
+ * 创建新的 SQL 构建器实例
+ */
+export declare function createQueryBuilder(): SqlBuilder;