mm_sql 1.3.8 → 1.3.9

package/README.md

@@ -1,6 +1,6 @@
 # mm_sql
 
-一个通用的SQL帮助类，支持通过切换db_type实现对不同数据库的操作，包括MySQL和SQLite等。
+一个通用的SQL帮助类，支持通过切换db_type实现对不同数据库的操作，包括MySQL和SQLite等，提供统一的API接口，支持异步操作、事务处理和批量操作。
 
 ## 安装
 
@@ -10,8 +10,8 @@ npm install mm_sql
 
 ## 依赖
 
-- mm_mysql: ^2.0.3
-- mm_sqlite: ^1.0.0
+- mm_mysql: ^2.1.1
+- mm_sqlite: ^1.1.3
 
 ## 使用方法
 
@@ -19,7 +19,7 @@ npm install mm_sql
 
 ```javascript
 // 引入模块
-const Sql = require('mm_sql');
+const { Sql } = require('mm_sql');
 
 // 创建实例（默认使用MySQL）
 const sql = new Sql({
@@ -31,10 +31,7 @@ const sql = new Sql({
   table: 'users'
 });
 
-// 初始化连接
-await sql.init();
-
-// 查询数据
+// 直接使用（自动初始化连接）
 const users = await sql.get({ status: 1 }, 'created_at DESC');
 
 // 销毁连接
@@ -45,7 +42,7 @@ await sql.destroy();
 
 ```javascript
 // 创建MySQL实例
