mm_sqlite 1.5.8 → 1.6.0

package/index.js

@@ -3,22 +3,22 @@
  * @description 参考 mm_redis 结构，index.js 为薄包装，类定义在 lib/sqlite.js
  */
 const SQLite = require('./lib/sqlite');
-const Admin = require('mm_corejs').Admin;
+const { reg } = require('mm_admin');
 
 /**
  * SQLite 管理器实例（Admin 工厂）
  * 支持 os.js 调用：require('mm_sqlite').admin.setServer(os) -> admin.get('os', config)
  */
-let admin = new Admin();
+const admin = reg('mm_sqlite');
 admin.setClass(SQLite);
 
 module.exports = {
   SQLite,
   admin,
   sqliteAdmin(scope, config) {
-    if (!scope) {
-      scope = 'os';
-    }
-    return admin.get(scope, config);
+    return admin.get(scope || 'os', config);
   }
-};
+};
+/* mm-tool-logic-export 工具能力层：其它模块可 require("<pkg>").tools.<name> 直接引用 */
+Object.defineProperty(module.exports, 'tools', { enumerable: true, configurable: true,
+  get: function () { return require('./lib/tools'); } });

package/lib/tools/index.js

@@ -0,0 +1,16 @@
+'use strict';
+const fs = require('fs');
+const path = require('path');
+/** 模块能力层：懒加载工具实现，避免模块入口被 require 时加载全部实现 */
+module.exports = new Proxy({}, {
+  get(_t, key) {
+    if (typeof key !== 'string') return undefined;
+    if (!fs.existsSync(path.join(__dirname, key, 'index.js'))) return undefined;
+    return require('./' + key);
+  },
+  has(_t, key) {
+    return typeof key === 'string' && fs.existsSync(path.join(__dirname, key, 'index.js'));
+  },
+  ownKeys() { return fs.readdirSync(__dirname, { withFileTypes: true }).filter(e => e.isDirectory()).map(e => e.name); },
+  getOwnPropertyDescriptor(_t, key) { return this.has(_t, key) ? { enumerable: true, configurable: true } : undefined; }
+});

package/lib/tools/sqlite/index.js

