wok-server 0.5.0 → 0.7.0

package/dist/mysql/manager/ops/criteria.js

@@ -1,356 +1,381 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildQuery = exports.MysqlCriteria = void 0;
-const exception_1 = require("../../exception");
-/**
- * 生成条件查询中键的sql片段，包含 sql 内容和要传递的值
- */
-function generateMysqlCriteriaKeySqlSeg(key) {
-    if (Array.isArray(key)) {
-        if (key[0] === 'json_extract') {
-            return { sqlSeg: `JSON_EXTRACT(??, ${JSON.stringify(key[2])})`, value: key[1] };
-        }
-        if (key[0] === 'json_length') {
-            return { sqlSeg: `JSON_LENGTH(??)`, value: key[1] };
-        }
-        throw new exception_1.MysqlException(`Unsupported MysqlCriteriaKey type: ${key[0]}`);
-    }
-    return { sqlSeg: '??', value: key };
-}
-/**
- * mysql 查询条件（ query criterion ），默认查询条件都是并且关系（and）， 部分方法会有例外，在使用的时候请注意方法说明。
- *
- * @param <T> 表类型
- */
-class MysqlCriteria {
-    /**
-     * 条件列表.
-     */
-    criteria = [];
-    /**
-     * 相等.
-     * @param column
-     * @param value
-     */
-    eq(column, value) {
-        this.criteria.push({ type: 'eq', key: column, value });
-        return this;
-    }
-    /**
-     * 不等于，注意不相等不能走索引，谨慎使用
-     * @param column
-     * @param value
-     */
-    neq(column, value) {
-        this.criteria.push({ type: 'neq', key: column, value });
-        return this;
-    }
-    /**
-     * like
-     * @param column
-     * @param value
-     * @returns
-     */
-    like(column, value) {
-        this.criteria.push({ type: 'like', key: column, value });
-        return this;
-    }
-    /**
-     * not like
-     * @param column
-     * @param value
-     * @returns
-     */
-    notLike(column, value) {
-        this.criteria.push({ type: 'notLike', key: column, value });
-        return this;
-    }
-    /**
-     * BETWEEN x and y
-     */
-    between(column, min, max) {
-        this.criteria.push({ type: 'between', key: column, value: [min, max] });
-        return this;
-    }
-    /**
-     * 大于
-     * @param column
-     * @param value
-     */
-    gt(column, value) {
-        this.criteria.push({ type: 'gt', key: column, value });
-        return this;
-    }
-    /**
-     * 大于等于
-     * @param column
-     * @param value
-     */
-    gte(column, value) {
-        this.criteria.push({ type: 'gte', key: column, value });
-        return this;
-    }
-    /**
-     * 小于
-     * @param column
-     * @param value
-     */
-    lt(column, value) {
-        this.criteria.push({ type: 'lt', key: column, value });
-        return this;
-    }
-    /**
-     * 小于等于
-     * @param column
-     * @param value
-     */
-    lte(column, value) {
-        this.criteria.push({ type: 'lte', key: column, value });
-        return this;
-    }
-    /**
-     * in 条件
-     * @param column
-     * @param values
-     */
-    in(column, values) {
-        this.criteria.push({ type: 'in', key: column, value: values });
-        return this;
-    }
-    /**
-     * not in 条件
-     * @param column
-     * @param values
-     */
-    notIn(column, values) {
-        this.criteria.push({ type: 'notIn', key: column, value: values });
-        return this;
-    }
-    /**
-     * 嵌入其它的查询条件，与现有的查询条件是或者关系.
-     * @param criteria
-     */
-    or(orCriteria) {
-        const criteria = new MysqlCriteria();
-        orCriteria(criteria);
-        this.criteria.push({ type: 'or', criteria });
-        return this;
-    }
-    /**
-     * 嵌入其它的查询条件，与现有的查询条件是并且关系.
-     * @param criteria
-     */
-    and(andCriteria) {
-        const criteria = new MysqlCriteria();
-        andCriteria(criteria);
-        this.criteria.push({ type: 'and', criteria });
-        return this;
-    }
-    /**
-     * 字段为空
-     * @param field
-     * @returns
-     */
-    isNull(field) {
-        this.criteria.push({ type: 'isNull', key: field });
-        return this;
-    }
-    /**
-     * 字段非空
-     * @param field
-     * @returns
-     */
-    isNotNull(field) {
-        this.criteria.push({ type: 'isNotNull', key: field });
-        return this;
-    }
-    /**
-     * 判定是否空，未设置条件.
-     * @returns
-     */
-    isEmpty() {
-        return !this.criteria.length;
-    }
-    /**
-     * 检查条件信息是否有效，在出错时能给予较详细的提示，以方便排查.
-     */
-    check() {
-        for (const criterion of this.criteria) {
-            if (criterion.type === 'or' || criterion.type === 'and') {
-                if (!criterion.criteria) {
-                    throw new exception_1.MysqlException(`${criterion.type} clause cannot be empty`);
-                }
-                criterion.criteria.check();
-                continue;
-            }
-            if (!criterion.key) {
-                throw new exception_1.MysqlException('The column name of the query criteria cannot be blank.');
-            }
-            if (criterion.type === 'isNull' || criterion.type === 'isNotNull') {
-                continue;
-            }
-            if (criterion.type === 'in' || criterion.type === 'notIn') {
-                if (!Array.isArray(criterion.value)) {
-                    throw new exception_1.MysqlException(`Invalid ${criterion.type} condition，the condition value is not a array type，column name：${criterion.key.toString()}`);
-                }
-                if (!criterion.value.length) {
-                    throw new exception_1.MysqlException(`Invalid ${criterion.type} condition，the condition value cannot be an empty array，column name：${criterion.key.toString()}`);
-                }
-                continue;
-            }
-            if (criterion.type === 'between') {
-                if (!Array.isArray(criterion.value)) {
-                    throw new exception_1.MysqlException(`Invalid between condition，the condition value is not an array type，column name：${criterion.key.toString()}, value:${criterion.value}`);
-                }
-                if (criterion.value.length !== 2) {
-                    throw new exception_1.MysqlException(`Invalid between condition，the condition value must be an array of length 2，column: ${criterion.key.toString()}，value：${criterion.value.length}`);
-                }
-                continue;
-            }
-            if (typeof criterion.value !== 'number' &&
-                typeof criterion.value !== 'string' &&
-                typeof criterion.value !== 'boolean' &&
-                !(criterion.value instanceof Date)) {
-                throw new exception_1.MysqlException('The value of the query criteria is invalid，only number,string,boolean and Date are supported，' +
-                    `column name : ${criterion.key.toString()}，value : ${criterion.value} .`);
-            }
-        }
-    }
-    /**
-     * 生成查询数据
-     */
-    generateQuery() {
-        this.check();
-        const sqlFragments = [];
-        const values = [];
-        for (const criterion of this.criteria) {
-            // 普通的查询
-            if (criterion.key && criterion.value !== undefined) {
-                // between 特殊处理
-                if (criterion.type === 'between') {
-                    sqlFragments.push('and ?? between ? and ? ');
-                    values.push(criterion.key, criterion.value[0], criterion.value[1]);
-                    continue;
-                }
-                // 符号
-                let sign = '';
-                if (criterion.type === 'eq') {
-                    sign = '=';
-                }
-                else if (criterion.type === 'neq') {
-                    sign = '!=';
-                }
-                else if (criterion.type === 'gt') {
-                    sign = '>';
-                }
-                else if (criterion.type === 'gte') {
-                    sign = '>=';
-                }
-                else if (criterion.type === 'lt') {
-                    sign = '<';
-                }
-                else if (criterion.type === 'lte') {
-                    sign = '<=';
-                }
-                else if (criterion.type === 'in') {
-                    sign = 'in';
-                }
-                else if (criterion.type === 'notIn') {
-                    sign = 'not in';
-                }
-                else if (criterion.type === 'like') {
-                    sign = 'like';
-                }
-                else if (criterion.type === 'notLike') {
-                    sign = 'not like';
-                }
-                if (sign) {
-                    const keySeg = generateMysqlCriteriaKeySqlSeg(criterion.key);
-                    if (criterion.type === 'in' || criterion.type === 'notIn') {
-                        sqlFragments.push(`and ${keySeg.sqlSeg} ${sign} (?) `);
-                    }
-                    else {
-                        sqlFragments.push(`and ${keySeg.sqlSeg} ${sign} ? `);
-                    }
-                    values.push(keySeg.value, criterion.value);
-                }
-                continue;
-            }
-            else if (criterion.key) {
-                const keySeg = generateMysqlCriteriaKeySqlSeg(criterion.key);
-                if (criterion.type === 'isNull') {
-                    sqlFragments.push(`and ${keySeg.sqlSeg} is null `);
-                    values.push(keySeg.value);
-                    continue;
-                }
-                if (criterion.type === 'isNotNull') {
-                    sqlFragments.push(`and ${keySeg.sqlSeg} is not null `);
-                    values.push(keySeg.value);
-                    continue;
-                }
-            }
-            // 特殊查询 or 和 and
-            else if (criterion.criteria) {
-                const query = criterion.criteria.generateQuery();
-                if (criterion.type === 'or') {
-                    sqlFragments.push(`or (${query.sql}) `);
-                    values.push(...query.values);
-                    continue;
-                }
-                if (criterion.type === 'and') {
-                    sqlFragments.push(`and (${query.sql}) `);
-                    values.push(...query.values);
-                    continue;
-                }
-            }
-        }
-        if (!sqlFragments.length) {
-            throw new exception_1.MysqlException('No valid query criteria have been set.');
-        }
-        let sql = sqlFragments.join('');
-        // 去除掉第一个条件的连接关键字，可能是 and 或 or
-        if (sql.startsWith('and')) {
-            sql = sql.substring(3);
-        }
-        else if (sql.startsWith('or')) {
-            sql = sql.substring(2);
-        }
-        return { sql, values };
-    }
-}
-exports.MysqlCriteria = MysqlCriteria;
-function convertToCriteria(example) {
-    const criteria = new MysqlCriteria();
-    Object.entries(example).forEach(entry => {
-        const [key, value] = entry;
-        criteria.eq(key, value);
-    });
-    return criteria;
-}
-/**
- * 将混合的查询条件转换成查询语句，如果最终构建的条件是空的，返回 undefined
- * @param criteria
- * @returns
- */
-function buildQuery(criteria) {
-    if (criteria instanceof Function) {
-        const c = new MysqlCriteria();
-        criteria(c);
-        if (!c.isEmpty()) {
-            return c.generateQuery();
-        }
-    }
-    else if (criteria instanceof MysqlCriteria) {
-        if (!criteria.isEmpty()) {
-            return criteria.generateQuery();
-        }
-    }
-    else {
-        const c = convertToCriteria(criteria);
-        if (!c.isEmpty()) {
-            return c.generateQuery();
-        }
-    }
-    return undefined;
-}
-exports.buildQuery = buildQuery;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildQuery = exports.MysqlCriteria = void 0;
+const exception_1 = require("../../exception");
+/**
+ * 生成条件查询中键的sql片段，包含 sql 内容和要传递的值
+ */
+function generateMysqlCriteriaKeySqlSeg(key) {
+    if (Array.isArray(key)) {
+        if (key[0] === 'json_extract') {
+            return { sqlSeg: `JSON_EXTRACT(??, ${JSON.stringify(key[2])})`, value: key[1] };
+        }
+        if (key[0] === 'json_length') {
+            return { sqlSeg: `JSON_LENGTH(??)`, value: key[1] };
+        }
+        throw new exception_1.MysqlException(`Unsupported MysqlCriteriaKey type: ${key[0]}`);
+    }
+    return { sqlSeg: '??', value: key };
+}
+/**
+ * mysql 查询条件（ query criterion ），默认查询条件都是并且关系（and）， 部分方法会有例外，在使用的时候请注意方法说明。
+ *
+ * @param <T> 表类型
+ */
+class MysqlCriteria {
+    /**
+     * 条件列表.
+     */
+    criteria = [];
+    /**
+     * 相等.
+     * @param column
+     * @param value
+     */
+    eq(column, value) {
+        this.criteria.push({ type: 'eq', key: column, value });
+        return this;
+    }
+    /**
+     * 不等于，注意不相等不能走索引，谨慎使用
+     * @param column
+     * @param value
+     */
+    neq(column, value) {
+        this.criteria.push({ type: 'neq', key: column, value });
+        return this;
+    }
+    /**
+     * like
+     * @param column
+     * @param value
+     * @returns
+     */
+    like(column, value) {
+        this.criteria.push({ type: 'like', key: column, value });
+        return this;
+    }
+    /**
+     * not like
+     * @param column
+     * @param value
+     * @returns
+     */
+    notLike(column, value) {
+        this.criteria.push({ type: 'notLike', key: column, value });
+        return this;
+    }
+    /**
+     * BETWEEN x and y
+     */
+    between(column, min, max) {
+        this.criteria.push({ type: 'between', key: column, value: [min, max] });
+        return this;
+    }
+    /**
+     * 大于
+     * @param column
+     * @param value
+     */
+    gt(column, value) {
+        this.criteria.push({ type: 'gt', key: column, value });
+        return this;
+    }
+    /**
+     * 大于等于
+     * @param column
+     * @param value
+     */
+    gte(column, value) {
+        this.criteria.push({ type: 'gte', key: column, value });
+        return this;
+    }
+    /**
+     * 小于
+     * @param column
+     * @param value
+     */
+    lt(column, value) {
+        this.criteria.push({ type: 'lt', key: column, value });
+        return this;
+    }
+    /**
+     * 小于等于
+     * @param column
+     * @param value
+     */
+    lte(column, value) {
+        this.criteria.push({ type: 'lte', key: column, value });
+        return this;
+    }
+    /**
+     * in 条件
+     * @param column
+     * @param values
+     */
+    in(column, values) {
+        this.criteria.push({ type: 'in', key: column, value: values });
+        return this;
+    }
+    /**
+     * not in 条件
+     * @param column
+     * @param values
+     */
+    notIn(column, values) {
+        this.criteria.push({ type: 'notIn', key: column, value: values });
+        return this;
+    }
+    /**
+     * 嵌入其它的查询条件，与现有的查询条件是或者关系.
+     * @param criteria
+     */
+    or(orCriteria) {
+        const criteria = new MysqlCriteria();
+        orCriteria(criteria);
+        this.criteria.push({ type: 'or', criteria });
+        return this;
+    }
+    /**
+     * 嵌入其它的查询条件，与现有的查询条件是并且关系.
+     * @param criteria
+     */
+    and(andCriteria) {
+        const criteria = new MysqlCriteria();
+        andCriteria(criteria);
+        this.criteria.push({ type: 'and', criteria });
+        return this;
+    }
+    /**
+     * 字段为空
+     * @param field
+     * @returns
+     */
+    isNull(field) {
+        this.criteria.push({ type: 'isNull', key: field });
+        return this;
+    }
+    /**
+     * 字段非空
+     * @param field
+     * @returns
+     */
+    isNotNull(field) {
+        this.criteria.push({ type: 'isNotNull', key: field });
+        return 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, values) {
+        this.criteria.push({ type: 'expr', exprSql: sql, exprValues: values || [] });
+        return this;
+    }
+    /**
+     * 判定是否空，未设置条件.
+     * @returns
+     */
+    isEmpty() {
+        return !this.criteria.length;
+    }
+    /**
+     * 检查条件信息是否有效，在出错时能给予较详细的提示，以方便排查.
+     */
+    check() {
+        for (const criterion of this.criteria) {
+            if (criterion.type === 'expr') {
+                if (!criterion.exprSql) {
+                    throw new exception_1.MysqlException('expr clause exprSql cannot be empty');
+                }
+                continue;
+            }
+            if (criterion.type === 'or' || criterion.type === 'and') {
+                if (!criterion.criteria) {
+                    throw new exception_1.MysqlException(`${criterion.type} clause cannot be empty`);
+                }
+                criterion.criteria.check();
+                continue;
+            }
+            if (!criterion.key) {
+                throw new exception_1.MysqlException('The column name of the query criteria cannot be blank.');
+            }
+            if (criterion.type === 'isNull' || criterion.type === 'isNotNull') {
+                continue;
+            }
+            if (criterion.type === 'in' || criterion.type === 'notIn') {
+                if (!Array.isArray(criterion.value)) {
+                    throw new exception_1.MysqlException(`Invalid ${criterion.type} condition，the condition value is not a array type，column name：${criterion.key.toString()}`);
+                }
+                if (!criterion.value.length) {
+                    throw new exception_1.MysqlException(`Invalid ${criterion.type} condition，the condition value cannot be an empty array，column name：${criterion.key.toString()}`);
+                }
+                continue;
+            }
+            if (criterion.type === 'between') {
+                if (!Array.isArray(criterion.value)) {
+                    throw new exception_1.MysqlException(`Invalid between condition，the condition value is not an array type，column name：${criterion.key.toString()}, value:${criterion.value}`);
+                }
+                if (criterion.value.length !== 2) {
+                    throw new exception_1.MysqlException(`Invalid between condition，the condition value must be an array of length 2，column: ${criterion.key.toString()}，value：${criterion.value.length}`);
+                }
+                continue;
+            }
+            if (typeof criterion.value !== 'number' &&
+                typeof criterion.value !== 'string' &&
+                typeof criterion.value !== 'boolean' &&
+                !(criterion.value instanceof Date)) {
+                throw new exception_1.MysqlException('The value of the query criteria is invalid，only number,string,boolean and Date are supported，' +
+                    `column name : ${criterion.key.toString()}，value : ${criterion.value} .`);
+            }
+        }
+    }
+    /**
+     * 生成查询数据
+     */
+    generateQuery() {
+        this.check();
+        const sqlFragments = [];
+        const values = [];
+        for (const criterion of this.criteria) {
+            // 普通的查询
+            if (criterion.key && criterion.value !== undefined) {
+                // between 特殊处理
+                if (criterion.type === 'between') {
+                    sqlFragments.push('and ?? between ? and ? ');
+                    values.push(criterion.key, criterion.value[0], criterion.value[1]);
+                    continue;
+                }
+                // 符号
+                let sign = '';
+                if (criterion.type === 'eq') {
+                    sign = '=';
+                }
+                else if (criterion.type === 'neq') {
+                    sign = '!=';
+                }
+                else if (criterion.type === 'gt') {
+                    sign = '>';
+                }
+                else if (criterion.type === 'gte') {
+                    sign = '>=';
+                }
+                else if (criterion.type === 'lt') {
+                    sign = '<';
+                }
+                else if (criterion.type === 'lte') {
+                    sign = '<=';
+                }
+                else if (criterion.type === 'in') {
+                    sign = 'in';
+                }
+                else if (criterion.type === 'notIn') {
+                    sign = 'not in';
+                }
+                else if (criterion.type === 'like') {
+                    sign = 'like';
+                }
+                else if (criterion.type === 'notLike') {
+                    sign = 'not like';
+                }
+                if (sign) {
+                    const keySeg = generateMysqlCriteriaKeySqlSeg(criterion.key);
+                    if (criterion.type === 'in' || criterion.type === 'notIn') {
+                        sqlFragments.push(`and ${keySeg.sqlSeg} ${sign} (?) `);
+                    }
+                    else {
+                        sqlFragments.push(`and ${keySeg.sqlSeg} ${sign} ? `);
+                    }
+                    values.push(keySeg.value, criterion.value);
+                }
+                continue;
+            }
+            else if (criterion.key) {
+                const keySeg = generateMysqlCriteriaKeySqlSeg(criterion.key);
+                if (criterion.type === 'isNull') {
+                    sqlFragments.push(`and ${keySeg.sqlSeg} is null `);
+                    values.push(keySeg.value);
+                    continue;
+                }
+                if (criterion.type === 'isNotNull') {
+                    sqlFragments.push(`and ${keySeg.sqlSeg} is not null `);
+                    values.push(keySeg.value);
+                    continue;
+                }
+            }
+            // 特殊查询 or 和 and
+            else if (criterion.criteria) {
+                const query = criterion.criteria.generateQuery();
+                if (criterion.type === 'or') {
+                    sqlFragments.push(`or (${query.sql}) `);
+                    values.push(...query.values);
+                    continue;
+                }
+                if (criterion.type === 'and') {
+                    sqlFragments.push(`and (${query.sql}) `);
+                    values.push(...query.values);
+                    continue;
+                }
+            }
+            // 自定义表达式
+            else if (criterion.type === 'expr' && criterion.exprSql) {
+                sqlFragments.push(`and ${criterion.exprSql} `);
+                values.push(...(criterion.exprValues || []));
+                continue;
+            }
+        }
+        if (!sqlFragments.length) {
+            throw new exception_1.MysqlException('No valid query criteria have been set.');
+        }
+        let sql = sqlFragments.join('');
+        // 去除掉第一个条件的连接关键字，可能是 and 或 or
+        if (sql.startsWith('and')) {
+            sql = sql.substring(3);
+        }
+        else if (sql.startsWith('or')) {
+            sql = sql.substring(2);
+        }
+        return { sql, values };
+    }
+}
+exports.MysqlCriteria = MysqlCriteria;
+function convertToCriteria(example) {
+    const criteria = new MysqlCriteria();
+    Object.entries(example).forEach(entry => {
+        const [key, value] = entry;
+        criteria.eq(key, value);
+    });
+    return criteria;
+}
+/**
+ * 将混合的查询条件转换成查询语句，如果最终构建的条件是空的，返回 undefined
+ * @param criteria
+ * @returns
+ */
+function buildQuery(criteria) {
+    if (criteria instanceof Function) {
+        const c = new MysqlCriteria();
+        criteria(c);
+        if (!c.isEmpty()) {
+            return c.generateQuery();
+        }
+    }
+    else if (criteria instanceof MysqlCriteria) {
+        if (!criteria.isEmpty()) {
+            return criteria.generateQuery();
+        }
+    }
+    else {
+        const c = convertToCriteria(criteria);
+        if (!c.isEmpty()) {
+            return c.generateQuery();
+        }
+    }
+    return undefined;
+}
+exports.buildQuery = buildQuery;