wok-server 0.5.0 → 0.7.0

package/types/mysql/manager/base.d.ts

@@ -1,165 +1,196 @@
-import { Pool, PoolConnection } from 'mysql2';
-import { MysqlConfig } from '../config';
-import { Table } from '../table-info';
-import { DeleteManyOpts, FindOpts, MixCriteria, MysqlPage, MysqlPaginateOpts, UpdateOpts, Updater, FindSelectOpts } from './ops';
-/**
- * mysql 管理器基类，提供基础的操作方法.
- */
-export declare abstract class BaseMysqlManager {
-    /**
-     * 选项，连接池和连接必须有一个，连接池优先.
-     */
-    private readonly opts;
-    /**
-     * @param mapping 映射
-     */
-    constructor(
-    /**
-     * 选项，连接池和连接必须有一个，连接池优先.
-     */
-    opts: {
-        config: MysqlConfig;
-        pool?: Pool;
-        connection?: PoolConnection;
-    });
-    protected queryWithConnection<T>(queryFn: (conn: PoolConnection) => Promise<T>): Promise<T>;
-    /**
-     * 依据id查找.
-     * @param table 表信息
-     * @param id id
-     * @returns
-     */
-    findById<T>(table: Table<T>, id: string | number): Promise<T | null>;
-    /**
-     * 根据id列表查询
-     * @param table
-     * @param ids
-     * @returns
-     */
-    findByIdIn<T>(table: Table<T>, ids: Array<string | number>): Promise<T[]>;
-    /**
-     * 根据条件判定是否存在记录.
-     * @param table
-     * @param criteria  条件信息，可以为空，为空的情况下判定整个表是否有记录
-     * @returns
-     */
-    existsBy<T>(table: Table<T>, criteria?: MixCriteria<T>): Promise<boolean>;
-    /**
-     * 根据id判定记录是否存在
-     * @param table
-     * @param id
-     * @returns
-     */
-    existsById<T>(table: Table<T>, id: string | number): Promise<boolean>;
-    /**
-     * 按 id 查询
-     * @param table 表信息
-     * @param id
-     */
-    deleteById<T>(table: Table<T>, id: string | number): Promise<boolean>;
-    /**
-     * 按条件删除数据。批量删除是危险操作，建议在使用时尽可能设置 limit 参数来限制数量。
-     * @param opts
-     * @returns
-     */
-    deleteMany<T>(opts: DeleteManyOpts<T>): Promise<number>;
-    /**
-     * 仅删除符合条件的一条记录，必须是相等条件
-     * @param table
-     * @param criteria
-     * @returns
-     */
-    deleteOne<T>(table: Table<T>, criteria: Partial<T>): Promise<boolean>;
-    /**
-     * 查询表中所有数据.
-     * @param table  表信息
-     * @returns
-     */
-    findAll<T>(table: Table<T>): Promise<T[]>;
-    /**
-     * 按条件查询第一条记录.
-     * @param table 表信息
-     * @param criteria 查询条件
-     * @param orderBy 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
-     * @returns
-     */
-    findFirst<T>(table: Table<T>, criteria?: MixCriteria<T>, orderBy?: Array<[keyof T, 'asc' | 'desc']>): Promise<T | null>;
-    /**
-     * 插入数据. 不支持自增加长id,id必须提前生成，请使用 uuid.
-     * @param table 表信息
-     * @param data 数据，数据必须是 T 的实例, T 必须是已配置的实体类类型，否则无法完成操作
-     * @returns 插入后的数据
-     */
-    insert<T>(table: Table<T>, data: T): Promise<T>;
-    /**
-     * 批量插入
-     * @param table 表
-     * @param list 要插入的数据列表
-     */
-    insertMany<T>(table: Table<T>, list: T[]): Promise<void>;
-    /**
-     * 更新
-     * @param table 表信息
-     * @param data
-     */
-    update<T>(table: Table<T>, data: T): Promise<T>;
-    /**
-     * 更新所以匹配条件的记录
-     * @param opts
-     * @returns
-     */
-    updateMany<T>(opts: UpdateOpts<T>): Promise<number>;
-    /**
-     * 只更新一条记录。仅支持相等条件，不支持范围条件，可以严格事务中使用。
-     * @param table
-     * @param criteria
-     * @param updater
-     * @returns 更新是否成功
-     */
-    updateOne<T>(table: Table<T>, criteria: MixCriteria<T>, updater: Updater<T>): Promise<boolean>;
-    /**
-     * 部分更新
-     * @param table 表信息
-     * @param data 字段信息，必须要包含id字段，如果包含了更新和创建时间的字段，则忽略掉
-     */
-    partialUpdate<T>(table: Table<T>, data: Updater<T>): Promise<boolean>;
-    /**
-     * 查找实体类 自定义条件
-     * @param opts
-     * @returns
-     */
-    find<T>(opts: FindOpts<T>): Promise<T[]>;
-    /**
-     * 指定字段条件查询
-     * @param opts
-     * @returns
-     */
-    findSelect<T, K extends keyof T>(opts: FindSelectOpts<T, K>): Promise<Pick<T, K>[]>;
-    /**
-     * 指定条件查询数量
-     * @param table 表信息
-     * @param criteria 查询条件
-     * @returns
-     */
-    count<T>(table: Table<T>, criteria?: MixCriteria<T>): Promise<number>;
-    /**
-     * 分页查询
-     * @param opts
-     * @returns
-     */
-    paginate<T>(opts: MysqlPaginateOpts<T>): Promise<MysqlPage<T>>;
-    /**
-     * 自定义查询，指定 sql 、参数和返回值类型
-     * @param sql 预编译 sql ，参数使用 ”?“（英文问号） 占位，注意查询的字段名称会与返回值类型的字段映射，如果 sql 中的字段名称很特殊（比如纯数字等），需要设置别名，避免产生映射错误
-     * @param values 要传递的值，对应 sql 中的占位符 ”?“（英文问号）
-     * @param T 返回值类型，注意类型映射问题，详细可以参考文档中关于类型映射的说明
-     */
-    query<T>(sql: string, values?: any[]): Promise<T[]>;
-    /**
-     * 自定义 sql 执行，必须是修改类的 sql ，否则会发生错误
-     * @param sql
-     * @param values
-     * @returns 返回影响的行数
-     */
-    modify(sql: string, values?: any[]): Promise<number>;
-}
+import { Pool, PoolConnection } from 'mysql2';
+import { MysqlConfig } from '../config';
+import { Table } from '../table-info';
+import { DeleteManyOpts, FindOpts, MixCriteria, MysqlPage, MysqlPaginateOpts, MysqlPaginateSelectOpts, OrderBy, UpdateOpts, Updater, InsertValue, FindSelectOpts } from './ops';
+/**
+ * mysql 管理器基类，提供基础的操作方法.
+ */
+export declare abstract class BaseMysqlManager {
+    /**
+     * 选项，连接池和连接必须有一个，连接池优先.
+     */
+    private readonly opts;
+    /**
+     * @param mapping 映射
+     */
+    constructor(
+    /**
+     * 选项，连接池和连接必须有一个，连接池优先.
+     */
+    opts: {
+        config: MysqlConfig;
+        pool?: Pool;
+        connection?: PoolConnection;
+    });
+    protected queryWithConnection<T>(queryFn: (conn: PoolConnection) => Promise<T>): Promise<T>;
+    /**
+     * 依据id查找.
+     * @param table 表信息
+     * @param id id
+     * @returns
+     */
+    findById<T>(table: Table<T>, id: string | number): Promise<T | null>;
+    /**
+     * 根据id列表查询
+     * @param table
+     * @param ids
+     * @returns
+     */
+    findByIdIn<T>(table: Table<T>, ids: Array<string | number>): Promise<T[]>;
+    /**
+     * 根据条件判定是否存在记录.
+     * @param table
+     * @param criteria  条件信息，可以为空，为空的情况下判定整个表是否有记录
+     * @returns
+     */
+    existsBy<T>(table: Table<T>, criteria?: MixCriteria<T>): Promise<boolean>;
+    /**
+     * 根据id判定记录是否存在
+     * @param table
+     * @param id
+     * @returns
+     */
+    existsById<T>(table: Table<T>, id: string | number): Promise<boolean>;
+    /**
+     * 按 id 查询
+     * @param table 表信息
+     * @param id
+     */
+    deleteById<T>(table: Table<T>, id: string | number): Promise<boolean>;
+    /**
+     * 按条件删除数据。批量删除是危险操作，建议在使用时尽可能设置 limit 参数来限制数量。
+     * @param opts
+     * @returns
+     */
+    deleteMany<T>(opts: DeleteManyOpts<T>): Promise<number>;
+    /**
+     * 仅删除符合条件的一条记录，必须是相等条件
+     * @param table
+     * @param criteria
+     * @returns
+     */
+    deleteOne<T>(table: Table<T>, criteria: Partial<T>): Promise<boolean>;
+    /**
+     * 查询表中所有数据.
+     * @param table  表信息
+     * @returns
+     */
+    findAll<T>(table: Table<T>): Promise<T[]>;
+    /**
+     * 按条件查询第一条记录.
+     * @param table 表信息
+     * @param criteria 查询条件
+     * @param orderBy 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
+     * @returns
+     */
+    findFirst<T>(table: Table<T>, criteria?: MixCriteria<T>, orderBy?: OrderBy<T>): Promise<T | null>;
+    /**
+     * 插入数据. 不支持自增加长id,id必须提前生成，请使用 uuid.
+     * @param table 表信息
+     * @param data 数据，数据必须是 T 的实例, T 必须是已配置的实体类类型，否则无法完成操作
+     * @returns 插入后的数据
+     */
+    insert<T>(table: Table<T>, data: InsertValue<T>): Promise<T>;
+    /**
+     * 批量插入
+     * @param table 表
+     * @param list 要插入的数据列表
+     */
+    insertMany<T>(table: Table<T>, list: InsertValue<T>[]): Promise<void>;
+    /**
+     * Upsert 单条数据
+     * 如果主键冲突则更新，否则插入
+     * @param table 表信息
+     * @param data 数据
+     * @returns
+     */
+    upsert<T>(table: Table<T>, data: InsertValue<T>): Promise<T>;
+    /**
+     * Upsert 多条数据
+     * 如果主键冲突则更新，否则插入
+     * @param table 表
+     * @param list 要插入的数据列表
+     * @returns 影响的行数
+     */
+    upsertMany<T>(table: Table<T>, list: InsertValue<T>[]): Promise<number>;
+    /**
+     * Upsert 单条数据（支持自定义更新器）
+     * 如果主键冲突则按自定义逻辑更新，否则插入
+     * @param table 表信息
+     * @param data 插入的数据
+     * @param updater 冲突时的更新器
+     * @returns
+     */
+    upsertWithUpdater<T>(table: Table<T>, data: InsertValue<T>, updater: Updater<T>): Promise<T>;
+    /**
+     * 更新
+     * @param table 表信息
+     * @param data
+     */
+    update<T>(table: Table<T>, data: T): Promise<T>;
+    /**
+     * 更新所以匹配条件的记录
+     * @param opts
+     * @returns
+     */
+    updateMany<T>(opts: UpdateOpts<T>): Promise<number>;
+    /**
+     * 只更新一条记录。仅支持相等条件，不支持范围条件，可以严格事务中使用。
+     * @param table
+     * @param criteria
+     * @param updater
+     * @returns 更新是否成功
+     */
+    updateOne<T>(table: Table<T>, criteria: MixCriteria<T>, updater: Updater<T>): Promise<boolean>;
+    /**
+     * 部分更新
+     * @param table 表信息
+     * @param data 字段信息，必须要包含id字段，如果包含了更新和创建时间的字段，则忽略掉
+     */
+    partialUpdate<T>(table: Table<T>, data: Updater<T>): Promise<boolean>;
+    /**
+     * 查找实体类 自定义条件
+     * @param opts
+     * @returns
+     */
+    find<T>(opts: FindOpts<T>): Promise<T[]>;
+    /**
+     * 指定字段条件查询
+     * @param opts
+     * @returns
+     */
+    findSelect<T, K extends keyof T>(opts: FindSelectOpts<T, K>): Promise<Pick<T, K>[]>;
+    /**
+     * 指定条件查询数量
+     * @param table 表信息
+     * @param criteria 查询条件
+     * @returns
+     */
+    count<T>(table: Table<T>, criteria?: MixCriteria<T>): Promise<number>;
+    /**
+     * 分页查询
+     * @param opts
+     * @returns
+     */
+    paginate<T>(opts: MysqlPaginateOpts<T>): Promise<MysqlPage<T>>;
+    /**
+     * 指定字段分页查询
+     * @param opts
+     * @returns
+     */
+    paginateSelect<T, K extends keyof T>(opts: MysqlPaginateSelectOpts<T, K>): Promise<MysqlPage<Pick<T, K>>>;
+    /**
+     * 自定义查询，指定 sql 、参数和返回值类型
+     * @param sql 预编译 sql ，参数使用 ”?“（英文问号） 占位，注意查询的字段名称会与返回值类型的字段映射，如果 sql 中的字段名称很特殊（比如纯数字等），需要设置别名，避免产生映射错误
+     * @param values 要传递的值，对应 sql 中的占位符 ”?“（英文问号）
+     * @param T 返回值类型，注意类型映射问题，详细可以参考文档中关于类型映射的说明
+     */
+    query<T>(sql: string, values?: any[]): Promise<T[]>;
+    /**
+     * 自定义 sql 执行，必须是修改类的 sql ，否则会发生错误
+     * @param sql
+     * @param values
+     * @returns 返回影响的行数
+     */
+    modify(sql: string, values?: any[]): Promise<number>;
+}

