mm_dao 1.8.8 → 1.9.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/index.js +7 -45
- package/lib/dao.js +45 -1
- package/lib/manager.js +6 -44
- package/package.json +5 -5
- package/tests/main.test.js +3 -1
- package/tests/query.test.js +3 -1
- package/tests/scope.test.js +9 -28
package/index.js
CHANGED
|
@@ -1,29 +1,11 @@
|
|
|
1
1
|
const Dao = require('./lib/dao');
|
|
2
2
|
const Manager = require('./lib/manager');
|
|
3
3
|
const { Sql } = require('mm_sql');
|
|
4
|
-
const
|
|
4
|
+
const { reg } = require('mm_admin');
|
|
5
5
|
|
|
6
|
-
const admin =
|
|
6
|
+
const admin = reg('mm_dao');
|
|
7
7
|
admin.setClass(Manager);
|
|
8
8
|
|
|
9
|
-
/**
|
|
10
|
-
* 数据域配置模板:config.sql 中含 {org_id} 占位符时只登记、不实例化,
|
|
11
|
-
* 供 daoAdmin(域, { org_id }) 按机构派生独立库
|
|
12
|
-
* @type {Object}
|
|
13
|
-
*/
|
|
14
|
-
const templates = {};
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* 按机构生成数据源配置(替换 {org_id} 占位符,深拷贝避免污染模板)
|
|
18
|
-
* @param {object} sql_config 数据源配置模板
|
|
19
|
-
* @param {number} org_id 机构ID
|
|
20
|
-
* @returns {object} 该机构的数据源配置
|
|
21
|
-
*/
|
|
22
|
-
function bindOrg(sql_config, org_id) {
|
|
23
|
-
const cfg = JSON.parse(JSON.stringify(sql_config));
|
|
24
|
-
return JSON.parse(JSON.stringify(cfg).replace(/\{org_id\}/g, String(org_id)));
|
|
25
|
-
}
|
|
26
|
-
|
|
27
9
|
module.exports = {
|
|
28
10
|
Sql,
|
|
29
11
|
Dao,
|
|
@@ -32,33 +14,13 @@ module.exports = {
|
|
|
32
14
|
/**
|
|
33
15
|
* 获取指定作用域的 DAO 管理器
|
|
34
16
|
* 作用域即数据域:os(系统)、user(用户)、org(机构)、project(项目)、client(客户端)、app(应用)。
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
* 按机构分库:数据源配置里用 {org_id} 占位时,该域只登记模板;
|
|
38
|
-
* 用 daoAdmin('org', { org_id: 3 }) 取用时,派生实例 org_3,库名按模板替换为 org_3.db。
|
|
17
|
+
* 同一作用域复用同一实例;数据源由驱动(lib/dao.js)按配置决定:
|
|
18
|
+
* config.sql 指定时该作用域绑定独立数据源,未配置时复用主库。
|
|
39
19
|
* @param {string} [scope='os'] 作用域名称
|
|
40
|
-
* @param {object} [config] 配置参数,config.sql
|
|
41
|
-
* @returns {object
|
|
20
|
+
* @param {object} [config] 配置参数,config.sql 指定数据源
|
|
21
|
+
* @returns {object} DAO 管理器实例
|
|
42
22
|
*/
|
|
43
23
|
daoAdmin(scope, config) {
|
|
44
|
-
|
|
45
|
-
scope = 'os';
|
|
46
|
-
}
|
|
47
|
-
// 1) 登记模板:含 {org_id} 的数据源不建固定实例,等按机构取用时再派生
|
|
48
|
-
if (config && config.sql && /\{org_id\}/.test(JSON.stringify(config.sql))) {
|
|
49
|
-
templates[scope] = config.sql;
|
|
50
|
-
return null;
|
|
51
|
-
}
|
|
52
|
-
// 2) 按机构派生:daoAdmin('org', { org_id: 3 }) → 实例名 org_3,库按模板替换
|
|
53
|
-
if (config && config.org_id) {
|
|
54
|
-
const org_id = parseInt(config.org_id) || 0;
|
|
55
|
-
const name = scope + '_' + org_id;
|
|
56
|
-
const tpl = config.sql || templates[scope];
|
|
57
|
-
const next = Object.assign({}, config);
|
|
58
|
-
delete next.org_id;
|
|
59
|
-
next.sql = tpl ? bindOrg(tpl, org_id) : undefined;
|
|
60
|
-
return admin.get(name, next);
|
|
61
|
-
}
|
|
62
|
-
return admin.get(scope, config);
|
|
24
|
+
return admin.get(scope || 'os', config);
|
|
63
25
|
}
|
|
64
26
|
};
|
package/lib/dao.js
CHANGED
|
@@ -2,6 +2,7 @@ const path = require('path');
|
|
|
2
2
|
const Item = require('mm_machine').Mod;
|
|
3
3
|
const { string, array, file } = require('mm_helper');
|
|
4
4
|
const { getRet } = require('mm_ret');
|
|
5
|
+
const { getSql, sqlAdmin } = require('mm_sql');
|
|
5
6
|
const dbAdmin = require('mm_dbs');
|
|
6
7
|
|
|
7
8
|
/**
|
|
@@ -138,6 +139,10 @@ class Dao extends Item {
|
|
|
138
139
|
log: false,
|
|
139
140
|
// 驱动目录(方案B:手动配置,替代目录扫描)
|
|
140
141
|
dir: '',
|
|
142
|
+
// 作用域名称(数据源实例名,由管理器注入,如 os / user / org)
|
|
143
|
+
scope: 'os',
|
|
144
|
+
// 数据源配置(由管理器注入;配置后本驱动按作用域绑定独立数据源,未配置时复用主库)
|
|
145
|
+
sql: null,
|
|
141
146
|
};
|
|
142
147
|
|
|
143
148
|
/**
|
|
@@ -152,6 +157,9 @@ class Dao extends Item {
|
|
|
152
157
|
// 父级管理器引用(用于默认配置回退与插件查找)
|
|
153
158
|
this.parent = parent || null;
|
|
154
159
|
|
|
160
|
+
// 本驱动绑定的 Sql 实例(惰性创建,见 _getSql)
|
|
161
|
+
this._sql = null;
|
|
162
|
+
|
|
155
163
|
// 初始化运行时数据结构
|
|
156
164
|
this._preset();
|
|
157
165
|
}
|
|
@@ -241,14 +249,50 @@ Dao.prototype.after = async function (params, db) {
|
|
|
241
249
|
*/
|
|
242
250
|
Dao.prototype.updateCache = async function (table, sql) {};
|
|
243
251
|
|
|
252
|
+
/**
|
|
253
|
+
* 获取本驱动绑定的 Sql 实例(数据源由本驱动配置决定)
|
|
254
|
+
* 作用域即数据域:os / user / org / project / client / app 各自可独立配置数据库;
|
|
255
|
+
* 未单独配置 sql 时复用进程级主库,便于同库分域与后续平滑拆库。
|
|
256
|
+
* @returns {object} Sql 实例
|
|
257
|
+
* @private
|
|
258
|
+
*/
|
|
259
|
+
Dao.prototype._getSql = function () {
|
|
260
|
+
if (!this._sql) {
|
|
261
|
+
var name = this.config.scope || 'os';
|
|
262
|
+
var sql_config = this.config.sql;
|
|
263
|
+
this._sql = sql_config ? sqlAdmin(name, sql_config) : getSql();
|
|
264
|
+
}
|
|
265
|
+
return this._sql;
|
|
266
|
+
};
|
|
267
|
+
|
|
268
|
+
/**
|
|
269
|
+
* 获取数据库管理器(委托本驱动绑定的 Sql 实例)
|
|
270
|
+
* @returns {object} 数据库管理器实例
|
|
271
|
+
*/
|
|
272
|
+
Dao.prototype.db = function () {
|
|
273
|
+
return this._getSql().db();
|
|
274
|
+
};
|
|
275
|
+
|
|
276
|
+
/**
|
|
277
|
+
* 读取并执行 .sql 文件脚本(委托本驱动绑定的 Sql 实例)
|
|
278
|
+
* @param {string} fpath SQL 文件路径
|
|
279
|
+
* @returns {Promise<object>} 执行结果统计对象
|
|
280
|
+
*/
|
|
281
|
+
Dao.prototype.load = function (fpath) {
|
|
282
|
+
return this._getSql().load(fpath);
|
|
283
|
+
};
|
|
284
|
+
|
|
244
285
|
/**
|
|
245
286
|
* @ 执行修改
|
|
246
287
|
* @param {object} query 查询url参数
|
|
247
288
|
* @param {object} body 修改时置入body的参数
|
|
248
|
-
* @param {object} db
|
|
289
|
+
* @param {object} [db] 数据库管理器,不传时由本驱动按自身配置选择数据源
|
|
249
290
|
* @returns {object} 返回执行结果
|
|
250
291
|
*/
|
|
251
292
|
Dao.prototype.run = async function (query, body, db) {
|
|
293
|
+
if (!db) {
|
|
294
|
+
db = this.db();
|
|
295
|
+
}
|
|
252
296
|
var params = {
|
|
253
297
|
query,
|
|
254
298
|
body,
|
package/lib/manager.js
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
const path = require("path");
|
|
2
2
|
const Manager = require('mm_machine').Manager;
|
|
3
3
|
const Dao = require("./dao");
|
|
4
|
-
const { getSql, sqlAdmin } = require("mm_sql");
|
|
5
4
|
const { array } = require("mm_helper");
|
|
6
5
|
|
|
7
6
|
/**
|
|
@@ -63,8 +62,6 @@ class DaoManager extends Manager {
|
|
|
63
62
|
*/
|
|
64
63
|
constructor(config, parent) {
|
|
65
64
|
super({ ...DaoManager.config, ...config }, parent);
|
|
66
|
-
// 兼容 Sql 实例(惰性创建,按作用域绑定数据源,见 _getSql)
|
|
67
|
-
this._sql = null;
|
|
68
65
|
}
|
|
69
66
|
}
|
|
70
67
|
|
|
@@ -113,6 +110,9 @@ DaoManager.prototype.add = function (config) {
|
|
|
113
110
|
user_path: this.config.user_path,
|
|
114
111
|
static_path: this.config.static_path,
|
|
115
112
|
run_path: this.config.run_path,
|
|
113
|
+
// 作用域与数据源配置注入驱动,由驱动决定使用哪个数据库(见 dao._getSql)
|
|
114
|
+
scope: this.config.name,
|
|
115
|
+
sql: this.config.sql,
|
|
116
116
|
...config,
|
|
117
117
|
},
|
|
118
118
|
this,
|
|
@@ -187,57 +187,19 @@ DaoManager.prototype.sort = function () {
|
|
|
187
187
|
|
|
188
188
|
/**
|
|
189
189
|
* 执行sql
|
|
190
|
+
* 数据源由驱动按自身配置决定(见 dao._getSql),本管理器不介入数据库选择
|
|
190
191
|
* @param {string} name 名称
|
|
191
192
|
* @param {object} query 查询参数
|
|
192
193
|
* @param {object} body 修改参数
|
|
193
|
-
* @param {object} [db]
|
|
194
|
+
* @param {object} [db] 数据库管理器,不传时由驱动按自身配置选择数据源
|
|
194
195
|
* @returns {object} 执行结果
|
|
195
196
|
*/
|
|
196
197
|
DaoManager.prototype.run = async function (name, query, body, db) {
|
|
197
198
|
var obj = this.get(name);
|
|
198
199
|
if (obj) {
|
|
199
|
-
return await obj.run(query, body, db
|
|
200
|
+
return await obj.run(query, body, db);
|
|
200
201
|
}
|
|
201
202
|
return null;
|
|
202
203
|
};
|
|
203
204
|
|
|
204
|
-
/**
|
|
205
|
-
* 获取本作用域绑定的 Sql 实例
|
|
206
|
-
* 数据源按作用域划分:os / user / org / project / client / app 各自可独立配置数据库;
|
|
207
|
-
* 作用域未单独配置 sql 时复用一个进程级主库,便于同库分域与后续平滑拆库。
|
|
208
|
-
* @returns {Sql} 兼容 Sql 实例
|
|
209
|
-
* @private
|
|
210
|
-
*/
|
|
211
|
-
DaoManager.prototype._getSql = function () {
|
|
212
|
-
if (!this._sql) {
|
|
213
|
-
const name = this.config.name || 'os';
|
|
214
|
-
const sql_config = this.config.sql;
|
|
215
|
-
if (sql_config) {
|
|
216
|
-
// 该作用域显式配置了数据源:按名取独立实例
|
|
217
|
-
this._sql = sqlAdmin(name, sql_config);
|
|
218
|
-
} else {
|
|
219
|
-
// 未单独配置:复用主库,避免出现未选库的空连接
|
|
220
|
-
this._sql = getSql();
|
|
221
|
-
}
|
|
222
|
-
}
|
|
223
|
-
return this._sql;
|
|
224
|
-
};
|
|
225
|
-
|
|
226
|
-
/**
|
|
227
|
-
* 获取数据库管理器(等价入口,委托内部 Sql 实例)
|
|
228
|
-
* @returns {object} 数据库管理器实例
|
|
229
|
-
*/
|
|
230
|
-
DaoManager.prototype.db = function () {
|
|
231
|
-
return this._getSql().db();
|
|
232
|
-
};
|
|
233
|
-
|
|
234
|
-
/**
|
|
235
|
-
* 读取并执行 .sql 文件脚本(等价入口,委托内部 Sql 实例)
|
|
236
|
-
* @param {string} file SQL 文件路径
|
|
237
|
-
* @returns {Promise<object>} 执行结果统计对象
|
|
238
|
-
*/
|
|
239
|
-
DaoManager.prototype.load = function (file) {
|
|
240
|
-
return this._getSql().load(file);
|
|
241
|
-
};
|
|
242
|
-
|
|
243
205
|
module.exports = DaoManager;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mm_dao",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.9.0",
|
|
4
4
|
"description": "一个通用的SQL帮助类,支持通过切换db_type实现对不同数据库的操作,包括MySQL和SQLite等;另提供 manager.js/drive.js 的SQL模板管理器(融合自 mm_os com/sql,基于 mm_corejs,内置管理器池,无全局/原型扩展依赖)",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -37,8 +37,8 @@
|
|
|
37
37
|
"多数据库",
|
|
38
38
|
"database-adapter"
|
|
39
39
|
],
|
|
40
|
-
"layer": "
|
|
41
|
-
"group": "
|
|
40
|
+
"layer": "infrastructure",
|
|
41
|
+
"group": "persistence",
|
|
42
42
|
"author": "邱文武",
|
|
43
43
|
"license": "ISC",
|
|
44
44
|
"bugs": {
|
|
@@ -49,11 +49,11 @@
|
|
|
49
49
|
"node": ">=12.0.0"
|
|
50
50
|
},
|
|
51
51
|
"dependencies": {
|
|
52
|
-
"
|
|
52
|
+
"mm_admin": "^1.1.0",
|
|
53
53
|
"mm_dbs": "^1.0.1",
|
|
54
54
|
"mm_excel": "^1.2.4",
|
|
55
55
|
"mm_helper": "^1.0.0",
|
|
56
|
-
"mm_machine": "^
|
|
56
|
+
"mm_machine": "^6.0.0",
|
|
57
57
|
"mm_ret": "^1.4.8",
|
|
58
58
|
"mm_sql": "^1.8.0"
|
|
59
59
|
},
|
package/tests/main.test.js
CHANGED
|
@@ -25,7 +25,9 @@ function makeTable() {
|
|
|
25
25
|
daoAdmin('main_test', {
|
|
26
26
|
sql: { way: 'sqlite', sqlite: { dir: db_dir, database: 'main_test' } }
|
|
27
27
|
});
|
|
28
|
-
|
|
28
|
+
const manager = daoAdmin('main_test');
|
|
29
|
+
const drive = manager.get('demo') || manager.add({ name: 'demo', table: 'demo' });
|
|
30
|
+
return drive.db().new('demo', 'id');
|
|
29
31
|
}
|
|
30
32
|
|
|
31
33
|
/**
|
package/tests/query.test.js
CHANGED
|
@@ -33,7 +33,9 @@ function makeTable() {
|
|
|
33
33
|
daoAdmin('query_test', {
|
|
34
34
|
sql: { way: 'sqlite', sqlite: { dir: db_dir, database: 'query_test' } }
|
|
35
35
|
});
|
|
36
|
-
|
|
36
|
+
const manager = daoAdmin('query_test');
|
|
37
|
+
const drive = manager.get('demo') || manager.add({ name: 'demo', table: 'demo' });
|
|
38
|
+
return drive.db().new('demo', 'id');
|
|
37
39
|
}
|
|
38
40
|
|
|
39
41
|
test('控制参数不进入查询条件,真值赋给数据管理器', () => {
|
package/tests/scope.test.js
CHANGED
|
@@ -39,15 +39,16 @@ test('不同域的管理器相互独立', () => {
|
|
|
39
39
|
assert.strictEqual(org.config.name, 'test_org_only');
|
|
40
40
|
});
|
|
41
41
|
|
|
42
|
-
test('配置 sql
|
|
42
|
+
test('配置 sql 时驱动按域绑定独立数据源', () => {
|
|
43
43
|
ensureDir();
|
|
44
44
|
const manager = daoAdmin('test_bound', {
|
|
45
45
|
sql: { way: 'sqlite', sqlite: { dir: db_dir, database: 'test_bound' } }
|
|
46
46
|
});
|
|
47
|
-
|
|
47
|
+
const dao = manager.add({ name: 'probe_bound', table: 'probe' });
|
|
48
|
+
assert.strictEqual(dao.db().getParent().config.database, 'test_bound');
|
|
48
49
|
});
|
|
49
50
|
|
|
50
|
-
test('
|
|
51
|
+
test('两个域配置不同数据库时驱动取用的数据源互不干扰', () => {
|
|
51
52
|
ensureDir();
|
|
52
53
|
const a = daoAdmin('test_db_a', {
|
|
53
54
|
sql: { way: 'sqlite', sqlite: { dir: db_dir, database: 'db_a' } }
|
|
@@ -55,37 +56,17 @@ test('两个域配置不同数据库时互不干扰', () => {
|
|
|
55
56
|
const b = daoAdmin('test_db_b', {
|
|
56
57
|
sql: { way: 'sqlite', sqlite: { dir: db_dir, database: 'db_b' } }
|
|
57
58
|
});
|
|
58
|
-
assert.strictEqual(a.db().getParent().config.database, 'db_a');
|
|
59
|
-
assert.strictEqual(b.db().getParent().config.database, 'db_b');
|
|
59
|
+
assert.strictEqual(a.add({ name: 'probe_a', table: 'probe' }).db().getParent().config.database, 'db_a');
|
|
60
|
+
assert.strictEqual(b.add({ name: 'probe_b', table: 'probe' }).db().getParent().config.database, 'db_b');
|
|
60
61
|
});
|
|
61
62
|
|
|
62
|
-
test('未配置 sql
|
|
63
|
+
test('未配置 sql 的域驱动回落主库实例', () => {
|
|
63
64
|
const manager = daoAdmin('test_fallback');
|
|
64
|
-
assert.strictEqual(manager._getSql(), getSql());
|
|
65
|
+
assert.strictEqual(manager.add({ name: 'probe_fallback', table: 'probe' })._getSql(), getSql());
|
|
65
66
|
});
|
|
66
67
|
|
|
67
68
|
test('默认域为 os', () => {
|
|
68
69
|
const manager = daoAdmin();
|
|
69
70
|
assert.strictEqual(manager.config.name, 'os');
|
|
70
|
-
assert.strictEqual(manager._getSql(), getSql());
|
|
71
|
-
});
|
|
72
|
-
|
|
73
|
-
test('含 {org_id} 的数据源配置只登记模板,不建实例', () => {
|
|
74
|
-
const ret = daoAdmin('test_org_tpl', {
|
|
75
|
-
sql: { way: 'sqlite', sqlite: { dir: db_dir, database: 'tpl_{org_id}' } }
|
|
76
|
-
});
|
|
77
|
-
assert.strictEqual(ret, null);
|
|
78
|
-
});
|
|
79
|
-
|
|
80
|
-
test('按机构派生出独立库,且同机构复用', () => {
|
|
81
|
-
ensureDir();
|
|
82
|
-
daoAdmin('test_org_tpl2', {
|
|
83
|
-
sql: { way: 'sqlite', sqlite: { dir: db_dir, database: 'tpl2_{org_id}' } }
|
|
84
|
-
});
|
|
85
|
-
const one = daoAdmin('test_org_tpl2', { org_id: 1 });
|
|
86
|
-
const two = daoAdmin('test_org_tpl2', { org_id: 2 });
|
|
87
|
-
assert.strictEqual(one.db().database(), 'tpl2_1');
|
|
88
|
-
assert.strictEqual(two.db().database(), 'tpl2_2');
|
|
89
|
-
assert.strictEqual(daoAdmin('test_org_tpl2', { org_id: 1 }), one);
|
|
90
|
-
assert.strictEqual(one.config.name, 'test_org_tpl2_1');
|
|
71
|
+
assert.strictEqual(manager.add({ name: 'probe_os', table: 'probe' })._getSql(), getSql());
|
|
91
72
|
});
|