mm_dbs 1.0.2 → 1.0.3

package/README.md

@@ -1,3 +1,12 @@
-## 数据库框架（mm_db）
+| `dbs` | 数据库结构与建表模型 | 库清单、建表模型与索引 |## 数据库框架（mm_db）
 用于mysql数据库生成表或生成sql模板，通过设计数据库就可以生成sql模板，或通过db.json配置文件就可以生成mysql数据表
-可以便捷的实现数据库架构设计和相应业务的API
+可以便捷的实现数据库架构设计和相应业务的API
+
+## 工具契约（LLM 可调用）
+
+本模块 `tool/` 下登记以下工具契约，实现位于 `lib/tools/<name>/`，`tool/<name>/index.js` 仅为薄适配层。
+其它模块可直接 `require('<pkg>').tools.<name>` 复用实现，无需经过工具注册面。
+
+| 工具名 | 标题 | 说明 |
+| --- | --- | --- |
+| `dbs` | 数据库设计登记 | 库清单、设计配置、登记与重载 |

package/index.js

@@ -1,7 +1,7 @@
 const Manager = require('./lib/manager');
-const Admin = require('mm_corejs').Admin;
+const { reg } = require('mm_admin');
 
-const admin = new Admin();
+const admin = reg('mm_dbs');
 admin.setClass(Manager);
 
 module.exports = {
@@ -16,9 +16,10 @@ module.exports = {
    * @returns {Manager} 数据库管理器实例
    */
   dbAdmin(scope, config = {}, os) {
-    if (!scope) {
-      scope = 'os';
-    }
-    return admin.get(scope, config, os);
+return admin.get(scope, config, os);
   }
-};
+};
+
+/* mm-tool-logic-export 工具能力层：其它模块可 require("mm_dbs").tools.<name> 直接引用 */
+Object.defineProperty(module.exports, 'tools', { enumerable: true, configurable: true,
+  get: function () { return require('./lib/tools'); } });

package/lib/tools/dbs/index.js

@@ -0,0 +1,59 @@
+'use strict';
+/**
+ * dbs —— 数据库结构与建表模型工具
+ * DbManager 由 dbAdmin 构造（要求 config.name），建表模型来自模块 Db 类。
+ */
+const { dbAdmin, Db } = require('../../../index.js');
+
+/**
+ * 取管理器：DbManager 构造必须带 name，缺省用作用域名占位
+ * @param {string} scope 作用域
+ * @returns {object} 管理器
+ */
+function managerOf(scope) {
+  const s = scope || 'os';
+  return dbAdmin(s, { name: s, scope: s });
+}
+
+async function main(params, ctx, options) {
+  void options;
+  const p = params || {};
+  const action = p.action || 'list';
+  const write = (data) => { ctx.output = data; return data; };
+
+  try {
+    const mgr = managerOf(p.scope);
+
+    if (action === 'list') {
+      const rows = typeof mgr.getList === 'function' ? mgr.getList() : [];
+      const list = rows.map((o) => ({
+        name: (o && o.name) || '',
+        table: (o && o.table) || '',
+        engine: (o && o.engine) || (o && o.type) || '',
+        fields: Array.isArray(o && o.fields) ? o.fields.length : 0
+      }));
+      return write({ code: 0, msg: list.length ? '成功' : '当前作用域没有已登记的库', count: list.length, list });
+    }
+
+    if (action === 'schema') {
+      if (!p.config || typeof p.config !== 'object') throw new TypeError('schema 需要 config');
+      const inst = new Db(p.config);
+      const model = typeof inst.getModel === 'function' ? inst.getModel() : null;
+      if (!model) return write({ code: 10002, msg: '该库配置无法生成模型' });
+      return write({
+        code: 0,
+        msg: '成功',
+        table: model.table || '',
+        key: model.key || '',
+        schema: model,
+        index: Array.isArray(model.index) ? model.index : []
+      });
+    }
+
+    return write({ code: 10001, msg: '不支持的操作: ' + action });
+  } catch (error) {
+    return write({ code: 10000, msg: '执行失败：' + error.message, error: { name: error.name, message: error.message } });
+  }
+}
+
+module.exports = { main };

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mm_dbs",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "数据库框架，通过设计数据库生成sql模板，或通过db.json配置文件生成mysql数据表（基于 mm_corejs，内置管理器池，无全局/原型扩展依赖）",
   "main": "index.js",
   "keywords": [
@@ -12,8 +12,8 @@
     "schema",
     "数据管理器"
   ],
-  "layer": "infra",
-  "group": "data",
+  "layer": "infrastructure",
+  "group": "persistence",
   "author": "邱文武",
   "license": "ISC",
   "repository": {
@@ -21,7 +21,7 @@
     "url": "git+https://gitee.com/qiuwenwu91/mm_dbs.git"
   },
   "dependencies": {
-    "mm_corejs": "^1.1.4",
+    "mm_admin": "^1.1.0",
     "mm_mod": "^1.0.1",
     "mm_helper": "^1.0.0"
   },

package/tool/dbs/index.js

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

package/tool/dbs/tool.json

@@ -0,0 +1,65 @@
+{
+  "name": "dbs",
+  "title": "数据库结构与建表模型",
+  "description": "基于 mm_dbs 的库结构能力：列出已登记的库、按配置生成建表模型（表名/主键/字段/索引）。适用场景：核对某库的表结构定义、确认主键与索引口径、建表前检查字段配置。工作流提示：schema 传 config（库配置对象）；管理器的 getInfos 不可用，清单走 getList。",
+  "category": "数据库结构",
+  "group": "store",
+  "type": "function",
+  "main": "./index.js",
+  "params": {
+    "type": "object",
+    "properties": {
+      "action": {
+        "type": "string",
+        "description": "操作类型: list(登记清单)/schema(建表模型)",
+        "enum": [
+          "list",
+          "schema"
+        ],
+        "default": "list"
+      },
+      "scope": {
+        "type": "string",
+        "description": "作用域，缺省 os",
+        "default": "os"
+      },
+      "config": {
+        "type": "object",
+        "description": "库配置(schema 必填)"
+      }
+    },
+    "required": [
+      "action"
+    ]
+  },
+  "returns": {
+    "type": "object",
+    "properties": {
+      "code": {
+        "type": "number",
+        "description": "0 表示成功，1xxxx 表示业务/执行异常"
+      },
+      "msg": {
+        "type": "string",
+        "description": "结果描述"
+      },
+      "list": {
+        "type": "array",
+        "description": "登记清单(list)"
+      },
+      "schema": {
+        "type": "object",
+        "description": "建表模型(schema)"
+      },
+      "index": {
+        "type": "array",
+        "description": "索引定义(schema)"
+      },
+      "error": {
+        "type": "object",
+        "description": "异常对象 { name, message }"
+      }
+    }
+  },
+  "handler": "manager"
+}