mm_mysql 2.5.6 → 2.6.0

package/package.json

@@ -1,43 +1,51 @@
-{
-	"name": "mm_mysql",
-	"version": "2.5.6",
-	"description": "这是超级美眉mysql帮助函数模块，用于便捷操作mysql，使用await方式，可以避免嵌套函数",
-	"main": "index.js",
-	"dependencies": {
-		"mm_expand": "^2.5.4",
-		"mysql2": "^3.24.2",
-		"sqlstring": "^2.3.3"
-	},
-	"scripts": {
-		"start": "node index.js",
-		"test": "node test.js",
-		"lint": "eslint . --config eslint.config.js",
-		"lint:fix": "eslint . --config eslint.config.js --fix"
-	},
-	"repository": {
-		"type": "git",
-		"url": "https://gitee.com/qiuwenwu91/mm_mysql.git"
-	},
-	"keywords": [
-		"mysql",
-		"async",
-		"await",
-		"promise",
-		"mysql2",
-		"database",
-		"query",
-		"transaction",
-		"sql",
-		"db"
-	],
-	"author": "qww",
-	"license": "ISC",
-	"engines": {
-		"node": ">=12.0.0"
-	},
-	"devDependencies": {
-		"eslint": "^10.9.1",
-		"eslint-plugin-jsdoc": "^64.2.1",
-		"mm_eslint": "^1.7.6"
-	}
-}
+{
+  "name": "mm_mysql",
+  "version": "2.6.0",
+  "description": "这是超级美眉mysql帮助函数模块，用于便捷操作mysql，使用await方式，可以避免嵌套函数",
+  "main": "index.js",
+  "dependencies": {
+    "mm_admin": "^1.1.0",
+    "mm_eslint": "^1.0.0",
+    "mm_helper": "^1.0.0",
+    "mm_mod": "^1.0.1",
+    "mysql2": "^3.24.2",
+    "sqlstring": "^2.3.3"
+  },
+  "scripts": {
+    "start": "node index.js",
+    "test": "node test.js",
+    "lint": "eslint . --config eslint.config.js",
+    "lint:fix": "eslint . --config eslint.config.js --fix"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/qiuwenwu91/mm_mysql.git"
+  },
+  "keywords": [
+    "mm_mod",
+    "mm_adapter",
+    "mm_persist",
+    "mysql",
+    "async",
+    "await",
+    "promise",
+    "mysql2",
+    "database",
+    "query",
+    "transaction",
+    "sql",
+    "db"
+  ],
+  "layer": "infrastructure",
+  "group": "persistence",
+  "author": "qww",
+  "license": "ISC",
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "devDependencies": {
+    "eslint": "^10.9.1",
+    "eslint-plugin-jsdoc": "^64.2.1",
+    "mm_eslint": "^1.7.7"
+  }
+}

package/test.js