@@ -0,0 +1,125 @@
+/**
+ * SQLite管理器
+ * 管理 SQLite 连接和操作（基于 mm_sqlite 连接池）
+ * SQL 方法: query/execute, ORM 方法: add/del/set/list/getObj/count
+ */
+async function main(params, ctx, options) {
+  const { sqliteAdmin } = require('mm_sqlite');
+  var action = params.action || '';
+  var table = params.table || '';
+  var sql = params.sql || '';
+  var sql_params = params.params || [];
+  var query = params.query || {};
+  var body = params.body || {};
+
+  var opts = this.getOptions();
+
+  let config = { ...opts };
+
+  var sqlite = sqliteAdmin('os', config);
+  await sqlite.open();
+
+  ctx.output = await dispatch(sqlite, action, table, sql, sql_params, query, body);
+  return ctx.output;
+}
+
+/**
+ * 分发 action 到对应的处理方法
+ */
+async function dispatch(sqlite, action, table, sql, sql_params, query, body) {
+  const SQL_METHODS = ['query', 'run', 'execute', 'exec', 'insert', 'update', 'delete'];
+  const ORM_METHODS = ['add', 'del', 'set', 'list', 'getObj', 'count'];
+
+  if (SQL_METHODS.indexOf(action) !== -1) {
+    return handleSql(sqlite, action, sql, sql_params);
+  }
+  if (ORM_METHODS.indexOf(action) !== -1) {
+    return handleOrm(sqlite, action, table, query, body);
+  }
+  if (action === 'runSql') {
+    return handleRunSql(sqlite, sql);
+  }
+  return { error: { code: 'MGR_UNKNOWN_ACTION', message: '不支持的操作: ' + action } };
+}
+
+/**
+ * 执行多语句 SQL 脚本（支持分号分隔的建表/插入语句）
+ * @param {object} sqlite 数据库实例
+ * @param {string} sql SQL 脚本内容
+ * @returns {object} { success, statements, affected_rows }
+ */
+async function handleRunSql(sqlite, sql) {
+  if (!sql) {
+    return _errorResult('MGR_SQL_EMPTY', 'SQL 语句不能为空');
+  }
+  var result = await sqlite.runSql(sql);
+  if (sqlite.error) {
+    return _errorResult('MGR_RUNSQL_ERROR', sqlite.error.message);
+  }
+  return {
+    success: result.success,
+    statements: result.statements,
+    affected_rows: result.affected_rows
+  };
+}
+
+/**
+ * 处理 SQL 方法: query/run → SELECT, execute/exec → INSERT/UPDATE/DELETE
+ */
+async function handleSql(sqlite, action, sql, sql_params) {
+  var is_query = action === 'query' || action === 'run';
+  var result = is_query
+    ? await sqlite.run(sql, sql_params)
+    : await sqlite.exec(sql, sql_params);
+
+  if (sqlite.error) {
+    return _errorResult('MGR_SQL_ERROR', sqlite.error.message);
+  }
+  return is_query
+    ? { list: Array.isArray(result) ? result : [], count: Array.isArray(result) ? result.length : 0 }
+    : { affected: result || 0 };
+}
+
+/**
+ * 处理 ORM 方法: add/del/set/list/getObj/count
+ */
+async function handleOrm(sqlite, action, table, query, body) {
+  var db = sqlite.db();
+  db.table = table;
+
+  var result;
+  switch (action) {
+    case 'add':
+      result = await db.add(body);
+      break;
+    case 'del':
+      result = await db.del(query);
+      break;
+    case 'set':
+      result = await db.set(query, body);
+      break;
+    case 'list':
+      result = await db.list(query);
+      break;
+    case 'getObj':
+      result = await db.getObj(query);
+      break;
+    case 'count':
+      result = await db.count(query);
+      break;
+  }
+
+  if (db.error) {
+    return _errorResult('MGR_ORM_ERROR', db.error.message);
+  }
+  return result;
+}
+
+/**
+ * 构建错误结果对象
+ */
+function _errorResult(code, message) {
+  return { error: { code: code, message: message } };
+}
+
+module.exports = { main };

package/package.json

