wok-server 0.5.0 → 0.7.0

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

@@ -1,134 +1,144 @@
-export interface MysqlQuery {
-    sql: string;
-    values: any[];
-}
-/**
- * mysql 查询条件中的键，左侧表达式，可以是提取信息的表达式，也可以直接是列名
- *
- * keyof T 列名，直接用列的值来比较
- * ['json_extract', keyof T, string] 使用 json_extract 函数提取 json 信息，第二个参数是列名，最后一个参数是表达式（如：'$.name'）
- * ['json_length',keyof T] 使用 json_length 函数提取 json 数组的元素数量
- */
-export type MysqlCriteriaKey<T> = keyof T | ['json_extract', keyof T, string] | ['json_length', keyof T];
-/**
- * mysql 查询条件（ query criterion ），默认查询条件都是并且关系（and）， 部分方法会有例外，在使用的时候请注意方法说明。
- *
- * @param <T> 表类型
- */
-export declare class MysqlCriteria<T> {
-    /**
-     * 条件列表.
-     */
-    private criteria;
-    /**
-     * 相等.
-     * @param column
-     * @param value
-     */
-    eq(column: MysqlCriteriaKey<T>, value: any): this;
-    /**
-     * 不等于，注意不相等不能走索引，谨慎使用
-     * @param column
-     * @param value
-     */
-    neq(column: MysqlCriteriaKey<T>, value: any): this;
-    /**
-     * like
-     * @param column
-     * @param value
-     * @returns
-     */
-    like(column: MysqlCriteriaKey<T>, value: string): this;
-    /**
-     * not like
-     * @param column
-     * @param value
-     * @returns
-     */
-    notLike(column: MysqlCriteriaKey<T>, value: string): this;
-    /**
-     * BETWEEN x and y
-     */
-    between(column: MysqlCriteriaKey<T>, min: number, max: number): this;
-    /**
-     * 大于
-     * @param column
-     * @param value
-     */
-    gt(column: MysqlCriteriaKey<T>, value: number | Date | string): this;
-    /**
-     * 大于等于
-     * @param column
-     * @param value
-     */
-    gte(column: MysqlCriteriaKey<T>, value: number | Date | string): this;
-    /**
-     * 小于
-     * @param column
-     * @param value
-     */
-    lt(column: MysqlCriteriaKey<T>, value: number | Date | string): this;
-    /**
-     * 小于等于
-     * @param column
-     * @param value
-     */
-    lte(column: MysqlCriteriaKey<T>, value: number | Date | string): this;
-    /**
-     * in 条件
-     * @param column
-     * @param values
-     */
-    in(column: MysqlCriteriaKey<T>, values: Array<string | number>): this;
-    /**
-     * not in 条件
-     * @param column
-     * @param values
-     */
-    notIn(column: MysqlCriteriaKey<T>, values: Array<string | number>): this;
-    /**
-     * 嵌入其它的查询条件，与现有的查询条件是或者关系.
-     * @param criteria
-     */
-    or(orCriteria: (criteria: MysqlCriteria<T>) => void): this;
-    /**
-     * 嵌入其它的查询条件，与现有的查询条件是并且关系.
-     * @param criteria
-     */
-    and(andCriteria: (criteria: MysqlCriteria<T>) => void): this;
-    /**
-     * 字段为空
-     * @param field
-     * @returns
-     */
-    isNull(field: MysqlCriteriaKey<T>): this;
-    /**
-     * 字段非空
-     * @param field
-     * @returns
-     */
-    isNotNull(field: MysqlCriteriaKey<T>): this;
-    /**
-     * 判定是否空，未设置条件.
-     * @returns
-     */
-    isEmpty(): boolean;
-    /**
-     * 检查条件信息是否有效，在出错时能给予较详细的提示，以方便排查.
-     */
-    check(): void;
-    /**
-     * 生成查询数据
-     */
-    generateQuery(): MysqlQuery;
-}
-/**
- * 混合的查询对象.
- */
-export type MixCriteria<T> = Partial<T> | ((criteria: MysqlCriteria<T>) => void) | MysqlCriteria<T>;
-/**
- * 将混合的查询条件转换成查询语句，如果最终构建的条件是空的，返回 undefined
- * @param criteria
- * @returns
- */
-export declare function buildQuery<T>(criteria: MixCriteria<T>): MysqlQuery | undefined;
+export interface MysqlQuery {
+    sql: string;
+    values: any[];
+}
+/**
+ * mysql 查询条件中的键，左侧表达式，可以是提取信息的表达式，也可以直接是列名
+ *
+ * keyof T 列名，直接用列的值来比较
+ * ['json_extract', keyof T, string] 使用 json_extract 函数提取 json 信息，第二个参数是列名，最后一个参数是表达式（如：'$.name'）
+ * ['json_length',keyof T] 使用 json_length 函数提取 json 数组的元素数量
+ */
+export type MysqlCriteriaKey<T> = keyof T | ['json_extract', keyof T, string] | ['json_length', keyof T];
+/**
+ * mysql 查询条件（ query criterion ），默认查询条件都是并且关系（and）， 部分方法会有例外，在使用的时候请注意方法说明。
+ *
+ * @param <T> 表类型
+ */
+export declare class MysqlCriteria<T> {
+    /**
+     * 条件列表.
+     */
+    private criteria;
+    /**
+     * 相等.
+     * @param column
+     * @param value
+     */
+    eq(column: MysqlCriteriaKey<T>, value: any): this;
+    /**
+     * 不等于，注意不相等不能走索引，谨慎使用
+     * @param column
+     * @param value
+     */
+    neq(column: MysqlCriteriaKey<T>, value: any): this;
+    /**
+     * like
+     * @param column
+     * @param value
+     * @returns
+     */
+    like(column: MysqlCriteriaKey<T>, value: string): this;
+    /**
+     * not like
+     * @param column
+     * @param value
+     * @returns
+     */
+    notLike(column: MysqlCriteriaKey<T>, value: string): this;
+    /**
+     * BETWEEN x and y
+     */
+    between(column: MysqlCriteriaKey<T>, min: number, max: number): this;
+    /**
+     * 大于
+     * @param column
+     * @param value
+     */
+    gt(column: MysqlCriteriaKey<T>, value: number | Date | string): this;
+    /**
+     * 大于等于
+     * @param column
+     * @param value
+     */
+    gte(column: MysqlCriteriaKey<T>, value: number | Date | string): this;
+    /**
+     * 小于
+     * @param column
+     * @param value
+     */
+    lt(column: MysqlCriteriaKey<T>, value: number | Date | string): this;
+    /**
+     * 小于等于
+     * @param column
+     * @param value
+     */
+    lte(column: MysqlCriteriaKey<T>, value: number | Date | string): this;
+    /**
+     * in 条件
+     * @param column
+     * @param values
+     */
+    in(column: MysqlCriteriaKey<T>, values: Array<string | number>): this;
+    /**
+     * not in 条件
+     * @param column
+     * @param values
+     */
+    notIn(column: MysqlCriteriaKey<T>, values: Array<string | number>): this;
+    /**
+     * 嵌入其它的查询条件，与现有的查询条件是或者关系.
+     * @param criteria
+     */
+    or(orCriteria: (criteria: MysqlCriteria<T>) => void): this;
+    /**
+     * 嵌入其它的查询条件，与现有的查询条件是并且关系.
+     * @param criteria
+     */
+    and(andCriteria: (criteria: MysqlCriteria<T>) => void): this;
+    /**
+     * 字段为空
+     * @param field
+     * @returns
+     */
+    isNull(field: MysqlCriteriaKey<T>): this;
+    /**
+     * 字段非空
+     * @param field
+     * @returns
+     */
+    isNotNull(field: MysqlCriteriaKey<T>): this;
+    /**
+     * 自定义表达式查询
+     * 如 .expr('?? * ? > ?', ['balance', 2, 50])
+     * 如 .expr('MATCH(??, ??) AGAINST(? IN BOOLEAN MODE)', ['title', 'content', keyword])
+     * 如 .expr('VECTOR_DISTANCE(??, STRING_TO_VECTOR(?)) < ?', ['content_vec', embedding, threshold])
+     * @param sql SQL 片段，使用 ?? 引用列名，? 引用参数值
+     * @param values 参数值数组，按 SQL 中占位符顺序传入
+     * @returns
+     */
+    expr(sql: string, values?: any[]): this;
+    /**
+     * 判定是否空，未设置条件.
+     * @returns
+     */
+    isEmpty(): boolean;
+    /**
+     * 检查条件信息是否有效，在出错时能给予较详细的提示，以方便排查.
+     */
+    check(): void;
+    /**
+     * 生成查询数据
+     */
+    generateQuery(): MysqlQuery;
+}
+/**
+ * 混合的查询对象.
+ */
+export type MixCriteria<T> = Partial<T> | ((criteria: MysqlCriteria<T>) => void) | MysqlCriteria<T>;
+/**
+ * 将混合的查询条件转换成查询语句，如果最终构建的条件是空的，返回 undefined
+ * @param criteria
+ * @returns
+ */
+export declare function buildQuery<T>(criteria: MixCriteria<T>): MysqlQuery | undefined;

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