-const mysqlSql = new Sql({
+const sql = new Sql({
   db_type: 'mysql',
   host: 'localhost',
   user: 'root',
@@ -55,13 +52,13 @@ const mysqlSql = new Sql({
 });
 
 // 切换到SQLite
-const sqliteSql = mysqlSql.use('sqlite', {
+const sqliteSql = sql.use('sqlite', {
+  dir: '/db/',
   database: 'sqlite.db',
   table: 'users'
 });
 
-// 使用SQLite进行操作
-await sqliteSql.init();
+// 使用SQLite进行操作（自动初始化连接）
 const data = await sqliteSql.get({});
 ```
 
@@ -104,6 +101,13 @@ const updateResult = await sql.set(
   { name: '李四', age: 26 } // 更新字段
 );
 
+// 使用where属性修改数据
+const updateResult2 = await sql.set({
+  where: { id: 1 },
+  name: '李四',
+  age: 26
+});
+
 // 删除数据
 const deleteResult = await sql.del({ id: 1 });
 
@@ -136,15 +140,42 @@ const delListResult = await sql.delList([
 ]);
 ```
 
-#### 模型操作
+#### 字段操作方法
+
+```javascript
+// 添加字段
+await sql.addField('phone', 'varchar(20)', '');
+
+// 修改字段
+await sql.setField('phone', 'varchar(11)', '0');
+
+// 删除字段
+await sql.delField('phone');
+
+// 重命名字段
+await sql.renameField('old_name', 'new_name');
+
+// 编辑字段（高级）
+await sql.editField('field_name', 'varchar(100)', 'NOT NULL DEFAULT \'\'');
+```
+
+#### 表操作方法
 
 ```javascript
-// 获取模型对象
-const model = await sql.getObj({ id: 1 });
+// 检查表是否存在
+const exists = await sql.hasTable();
 
-// 直接修改模型属性会自动更新到数据库
-model.name = '新名称'; // 自动执行UPDATE操作
-model.age += 1; // 自动执行UPDATE操作，增加年龄
+// 创建表
+await sql.addTable('new_table', {
+  id: 'INTEGER PRIMARY KEY AUTOINCREMENT',
+  name: 'varchar(255) NOT NULL DEFAULT \'\'
+});
+
+// 删除表
+await sql.delTable();
+
+// 备份表
+await sql.backupTable('backup_table');
 ```
 
 ### 4. 配置选项
@@ -170,20 +201,41 @@ const sql = new Sql({
   password: '',
   database: '',
   charset: 'utf8mb4',
+  connect_timeout: 10000, // 连接超时时间（毫秒）
+  query_timeout: 30000, // 查询超时时间（毫秒）
   
   // SQLite配置
-  database: 'db.sqlite', // SQLite数据库文件路径
+  dir: '/db/', // SQLite数据库文件存储目录
+  database: 'db.sqlite', // SQLite数据库文件名
   
   // 其他配置
   filter: {}, // 过滤参数
-  separator: '|' // 分隔符，用于多条件查询
+  separator: '|', // 分隔符，用于多条件查询
+  way: 'add del set get', // 请求方式
+  field_hide: ['*password*', '*token*'] // 隐藏字段
 });
 ```
 
 ## 事务操作
 
 ```javascript
-// MySQL事务示例
+// 使用事务方法
+await sql.start(); // 开始事务
+
+try {
+  // 在事务中执行操作
+  await sql.add({ name: '测试用户1', age: 30 });
+  await sql.add({ name: '测试用户2', age: 25 });
+  
+  await sql.commit(); // 提交事务
+} catch (error) {
+  await sql.back(); // 回滚事务
+  console.error('事务执行失败:', error);
+} finally {
+  await sql.end(); // 结束事务
+}
+
+// 直接执行事务SQL（MySQL）
 const mysqlTransactionResult = await sql.exec(`
   START TRANSACTION;
   INSERT INTO users (name, age) VALUES ('测试用户', 30);
@@ -191,7 +243,7 @@ const mysqlTransactionResult = await sql.exec(`
   COMMIT;
 `);
 
-// SQLite事务示例
+// 直接执行事务SQL（SQLite）
 const sqliteTransactionResult = await sql.exec(`
   BEGIN TRANSACTION;
   INSERT INTO users (name, age) VALUES ('测试用户', 30);
@@ -213,8 +265,31 @@ const sqlTemplate = {
 };
 
 // 使用模板构建查询条件
-const query = sql.tpl_query({ name: '张', age: 20 }, sqlTemplate);
-// 生成的查询条件: "`name` LIKE \"张%\" && `age` > 20"
+const query = sql.tplQuery({ name: '张', age: 20 }, sqlTemplate);
+// 生成的查询条件: "`name` LIKE \"张%\" AND `age` > 20"
+
+// 使用模板构建更新语句
+const body = sql.tplBody({ name: '李四', age: 25 }, {
+  name: '`name` = {0}',
+  age: '`age` = {0}'
+});
+// 生成的更新语句: "`name` = '李四', `age` = 25"
+
+// 使用配置文件定义SQL模板
+const config = {
+  "query": {
+    "name": "`name` like '%{0}%'"
+  },
+  "where": {
+    "uid": "`uid` = {0}"
+  },
+  "update": {
+    "name": "`name` = {0}"
+  }
+};
+
+// 使用配置文件中的模板
+const queryFromConfig = sql.tplQuery({ name: '张' }, config.query);
 ```
 
 ### 2. 自定义SQL执行
@@ -225,14 +300,21 @@ const result = await sql.run('SELECT * FROM users WHERE status = 1');
 
 // 执行自定义更新SQL
 const updateResult = await sql.exec('UPDATE users SET status = 0 WHERE id = 1');
-```
+
+// 执行带参数的SQL
+const user = await sql.run('SELECT * FROM users WHERE id = ?', [1]);
+
+// 执行带超时的SQL
+const timeoutResult = await sql.run('SELECT * FROM users WHERE status = 1', [], 5000);
 
 ## 注意事项
 
-1. 使用前必须先调用`init()`方法初始化连接
-2. 使用完成后应调用`destroy()`方法销毁连接，避免资源泄漏
+1. 可以直接使用方法，系统会自动初始化连接，无需手动调用`init()`方法
+2. 使用完成后建议调用`destroy()`方法销毁连接，避免资源泄漏
 3. 切换数据库类型时会重新创建适配器，原来的连接会被关闭
 4. 为提高性能，系统会缓存数据库适配器，相同配置的实例会复用适配器
+5. 不同数据库的SQL语法可能有所差异，请根据实际使用的数据库类型调整SQL语句
+6. 事务操作中，建议使用`start()`/`commit()`/`back()`/`end()`方法，确保事务正确处理
 
 ## 支持的数据库类型
 

package/index.js

@@ -17,7 +17,12 @@ class Sql {
 		 * 配置信息
 		 */
 		this.config = Object.assign({
-			db_type: 'mysql'
+            scope: 'sys',
+			db_type: 'mysql',
+            dir: '/db/',
+            host: 'localhost',
+            port: 3306,
+            database: ''
 		}, config || {});
 		
 		/**
@@ -49,12 +54,12 @@ Sql.prototype._createSqlAdapter = function () {
 	// 根据数据库类型选择不同的初始化方式
 	if (this.config.db_type === 'mysql') {
 		// 创建MySQL实例
-		const Mysql = adapter.Mysql;
-		this._adapter = new Mysql(this.config);
+		const admin = adapter.mysqlAdmin;
+		this._adapter = admin(this.config.scope, this.config);
 	} else if (this.config.db_type === 'sqlite') {
 		// SQLite应该有类似的结构
-		const Sqlite = adapter.Sqlite;
-		this._adapter = new Sqlite(this.config);
+        const admin = adapter.sqliteAdmin;
+		this._adapter = admin(this.config.scope, this.config);
 	} else {
 		// 其他数据库类型直接使用Sql类（如果存在）
 		const AdapterClass = adapter.Sql;
@@ -135,6 +140,7 @@ Sql.prototype.getConnectionInfo = function () {
 		db_type: this.config.db_type,
 		host: this.config.host || 'localhost',
 		port: this.config.port || 3306,
+        dir: this.config.dir || '/db/',
 		database: this.config.database || ''
 	};
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mm_sql",
-  "version": "1.3.8",
+  "version": "1.3.9",
   "description": "一个通用的SQL帮助类，支持通过切换db_type实现对不同数据库的操作，包括MySQL和SQLite等",
   "main": "index.js",
   "scripts": {
@@ -41,7 +41,7 @@
     "node": ">=12.0.0"
   },
   "dependencies": {
-    "mm_mysql": "^2.1.1",
-    "mm_sqlite": "^1.1.2"
+    "mm_mysql": "^2.2.0",
+    "mm_sqlite": "^1.1.4"
   }
 }

package/test2.js

@@ -1,10 +1,10 @@
 const { Sql } = require('./index.js');
-
+require('mm_logs');
 async function test() {
     var sql = new Sql({
         // 数据库类型 mysql, sqlite, postgres
         db_type: 'sqlite',
-        host: '/db/',
+        dir: "/db/".fullname() + "/",
         user: 'root',
         password: 'Asd159357',
         database: 'mm'
@@ -15,17 +15,35 @@ async function test() {
 
     var db = sql.db();
     db.table = "user_account";
+    // 添加表
     var res = await db.addTable('user_account', 'user_id');
-    await db.addField('user_account', 'vip', 'INT', '0');
-    await db.addField('user_account', 'gm', 'INT', '0');
     console.log("添加表结果:", res);
+    
+    // 添加字段（不需要指定表名，因为已通过db.table设置）
+    var res2 = await db.addField('vip', 'INT', '0');
+    var res3 = await db.addField('gm', 'INT', '0');
+    console.log("添加字段结果:", res2, res3);
     db.key = "user_id";
     var user = await db.getObj({
         user_id: 1
     });
-    user.vip = 5;
-    user.gm = 5;
-    await $.sleep(3000);
+    
+    if (!user) {
+        // 如果用户不存在，创建一个新用户
+        user = {
+            user_id: 1,
+            vip: 5,
+            gm: 5
+        };
+        await db.add(user);
+    } else {
+        // 如果用户存在，更新其属性
+        user.vip = 5;
+        user.gm = 5;
+        await db.set({ user_id: 1 }, user);
+    }
+    // 使用原生的setTimeout实现延迟
+    await new Promise(resolve => setTimeout(resolve, 3000));
     db.size = 1;
     var list = await db.get({
         user_id: 1
@@ -33,4 +51,11 @@ async function test() {
     console.log("查询结果:", list);
 }
 
-test();
+// 调用test函数并处理异常
+test().catch(err => {
+    console.error('测试过程中发生错误:', err);
+    process.exit(1);
+}).finally(() => {
+    // 确保程序以零退出码结束
+    process.exit(0);
+});