mm_dbs 0.0.0-stage → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/manager.js ADDED
@@ -0,0 +1,213 @@
1
+ const Manager = require("mm_corejs").Manager;
2
+ const Drive = require("./drive");
3
+
4
+ /**
5
+ * 数据库帮助类
6
+ * @augments {Manager}
7
+ * @class
8
+ */
9
+ class Db extends Manager {
10
+ /**
11
+ * 配置参数
12
+ * @type {object}
13
+ */
14
+ static config = {
15
+ /**
16
+ * 名称
17
+ * @type {string}
18
+ */
19
+ name: "",
20
+ /**
21
+ * 标题
22
+ * @type {string}
23
+ */
24
+ title: "数据库管理",
25
+ /**
26
+ * 描述
27
+ * @type {string}
28
+ */
29
+ description: "这是数据库管理器",
30
+ /**
31
+ * 服务主机地址(可选,传递给驱动)
32
+ * @type {string}
33
+ */
34
+ host: "",
35
+ /**
36
+ * 事件接口管理器获取函数(可选注入,返回 event api 管理器实例;未配置则跳过相关判断)
37
+ * @type {Function|null}
38
+ */
39
+ get_event_api: null,
40
+ };
41
+
42
+ /**
43
+ * 构造函数
44
+ * @param {object} config 配置参数
45
+ * @param {object} parent 父级模块
46
+ */
47
+ constructor(config, parent) {
48
+ super({ ...Db.config, ...config }, parent);
49
+ // 插件注册表(方案B:手动注册,供驱动 plugin() 查找)
50
+ this.plugins = {};
51
+ }
52
+ }
53
+
54
+ /**
55
+ * 数据库驱动类
56
+ * @type {Drive}
57
+ */
58
+ Db.prototype.Drive = Drive;
59
+
60
+ /**
61
+ * 注册一个数据库驱动(方案B:手动注册,不扫描目录)
62
+ * @param {object} config 驱动配置(必须包含 name)
63
+ * @returns {object} 驱动实例
64
+ */
65
+ Db.prototype.add = function (config) {
66
+ var drive = new Drive({ host: this.config.host, ...config }, this);
67
+ this.set(drive.config.name, drive);
68
+ return drive;
69
+ };
70
+
71
+ /**
72
+ * 注销一个数据库驱动
73
+ * @param {string} name 驱动名称
74
+ * @returns {Promise<boolean>} 是否删除成功
75
+ */
76
+ Db.prototype.del = async function (name) {
77
+ return await Manager.prototype.del.call(this, name);
78
+ };
79
+
80
+ /**
81
+ * 重载一个数据库驱动(按原配置删除后重新注册)
82
+ * @param {string} name 驱动名称
83
+ * @returns {Promise<boolean>} 是否执行成功
84
+ */
85
+ Db.prototype.reload = async function (name) {
86
+ var drive = this.get(name);
87
+ if (!drive) {
88
+ this.log("warn", "驱动不存在,无法重载", name);
89
+ return false;
90
+ }
91
+ var config = { ...drive.config };
92
+ await this.del(name);
93
+ this.add(config);
94
+ return true;
95
+ };
96
+
97
+ /**
98
+ * 注册插件集合(供驱动 plugin() 查找,替代原全局插件池)
99
+ * @param {string} name 插件作用域名称(app 名)
100
+ * @param {object} obj 插件集合对象(需含 get 方法)
101
+ * @returns {object} 当前管理器实例
102
+ */
103
+ Db.prototype.usePlugin = function (name, obj) {
104
+ this.plugins[name] = obj;
105
+ return this;
106
+ };
107
+
108
+ /**
109
+ * 获取所有驱动配置列表(方案B:来自注册表,替代旧基类 getInfos)
110
+ * @returns {Array} 驱动配置数组
111
+ * @private
112
+ */
113
+ Db.prototype._getInfos = function () {
114
+ return this.values().map((d) => d.config);
115
+ };
116
+
117
+ /**
118
+ * 获取驱动项
119
+ * @param {string} table 表
120
+ * @returns {object} 返回驱动项
121
+ */
122
+ Db.prototype.getObj = function (table) {
123
+ var obj;
124
+ var mods = this.values();
125
+ for (var i = 0; i < mods.length; i++) {
126
+ var o = mods[i];
127
+ if (o.config.table === table) {
128
+ obj = o;
129
+ break;
130
+ }
131
+ }
132
+ return obj;
133
+ };
134
+
135
+ /**
136
+ * 通过数据库更新配置
137
+ * @param {object} db 数据库管理器
138
+ * @param {string} name 要更新的配置名
139
+ * @param {string} table 表名关键词, 支持*table后缀匹配、table*前缀匹配、*table*包含匹配
140
+ * @param {boolean} cover 是否覆盖文件
141
+ * @returns {string} 更新成功返回null, 失败返回错误提示
142
+ */
143
+ Db.prototype.updateFile = async function (db, name, table, cover = true) {
144
+ if (name) {
145
+ var o = this.get(name);
146
+ if (o) {
147
+ await o.updateFile(db, cover);
148
+ } else {
149
+ return "该配置不存在";
150
+ }
151
+ } else {
152
+ var list = await db.tables(table);
153
+ var len = list.length;
154
+ if (len > 0) {
155
+ for (var i = 0; i < len; i++) {
156
+ var te = list[i];
157
+ var obj = this.getObj(te);
158
+ if (obj) {
159
+ await obj.updateFile(db, cover);
160
+ } else {
161
+ var drive = new Drive({ scope: this.config.name }, this);
162
+ drive.config.table = te;
163
+ await drive.updateFile(db, cover);
164
+ this.set(drive.config.table, drive);
165
+ }
166
+ }
167
+ } else {
168
+ return "没有找到相关的数据表";
169
+ }
170
+ }
171
+ return null;
172
+ };
173
+
174
+ /**
175
+ * 通过配置修改数据库
176
+ * @param {object} db 数据库管理器
177
+ * @param {string} name 要更新的配置名
178
+ * @param {string} table 表名关键词, 支持*table后缀匹配、table*前缀匹配、*table*包含匹配
179
+ * @param {boolean} all 是否更新全部表,true为是,false为否
180
+ * @returns {string} 更新成功返回null, 失败返回错误提示
181
+ */
182
+ Db.prototype.updateDb = async function (db, name, table, all) {
183
+ var ret;
184
+ if (name) {
185
+ var o = this.get(name);
186
+ if (o) {
187
+ ret = await o.updateDb(db);
188
+ } else {
189
+ ret = "该配置不存在";
190
+ }
191
+ } else {
192
+ var mods = this.values();
193
+ if (table) {
194
+ for (var i = 0; i < mods.length; i++) {
195
+ var m = mods[i];
196
+ if (m.config.table === table) {
197
+ ret = await m.updateDb(db);
198
+ break;
199
+ }
200
+ }
201
+ } else if (all) {
202
+ for (var j = 0; j < mods.length; j++) {
203
+ await mods[j].updateDb(db);
204
+ }
205
+ }
206
+ }
207
+ return ret;
208
+ };
209
+
210
+ /**
211
+ * @module 导出数据库管理器类
212
+ */
213
+ module.exports = Db;
package/package.json CHANGED
@@ -1,6 +1,26 @@
1
1
  {
2
2
  "name": "mm_dbs",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "1.0.0",
4
+ "description": "数据库框架,通过设计数据库生成sql模板,或通过db.json配置文件生成mysql数据表(基于 mm_corejs,内置管理器池,无全局/原型扩展依赖)",
5
+ "main": "index.js",
6
+ "keywords": [
7
+ "mm_mod",
8
+ "mm_infra",
9
+ "mm_data",
10
+ "db",
11
+ "mysql",
12
+ "schema",
13
+ "数据管理器"
14
+ ],
15
+ "layer": "infra",
16
+ "group": "data",
17
+ "author": "邱文武",
18
+ "license": "ISC",
19
+ "dependencies": {
20
+ "mm_corejs": "^1.1.4",
21
+ "mm_helper": "^1.0.0"
22
+ },
23
+ "scripts": {
24
+ "test": "node test.js"
25
+ }
26
+ }
package/test.js ADDED
@@ -0,0 +1,18 @@
1
+ 'use strict';
2
+ const assert = require('assert');
3
+ const mod = require('./index.js');
4
+
5
+ // 验证导出结构
6
+ assert.ok(mod.Manager, '应导出 Manager');
7
+ assert.ok(mod.admin, '应导出 admin');
8
+ assert.strictEqual(typeof mod.dbAdmin, 'function', '应导出 dbAdmin 函数');
9
+
10
+ // 验证通过工厂函数获取实例
11
+ const inst = mod.dbAdmin('test');
12
+ assert.ok(inst instanceof mod.Manager, 'dbAdmin 返回的实例应为 Manager 类型');
13
+
14
+ // 验证通过 admin 获取实例
15
+ const inst2 = mod.admin.get('test2');
16
+ assert.ok(inst2 instanceof mod.Manager, 'admin.get 返回的实例应为 Manager 类型');
17
+
18
+ console.log('mm_db 模块测试通过');