mm_sql 1.4.0 → 1.4.2

package/index.js

@@ -1,298 +1,307 @@
-/**
- * @fileOverview SQL通用类
- * @author <a href="http://qww.elins.cn">qww</a>
- * @version 1.0
- */
-
-/**
- * @class 数据库SQL类
- */
-class Sql {
-	/**
-	 * @constructor
-	 * @param {Object} config - 配置对象
-	 */
-	constructor(config) {
-		/**
-		 * 配置信息
-		 */
-		this.config = Object.assign({
-            scope: 'sys',
-			db_type: 'mysql',
-            dir: '/db/',
-            host: 'localhost',
-            port: 3306,
-            database: ''
-		}, config || {});
-		
-		/**
-		 * SQL适配器
-		 */
-		this._adapter = null;
-		
-		// 初始化
-		this._init();
-	}
-}
-
-/**
- * 初始化
- * @private
- */
-Sql.prototype._init = function () {
-	this._createSqlAdapter();
-};
-
-/**
- * 创建SQL适配器
- * @private
- */
-Sql.prototype._createSqlAdapter = function () {
-	const adapterModule = `mm_${this.config.db_type}`;
-	const adapter = require(adapterModule);
-	
-	// 根据数据库类型选择不同的初始化方式
-	if (this.config.db_type === 'mysql') {
-		// 创建MySQL实例
-		const admin = adapter.mysqlAdmin;
-		this._adapter = admin(this.config.scope, this.config);
-	} else if (this.config.db_type === 'sqlite') {
-		// SQLite应该有类似的结构
-        const admin = adapter.sqliteAdmin;
-		this._adapter = admin(this.config.scope, this.config);
-	} else {
-		// 其他数据库类型直接使用Sql类（如果存在）
-		const AdapterClass = adapter.Sql;
-		if (AdapterClass) {
-			this._adapter = new AdapterClass(this.config);
-		} else {
-			throw new Error(`不支持的数据库类型: ${this.config.db_type}`);
-		}
-	}
-};
-
-/**
- * 执行查询操作
- * @param {String|Object} sql - SQL语句或选项对象
- * @param {Array} params - 参数数组
- * @param {Number} timeout - 超时时间(毫秒)
- * @returns {Promise} 查询结果
- * @throws {TypeError} 当sql参数无效时
- */
-Sql.prototype.run = function (sql, params = [], timeout = null) {
-    // 参数校验
-    if (typeof sql !== 'string' && typeof sql !== 'object') {
-        throw new TypeError('sql must be string or object');
-    }
-    if (!Array.isArray(params)) {
-        throw new TypeError('params must be array');
-    }
-    if (timeout !== null && typeof timeout !== 'number') {
-        throw new TypeError('timeout must be number or null');
-    }
-    
-    try {
-        // 支持两种调用方式：run(sql, params, timeout) 或 run({sql: '', params: []})
-        if (typeof sql === 'object') {
-            params = sql.params || [];
-            timeout = sql.timeout || null;
-            sql = sql.sql || '';
-        }
-        return this._adapter.run(sql, params, timeout);
-    } catch (error) {
-        this.logger('error', 'SQL查询执行失败', error);
-        throw error;
-    }
-};
-
-/**
- * 执行修改操作
- * @param {String|Object} sql - SQL语句或选项对象
- * @param {Array} params - 参数数组
- * @param {Number} timeout - 超时时间(毫秒)
- * @returns {Promise} 修改结果
- * @throws {TypeError} 当sql参数无效时
- */
-Sql.prototype.exec = function (sql, params = [], timeout = null) {
-    // 参数校验
-    if (typeof sql !== 'string' && typeof sql !== 'object') {
-        throw new TypeError('sql must be string or object');
-    }
-    if (!Array.isArray(params)) {
-        throw new TypeError('params must be array');
-    }
-    if (timeout !== null && typeof timeout !== 'number') {
-        throw new TypeError('timeout must be number or null');
-    }
-    
-    try {
-        // 支持两种调用方式：exec(sql, params, timeout) 或 exec({sql: '', params: []})
-        if (typeof sql === 'object') {
-            params = sql.params || [];
-            timeout = sql.timeout || null;
-            sql = sql.sql || '';
-        }
-        return this._adapter.exec(sql, params, timeout);
-    } catch (error) {
-        this.logger('error', 'SQL修改执行失败', error);
-        return 0;
-    }
-};
-
-/**
- * 打开数据库连接
- * @returns {Promise} 连接结果
- */
-Sql.prototype.open = function () {
-    try {
-        return this._adapter.open();
-    } catch (error) {
-        this.logger('error', '数据库连接打开失败', error);
-        return null;
-    }
-};
-
-/**
- * 关闭数据库连接
- * @returns {Promise} 关闭结果
- */
-Sql.prototype.close = function () {
-    try {
-        return this._adapter.close();
-    } catch (error) {
-        this.logger('error', '数据库连接关闭失败', error);
-    }
-};
-
-/**
- * 设置配置
- * @param {Object} config - 配置对象
- * @throws {TypeError} 当config参数无效时
- */
-Sql.prototype.setConfig = function (config) {
-    // 参数校验
-    if (!config || typeof config !== 'object') {
-        throw new TypeError('config must be object');
-    }
-    
-    try {
-        this.config = Object.assign(this.config, config);
-        this._init();
-    } catch (error) {
-        this.logger('error', '配置设置失败', error);
-    }
-};
-
-/**
- * 执行模板查询
- * @param {Object} paramDt - 参数对象
- * @param {Object} sqlDt - SQL模板对象
- * @returns {Object} 查询结果对象
- * @throws {TypeError} 当参数对象无效时
- */
-Sql.prototype.tplQuery = function (paramDt, sqlDt) {
-    // 参数校验
-    if (!paramDt || typeof paramDt !== 'object') {
-        throw new TypeError('paramDt must be object');
-    }
-    if (!sqlDt || typeof sqlDt !== 'object') {
-        throw new TypeError('sqlDt must be object');
-    }
-    
-    try {
-        let sql = '';
-        
-        for (const key in paramDt) {
-            if (sqlDt[key]) {
-                // 替换占位符{0}为参数值
-                const sqlSegment = sqlDt[key].replace(/\{0\}/g, paramDt[key]);
-                sql += 'AND ' + sqlSegment + ' ';
-            }
-            else {
-                sql += 'AND `' + key + "` = '" + paramDt[key] + "'";
-            }
-        }
-        
-        return sql.replace('AND ', '');
-    } catch (error) {
-        this.logger('error', '模板查询生成失败', error);
-        return '';
-    }
-};
-
-/**
- * 执行模板查询（仅返回数据部分）
- * @param {Object} paramDt - 参数对象
- * @param {Object} sqlDt - SQL模板对象
- * @returns {Object} 查询结果对象
- * @throws {TypeError} 当参数对象无效时
- */
-Sql.prototype.tplBody = function (paramDt, sqlDt) {
-    // 参数校验
-    if (!paramDt || typeof paramDt !== 'object') {
-        throw new TypeError('paramDt must be object');
-    }
-    if (!sqlDt || typeof sqlDt !== 'object') {
-        throw new TypeError('sqlDt must be object');
-    }
-    
-    try {
-        let sql = '';
-                
-        for (const key in paramDt) {
-            if (sqlDt[key]) {
-                // 替换占位符{0}为参数值
-                const sqlSegment = sqlDt[key].replace(/\{0\}/g, paramDt[key]);
-                sql += ', ' + sqlSegment + ' ';
-            }
-            else {
-                sql += ', `' + key + "` = '" + paramDt[key] + "'";
-            }
-        }
-        
-        return sql.replace(', ', '');
-    } catch (error) {
-        this.logger('error', '模板数据生成失败', error);
-        return '';
-    }
-};
-
-/**
- * 过滤参数对象中的指定键
- * @param {Object} paramDt - 参数对象
- * @param {Array} arr - 过滤数组
- * @returns {Object} 过滤后的参数对象
- * @throws {TypeError} 当参数对象无效时
- */
-Sql.prototype.filter = function (paramDt, arr) {
-    // 参数校验
-    if (!paramDt || typeof paramDt !== 'object') {
-        throw new TypeError('paramDt must be object');
-    }
-    if (!Array.isArray(arr)) {
-        throw new TypeError('arr must be array');
-    }
-    
-    try {
-        for (const key in paramDt) {
-            if (arr.includes(key)) {
-                delete paramDt[key];
-            }
-        }
-        return paramDt;
-    } catch (error) {
-        this.logger('error', '参数过滤失败', error);
-        return {};
-    }
-};
-
-/**
- * 获取新数据库管理器
- * @returns {Object} 新数据库管理器
- */
-Sql.prototype.db = function () {
-	return this._adapter.db();
-};
-
-// 导出模块
+/**
+ * SQL通用类
+ * @author <a href="http://qww.elins.cn">qww</a>
+ * @version 1.0
+ */
+
+/**
+ * 数据库SQL类
+ * @class
+ * @description 提供统一的SQL操作接口，支持多种数据库类型
+ */
+class Sql {
+  /**
+   * 构造函数
+   * @class
+   * @param {object} config - 配置对象
+   */
+  constructor(config) {
+    /**
+     * 配置信息
+     */
+    this.config = {scope: 'sys',
+      db_type: 'mysql',
+      dir: '/db/',
+      host: 'localhost',
+      port: 3306,
+      database: '', ...config || {}};
+
+    /**
+     * SQL适配器
+     */
+    this._adapter = null;
+
+    // 初始化
+    this._init();
+  }
+}
+
+/**
+ * 初始化
+ * @private
+ */
+Sql.prototype._init = function () {
+  this._createSqlAdapter();
+};
+
+/**
+ * 创建SQL适配器
+ * @private
+ */
+Sql.prototype._createSqlAdapter = function () {
+  const adapter_mod = `mm_${this.config.db_type}`;
+  const adapter = require(adapter_mod);
+
+  // 根据数据库类型选择不同的初始化方式
+  if (this.config.db_type === 'mysql') {
+    // 创建MySQL实例
+    const admin = adapter.mysqlAdmin;
+    this._adapter = admin(this.config.scope, this.config);
+  } else if (this.config.db_type === 'sqlite') {
+    // SQLite应该有类似的结构
+    const admin = adapter.sqliteAdmin;
+    this._adapter = admin(this.config.scope, this.config);
+  } else {
+    // 其他数据库类型直接使用Sql类（如果存在）
+    const adapter_cls = adapter.Sql;
+    if (adapter_cls) {
+      this._adapter = new adapter_cls(this.config);
+    } else {
+      throw new Error(`不支持的数据库类型: ${this.config.db_type}`);
+    }
+  }
+};
+
+/**
+ * 验证SQL参数
+ * @param {string | object} sql - SQL语句或选项对象
+ * @param {Array} param - 参数数组
+ * @param {number} timeout - 超时时间(毫秒)
+ * @private
+ */
+Sql.prototype._validateSqlParams = function (sql, param, timeout) {
+  if (typeof sql !== 'string' && typeof sql !== 'object') {
+    throw new TypeError('sql must be string or object');
+  }
+  if (!Array.isArray(param)) {
+    throw new TypeError('param must be array');
+  }
+  if (timeout !== null && typeof timeout !== 'number') {
+    throw new TypeError('timeout must be number or null');
+  }
+};
+
+/**
+ * 执行查询操作
+ * @param {string | object} sql - SQL语句或选项对象
+ * @param {Array} param - 参数数组
+ * @param {number} timeout - 超时时间(毫秒)
+ * @returns {Promise} 查询结果
+ * @throws {TypeError} 当sql参数无效时
+ */
+Sql.prototype.run = function (sql, param = [], timeout = null) {
+  this._validateSqlParams(sql, param, timeout);
+    
+  try {
+    // 支持两种调用方式：run(sql, param, timeout) 或 run({sql: '', param: []})
+    let final_sql = sql;
+    let final_param = param;
+    let final_timeout = timeout;
+    if (typeof sql === 'object') {
+      final_param = sql.param || [];
+      final_timeout = sql.timeout || null;
+      final_sql = sql.sql || '';
+    }
+    return this._adapter.run(final_sql, final_param, final_timeout);
+  } catch (error) {
+    this.log('error', 'SQL查询执行失败', error);
+    throw error;
+  }
+};
+
+/**
+ * 执行修改操作
+ * @param {string | object} sql - SQL语句或选项对象
+ * @param {Array} param - 参数数组
+ * @param {number} timeout - 超时时间(毫秒)
+ * @returns {Promise} 修改结果
+ * @throws {TypeError} 当sql参数无效时
+ */
+Sql.prototype.exec = function (sql, param = [], timeout = null) {
+  this._validateSqlParams(sql, param, timeout);
+    
+  try {
+    // 支持两种调用方式：exec(sql, param, timeout) 或 exec({sql: '', param: []})
+    let final_sql = sql;
+    let final_param = param;
+    let final_timeout = timeout;
+    if (typeof sql === 'object') {
+      final_param = sql.param || [];
+      final_timeout = sql.timeout || null;
+      final_sql = sql.sql || '';
+    }
+    return this._adapter.exec(final_sql, final_param, final_timeout);
+  } catch (error) {
+    this.log('error', 'SQL修改执行失败', error);
+    return 0;
+  }
+};
+
+/**
+ * 打开数据库连接
+ * @returns {Promise|null} 连接结果
+ */
+Sql.prototype.open = function () {
+  try {
+    return this._adapter.open();
+  } catch (error) {
+    this.log('error', '数据库连接打开失败', error);
+    return null;
+  }
+};
+
+/**
+ * 关闭数据库连接
+ * @returns {Promise|undefined} 关闭结果
+ */
+Sql.prototype.close = function () {
+  try {
+    return this._adapter.close();
+  } catch (error) {
+    this.log('error', '数据库连接关闭失败', error);
+  }
+};
+
+/**
+ * 设置配置
+ * @param {object} config - 配置对象
+ * @throws {TypeError} 当config参数无效时
+ */
+Sql.prototype.setConfig = function (config) {
+  // 参数校验
+  if (!config || typeof config !== 'object') {
+    throw new TypeError('config must be object');
+  }
+    
+  try {
+    this.config = Object.assign(this.config, config);
+    this._init();
+  } catch (error) {
+    this.log('error', '配置设置失败', error);
+  }
+};
+
+/**
+ * 执行模板查询
+ * @param {object} param - 参数对象
+ * @param {object} sql_tpl - SQL模板对象
+ * @returns {string} 查询条件字符串
+ * @throws {TypeError} 当参数对象无效时
+ */
+Sql.prototype.tplQuery = function (param, sql_tpl) {
+  // 参数校验
+  if (!param || typeof param !== 'object') {
+    throw new TypeError('param must be object');
+  }
+  
+  // 如果sql_tpl为null或undefined，使用空对象
+  const template = sql_tpl || {};
+  
+  try {
+    const segments = [];
+        
+    for (const key in param) {
+      if (template[key]) {
+        // 替换占位符{0}为参数值
+        const seg = template[key].replace(/\{0\}/g, param[key]);
+        segments.push(seg);
+      }
+      else {
+        segments.push('`' + key + "` = '" + param[key] + "'");
+      }
+    }
+        
+    return segments.join(' AND ');
+  } catch (error) {
+    this.log('error', '模板查询生成失败', error);
+    return '';
+  }
+};
+
+/**
+ * 执行模板查询（仅返回数据部分）
+ * @param {object} param - 参数对象
+ * @param {object} sql_tpl - SQL模板对象
+ * @returns {string} 数据部分字符串
+ * @throws {TypeError} 当参数对象无效时
+ */
+Sql.prototype.tplBody = function (param, sql_tpl) {
+  // 参数校验
+  if (!param || typeof param !== 'object') {
+    throw new TypeError('param must be object');
+  }
+  
+  // 如果sql_tpl为null或undefined，使用空对象
+  const template = sql_tpl || {};
+    
+  try {
+    const segments = [];
+                
+    for (const key in param) {
+      if (template[key]) {
+        // 替换占位符{0}为参数值
+        const seg = template[key].replace(/\{0\}/g, param[key]);
+        segments.push(seg);
+      }
+      else {
+        segments.push('`' + key + "` = '" + param[key] + "'");
+      }
+    }
+        
+    return segments.join(' , ');
+  } catch (error) {
+    this.log('error', '模板数据生成失败', error);
+    return '';
+  }
+};
+
+/**
+ * 过滤参数对象中的指定键
+ * @param {object} param - 参数对象
+ * @param {Array} arr - 过滤数组
+ * @returns {object} 过滤后的参数对象
+ * @throws {TypeError} 当参数对象无效时
+ */
+Sql.prototype.filter = function (param, arr) {
+  // 参数校验
+  if (!param || typeof param !== 'object') {
+    throw new TypeError('param must be object');
+  }
+  if (!Array.isArray(arr)) {
+    throw new TypeError('arr must be array');
+  }
+    
+  try {
+    const result = {};
+    for (const key of arr) {
+      if (param[key] !== undefined) {
+        result[key] = param[key];
+      }
+    }
+    return result;
+  } catch (error) {
+    this.log('error', '参数过滤失败', error);
+    return {};
+  }
+};
+
+/**
+ * 获取新数据库管理器
+ * @returns {object} 新数据库管理器
+ */
+Sql.prototype.db = function () {
+  return this._adapter.db();
+};
+
+// 导出模块
 exports.Sql = Sql;