wok-server 0.5.0 → 0.7.0

package/dist/mysql/manager/base.js

@@ -1,239 +1,278 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseMysqlManager = void 0;
-const exception_1 = require("../exception");
-const ops_1 = require("./ops");
-const utils_1 = require("./utils");
-/**
- * mysql 管理器基类，提供基础的操作方法.
- */
-class BaseMysqlManager {
-    opts;
-    /**
-     * @param mapping 映射
-     */
-    constructor(
-    /**
-     * 选项，连接池和连接必须有一个，连接池优先.
-     */
-    opts) {
-        this.opts = opts;
-        if (!opts.pool && !opts.connection) {
-            throw new exception_1.MysqlException('Pool and Connection cannot be both null.');
-        }
-    }
-    async queryWithConnection(queryFn) {
-        let conn;
-        if (this.opts.pool) {
-            conn = await (0, utils_1.promiseGetConnection)(this.opts.pool);
-        }
-        else if (this.opts.connection) {
-            conn = this.opts.connection;
-        }
-        if (!conn) {
-            throw new exception_1.MysqlException('Unable to obtain connection');
-        }
-        try {
-            return queryFn(conn);
-        }
-        finally {
-            // 如果是连接池来的，每次连接都是新建，必须释放掉
-            if (this.opts.pool) {
-                this.opts.pool.releaseConnection(conn);
-            }
-        }
-    }
-    /**
-     * 依据id查找.
-     * @param table 表信息
-     * @param id id
-     * @returns
-     */
-    findById(table, id) {
-        return this.queryWithConnection(conn => (0, ops_1.findById)(this.opts.config, conn, table, id));
-    }
-    /**
-     * 根据id列表查询
-     * @param table
-     * @param ids
-     * @returns
-     */
-    findByIdIn(table, ids) {
-        return this.queryWithConnection(conn => (0, ops_1.findByIdIn)(this.opts.config, conn, table, ids));
-    }
-    /**
-     * 根据条件判定是否存在记录.
-     * @param table
-     * @param criteria  条件信息，可以为空，为空的情况下判定整个表是否有记录
-     * @returns
-     */
-    existsBy(table, criteria) {
-        return this.queryWithConnection(conn => (0, ops_1.existsBy)(this.opts.config, conn, table, criteria));
-    }
-    /**
-     * 根据id判定记录是否存在
-     * @param table
-     * @param id
-     * @returns
-     */
-    existsById(table, id) {
-        return this.queryWithConnection(conn => (0, ops_1.existsById)(this.opts.config, conn, table, id));
-    }
-    /**
-     * 按 id 查询
-     * @param table 表信息
-     * @param id
-     */
-    deleteById(table, id) {
-        return this.queryWithConnection(conn => (0, ops_1.deleteById)(this.opts.config, conn, table, id));
-    }
-    /**
-     * 按条件删除数据。批量删除是危险操作，建议在使用时尽可能设置 limit 参数来限制数量。
-     * @param opts
-     * @returns
-     */
-    deleteMany(opts) {
-        return this.queryWithConnection(conn => (0, ops_1.deleteMany)(this.opts.config, conn, opts));
-    }
-    /**
-     * 仅删除符合条件的一条记录，必须是相等条件
-     * @param table
-     * @param criteria
-     * @returns
-     */
-    async deleteOne(table, criteria) {
-        if (!Object.keys(criteria).length) {
-            throw new exception_1.MysqlException('criteria cannot be empty !');
-        }
-        const res = await this.queryWithConnection(conn => (0, ops_1.deleteMany)(this.opts.config, conn, {
-            table,
-            criteria,
-            limit: 1
-        }));
-        return res === 1;
-    }
-    /**
-     * 查询表中所有数据.
-     * @param table  表信息
-     * @returns
-     */
-    findAll(table) {
-        return this.queryWithConnection(conn => (0, ops_1.findAll)(this.opts.config, conn, table));
-    }
-    /**
-     * 按条件查询第一条记录.
-     * @param table 表信息
-     * @param criteria 查询条件
-     * @param orderBy 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
-     * @returns
-     */
-    findFirst(table, criteria, orderBy) {
-        return this.queryWithConnection(conn => (0, ops_1.findFirst)(this.opts.config, conn, table, criteria, orderBy));
-    }
-    /**
-     * 插入数据. 不支持自增加长id,id必须提前生成，请使用 uuid.
-     * @param table 表信息
-     * @param data 数据，数据必须是 T 的实例, T 必须是已配置的实体类类型，否则无法完成操作
-     * @returns 插入后的数据
-     */
-    insert(table, data) {
-        return this.queryWithConnection(conn => (0, ops_1.insert)(this.opts.config, conn, table, data));
-    }
-    /**
-     * 批量插入
-     * @param table 表
-     * @param list 要插入的数据列表
-     */
-    insertMany(table, list) {
-        return this.queryWithConnection(conn => (0, ops_1.insertMany)(this.opts.config, conn, table, list));
-    }
-    /**
-     * 更新
-     * @param table 表信息
-     * @param data
-     */
-    update(table, data) {
-        return this.queryWithConnection(conn => (0, ops_1.update)(this.opts.config, conn, table, data));
-    }
-    /**
-     * 更新所以匹配条件的记录
-     * @param opts
-     * @returns
-     */
-    updateMany(opts) {
-        return this.queryWithConnection(conn => (0, ops_1.updateMany)(this.opts.config, conn, opts));
-    }
-    /**
-     * 只更新一条记录。仅支持相等条件，不支持范围条件，可以严格事务中使用。
-     * @param table
-     * @param criteria
-     * @param updater
-     * @returns 更新是否成功
-     */
-    updateOne(table, criteria, updater) {
-        if (!Object.keys(updater).length) {
-            throw new exception_1.MysqlException('updater cannot be empty !');
-        }
-        return this.queryWithConnection(conn => (0, ops_1.updateOne)(this.opts.config, conn, table, criteria, updater));
-    }
-    /**
-     * 部分更新
-     * @param table 表信息
-     * @param data 字段信息，必须要包含id字段，如果包含了更新和创建时间的字段，则忽略掉
-     */
-    partialUpdate(table, data) {
-        return this.queryWithConnection(conn => (0, ops_1.partialUpdate)(this.opts.config, conn, table, data));
-    }
-    /**
-     * 查找实体类 自定义条件
-     * @param opts
-     * @returns
-     */
-    find(opts) {
-        return this.queryWithConnection(conn => (0, ops_1.find)(this.opts.config, conn, opts));
-    }
-    /**
-     * 指定字段条件查询
-     * @param opts
-     * @returns
-     */
-    findSelect(opts) {
-        return this.queryWithConnection(conn => (0, ops_1.findSelect)(this.opts.config, conn, opts));
-    }
-    /**
-     * 指定条件查询数量
-     * @param table 表信息
-     * @param criteria 查询条件
-     * @returns
-     */
-    count(table, criteria) {
-        return this.queryWithConnection(conn => (0, ops_1.count)(this.opts.config, conn, table, criteria));
-    }
-    /**
-     * 分页查询
-     * @param opts
-     * @returns
-     */
-    paginate(opts) {
-        return this.queryWithConnection(conn => (0, ops_1.paginate)(this.opts.config, conn, opts));
-    }
-    /**
-     * 自定义查询，指定 sql 、参数和返回值类型
-     * @param sql 预编译 sql ，参数使用 ”?“（英文问号） 占位，注意查询的字段名称会与返回值类型的字段映射，如果 sql 中的字段名称很特殊（比如纯数字等），需要设置别名，避免产生映射错误
-     * @param values 要传递的值，对应 sql 中的占位符 ”?“（英文问号）
-     * @param T 返回值类型，注意类型映射问题，详细可以参考文档中关于类型映射的说明
-     */
-    async query(sql, values) {
-        return this.queryWithConnection(conn => (0, ops_1.query)(this.opts.config, conn, sql, values));
-    }
-    /**
-     * 自定义 sql 执行，必须是修改类的 sql ，否则会发生错误
-     * @param sql
-     * @param values
-     * @returns 返回影响的行数
-     */
-    async modify(sql, values) {
-        return this.queryWithConnection(conn => (0, ops_1.modify)(this.opts.config, conn, sql, values));
-    }
-}
-exports.BaseMysqlManager = BaseMysqlManager;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseMysqlManager = void 0;
+const exception_1 = require("../exception");
+const ops_1 = require("./ops");
+const utils_1 = require("./utils");
+/**
+ * mysql 管理器基类，提供基础的操作方法.
+ */
+class BaseMysqlManager {
+    opts;
+    /**
+     * @param mapping 映射
+     */
+    constructor(
+    /**
+     * 选项，连接池和连接必须有一个，连接池优先.
+     */
+    opts) {
+        this.opts = opts;
+        if (!opts.pool && !opts.connection) {
+            throw new exception_1.MysqlException('Pool and Connection cannot be both null.');
+        }
+    }
+    async queryWithConnection(queryFn) {
+        let conn;
+        if (this.opts.pool) {
+            conn = await (0, utils_1.promiseGetConnection)(this.opts.pool);
+        }
+        else if (this.opts.connection) {
+            conn = this.opts.connection;
+        }
+        if (!conn) {
+            throw new exception_1.MysqlException('Unable to obtain connection');
+        }
+        try {
+            return queryFn(conn);
+        }
+        finally {
+            // 如果是连接池来的，每次连接都是新建，必须释放掉
+            if (this.opts.pool) {
+                this.opts.pool.releaseConnection(conn);
+            }
+        }
+    }
+    /**
+     * 依据id查找.
+     * @param table 表信息
+     * @param id id
+     * @returns
+     */
+    findById(table, id) {
+        return this.queryWithConnection(conn => (0, ops_1.findById)(this.opts.config, conn, table, id));
+    }
+    /**
+     * 根据id列表查询
+     * @param table
+     * @param ids
+     * @returns
+     */
+    findByIdIn(table, ids) {
+        return this.queryWithConnection(conn => (0, ops_1.findByIdIn)(this.opts.config, conn, table, ids));
+    }
+    /**
+     * 根据条件判定是否存在记录.
+     * @param table
+     * @param criteria  条件信息，可以为空，为空的情况下判定整个表是否有记录
+     * @returns
+     */
+    existsBy(table, criteria) {
+        return this.queryWithConnection(conn => (0, ops_1.existsBy)(this.opts.config, conn, table, criteria));
+    }
+    /**
+     * 根据id判定记录是否存在
+     * @param table
+     * @param id
+     * @returns
+     */
+    existsById(table, id) {
+        return this.queryWithConnection(conn => (0, ops_1.existsById)(this.opts.config, conn, table, id));
+    }
+    /**
+     * 按 id 查询
+     * @param table 表信息
+     * @param id
+     */
+    deleteById(table, id) {
+        return this.queryWithConnection(conn => (0, ops_1.deleteById)(this.opts.config, conn, table, id));
+    }
+    /**
+     * 按条件删除数据。批量删除是危险操作，建议在使用时尽可能设置 limit 参数来限制数量。
+     * @param opts
+     * @returns
+     */
+    deleteMany(opts) {
+        return this.queryWithConnection(conn => (0, ops_1.deleteMany)(this.opts.config, conn, opts));
+    }
+    /**
+     * 仅删除符合条件的一条记录，必须是相等条件
+     * @param table
+     * @param criteria
+     * @returns
+     */
+    async deleteOne(table, criteria) {
+        if (!Object.keys(criteria).length) {
+            throw new exception_1.MysqlException('criteria cannot be empty !');
+        }
+        const res = await this.queryWithConnection(conn => (0, ops_1.deleteMany)(this.opts.config, conn, {
+            table,
+            criteria,
+            limit: 1
+        }));
+        return res === 1;
+    }
+    /**
+     * 查询表中所有数据.
+     * @param table  表信息
+     * @returns
+     */
+    findAll(table) {
+        return this.queryWithConnection(conn => (0, ops_1.findAll)(this.opts.config, conn, table));
+    }
+    /**
+     * 按条件查询第一条记录.
+     * @param table 表信息
+     * @param criteria 查询条件
+     * @param orderBy 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
+     * @returns
+     */
+    findFirst(table, criteria, orderBy) {
+        return this.queryWithConnection(conn => (0, ops_1.findFirst)(this.opts.config, conn, table, criteria, orderBy));
+    }
+    /**
+     * 插入数据. 不支持自增加长id,id必须提前生成，请使用 uuid.
+     * @param table 表信息
+     * @param data 数据，数据必须是 T 的实例, T 必须是已配置的实体类类型，否则无法完成操作
+     * @returns 插入后的数据
+     */
+    insert(table, data) {
+        return this.queryWithConnection(conn => (0, ops_1.insert)(this.opts.config, conn, table, data));
+    }
+    /**
+     * 批量插入
+     * @param table 表
+     * @param list 要插入的数据列表
+     */
+    insertMany(table, list) {
+        return this.queryWithConnection(conn => (0, ops_1.insertMany)(this.opts.config, conn, table, list));
+    }
+    /**
+     * Upsert 单条数据
+     * 如果主键冲突则更新，否则插入
+     * @param table 表信息
+     * @param data 数据
+     * @returns
+     */
+    upsert(table, data) {
+        return this.queryWithConnection(conn => (0, ops_1.upsert)(this.opts.config, conn, table, data));
+    }
+    /**
+     * Upsert 多条数据
+     * 如果主键冲突则更新，否则插入
+     * @param table 表
+     * @param list 要插入的数据列表
+     * @returns 影响的行数
+     */
+    upsertMany(table, list) {
+        return this.queryWithConnection(conn => (0, ops_1.upsertMany)(this.opts.config, conn, table, list));
+    }
+    /**
+     * Upsert 单条数据（支持自定义更新器）
+     * 如果主键冲突则按自定义逻辑更新，否则插入
+     * @param table 表信息
+     * @param data 插入的数据
+     * @param updater 冲突时的更新器
+     * @returns
+     */
+    upsertWithUpdater(table, data, updater) {
+        return this.queryWithConnection(conn => (0, ops_1.upsertWithUpdater)(this.opts.config, conn, table, data, updater));
+    }
+    /**
+     * 更新
+     * @param table 表信息
+     * @param data
+     */
+    update(table, data) {
+        return this.queryWithConnection(conn => (0, ops_1.update)(this.opts.config, conn, table, data));
+    }
+    /**
+     * 更新所以匹配条件的记录
+     * @param opts
+     * @returns
+     */
+    updateMany(opts) {
+        return this.queryWithConnection(conn => (0, ops_1.updateMany)(this.opts.config, conn, opts));
+    }
+    /**
+     * 只更新一条记录。仅支持相等条件，不支持范围条件，可以严格事务中使用。
+     * @param table
+     * @param criteria
+     * @param updater
+     * @returns 更新是否成功
+     */
+    updateOne(table, criteria, updater) {
+        if (!Object.keys(updater).length) {
+            throw new exception_1.MysqlException('updater cannot be empty !');
+        }
+        return this.queryWithConnection(conn => (0, ops_1.updateOne)(this.opts.config, conn, table, criteria, updater));
+    }
+    /**
+     * 部分更新
+     * @param table 表信息
+     * @param data 字段信息，必须要包含id字段，如果包含了更新和创建时间的字段，则忽略掉
+     */
+    partialUpdate(table, data) {
+        return this.queryWithConnection(conn => (0, ops_1.partialUpdate)(this.opts.config, conn, table, data));
+    }
+    /**
+     * 查找实体类 自定义条件
+     * @param opts
+     * @returns
+     */
+    find(opts) {
+        return this.queryWithConnection(conn => (0, ops_1.find)(this.opts.config, conn, opts));
+    }
+    /**
+     * 指定字段条件查询
+     * @param opts
+     * @returns
+     */
+    findSelect(opts) {
+        return this.queryWithConnection(conn => (0, ops_1.findSelect)(this.opts.config, conn, opts));
+    }
+    /**
+     * 指定条件查询数量
+     * @param table 表信息
+     * @param criteria 查询条件
+     * @returns
+     */
+    count(table, criteria) {
+        return this.queryWithConnection(conn => (0, ops_1.count)(this.opts.config, conn, table, criteria));
+    }
+    /**
+     * 分页查询
+     * @param opts
+     * @returns
+     */
+    paginate(opts) {
+        return this.queryWithConnection(conn => (0, ops_1.paginate)(this.opts.config, conn, opts));
+    }
+    /**
+     * 指定字段分页查询
+     * @param opts
+     * @returns
+     */
+    paginateSelect(opts) {
+        return this.queryWithConnection(conn => (0, ops_1.paginateSelect)(this.opts.config, conn, opts));
+    }
+    /**
+     * 自定义查询，指定 sql 、参数和返回值类型
+     * @param sql 预编译 sql ，参数使用 ”?“（英文问号） 占位，注意查询的字段名称会与返回值类型的字段映射，如果 sql 中的字段名称很特殊（比如纯数字等），需要设置别名，避免产生映射错误
+     * @param values 要传递的值，对应 sql 中的占位符 ”?“（英文问号）
+     * @param T 返回值类型，注意类型映射问题，详细可以参考文档中关于类型映射的说明
+     */
+    async query(sql, values) {
+        return this.queryWithConnection(conn => (0, ops_1.query)(this.opts.config, conn, sql, values));
+    }
+    /**
+     * 自定义 sql 执行，必须是修改类的 sql ，否则会发生错误
+     * @param sql
+     * @param values
+     * @returns 返回影响的行数
+     */
+    async modify(sql, values) {
+        return this.queryWithConnection(conn => (0, ops_1.modify)(this.opts.config, conn, sql, values));
+    }
+}
+exports.BaseMysqlManager = BaseMysqlManager;