@@ -1,56 +1,57 @@
 {
-    "name": "mm_sqlite",
-    "version": "1.5.8",
-    "description": "高性能SQLite数据库操作模块，提供与mm_mysql完全兼容的API接口，支持异步操作、事务处理和批量操作",
-    "main": "index.js",
-    "scripts": {
-        "test": "node test.js",
-        "dev": "nodemon test.js",
-        "lint": "eslint . --config eslint.config.js",
-        "lint:fix": "eslint . --config eslint.config.js --fix"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://gitee.com/qiuwenwu91/mm_sqlite.git"
-    },
-    "keywords": [
-        "mm_mod",
-        "mm_adapter",
-        "mm_persist",
-        "sqlite",
-        "node.js",
-        "async",
-        "await",
-        "promise",
-        "database",
-        "transaction",
-        "batch",
-        "sql",
-        "mm_mysql",
-        "compatible",
-        "node-sqlite3",
-        "async-await"
-    ],
-    "layer": "adapter",
-    "group": "persist",
-    "author": "邱文武",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://gitee.com/qiuwenwu91/mm_sqlite/issues"
-    },
-    "homepage": "https://gitee.com/qiuwenwu91/mm_sqlite#readme",
-    "engines": {
-        "node": ">=22.13.0"
-    },
-    "dependencies": {
-        "mm_corejs": "^1.1.4",
-        "mm_mod": "^1.0.1",
-        "mm_helper": "^1.0.0",
-        "sqlstring": "^2.3.3"
-    },
-    "devDependencies": {
-        "eslint": "^10.9.1",
-        "eslint-plugin-jsdoc": "^64.2.1",
-        "mm_eslint": "^1.7.7"
-    }
+  "name": "mm_sqlite",
+  "version": "1.6.0",
+  "description": "高性能SQLite数据库操作模块，提供与mm_mysql完全兼容的API接口，支持异步操作、事务处理和批量操作",
+  "main": "index.js",
+  "scripts": {
+    "test": "node test.js",
+    "dev": "nodemon test.js",
+    "lint": "eslint . --config eslint.config.js",
+    "lint:fix": "eslint . --config eslint.config.js --fix"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitee.com/qiuwenwu91/mm_sqlite.git"
+  },
+  "keywords": [
+    "mm_mod",
+    "mm_adapter",
+    "mm_persist",
+    "sqlite",
+    "node.js",
+    "async",
+    "await",
+    "promise",
+    "database",
+    "transaction",
+    "batch",
+    "sql",
+    "mm_mysql",
+    "compatible",
+    "node-sqlite3",
+    "async-await"
+  ],
+  "layer": "infrastructure",
+  "group": "persistence",
+  "author": "邱文武",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://gitee.com/qiuwenwu91/mm_sqlite/issues"
+  },
+  "homepage": "https://gitee.com/qiuwenwu91/mm_sqlite#readme",
+  "engines": {
+    "node": ">=22.13.0"
+  },
+  "dependencies": {
+    "mm_admin": "^1.1.0",
+    "mm_eslint": "^1.0.0",
+    "mm_helper": "^1.0.0",
+    "mm_mod": "^1.0.1",
+    "sqlstring": "^2.3.3"
+  },
+  "devDependencies": {
+    "eslint": "^10.9.1",
+    "eslint-plugin-jsdoc": "^64.2.1",
+    "mm_eslint": "^1.7.7"
+  }
 }

package/tool/sqlite/index.js

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

package/tool/sqlite/tool.json

@@ -0,0 +1,82 @@
+{
+  "name": "sqlite",
+  "handler": "manager",
+  "title": "SQLite管理器",
+  "description": "操作 SQLite 数据库，支持 SQL 与 ORM 两种方式。适用场景：本地单文件、嵌入式或轻量持久化时。工作流提示：action 必填（SQL 方法配 sql/params，ORM 方法配 table/query/body），db_path 指定库文件，读在 list+count、写在 affected。",
+  "type": "data",
+  "params": {
+    "type": "object",
+    "properties": {
+      "action": {
+        "type": "string",
+        "description": "操作类型: SQL方法(query/execute/run/exec/runSql) + ORM方法(add/del/set/list/getObj/count)",
+        "enum": [
+          "query",
+          "execute",
+          "run",
+          "exec",
+          "runSql",
+          "add",
+          "del",
+          "set",
+          "list",
+          "getObj",
+          "count"
+        ]
+      },
+      "sql": {
+        "type": "string",
+        "description": "SQL语句（SQL方法需要，runSql 可传多条以分号分隔的建表/插入语句）"
+      },
+      "params": {
+        "type": "array",
+        "description": "SQL参数（可选）"
+      },
+      "table": {
+        "type": "string",
+        "description": "表名（ORM方法需要）"
+      },
+      "query": {
+        "type": "object",
+        "description": "查询条件（ORM方法需要）"
+      },
+      "body": {
+        "type": "object",
+        "description": "数据对象（add/set 操作需要）"
+      },
+      "db_path": {
+        "type": "string",
+        "description": "SQLite数据库文件路径（可选，优先于 options 配置）"
+      }
+    },
+    "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": "受影响的行数（写操作）"
+      }
+    }
+  },
+  "options": {
+    "db_path": {
+      "type": "string",
+      "description": "SQLite数据库文件路径（默认值，params.db_path 优先级更高）",
+      "default": "./data/sqlite.db"
+    }
+  },
+  "group": "storage"
+}