@@ -1,46 +1,47 @@
-import { PoolConnection } from 'mysql2';
-import { Table } from '../../table-info';
-import { MixCriteria } from './criteria';
-import { MysqlConfig } from '../../config';
-/**
- * 按 id 删除.
- *
- * @param config
- * @param connection
- * @param mapping
- * @param type
- * @param id
- */
-export declare function deleteById<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, id: string | number): Promise<boolean>;
-/**
- * 批量删除的选项
- */
-export interface DeleteManyOpts<T> {
-    /**
-     * 表.
-     */
-    table: Table<T>;
-    /**
-     * 查询条件
-     * @param criteria
-     * @returns
-     */
-    criteria: MixCriteria<T>;
-    /**
-     * 限制数量
-     */
-    limit?: number;
-    /**
-     * 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
-     */
-    orderBy?: Array<[keyof T, 'asc' | 'desc']>;
-}
-/**
- * 按条件删除，返回被删除的记录数.
- * 务必谨慎使用，大批量删除容易带来性能问题，造成线上事故.
- * @param config
- * @param connection
- * @param table
- * @param criteria
- */
-export declare function deleteMany<T>(config: MysqlConfig, connection: PoolConnection, opts: DeleteManyOpts<T>): Promise<number>;
+import { PoolConnection } from 'mysql2';
+import { Table } from '../../table-info';
+import { MixCriteria } from './criteria';
+import { MysqlConfig } from '../../config';
+import { OrderBy } from './order-by';
+/**
+ * 按 id 删除.
+ *
+ * @param config
+ * @param connection
+ * @param mapping
+ * @param type
+ * @param id
+ */
+export declare function deleteById<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, id: string | number): Promise<boolean>;
+/**
+ * 批量删除的选项
+ */
+export interface DeleteManyOpts<T> {
+    /**
+     * 表.
+     */
+    table: Table<T>;
+    /**
+     * 查询条件
+     * @param criteria
+     * @returns
+     */
+    criteria: MixCriteria<T>;
+    /**
+     * 限制数量
+     */
+    limit?: number;
+    /**
+     * 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
+     */
+    orderBy?: OrderBy<T>;
+}
+/**
+ * 按条件删除，返回被删除的记录数.
+ * 务必谨慎使用，大批量删除容易带来性能问题，造成线上事故.
+ * @param config
+ * @param connection
+ * @param table
+ * @param criteria
+ */
+export declare function deleteMany<T>(config: MysqlConfig, connection: PoolConnection, opts: DeleteManyOpts<T>): Promise<number>;

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