package/types/mysql/manager/index.d.ts

@@ -1,36 +1,36 @@
-import { Pool } from 'mysql2';
-import { MysqlConfig } from '../config';
-import { BaseMysqlManager } from './base';
-import { MysqlTxSession } from './tx';
-/**
- * mysql 管理器，封装数据库操作，提供方便使用的实体类操作方法.
- */
-export declare class MysqlManager extends BaseMysqlManager {
-    private readonly config;
-    /**
-     * 连接池.
-     */
-    private readonly pool;
-    /**
-     * @param mapping 映射
-     */
-    constructor(config: MysqlConfig, 
-    /**
-     * 连接池.
-     */
-    pool: Pool);
-    /**
-     * 事务. 所有事务中的操作都必须使用 exec 函数中提供的 session 对象，直接使用 MysqlManager 上的方法
-     * 进行的操作不会在事务中生效.
-     * @param ops 逻辑执行函数，内部的所有逻辑都必须在函数内执行完，
-     * 不得有操作在函数外异步执行（异步操作不 await，或使用定时器单独执行等），否则不会在事务中生效
-     * @param opts 选项，可设置超时时间等
-     */
-    tx<T>(ops: (session: MysqlTxSession) => Promise<T>, opts?: {
-        timeout?: number;
-        isolationLevel?: 'REPEATABLE READ' | 'READ COMMITTED' | 'READ UNCOMMITTED' | 'SERIALIZABLE';
-        accessMode?: 'READ WRITE' | 'READ ONLY';
-    }): Promise<T>;
-}
-export { FindOpts, MixCriteria, MysqlCriteria } from './ops';
-export { BaseMysqlManager, MysqlTxSession };
+import { Pool } from 'mysql2';
+import { MysqlConfig } from '../config';
+import { BaseMysqlManager } from './base';
+import { MysqlTxSession } from './tx';
+/**
+ * mysql 管理器，封装数据库操作，提供方便使用的实体类操作方法.
+ */
+export declare class MysqlManager extends BaseMysqlManager {
+    private readonly config;
+    /**
+     * 连接池.
+     */
+    private readonly pool;
+    /**
+     * @param mapping 映射
+     */
+    constructor(config: MysqlConfig, 
+    /**
+     * 连接池.
+     */
+    pool: Pool);
+    /**
+     * 事务. 所有事务中的操作都必须使用 exec 函数中提供的 session 对象，直接使用 MysqlManager 上的方法
+     * 进行的操作不会在事务中生效.
+     * @param ops 逻辑执行函数，内部的所有逻辑都必须在函数内执行完，
+     * 不得有操作在函数外异步执行（异步操作不 await，或使用定时器单独执行等），否则不会在事务中生效
+     * @param opts 选项，可设置超时时间等
+     */
+    tx<T>(ops: (session: MysqlTxSession) => Promise<T>, opts?: {
+        timeout?: number;
+        isolationLevel?: 'REPEATABLE READ' | 'READ COMMITTED' | 'READ UNCOMMITTED' | 'SERIALIZABLE';
+        accessMode?: 'READ WRITE' | 'READ ONLY';
+    }): Promise<T>;
+}
+export { FindOpts, MixCriteria, MysqlCriteria } from './ops';
+export { BaseMysqlManager, MysqlTxSession };

package/types/mysql/manager/ops/count.d.ts

@@ -1,13 +1,13 @@
-import { PoolConnection } from 'mysql2';
-import { Table } from '../../table-info';
-import { MixCriteria } from './criteria';
-import { MysqlConfig } from '../../config';
-/**
- * 按条件统计数量.
- * @param config
- * @param conn
- * @param table
- * @param criteria
- * @returns
- */
-export declare function count<T>(config: MysqlConfig, conn: PoolConnection, table: Table<T>, criteria?: MixCriteria<T>): Promise<number>;
+import { PoolConnection } from 'mysql2';
+import { Table } from '../../table-info';
+import { MixCriteria } from './criteria';
+import { MysqlConfig } from '../../config';
+/**
+ * 按条件统计数量.
+ * @param config
+ * @param conn
+ * @param table
+ * @param criteria
+ * @returns
+ */
+export declare function count<T>(config: MysqlConfig, conn: PoolConnection, table: Table<T>, criteria?: MixCriteria<T>): Promise<number>;