mm_mongodb 2.0.5 → 2.1.0

package/index.js

@@ -3,22 +3,22 @@
  * @description 参考 mm_redis 结构，index.js 为薄包装，类定义在 lib/mongodb.js
  */
 const MongoDB = require('./lib/mongodb');
-const Admin = require('mm_corejs').Admin;
+const { reg } = require('mm_admin');
 
 /**
  * MongoDB 管理器实例（Admin 工厂）
  * 支持 os.js 调用：require('mm_mongodb').admin.setServer(os) -> admin.get('os', config)
  */
-let admin = new Admin();
+const admin = reg('mm_mongodb');
 admin.setClass(MongoDB);
 
 module.exports = {
 	MongoDB,
 	admin,
 	mongodbAdmin(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/mongodb/index.js

@@ -0,0 +1,75 @@
+/**
+ * MongoDB管理器
+ * 管理 MongoDB 连接和文档操作（基于 mm_mongodb）
+ */
+async function main(params, ctx, options) {
+  const { mongodbAdmin } = require('mm_mongodb');
+  var action = params.action || '';
+  var collection_name = params.collection || '';
+  var key = params.key || {};
+  var value = params.value || {};
+  var ttl = params.ttl || 0;
+  var field = params.field;
+  var body = params.body || {};
+  var options = params.options || {};
+
+  var opts = this.getOptions();
+
+  var db = mongodbAdmin('os', opts);
+  db.table = collection_name;
+
+  const SIMPLE = [
+    'get', 'set', 'del', 'has', 'exists', 'add', 'getset',
+    'expire', 'pexpire', 'persist', 'ttl',
+    'incr', 'decr', 'incrby', 'decrby', 'incrbyfloat',
+    'keys', 'clear', 'clearExpire', 'dbsize', 'flushdb', 'isConnected',
+    'mget', 'mset',
+    'strlen', 'append', 'setrange',
+    'hgetall', 'hkeys', 'hvals', 'hlen', 'hdel', 'hmset', 'hmget',
+    'setForList', 'addForList', 'getForList', 'clearForList', 'hasForList',
+    'sadd', 'srem', 'sismember', 'smembers', 'scard', 'sinter', 'sunion', 'sdiff',
+    'zcard', 'zrem', 'zcount', 'zrevrange',
+    'publish', 'unsubscribe'
+  ];
+
+  const FIELD_METHODS = [
+    'hget', 'hset', 'hexists',
+    'zadd', 'zscore', 'zrank', 'zrevrank', 'zincrby'
+  ];
+
+  const MONGO_METHODS = [
+    'findOne', 'find', 'addObj', 'addList', 'delete', 'count',
+    'addTable', 'createIndex', 'createTTLIndex', 'getIndexes',
+    'dropIndex', 'dropTable'
+  ];
+
+  if (SIMPLE.indexOf(action) !== -1) {
+    ctx.output = await db[action](key, value, ttl);
+  } else if (FIELD_METHODS.indexOf(action) !== -1) {
+    ctx.output = await db[action](key, field, value, ttl);
+  } else if (action === 'hsetObj') {
+    ctx.output = await db.hmset(key, body);
+  } else if (action === 'msetObj') {
+    ctx.output = await db.mset(body, ttl);
+  } else if (action === 'aggregate') {
+    await db._ensureConnected();
+    ctx.output = await db.db.collection(collection_name).aggregate(value).toArray();
+  } else if (action === 'setting') {
+    ctx.output = await db.setting(key, body, options);
+  } else if (MONGO_METHODS.indexOf(action) !== -1) {
+    ctx.output = await db[action](key, value);
+  } else if (action === 'runSql') {
+    // MongoDB 不支持执行 SQL，返回 NOT_SUPPORTED 保持接口一致
+    ctx.output = {
+      error: { code: 'NOT_SUPPORTED', message: 'MongoDB不支持执行SQL' }
+    };
+  } else {
+    ctx.output = {
+      error: { code: 'MGR_UNKNOWN_ACTION', message: '不支持的操作: ' + action }
+    };
+  }
+
+  return ctx.output;
+}
+
+module.exports = { main };

package/package.json

@@ -1,52 +1,53 @@
 {
-    "name": "mm_mongodb",
-    "version": "2.0.5",
-    "description": "MongoDB数据库操作模块，接口与 mm_redis / mm_cachebase 完全对齐：全异步API、冒号风格事件、统一签名与返回值，支持缓存功能、事务和连接池管理",
-    "main": "index.js",
-    "scripts": {
-        "test": "node test.js",
-        "test:events": "node test_events.js",
-        "test:redis": "node test_redis_api.js",
-        "test:redis-compatibility": "node test_redis_compatibility.js"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://gitee.com/qiuwenwu91/mm_mongodb.git"
-    },
-    "keywords": [
-        "mm_mod",
-        "mm_adapter",
-        "mm_mongodb",
-        "mongodb",
-        "redis",
-        "cache",
-        "async",
-        "await",
-        "promise",
-        "transaction",
-        "index",
-        "pool",
-        "nosql",
-        "database",
-        "redis-compatible",
-        "event",
-        "ttl"
-    ],
-    "layer": "adapter",
-    "group": "mongodb",
-    "author": "邱文武",
-    "license": "ISC",
-    "bugs": {
-        "url": "https://gitee.com/qiuwenwu91/mm_mongodb/issues"
-    },
-    "homepage": "https://gitee.com/qiuwenwu91/mm_mongodb#readme",
-    "dependencies": {
-        "mm_corejs": "^1.1.4",
-        "mm_mod": "^1.0.1",
-        "mm_logger": "^1.0.0",
-        "mongodb": "^7.6.0"
-    },
-    "devDependencies": {
-        "mm_eslint": "^1.7.7"
-    }
+  "name": "mm_mongodb",
+  "version": "2.1.0",
+  "description": "MongoDB数据库操作模块，接口与 mm_redis / mm_cachebase 完全对齐：全异步API、冒号风格事件、统一签名与返回值，支持缓存功能、事务和连接池管理",
+  "main": "index.js",
+  "scripts": {
+    "test": "node test.js",
+    "test:events": "node test_events.js",
+    "test:redis": "node test_redis_api.js",
+    "test:redis-compatibility": "node test_redis_compatibility.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitee.com/qiuwenwu91/mm_mongodb.git"
+  },
+  "keywords": [
+    "mm_mod",
+    "mm_adapter",
+    "mm_mongodb",
+    "mongodb",
+    "redis",
+    "cache",
+    "async",
+    "await",
+    "promise",
+    "transaction",
+    "index",
+    "pool",
+    "nosql",
+    "database",
+    "redis-compatible",
+    "event",
+    "ttl"
+  ],
+  "layer": "infrastructure",
+  "group": "persistence",
+  "author": "邱文武",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://gitee.com/qiuwenwu91/mm_mongodb/issues"
+  },
+  "homepage": "https://gitee.com/qiuwenwu91/mm_mongodb#readme",
+  "dependencies": {
+    "mm_admin": "^1.1.0",
+    "mm_eslint": "^1.0.0",
+    "mm_logger": "^1.0.0",
+    "mm_mod": "^1.0.1",
+    "mongodb": "^7.6.0"
+  },
+  "devDependencies": {
+    "mm_eslint": "^1.7.7"
+  }
 }

package/tool/mongodb/index.js

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

package/tool/mongodb/tool.json

@@ -0,0 +1,165 @@
+{
+  "name": "mongodb",
+  "handler": "manager",
+  "title": "MongoDB管理器",
+  "description": "管理 MongoDB，兼容 Redis 风格与原生 CRUD。适用场景：文档存储、复杂查询或索引时。工作流提示：action/collection 必填，Redis 风格用 key/value/field/ttl，原生操作配 findOne/find/addObj/delete 等，返回随操作而定。",
+  "type": "data",
+  "params": {
+    "type": "object",
+    "properties": {
+      "action": {
+        "type": "string",
+        "description": "操作类型",
+        "enum": [
+          "get",
+          "set",
+          "del",
+          "has",
+          "exists",
+          "add",
+          "getset",
+          "expire",
+          "pexpire",
+          "persist",
+          "ttl",
+          "incr",
+          "decr",
+          "incrby",
+          "decrby",
+          "incrbyfloat",
+          "keys",
+          "clear",
+          "clearExpire",
+          "dbsize",
+          "flushdb",
+          "isConnected",
+          "mget",
+          "mset",
+          "msetObj",
+          "strlen",
+          "append",
+          "setrange",
+          "hget",
+          "hset",
+          "hgetall",
+          "hkeys",
+          "hvals",
+          "hlen",
+          "hdel",
+          "hmset",
+          "hmget",
+          "hexists",
+          "hsetObj",
+          "setForList",
+          "addForList",
+          "getForList",
+          "clearForList",
+          "hasForList",
+          "sadd",
+          "srem",
+          "sismember",
+          "smembers",
+          "scard",
+          "sinter",
+          "sunion",
+          "sdiff",
+          "zadd",
+          "zrem",
+          "zscore",
+          "zrank",
+          "zrevrank",
+          "zincrby",
+          "zcard",
+          "zcount",
+          "zrevrange",
+          "publish",
+          "unsubscribe",
+          "aggregate",
+          "findOne",
+          "find",
+          "addObj",
+          "addList",
+          "delete",
+          "count",
+          "setting",
+          "addTable",
+          "createIndex",
+          "createTTLIndex",
+          "getIndexes",
+          "dropIndex",
+          "dropTable",
+          "runSql"
+        ]
+      },
+      "collection": {
+        "type": "string",
+        "description": "集合名称"
+      },
+      "sql": {
+        "type": "string",
+        "description": "SQL脚本内容（runSql 操作需要，MongoDB不支持SQL，返回 NOT_SUPPORTED）"
+      },
+      "key": {
+        "description": "键/查询条件"
+      },
+      "value": {
+        "description": "值/增量值/成员等"
+      },
+      "ttl": {
+        "type": "number",
+        "description": "过期时间(秒)",
+        "min": 0
+      },
+      "field": {
+        "type": "string",
+        "description": "哈希字段名/有序集合成员名(哈希和有序集合操作)"
+      },
+      "body": {
+        "type": "object",
+        "description": "批量数据对象/修改数据(setting/hsetObj/msetObj 操作)"
+      },
+      "options": {
+        "type": "object",
+        "description": "查询选项(findOne/find/createIndex 等操作)"
+      }
+    },
+    "required": [
+      "action",
+      "collection"
+    ]
+  },
+  "returns": {
+    "description": "管理操作结果，返回值类型根据操作而定",
+    "type": "object"
+  },
+  "options": {
+    "uri": {
+      "type": "string",
+      "description": "MongoDB连接URI",
+      "default": "mongodb://localhost:27017"
+    },
+    "database": {
+      "type": "string",
+      "description": "数据库名",
+      "default": "mm"
+    },
+    "user": {
+      "type": "string",
+      "description": "数据库用户名",
+      "default": "root"
+    },
+    "password": {
+      "type": "string",
+      "description": "数据库密码",
+      "default": "asd159357"
+    },
+    "pool_size": {
+      "type": "number",
+      "description": "连接池大小",
+      "default": 10,
+      "min": 1,
+      "max": 100
+    }
+  },
+  "group": "storage"
+}