@@ -1,6 +1,6 @@
-import { PoolConnection } from 'mysql2';
-import { Table } from '../../table-info';
-import { MixCriteria } from './criteria';
-import { MysqlConfig } from '../../config';
-export declare function existsById<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, id: string | number): Promise<boolean>;
-export declare function existsBy<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, criteria?: MixCriteria<T>): Promise<boolean>;
+import { PoolConnection } from 'mysql2';
+import { Table } from '../../table-info';
+import { MixCriteria } from './criteria';
+import { MysqlConfig } from '../../config';
+export declare function existsById<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, id: string | number): Promise<boolean>;
+export declare function existsBy<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, criteria?: MixCriteria<T>): Promise<boolean>;

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

@@ -1,86 +1,87 @@
-import { PoolConnection } from 'mysql2';
-import { Table } from '../../table-info';
-import { MixCriteria } from './criteria';
-import { MysqlConfig } from '../../config';
-/**
- * 按 id 查询
- * @param connection
- * @param mapping
- * @param type
- * @param id
- */
-export declare function findById<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, id: string | number): Promise<T | null>;
-/**
- * 查询表中所有数据。需谨慎操作，全表查询有可能会产生大列表问题。
- * @param connection
- * @param mapping
- * @param type
- * @returns
- */
-export declare function findAll<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>): Promise<T[]>;
-export interface FindOpts<T> {
-    /**
-     * 表
-     */
-    table: Table<T>;
-    /**
-     * 查询条件
-     * @param criteria
-     * @returns
-     */
-    criteria?: MixCriteria<T>;
-    /**
-     * 偏移，需要 limit 有值才可以
-     */
-    offset?: number;
-    /**
-     * 限制返回的数量
-     */
-    limit?: number;
-    /**
-     * 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
-     */
-    orderBy?: Array<[keyof T, 'asc' | 'desc']>;
-}
-/**
- * 条件查询
- * @param opts
- * @returns
- */
-export declare function find<T>(config: MysqlConfig, conn: PoolConnection, opts: FindOpts<T>): Promise<T[]>;
-/**
- * 指定字段条件查询选项
- */
-export interface FindSelectOpts<T, K extends keyof T> extends FindOpts<T> {
-    /**
-     * 要查询的字段
-     */
-    select: K[];
-}
-/**
- * 查询指定的字段，返回值类型与选择的字段有关
- * @param onfig
- * @param conn
- * @param opts
- */
-export declare function findSelect<T, K extends keyof T>(config: MysqlConfig, conn: PoolConnection, opts: FindSelectOpts<T, K>): Promise<Array<Pick<T, K>>>;
-/**
- * 根据 id 列表查询记录
- * @param connection
- * @param table
- * @param ids
- * @returns
- */
-export declare function findByIdIn<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, ids: Array<string | number>): Promise<T[]>;
-/**
- * 查找符合条件的第一条记录
- * @param conn
- * @param table
- * @param criteria
- * @returns
- */
-export declare function findFirst<T>(config: MysqlConfig, conn: PoolConnection, table: Table<T>, criteria?: MixCriteria<T>, 
-/**
- * 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
- */
-orderBy?: Array<[keyof T, 'asc' | 'desc']>): Promise<T | null>;
+import { PoolConnection } from 'mysql2';
+import { Table } from '../../table-info';
+import { MixCriteria } from './criteria';
+import { MysqlConfig } from '../../config';
+import { OrderBy } from './order-by';
+/**
+ * 按 id 查询
+ * @param connection
+ * @param mapping
+ * @param type
+ * @param id
+ */
+export declare function findById<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, id: string | number): Promise<T | null>;
+/**
+ * 查询表中所有数据。需谨慎操作，全表查询有可能会产生大列表问题。
+ * @param connection
+ * @param mapping
+ * @param type
+ * @returns
+ */
+export declare function findAll<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>): Promise<T[]>;
+export interface FindOpts<T> {
+    /**
+     * 表
+     */
+    table: Table<T>;
+    /**
+     * 查询条件
+     * @param criteria
+     * @returns
+     */
+    criteria?: MixCriteria<T>;
+    /**
+     * 偏移，需要 limit 有值才可以
+     */
+    offset?: number;
+    /**
+     * 限制返回的数量
+     */
+    limit?: number;
+    /**
+     * 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
+     */
+    orderBy?: OrderBy<T>;
+}
+/**
+ * 条件查询
+ * @param opts
+ * @returns
+ */
+export declare function find<T>(config: MysqlConfig, conn: PoolConnection, opts: FindOpts<T>): Promise<T[]>;
+/**
+ * 指定字段条件查询选项
+ */
+export interface FindSelectOpts<T, K extends keyof T> extends FindOpts<T> {
+    /**
+     * 要查询的字段
+     */
+    select: K[];
+}
+/**
+ * 查询指定的字段，返回值类型与选择的字段有关
+ * @param onfig
+ * @param conn
+ * @param opts
+ */
+export declare function findSelect<T, K extends keyof T>(config: MysqlConfig, conn: PoolConnection, opts: FindSelectOpts<T, K>): Promise<Array<Pick<T, K>>>;
+/**
+ * 根据 id 列表查询记录
+ * @param connection
+ * @param table
+ * @param ids
+ * @returns
+ */
+export declare function findByIdIn<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, ids: Array<string | number>): Promise<T[]>;
+/**
+ * 查找符合条件的第一条记录
+ * @param conn
+ * @param table
+ * @param criteria
+ * @returns
+ */
+export declare function findFirst<T>(config: MysqlConfig, conn: PoolConnection, table: Table<T>, criteria?: MixCriteria<T>, 
+/**
+ * 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
+ */
+orderBy?: OrderBy<T>): Promise<T | null>;

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