@@ -40,24 +40,30 @@ class TestMysql {
 TestMysql.prototype._init = async function() {
   try {
     console.log('=== 初始化测试环境（优化版） ===');
-        
+
     // 直接使用指定数据库，避免重复连接
     if (!this.config.database) {
       this.config.database = 'test_db';
     }
-        
+
+    // 先以空 database 连接并创建测试数据库，避免 Unknown database 报错
+    const bootstrap = new Mysql({ ...this.config, database: '' });
+    await bootstrap.open();
+    await bootstrap.exec(`CREATE DATABASE IF NOT EXISTS ${this.config.database}`);
+    await bootstrap.close();
+
     // 创建Mysql实例
     this._mysql = new Mysql(this.config);
-        
+
     // 连接数据库
     await this._mysql.open();
-        
+
     // 创建测试数据库（如果不存在）
     await this._createTestDatabase();
-        
+
     // 创建测试表
     await this._createTestTable();
-        
+
     console.log('测试环境初始化完成');
     return true;
   } catch (error) {

package/tool/mysql/index.js

@@ -0,0 +1,7 @@
+'use strict';
+/**
+ * mysql —— 工具契约适配层
+ * 业务实现归位于模块 lib/tools/mysql/，本文件只把模块能力暴露给加载器。
+ * 其它模块可直接 require('mm_mysql').tools.mysql 复用。
+ */
+module.exports = require('../../lib/tools/mysql');

package/tool/mysql/tool.json

@@ -0,0 +1,118 @@
+{
+  "name": "mysql",
+  "handler": "manager",
+  "title": "MySQL管理器",
+  "description": "操作 MySQL 数据库，支持 SQL 与 ORM 两种方式。适用场景：需要持久化数据、增删改查、统计计数时。工作流提示：action 必填（query/execute/runSql 配 sql，add/del/set/list/getObj/count/upsert 配 table/query/body），读结果在 list/count、写结果在 affected/id。",
+  "type": "data",
+  "params": {
+    "type": "object",
+    "properties": {
+      "action": {
+        "type": "string",
+        "description": "操作类型: SQL方法(query/execute/runSql) + ORM方法(add/del/set/list/getObj/count) + upsert + batch",
+        "enum": [
+          "query",
+          "execute",
+          "runSql",
+          "add",
+          "del",
+          "set",
+          "list",
+          "getObj",
+          "count",
+          "upsert",
+          "batch"
+        ]
+      },
+      "sql": {
+        "type": "string",
+        "description": "SQL语句（SQL方法需要）"
+      },
+      "params": {
+        "type": "array",
+        "description": "SQL参数（可选）"
+      },
+      "table": {
+        "type": "string",
+        "description": "表名（ORM方法需要）"
+      },
+      "query": {
+        "type": "object",
+        "description": "查询条件（ORM方法需要）"
+      },
+      "body": {
+        "type": "object",
+        "description": "数据对象（add/set/upsert 操作需要）"
+      },
+      "unique": {
+        "type": "array",
+        "description": "唯一约束字段列表（upsert 操作，不更新的字段）"
+      }
+    },
+    "required": [
+      "action"
+    ]
+  },
+  "returns": {
+    "description": "管理操作结果，读操作返回 list+count，写操作返回 affected，异常时返回 error",
+    "type": "object",
+    "properties": {
+      "list": {
+        "type": "array",
+        "description": "查询结果列表（query/run 操作）"
+      },
+      "count": {
+        "type": "number",
+        "description": "列表条目数/统计数"
+      },
+      "affected": {
+        "type": "number",
+        "description": "受影响的行数（写操作）"
+      },
+      "id": {
+        "type": "number",
+        "description": "插入的自增ID（upsert 操作）"
+      }
+    }
+  },
+  "options": {
+    "host": {
+      "type": "string",
+      "description": "数据库主机地址",
+      "default": "localhost"
+    },
+    "port": {
+      "type": "number",
+      "description": "数据库端口",
+      "default": 3306
+    },
+    "user": {
+      "type": "string",
+      "description": "数据库用户名",
+      "default": "root"
+    },
+    "password": {
+      "type": "string",
+      "description": "数据库密码",
+      "default": "Asd159357"
+    },
+    "database": {
+      "type": "string",
+      "description": "数据库名",
+      "default": "mm"
+    },
+    "charset": {
+      "type": "string",
+      "description": "字符集",
+      "default": "utf8mb4"
+    },
+    "pool_size": {
+      "type": "number",
+      "description": "连接池大小",
+      "default": 10,
+      "min": 1,
+      "max": 100
+    }
+  },
+  "group": "storage"
+}

package/tool/mysql_rw/index.js

@@ -0,0 +1,7 @@
+'use strict';
+/**
+ * mysql_rw —— 工具契约适配层
+ * 业务实现归位于模块 lib/tools/mysql_rw/，本文件只把模块能力暴露给加载器。
+ * 其它模块可直接 require('mm_mysql').tools.mysql_rw 复用。
+ */
+module.exports = require('../../lib/tools/mysql_rw');

package/tool/mysql_rw/tool.json

@@ -0,0 +1,105 @@
+{
+  "name": "mysql_rw",
+  "handler": "manager",
+  "title": "MySQL读写分离",
+  "description": "MySQL 读写分离，SELECT 走读库、写操作走主库，多读库负载均衡。适用场景：高并发读、读写分离部署时。工作流提示：action 必填（SQL 配 sql/values，ORM 配 table/query/body），读在 list/count、写后 affected、路由在 route。",
+  "type": "data",
+  "params": {
+    "type": "object",
+    "properties": {
+      "action": {
+        "type": "string",
+        "description": "操作类型: SQL(query/insert/update/delete/execute/runSql) + ORM(add/del/set/getObj/list/count)，写操作走主库，读操作走读库",
+        "enum": [
+          "query",
+          "insert",
+          "update",
+          "delete",
+          "execute",
+          "runSql",
+          "add",
+          "del",
+          "set",
+          "getObj",
+          "list",
+          "count"
+        ]
+      },
+      "sql": {
+        "type": "string",
+        "description": "SQL 语句（runSql 可传多条以分号分隔的建表/插入语句，强制走主库）"
+      },
+      "values": {
+        "type": "array",
+        "description": "SQL 参数值(使用参数化查询防注入)"
+      },
+      "table": {
+        "type": "string",
+        "description": "表名(ORM 方法需要)"
+      },
+      "query": {
+        "type": "object",
+        "description": "查询条件(ORM 方法需要)，如 {username: 'demo'} 或 {id: 1}"
+      },
+      "body": {
+        "type": "object",
+        "description": "数据对象(add/set 操作需要)"
+      }
+    },
+    "required": [
+      "action"
+    ]
+  },
+  "returns": {
+    "description": "操作结果，返回 route 字段标识实际路由到的库",
+    "type": "object",
+    "properties": {
+      "list": {
+        "type": "array",
+        "description": "查询结果列表(query操作)"
+      },
+      "count": {
+        "type": "number",
+        "description": "查询结果数量(query操作)"
+      },
+      "affected": {
+        "type": "number",
+        "description": "影响行数或插入ID(insert/update/delete操作)"
+      },
+      "route": {
+        "type": "string",
+        "description": "实际路由: master/replica"
+      }
+    }
+  },
+  "options": {
+    "master": {
+      "type": "object",
+      "description": "写库(主库)配置",
+      "properties": {
+        "host": { "type": "string", "description": "主机", "default": "localhost" },
+        "port": { "type": "number", "description": "端口", "default": 3306 },
+        "user": { "type": "string", "description": "用户名", "default": "root" },
+        "password": { "type": "string", "description": "密码", "default": "Asd159357" },
+        "database": { "type": "string", "description": "数据库名", "default": "mm" },
+        "connectionLimit": { "type": "number", "description": "连接池大小", "default": 10 }
+      }
+    },
+    "replicas": {
+      "type": "array",
+      "description": "读库(从库)配置列表，多台随机负载均衡",
+      "items": {
+        "type": "object",
+        "properties": {
+          "host": { "type": "string", "description": "主机" },
+          "port": { "type": "number", "description": "端口", "default": 3306 },
+          "user": { "type": "string", "description": "用户名" },
+          "password": { "type": "string", "description": "密码" },
+          "database": { "type": "string", "description": "数据库名" },
+          "connectionLimit": { "type": "number", "description": "连接池大小", "default": 10 }
+        }
+      }
+    }
+  },
+  "group": "system"
+}

package/tool/sql_dump/index.js

@@ -0,0 +1,7 @@
+'use strict';
+/**
+ * sql_dump —— 工具契约适配层
+ * 业务实现归位于模块 lib/tools/sql_dump/，本文件只把模块能力暴露给加载器。
+ * 其它模块可直接 require('mm_mysql').tools.sql_dump 复用。
+ */
+module.exports = require('../../lib/tools/sql_dump');

package/tool/sql_dump/tool.json

@@ -0,0 +1,83 @@
+{
+  "name": "sql_dump",
+  "handler": "manager",
+  "title": "SQL导出管理器",
+  "description": "将 MySQL 表导出为 SQL 文件（建表语句+数据）。适用场景：备份表结构数据、迁移或重建环境时。工作流提示：table 必填导出表名，output_file 指定路径（默认 ./backup/{table}.sql），路径在 file_path、条数与行数在 statements/rows。",
+  "type": "data",
+  "params": {
+    "type": "object",
+    "properties": {
+      "table": {
+        "type": "string",
+        "description": "要导出的表名"
+      },
+      "output_file": {
+        "type": "string",
+        "description": "输出文件路径（可选，默认 ./backup/{table}.sql）"
+      }
+    },
+    "required": ["table"]
+  },
+  "returns": {
+    "description": "导出结果",
+    "type": "object",
+    "properties": {
+      "file_path": {
+        "type": "string",
+        "description": "导出文件绝对路径"
+      },
+      "table": {
+        "type": "string",
+        "description": "导出的表名"
+      },
+      "statements": {
+        "type": "number",
+        "description": "生成的 SQL 语句条数"
+      },
+      "rows": {
+        "type": "number",
+        "description": "导出的数据行数"
+      }
+    }
+  },
+  "options": {
+    "host": {
+      "type": "string",
+      "description": "数据库主机地址",
+      "default": "localhost"
+    },
+    "port": {
+      "type": "number",
+      "description": "数据库端口",
+      "default": 3306
+    },
+    "user": {
+      "type": "string",
+      "description": "数据库用户名",
+      "default": "root"
+    },
+    "password": {
+      "type": "string",
+      "description": "数据库密码",
+      "default": "Asd159357"
+    },
+    "database": {
+      "type": "string",
+      "description": "数据库名",
+      "default": "mm"
+    },
+    "charset": {
+      "type": "string",
+      "description": "字符集",
+      "default": "utf8mb4"
+    },
+    "pool_size": {
+      "type": "number",
+      "description": "连接池大小",
+      "default": 10,
+      "min": 1,
+      "max": 100
+    }
+  },
+  "group": "storage"
+}