@maiyunnet/kebab 2.0.7 → 2.0.8

package/sys/master.js

@@ -33,9 +33,15 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2019-5-2 21:03:42
+ * Last: 2020-3-7 10:33:17, 2022-07-22 13:40:10, 2022-09-06 22:40:58, 2024-2-7 01:44:59, 2024-7-2 15:17:09, 2025-6-13 13:06:43
+ */
 const os = __importStar(require("os"));
 const cluster = __importStar(require("cluster"));
 const http = __importStar(require("http"));
+// --- 库和定义 ---
 const kebab = __importStar(require("../index"));
 const sRoute = __importStar(require("../sys/route"));
 const lCore = __importStar(require("../lib/core"));
@@ -44,22 +50,31 @@ const lText = __importStar(require("../lib/text"));
 const lCrypto = __importStar(require("../lib/crypto"));
 const lTime = __importStar(require("../lib/time"));
 const lZip = __importStar(require("../lib/zip"));
+/** --- 当前运行中的子进程列表 --- */
 const workerList = {};
+/**
+ * --- 最终调用执行的函数块 ---
+ */
 async function run() {
+    // --- 读取配置文件 ---
     const configContent = await lFs.getContent(kebab.CONF_CWD + 'config.json', 'utf8');
     if (!configContent) {
         throw `File '${kebab.CONF_CWD}config.json' not found.`;
     }
+    /** --- 系统 config.json --- */
     const config = lText.parseJson(configContent);
     for (const key in config) {
         lCore.globalConfig[key] = config[key];
     }
+    // --- 监听 RPC 命令 ---
     createRpcListener();
+    // --- 30 秒检测一次是否有丢失的子进程 ---
     setInterval(function () {
         checkWorkerLost().catch(function (e) {
             lCore.display('[master] [run] [checkWorkerLost]', e);
         });
     }, 30000);
+    // --- 启动进程 ---
     const cpuLength = os.cpus().length;
     lCore.display('[master] [run] CPU LENGTH: ' + cpuLength.toString());
     const cpuLengthMax = cpuLength > lCore.globalConfig.max ? lCore.globalConfig.max : cpuLength;
@@ -67,16 +82,20 @@ async function run() {
         await createChildProcess(i);
     }
     cluster.default.on('listening', function (worker, address) {
+        // --- 子进程开始监听 ---
         lCore.display(`[master] Listening: worker ${worker.process.pid ?? 'undefined'}, Address: ${address.address}:${address.port}.`);
     }).on('exit', function (worker, code) {
         (async function () {
             if (!worker.process.pid) {
                 return;
             }
+            // --- 有子线程退出 ---
             if (code === 0) {
+                // --- 正常关闭，证明关闭前主进程已经重启新进程了，这里无需在 fork ---
                 lCore.display(`[master] Worker ${worker.process.pid} has been disconnected.`);
             }
             else {
+                // --- 中断，致命错误，需要重新启动一个新线程 ---
                 lCore.display(`[master] Worker ${worker.process.pid} has collapsed.`);
                 const cpu = workerList[worker.process.pid].cpu;
                 delete workerList[worker.process.pid];
@@ -87,10 +106,15 @@ async function run() {
         });
     });
 }
+/**
+ * --- 创建 RPC 监听，用来监听 cmd 或局域网传递过来的数据，并广播给所有子进程，cmd 部分代码在 cmd 中实现 ---
+ */
 function createRpcListener() {
     http.createServer(function (req, res) {
         (async function () {
+            /** --- 当前时间戳 --- */
             const time = lTime.stamp();
+            /** --- cmd 数据对象 --- */
             const cmd = lCrypto.aesDecrypt((req.url ?? '').slice(1), lCore.globalConfig.rpcSecret);
             if (!cmd) {
                 res.end('Error');
@@ -111,6 +135,7 @@ function createRpcListener() {
             }
             switch (msg.action) {
                 case 'reload': {
+                    // --- 为所有子线程发送 reload 信息 ---
                     for (const pid in workerList) {
                         workerList[pid].worker.send({
                             'action': 'reload'
@@ -119,16 +144,20 @@ function createRpcListener() {
                     break;
                 }
                 case 'restart': {
+                    // --- 为所有子线程发送 stop 信息 ---
                     for (const pid in workerList) {
                         workerList[pid].worker.send({
                             'action': 'stop'
                         });
+                        // --- 开启新线程 ---
                         await createChildProcess(workerList[pid].cpu);
+                        // --- 删除记录 ---
                         delete workerList[pid];
                     }
                     break;
                 }
                 case 'global': {
+                    // --- 为所有子进程更新 global 变量 ---
                     for (const pid in workerList) {
                         workerList[pid].worker.send({
                             'action': 'global',
@@ -136,6 +165,7 @@ function createRpcListener() {
                             'data': msg.data
                         });
                     }
+                    // --- 更新 master 的数据 ---
                     if (msg.data === undefined || msg.data === null) {
                         delete lCore.global[msg.key];
                         break;
@@ -144,6 +174,7 @@ function createRpcListener() {
                     break;
                 }
                 case 'code': {
+                    // --- 更新 code 代码包 ---
                     const rtn = await sRoute.getFormData(req);
                     if (!rtn) {
                         res.end('Abnormal');
@@ -162,6 +193,7 @@ function createRpcListener() {
                     if (path.endsWith('/')) {
                         path = path.slice(0, -1);
                     }
+                    /** --- 最终更新的根目录，以 / 结尾，但用户传入的无所谓 --- */
                     let to = kebab.ROOT_CWD + path;
                     if (!to.endsWith('/')) {
                         to += '/';
@@ -185,22 +217,31 @@ function createRpcListener() {
                     }
                     const ls = await zip.getList();
                     for (const path in ls) {
+                        /** --- 带 / 开头的 zip 中文件完整路径 --- */
                         const fpath = path.startsWith('/') ? path : '/' + path;
+                        /** --- 最后一个 / 的所在位置 --- */
                         const lio = fpath.lastIndexOf('/');
+                        /** --- 纯路径，不以 / 开头，以 / 结尾，若是根路径就是空字符串 --- */
                         const pat = fpath.slice(1, lio + 1);
+                        /** --- 纯文件名 --- */
                         const fname = fpath.slice(lio + 1);
                         if ((pat === 'conf/' && fname === 'config.json') || fname === 'kebab.json') {
+                            // --- 特殊文件不能覆盖 ---
                             continue;
                         }
                         if (fname.endsWith('.js.map') || fname.endsWith('.ts') || fname.endsWith('.gitignore')) {
+                            // --- 测试或开发文件不覆盖 ---
                             continue;
                         }
+                        // --- 看文件夹是否存在 ---
                         if (pat && !await lFs.isDir(to + pat)) {
                             await lFs.mkdir(to + pat);
                         }
+                        // --- 覆盖或创建文件 ---
                         await lFs.putContent(to + pat + fname, ls[path]);
                     }
                     await sRoute.unlinkUploadFiles(rtn.files);
+                    // --- 检查是否更新 config ---
                     if (rtn.post['config'] === '1') {
                         const configContent = await lFs.getContent(kebab.CONF_CWD + 'config.json', 'utf8');
                         if (configContent) {
@@ -222,12 +263,18 @@ function createRpcListener() {
         });
     }).listen(lCore.globalConfig.rpcPort);
 }
+/**
+ * --- 检测是否有死掉丢失的子进程，复活之 ---
+ */
 async function checkWorkerLost() {
     const now = Date.now();
     for (const pid in workerList) {
         if (now - workerList[pid].hbtime < 30000) {
+            // --- 距离上次心跳，小于 30 秒，正常 ---
+            // --- 子线程 10 秒发送一次心跳 ---
             continue;
         }
+        // --- 异常，也可能主线程因为各种原因休眠，不过无论如何都要将原线程关闭，要不然原线程又发心跳包，就捕获不到了 ---
         lCore.display(`[master] Worker ${pid} lost.`);
         workerList[pid].worker.send({
             'action': 'stop'
@@ -236,6 +283,10 @@ async function checkWorkerLost() {
         delete workerList[pid];
     }
 }
+/**
+ * --- 创建一个新的子进程 ---
+ * @param cpu CPU ID
+ */
 async function createChildProcess(cpu) {
     const worker = cluster.default.fork();
     if (!worker.process.pid) {
@@ -246,15 +297,19 @@ async function createChildProcess(cpu) {
         'cpu': cpu,
         'hbtime': Date.now()
     };
+    // --- 如果是支持将线程放到对应的 CPU，则执行相关操作 ---
     if (!os.type().toLowerCase().includes('windows')) {
+        // --- 非 Windows ---
         const cpr = await lCore.exec(`taskset -cp ${cpu} ${worker.process.pid}`);
         lCore.display(cpr);
         lCore.display(`[master] Worker ${worker.process.pid} start on cpu #${cpu}.`);
     }
+    // --- 监听子进程发来的讯息，并扩散给所有子进程 ---
     worker.on('message', function (msg) {
         (async function () {
             switch (msg.action) {
                 case 'reload': {
+                    // --- 为所有子线程发送 reload 信息 ---
                     for (const pid in workerList) {
                         workerList[pid].worker.send({
                             'action': msg.action
@@ -263,16 +318,20 @@ async function createChildProcess(cpu) {
                     break;
                 }
                 case 'restart': {
+                    // --- 为所有子进程发送 restart 信息 ---
                     for (const pid in workerList) {
                         workerList[pid].worker.send({
                             'action': 'stop'
                         });
+                        // --- 开启新线程 ---
                         await createChildProcess(workerList[pid].cpu);
+                        // --- 删除记录 ---
                         delete workerList[pid];
                     }
                     break;
                 }
                 case 'global': {
+                    // --- 为所有子进程更新 global 变量 ---
                     for (const pid in workerList) {
                         workerList[pid].worker.send({
                             'action': 'global',
@@ -280,6 +339,7 @@ async function createChildProcess(cpu) {
                             'data': msg.data
                         });
                     }
+                    // --- 更新 master 的数据 ---
                     if (msg.data === undefined || msg.data === null) {
                         delete lCore.global[msg.key];
                         break;
@@ -288,7 +348,9 @@ async function createChildProcess(cpu) {
                     break;
                 }
                 case 'hbtime': {
+                    // --- 获得子进程发来的 10 秒一次的心跳 ---
                     if (!workerList[msg.pid]) {
+                        // --- 线程存在，主进程记录里没找到 ---
                         lCore.display(`[master] Worker ${msg.pid} not found.`);
                         break;
                     }
@@ -300,6 +362,7 @@ async function createChildProcess(cpu) {
             lCore.display('[createChildProcess] [message]', e);
         });
     });
+    // --- 将主线程的全局变量传给这个新建的子线程 ---
     if (Object.keys(lCore.global).length) {
         worker.send({
             'action': 'global',

package/sys/mod.d.ts

@@ -1,33 +1,64 @@
+/**
+ * Project: Mutton, User: JianSuoQiYue
+ * Date: 2019-6-4 21:35
+ * Last: 2020-4-14 13:33:51, 2022-07-23 16:01:34, 2022-09-06 22:59:26, 2023-5-24 19:11:37, 2023-6-13 21:47:58, 2023-7-10 18:54:03, 2023-8-23 17:03:16, 2023-12-11 15:21:22, 2023-12-20 23:12:03, 2024-3-8 16:05:29, 2024-3-20 19:58:15, 2024-8-11 21:14:54, 2024-10-5 14:00:22, 2024-12-14 19:58:34
+ */
 import * as lSql from '../lib/sql';
 import * as lDb from '../lib/db';
 import * as sCtr from '../sys/ctr';
 import * as types from '../types';
+/** --- 条数列表 --- */
 declare class Rows<T extends Mod> implements types.Rows<T> {
     private readonly _items;
     constructor(initialItems?: T[]);
+    /** --- 总行数 --- */
     get length(): number;
+    /** --- 通过索引获取一个对象 --- */
     item(index: number): T;
+    /** --- 转换为数组对象 --- */
     toArray(): Array<Record<string, any>>;
+    /** --- 根据规则筛掉项，predicate 返回 true 代表保留 --- */
     filter(predicate: (value: T, index: number) => boolean): Rows<T>;
+    /** --- 重塑对象内容 --- */
     map<TU>(allbackfn: (value: T, index: number) => TU): TU[];
     [Symbol.iterator](): Iterator<T>;
 }
+/**
+ * --- 开启软更需要在表添加字段：ALTER TABLE `table_name` ADD `time_remove` bigint NOT NULL DEFAULT '0' AFTER `xxx`; ---
+ */
 export default class Mod {
+    /** --- 表名 --- */
     protected static _$table: string;
+    /** --- 主键字段名 --- */
     protected static _$primary: string;
+    /** --- 设置后将由 _keyGenerator 函数生成唯一字段 --- */
     protected static _$key: string;
+    /** ---- 可开启软删软更新软新增 --- */
     protected static _$soft: boolean;
+    /** --- 要 update 的内容 --- */
     protected _updates: Record<string, boolean>;
+    /** --- 模型获取的属性 --- */
     protected _data: Record<string, any>;
+    /** --- 当前选择的分表 _ 后缀，多个代表联查 --- */
     protected _index: string[] | null;
+    /** --- 必须追加的数据筛选 key 与 values，仅单表模式有效 --- */
     protected _contain: {
         'key': string;
         'list': string[];
     } | null;
+    /** --- 已算出的 total --- */
     protected _total: number[];
+    /** --- 数据库连接对象 --- */
     protected _db: lDb.Pool | lDb.Transaction;
+    /** --- Sql 对象 --- */
     protected _sql: lSql.Sql;
+    /** --- ctr 对象, Mutton: false, Kebab: true --- */
     protected _ctr?: sCtr.Ctr;
+    /**
+     * --- 构造函数 ---
+     * @param ctr Ctr 对象
+     * @param opt 选项
+     */
     constructor(opt: {
         'db': lDb.Pool | lDb.Transaction;
         'ctr'?: sCtr.Ctr;
@@ -43,23 +74,50 @@ export default class Mod {
         'raw'?: boolean;
         'pre'?: string;
     });
+    /** --- 创建字段对象 --- */
     static column(field: string): {
         'type': 'column';
         'token': string;
         'value': string;
     };
+    /**
+     * --- 添加一个序列 ---
+     * @param db 数据库对象
+     * @param cs 字段列表
+     * @param vs 数据列表
+     * @param opt 选项
+     */
     static insert(db: lDb.Pool | lDb.Transaction, cs: string[] | Record<string, any>, vs?: any[] | any[][], opt?: {
         'pre'?: sCtr.Ctr | string;
         'index'?: string;
     }): Promise<boolean | null | false>;
+    /**
+     * --- 获取添加一个序列的模拟 SQL ---
+     * @param cs 字段列表
+     * @param vs 数据列表
+     * @param opt 选项
+     */
     static insertSql(cs: string[] | Record<string, any>, vs?: any[] | any[][], opt?: {
         'pre'?: sCtr.Ctr | string;
         'index'?: string;
     }): string;
+    /**
+     * --- 插入数据如果唯一键冲突则更新 ---
+     * @param db 数据库对象
+     * @param data 要插入的数据
+     * @param update 要更新的数据
+     * @param opt 选项
+     */
     static insertDuplicate(db: lDb.Pool | lDb.Transaction, data: Record<string, any>, update: types.Json, opt?: {
         'pre'?: sCtr.Ctr | string;
         'index'?: string;
     }): Promise<boolean | null>;
+    /**
+     * --- 根据条件移除条目 ---
+     * @param db 数据库对象
+     * @param where 筛选条件
+     * @param opt 选项
+     */
     static removeByWhere(db: lDb.Pool | lDb.Transaction, where: string | types.Json, opt?: {
         'raw'?: boolean;
         'pre'?: sCtr.Ctr | string;
@@ -67,6 +125,12 @@ export default class Mod {
         'by'?: [string | string[], 'DESC' | 'ASC'];
         'limit'?: [number, number?];
     }): Promise<number | false | null>;
+    /**
+     * --- 根据条件移除条目（仅获取 SQL 对象） ---
+     * @param db 数据库对象
+     * @param where 筛选条件
+     * @param opt 选项
+     */
     static removeByWhereSql(db: lDb.Pool | lDb.Transaction, where: string | types.Json, opt?: {
         'raw'?: boolean;
         'pre'?: sCtr.Ctr | string;
@@ -74,6 +138,13 @@ export default class Mod {
         'by'?: [string | string[], 'DESC' | 'ASC'];
         'limit'?: [number, number?];
     }): lSql.Sql;
+    /**
+     * --- 根据条件更新数据 ---
+     * @param db 数据库对象
+     * @param data 要更新的数据
+     * @param where 筛选条件
+     * @param opt 选项
+     */
     static updateByWhere(db: lDb.Pool | lDb.Transaction, data: types.Json, where: string | types.Json, opt?: {
         'raw'?: boolean;
         'pre'?: sCtr.Ctr | string;
@@ -81,6 +152,12 @@ export default class Mod {
         'by'?: [string | string[], 'DESC' | 'ASC'];
         'limit'?: [number, number?];
     }): Promise<number | false | null>;
+    /**
+     * --- 根据条件更新数据（仅获取 SQL 对象） ---
+     * @param data 要更新的数据
+     * @param where 筛选条件
+     * @param opt 选项
+     */
     static updateByWhereSql(data: types.Json, where: string | types.Json, opt?: {
         'raw'?: boolean;
         'pre'?: sCtr.Ctr | string;
@@ -88,6 +165,12 @@ export default class Mod {
         'by'?: [string | string[], 'DESC' | 'ASC'];
         'limit'?: [number, number?];
     }): lSql.Sql;
+    /**
+     * --- select 自定字段 ---
+     * @param db 数据库对象
+     * @param c 字段字符串或字段数组
+     * @param opt 选项
+     */
     static select<T extends Mod>(db: lDb.Pool | lDb.Transaction, c: string | string[], opt?: {
         'ctr'?: sCtr.Ctr;
         'pre'?: string;
@@ -98,6 +181,12 @@ export default class Mod {
             'list': string[];
         };
     }): T & Record<string, any>;
+    /**
+     * --- 通过 where 条件获取模型 ---
+     * @param db 数据库对象
+     * @param s 筛选条件数组或字符串
+     * @param opt 选项
+     */
     static where<T extends Mod>(db: lDb.Pool | lDb.Transaction, s?: string | types.Json, opt?: {
         'ctr'?: sCtr.Ctr;
         'raw'?: boolean;
@@ -108,11 +197,23 @@ export default class Mod {
             'list': string[];
         };
     }): T & Record<string, any>;
+    /**
+     * --- 获取创建对象，通常用于新建数据库条目 ---
+     * @param db 数据库对象
+     * @param opt 选项
+     */
     static getCreate<T extends Mod>(db: lDb.Pool | lDb.Transaction, opt?: {
         'ctr'?: sCtr.Ctr;
         'pre'?: string;
         'index'?: string;
     }): T;
+    /**
+     * --- 根据主键获取对象 ---
+     * @param db 数据库对象
+     * @param val 主键值
+     * @param lock 是否加锁
+     * @param opt 选项
+     */
     static find<T extends Mod>(db: lDb.Pool | lDb.Transaction, val: string | number | null, opt?: {
         'ctr'?: sCtr.Ctr;
         'lock'?: boolean;
@@ -138,6 +239,12 @@ export default class Mod {
         'by'?: [string | string[], 'DESC' | 'ASC'];
         'array'?: false;
     }): Promise<false | null | (T & Record<string, any>)>;
+    /**
+     * --- 通过 where 条件筛选单条数据返回原生对象 ---
+     * @param db 数据库对象
+     * @param s 筛选条件数组或字符串
+     * @param opt 选项
+     */
     static oneArray(db: lDb.Pool | lDb.Transaction, s: string | types.Json, opt?: {
         'ctr'?: sCtr.Ctr;
         'raw'?: boolean;
@@ -145,25 +252,71 @@ export default class Mod {
         'index'?: string | string[];
         'select'?: string | string[];
     }): Promise<false | null | Record<string, any>>;
+    /**
+     * --- 根据 where 条件获取主键值列表 ---
+     * @param db 数据库对象
+     * @param where where 条件
+     * @param opt 选项
+     */
     static primarys(db: lDb.Pool | lDb.Transaction, where?: string | types.Json, opt?: {
         'ctr'?: sCtr.Ctr;
         'raw'?: boolean;
         'pre'?: string;
         'index'?: string;
     }): Promise<any[] | false>;
+    /**
+     * --- 将 key val 组成的数据列表转换为原生对象模式 ---
+     * @param obj 要转换的 kv 数据列表
+     */
     static toArrayByRecord<T extends Mod>(obj: Record<string, T>): Record<string, Record<string, any>>;
     set<T extends this, TK extends keyof T>(n: Record<TK, T[TK] | undefined>): void;
     set<T extends this, TK extends keyof T>(n: TK, v: T[TK]): void;
+    /**
+     * --- 获取一个字段值
+     * @param n 字段名
+     */
     get(n: string): any;
+    /**
+     * --- 创建数据 ---
+     * @param notWhere 若要不存在才成功，则要传入限定条件
+     * @param table 可对限定条件传入适当的表
+     */
     create(notWhere?: string | types.Json, table?: string): Promise<boolean>;
+    /**
+     * --- 唯一键冲突则替换，不冲突则创建数据 ---
+     */
     replace(): Promise<boolean>;
+    /**
+     * --- 刷新当前模型获取最新数据 ---
+     * @param lock 是否加锁
+     */
     refresh(lock?: boolean): Promise<boolean | null>;
+    /**
+     * --- 更新 set 的数据到数据库，有未保存数据时才保存 ---
+     */
     save(): Promise<boolean>;
+    /**
+     * --- 移除本条目 ---
+     * @param raw 是否真实移除
+     */
     remove(raw?: boolean): Promise<boolean>;
     first(lock: boolean, array: true): Promise<false | null | Record<string, any>>;
     first(lock?: boolean, array?: false): Promise<false | null | (this & Record<string, any>)>;
+    /**
+     * --- 获取数据库第一个原生对象 ---
+     * @param lock 是否加锁
+     */
     firstArray(lock?: boolean): Promise<Record<string, any> | false | null>;
+    /**
+     * --- 联合查询表数据 ---
+     * @param f 要联合查询的表列表、单个表、sql 对象
+     * @param type 类型
+     */
     union(f: lSql.Sql | string | types.IModUnionItem | string[] | types.IModUnionItem[], type?: string): this;
+    /**
+     * --- 所有联合查询表数据 ---
+     * @param f 要联合查询的表列表、单个表、sql 对象
+     */
     unionAll(f: lSql.Sql | string | types.IModUnionItem | string[] | types.IModUnionItem[]): this;
     all(): Promise<false | Rows<this>>;
     all(key: string): Promise<false | Record<string, this>>;
@@ -172,34 +325,147 @@ export default class Mod {
     explain(all?: false): Promise<false | string>;
     explain(all: true): Promise<false | Record<string, any>>;
     private _formatTotal;
+    /**
+     * --- 获取总条数，自动抛弃 LIMIT，仅用于获取数据的情况（select） ---
+     */
     total(f?: string): Promise<number>;
+    /**
+     * --- 根据当前条件，筛选出当前条目该有的数据条数 ---
+     */
     count(): Promise<number>;
+    /**
+     * @param f 表名
+     * @param s ON 信息
+     * @param type 类型
+     * @param index 给本表增加 index 分表项
+     * @param pre 前缀
+     */
     join(f: string, s?: types.Json, type?: string, index?: string, pre?: string): this;
+    /**
+     * --- left join 方法 ---
+     * @param f 表名
+     * @param s ON 信息
+     * @param index 给本表增加 index 分表项
+     */
     leftJoin(f: string, s: types.Json, index?: string, pre?: string): this;
+    /**
+     * --- right join 方法 ---
+     * @param f 表名
+     * @param s ON 信息
+     * @param index 给本表增加 index 分表项
+     */
     rightJoin(f: string, s: types.Json, index?: string, pre?: string): this;
+    /**
+     * --- inner join 方法 ---
+     * @param f 表名
+     * @param s ON 信息
+     * @param index 给本表增加 index 分表项
+     */
     innerJoin(f: string, s: types.Json, index?: string, pre?: string): this;
+    /**
+     * --- full join 方法 ---
+     * @param f 表名
+     * @param s ON 信息
+     * @param index 给本表增加 index 分表项
+     */
     fullJoin(f: string, s: types.Json, index?: string, pre?: string): this;
+    /**
+     * --- cross join 方法 ---
+     * @param f 表名
+     * @param s ON 信息
+     * @param index 给本表增加 index 分表项
+     */
     crossJoin(f: string, s: types.Json, index?: string, pre?: string): this;
+    /**
+     * --- 筛选器 ---
+     * @param s 筛选条件数组或字符串
+     */
     having(s: types.Json): this;
+    /**
+     * --- 筛选器 ---
+     * @param s 筛选条件数组或字符串
+     * @param raw 是否包含已被软删除的数据
+     */
     filter(s: types.Json, raw?: boolean): this;
+    /**
+     * --- 是 filter 的别名 ---
+     * @param s 筛选条件数组或字符串
+     * @param raw 是否包含已被软删除的数据
+     */
     where(s: types.Json, raw?: boolean): this;
+    /**
+     * --- ORDER BY ---
+     * @param c 字段字符串或数组
+     * @param d 排序规则
+     */
     by(c: string | Array<string | string[]>, d?: 'DESC' | 'ASC'): this;
+    /**
+     * --- GROUP BY ---
+     * @param c 字段字符串或数组
+     */
     group(c: string | string[]): this;
+    /** --- 设置的 limit --- */
     private _limit;
+    /**
+     * --- LIMIT ---
+     * @param a 起始
+     * @param b 长度
+     */
     limit(a: number, b?: number): this;
+    /**
+     * --- 分页 ---
+     * @param count 每页条数
+     * @param page 当前页数
+     */
     page(count: number, page?: number): this;
+    /**
+     * --- 在 sql 最后追加字符串 ---
+     * @param sql
+     */
     append(sql: string): this;
+    /**
+     * --- 设置闭包含数据 ---
+     * @param contain 设置项
+     */
     contain(contain: {
         'key': string;
         'list': string[];
     }): this;
+    /**
+     * --- 获取 sql 语句 ---
+     */
     getSql(): string;
+    /**
+     * --- 获取全部 data ---
+     */
     getData(): any[];
+    /**
+     * --- 获取带 data 的 sql 语句 ---
+     * @param sql sql 语句
+     * @param data 数据
+     */
     format(sql?: string, data?: any[]): string;
+    /**
+     * --- 获取值对象 ---
+     */
     toArray(): Record<string, any>;
+    /**
+     * --- 获取当前设置要提交的数据 ---
+     */
     updates(): Record<string, any>;
+    /**
+     * --- 当前是否设置了未保存 --=
+     */
     unsaved(): boolean;
+    /**
+     * --- 获取字段的可用语种文本 ---
+     * @param col 字段名
+     * @param lang 当前请求语种，如 sc
+     */
     langText(col: string, lang: string): string;
+    /**
+     * --- 当 _key 不为空时，则依据继承此方法的方法自动生成填充 key ---
+     */
     protected _keyGenerator(): string;
 }
 export {};