@@ -1,10 +1,12 @@
-export * from './count';
-export * from './criteria';
-export * from './delete';
-export * from './exist';
-export * from './find';
-export * from './insert';
-export * from './modify';
-export * from './paginate';
-export * from './query';
-export * from './update';
+export * from './count';
+export * from './criteria';
+export * from './delete';
+export * from './exist';
+export * from './find';
+export * from './insert';
+export * from './modify';
+export * from './order-by';
+export * from './upsert';
+export * from './paginate';
+export * from './query';
+export * from './update';

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

@@ -1,18 +1,32 @@
-import { PoolConnection } from 'mysql2';
-import { Table } from '../../table-info';
-import { MysqlConfig } from '../../config';
-/**
- * 为表插入数据
- * @param connection
- * @param table
- * @param data
- * @returns
- */
-export declare function insert<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, data: T): Promise<T>;
-/**
- * 一次插入多条记录
- * @param connection 连接
- * @param table 表
- * @param list 要插入的记录列表
- */
-export declare function insertMany<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, list: T[]): Promise<void>;
+import { PoolConnection } from 'mysql2';
+import { Table } from '../../table-info';
+import { MysqlConfig } from '../../config';
+/**
+ * 插入值类型，支持在 INSERT VALUES 中使用表达式
+ */
+export type InsertValue<T> = {
+    [K in keyof T]?: T[K] | ['now'] | ['set', T[K]] | ['expr', string] | ['expr', string, any[]];
+};
+/**
+ * 处理 insert value，支持表达式
+ * @returns { frag: SQL 片段, values: 参数值数组 }
+ */
+export declare function processInsertValue(value: any): {
+    frag: string;
+    values: any[];
+};
+/**
+ * 为表插入数据
+ * @param connection
+ * @param table
+ * @param data
+ * @returns
+ */
+export declare function insert<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, data: InsertValue<T>): Promise<T>;
+/**
+ * 一次插入多条记录
+ * @param connection 连接
+ * @param table 表
+ * @param list 要插入的记录列表
+ */
+export declare function insertMany<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, list: InsertValue<T>[]): Promise<void>;

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

@@ -1,3 +1,3 @@
-import { PoolConnection } from 'mysql2';
-import { MysqlConfig } from '../../config';
-export declare function modify(config: MysqlConfig, connection: PoolConnection, sql: string, values?: any[]): Promise<number>;
+import { PoolConnection } from 'mysql2';
+import { MysqlConfig } from '../../config';
+export declare function modify(config: MysqlConfig, connection: PoolConnection, sql: string, values?: any[]): Promise<number>;