当前: MongoDB增强层(10~100倍性能 · 企业特性 · 零学习成本)
未来: 让MySQL/PostgreSQL也能用MongoDB语法查询
monSQLize = MongoDB + SQL = 一套语法,多种数据库
npm install monsqlize当前仓库仍处于 TypeScript 全量重写阶段;当前工作区已完成 P4-D compatibility / performance / validation / docs 收口:除包根
lib/index.js、index.mjs、index.d.ts与types/**外,已恢复真实 MongoDBconnect()/db()/collection()链路、最小expr()校验、find/findOne/count/aggregate/distinct/findPage/watchquery façade、完整writes-core convenience、namespace/index/bookmark/db.admin()管理能力、insertBatch/updateBatch/deleteBatch/incrementOne批量写入扩展、MemoryCache/createRedisCacheAdapter/DistributedCacheInvalidator、withCache()/FunctionCache、Model.define/get/list/undefine/redefine与首批 model registry/features、startSession()/withTransaction()/withLock()/acquireLock()/tryAcquireLock()、ConnectionPoolManager/pool()路由,以及最小defineSaga()/executeSaga()/getSagaStats()、ChangeStreamSyncManager/ResumeTokenStore/startSync()/stopSync()/getSyncStats()、SlowQueryLogManager/recordSlowQuery()/getSlowQueryLogs()公开面;同时已补回test/compatibility/matrix.json、test/compatibility/matrix.test.js、test/performance/baselines/function-cache.benchmark.js、test/validation/VERIFICATION-PROGRESS.md、test/validation/DOCS-EXAMPLES-MAPPING.md,并建立首批 TS 文档/示例入口docs/README.md、docs/getting-started.md、docs/cache-and-function-cache.md、docs/capability-index.md、examples/quick-start/basic-connect.ts与examples/cache/with-cache.ts。当前官方示例已统一采用 TypeScript,并纳入类型检查与运行验证链路。更完整的跨版本 / 实机矩阵与更细粒度的 TS 文档体系仍在后续阶段继续补齐。
快速开始 · TS 文档入口 · 项目愿景 · 核心特性 · 文档现状 · 贡献指南
- ⚡ 性能对比
- 🎯 项目愿景
- 💡 为什么选择 monSQLize?
- 🎯 何时使用 monSQLize?
- 🚀 快速开始
- 🌟 核心特性
- 📊 性能测试报告
- 🎨 能力概览
- 🆚 与 MongoDB 原生驱动对比
- 📚 TS 文档入口
- 🧭 文档现状
- 🌍 兼容性
- 🗺️ 产品路线图
- 🤝 贡献指南
- 📄 许可证
- 💬 社区与支持
// ❌ MongoDB 原生驱动
const users = await collection.find({ status: 'active' }).toArray(); // 50ms
const product = await products.findOne({ _id: productId }); // 10ms
// ✅ monSQLize(启用缓存)
const users = await collection.find({ status: 'active' }, { cache: 60000 }); // 0.5ms ⚡ 100x faster
const product = await products.findOne({ _id: productId }, { cache: 60000 }); // 0.1ms ⚡ 100x faster只需在初始化时配置缓存,业务代码一行不改,性能立即提升!
用MongoDB语法统一所有数据库查询
monSQLize = MongoDB + SQL = 统一查询语法
为MongoDB应用提供:
- ⚡ 10~100倍性能提升 - L1(内存)+ L2(Redis)智能缓存,业界最完善
- 🏢 企业级特性 - 分布式锁、SSH隧道、慢查询监控(内置,零配置)
- 🛠️ 56+增强方法 - 业界最完整,代码减少60~80%
- 🎯 可选Model层 - Schema验证、Hooks、Populate(6个方法支持)
- ✅ 100% API兼容 - 零学习成本,渐进式采用
- L1:内存缓存(LRU)
- L2:Redis 缓存
- 自动失效
- 10~100 倍性能提升
- 分布式锁
- SSH 隧道
- 慢查询监控
- 事务优化
- 批量操作
- 56+ 个方法
- 代码减少 60~80%
- ObjectId 自动转换
- 语义化 API
革命性目标: 让MySQL/PostgreSQL也能用MongoDB语法
// 同一套代码,支持多种数据库
const users = await collection.find({
age: { $gte: 18 },
status: 'active'
});
// MongoDB - ✅ 当前已支持
// MySQL - 🎯 未来自动转换为: SELECT * FROM users WHERE age >= 18 AND status = 'active'
// PostgreSQL - 🎯 未来自动转换为: SELECT * FROM users WHERE age >= 18 AND status = 'active'解决的核心痛点:
- ❌ 切换数据库需要重写所有查询代码
- ❌ 团队需要学习多种查询语法
- ❌ 跨数据库迁移成本极高
- ❌ 多数据库项目维护复杂
monSQLize方案:
- ✅ 统一使用MongoDB查询语法(最直观、最灵活)
- ✅ 底层自动适配不同数据库
- ✅ 一套代码,多种数据库
- ✅ 零迁移成本
数据库性能瓶颈
- 高并发时查询变慢
- 热点数据重复查询数据库
- 聚合统计拖慢响应速度
- 用户抱怨页面加载慢
代码重复繁琐
- ObjectId 转换到处都是
- 批量查询要写很多代码
- Upsert 操作不够直观
- 事务代码复杂易错
多实例部署问题
- 缓存不一致导致脏读
- 定时任务重复执行
- 库存扣减并发冲突
- 需要额外的锁机制
针对性能瓶颈
- 智能缓存系统:热点数据走缓存,10~100 倍性能提升
- 自动失效机制:写操作自动清理,保证数据一致性
- 缓存命中率 70~90%:真实业务场景验证
- 响应时间 < 1ms:从 10~50ms 降至毫秒级
针对代码重复
- 便利方法:
findOneById、findByIds、upsertOne - 自动转换 ObjectId:无需手动处理
- 语义化 API:代码更清晰易读
- 事务自动管理:
withTransaction简化事务代码
针对多实例部署
- Redis 广播:多实例缓存自动同步
- 分布式锁:解决并发控制问题
- 定时任务防重:
tryAcquireLock机制 - 开箱即用:配置简单,无需额外组件
| 场景 | 优化前 | 优化后 | 提升 |
|---|---|---|---|
| 商品详情页 | 50ms/次 | 0.5ms/次 | 100x ⚡ |
| 用户列表 | 80ms/次 | 0.8ms/次 | 100x ⚡ |
| 订单统计 | 200ms/次 | 2ms/次 | 100x ⚡ |
| 批量插入 10万条 | 30s | 1.2s | 25x ⚡ |
缓存命中率:电商 85% · 内容平台 75% · 社交应用 80%
| 场景 | 说明 | 预期效果 |
|---|---|---|
| 高并发读取 | 商品详情、用户信息等热点数据 | 缓存命中率 70 |
| 复杂查询 | 聚合统计、关联查询 | 重复查询直接走缓存,避免重复计算 |
| 多实例部署 | 负载均衡、水平扩展 | Redis 广播保证缓存一致性 |
| 事务密集 | 订单、支付等业务 | 自动管理事务,优化只读操作 |
| 并发控制 | 库存扣减、定时任务 | 分布式锁解决复杂并发场景 |
| 场景 | 原因 | 建议 |
|---|---|---|
| 纯写入应用 | 大量写入,很少查询 | 缓存作用有限,使用原生驱动即可 |
| 实时性要求极高 | 必须每次查询最新数据 | 不启用缓存,或使用极短 TTL |
| 简单 CRUD | 简单应用,流量不大 | 原生驱动足够,无需引入复杂度 |
| 内存受限 | 服务器内存紧张 | 缓存会占用额外内存 |
- 渐进式采用:先在热点查询启用缓存,观察效果后逐步扩展
- 监控指标:关注缓存命中率、内存使用、慢查询日志
- 合理配置:根据业务特点调整 TTL、缓存大小
- 混合使用:可与原生驱动混用,性能敏感用 monSQLize,简单查询用原生
- 当前仓库旧的
docs/、examples/与 v1 时代的历史test/资产已从现行长期资产中移除;当前新增的docs/**、examples/**是面向 TS 版本的新入口,不是旧目录的原样回滚。 - 这里保留产品定位、适用场景、快速开始和核心能力概览,帮助你先判断 monSQLize 是否适合当前业务。
- 当前正式文档入口位于:
docs/README.md、docs/getting-started.md、docs/cache-and-function-cache.md、docs/capability-index.md。 - 当前最小可执行示例入口位于:
examples/quick-start/basic-connect.ts、examples/cache/with-cache.ts。 - 当前已恢复的验证入口位于:
test/compatibility/**、test/performance/baselines/**、test/validation/**。 - 尚未迁移到当前
docs/**的详细 API 语义、历史行为说明和旧示例,当前继续以monSQLize-v1的对应实现资产为参考;映射关系见test/validation/DOCS-EXAMPLES-MAPPING.md。
npm install monsqlize自动安装的依赖:
- ✅
mongodb- MongoDB 官方驱动 - ✅
schema-dsl- Schema 验证库(Model 层必需) - ✅
ssh2- SSH 隧道支持
可选依赖:
⚠️ ioredis- Redis 多层缓存(启用 L2 缓存需要)
const MonSQLize = require('monsqlize');
// 1. 初始化并连接
const msq = new MonSQLize({
type: 'mongodb',
databaseName: 'mydb',
config: { uri: 'mongodb://localhost:27017' },
cache: { enabled: true, ttl: 60000 } // 启用缓存,60秒过期
});
await msq.connect();
// 2. 获取集合
const users = msq.collection('users');
// 3. 基础查询(自动缓存)
const user = await users.findOne({ email: 'test@example.com' });
// 4. 插入数据
await users.insertOne({
username: 'john',
email: 'john@example.com',
createdAt: new Date()
});
// 5. 更新数据(自动清除缓存)
await users.updateOne(
{ email: 'test@example.com' },
{ $set: { lastLogin: new Date() } }
);
// 6. 便利方法(自动转换ObjectId)
const userById = await users.findOneById('507f1f77bcf86cd799439011');
// 7. 关闭连接
await msq.close();就这么简单! 完全兼容MongoDB原生API,只需初始化时启用缓存,业务代码零改动。
如果需要 Schema验证、Populate关联查询、Hooks生命周期 等 ORM 特性,可以使用 Model 层。
📦 依赖说明: Model 层需要
schema-dsl包支持(已随 monsqlize 自动安装,无需额外操作)
Model 层有两种使用方式,二者互斥,选其一即可:
| 方式 | 适合场景 |
|---|---|
手动注册(Model.define()) |
少量 Model、测试环境、需要精确控制加载顺序 |
自动加载(models: 配置项) |
生产环境,Model 文件统一放在一个目录下 |
const MonSQLize = require('monsqlize');
const { Model } = MonSQLize;
// 1. 先在 connect() 之前调用 Model.define() 注册所有 Model
Model.define('users', {
schema: (dsl) => dsl({
username: 'string:3-32!',
email: 'email!',
password: 'string:6-!',
age: 'number:0-120'
}),
relations: {
posts: { from: 'posts', localField: '_id', foreignField: 'userId', single: false }
},
hooks: (model) => ({
insert: { before: async (ctx, doc) => { doc.createdAt = new Date(); return doc; } }
}),
methods: (model) => ({
instance: { checkPassword(password) { return this.password === password; } },
static: { async findByUsername(username) { return await model.findOne({ username }); } }
})
});
Model.define('posts', {
schema: (dsl) => dsl({ title: 'string:1-200!', content: 'string!', userId: 'string!' })
});
// 2. 创建实例并连接
const msq = new MonSQLize({
type: 'mongodb',
databaseName: 'mydb',
config: { uri: 'mongodb://localhost:27017' },
cache: { enabled: true }
});
await msq.connect();
// 3. 获取 Model 并使用
const User = msq.model('users');将每个 Model 单独放在一个文件里,connect() 时自动扫描目录加载,无需手动 Model.define():
// app.js
const path = require('path');
const msq = new MonSQLize({
type: 'mongodb',
databaseName: 'mydb',
config: { uri: 'mongodb://localhost:27017' },
// 推荐用绝对路径,避免受 process.cwd() 影响
models: path.join(__dirname, 'models')
// 或完整配置:
// models: { path: path.join(__dirname, 'models'), pattern: '*.model.js', recursive: true }
});
await msq.connect(); // ← 自动扫描 models/*.model.{js,ts,mjs,cjs}
const User = msq.model('users'); // 直接使用,无需 Model.define()相对路径(如
'./models')以process.cwd()为基准,即 Node.js 进程的启动目录。为避免歧义,推荐始终使用path.join(__dirname, 'models')这样的绝对路径。
// models/user.model.js ← 每个 Model 独立一个文件
module.exports = {
name: 'users', // 集合名称(必需)
schema: (dsl) => dsl({
username: 'string:3-32!',
email: 'email!'
}),
methods: (model) => ({
static: {
async findByUsername(username) { return await model.findOne({ username }); }
}
})
};完整配置项、文件格式和错误处理的历史说明,当前请以
monSQLize-v1中的 Model 文档与实现为参考;本仓库不再保留对应本地深链。
// ✅ Schema 验证自动生效
try {
await User.insertOne({
username: 'jo', // ❌ 太短,验证失败
email: 'invalid-email', // ❌ 邮箱格式错误
age: 25
});
} catch (err) {
console.error(err.code); // 'VALIDATION_ERROR'
console.error(err.errors); // 详细的验证错误
}
// ✅ 正确的数据
const user = await User.insertOne({
username: 'john',
email: 'john@example.com',
password: 'secret123',
age: 25
// createdAt 由 hook 自动添加
});
// 使用自定义方法
const foundUser = await User.findByUsername('john');
if (foundUser.checkPassword('secret123')) {
console.log('登录成功');
}
// Populate 关联查询(自动填充用户的文章)
const userWithPosts = await User.findOne({ username: 'john' })
.populate('posts');
console.log(userWithPosts.posts); // [{ title: '...', content: '...' }, ...]
// 禁用验证(特殊场景)
await User.insertOne(doc, { skipValidation: true });Model 层特性:
- ✅ Schema 验证 - 自动验证数据格式(基于
schema-dsl库,v1.0.7 默认启用) - ✅ 自动加载 - 扫描目录自动加载 Model 文件(v1.0.7+)
- ✅ Populate - 关联查询,支持 6 个方法(业界领先)
- ✅ Hooks - 生命周期钩子(insert/update/delete/find)
- ✅ Relations - 定义表关系(hasOne/hasMany/belongsTo)
- ✅ 自定义方法 - instance 方法注入到文档,static 方法挂载到 Model
- ✅ 自动缓存 - Populate 查询结果也会缓存
- ✅ 数据源绑定 -
connection: { pool?, database? }绑定指定连接池和/或数据库(v1.2.2+)
数据源绑定示例(v1.2.2+):
// 在多连接池场景中,将 Model 绑定到指定的连接池 + 数据库
const msq = new MonSQLize({
uri: 'mongodb://localhost:27017',
databaseName: 'main_db',
pools: [{ name: 'analytics', uri: 'mongodb://analytics-host:27017' }]
});
// 绑定到不同数据库(使用默认连接池)
Model.define('AuditLog', {
schema: (dsl) => dsl({ action: 'string!', userId: 'string!' }),
connection: { database: 'audit_db' }
});
// 绑定到不同连接池 + 不同数据库
Model.define('AnalyticsReport', {
schema: (dsl) => dsl({ reportId: 'string!', data: 'object' }),
connection: { pool: 'analytics', database: 'reports_db' }
});
// 调用时自动路由,无需手动切换
const AuditLogModel = msq.model('AuditLog'); // → audit_db(默认池)
const ReportModel = msq.model('AnalyticsReport'); // → reports_db(analytics 池)
const UserModel = msq.model('users'); // → main_db(原逻辑,向后兼容)参考说明:Model / Populate / Hooks / Schema 验证的详细语义,当前请以 monSQLize-v1 的对应文档和实现为准。
// 原来的代码
const { MongoClient } = require('mongodb');
const client = await MongoClient.connect('mongodb://localhost:27017');
const db = client.db('mydb');
const users = db.collection('users');
// 迁移后(只需改初始化)
const MonSQLize = require('monsqlize');
const msq = new MonSQLize({
type: 'mongodb',
databaseName: 'mydb', // 数据库名称
config: { uri: 'mongodb://localhost:27017' },
cache: { enabled: true } // 启用缓存
});
await msq.connect();
const users = msq.collection('users');
// ✅ 后续代码完全不变
const user = await users.findOne({ email: 'test@example.com' });52个测试(100% 通过),为任意异步函数添加缓存能力,性能提升50000x!
const { withCache } = require('monsqlize');
// 业务函数
async function getUserProfile(userId) {
const user = await msq.collection('users')
.findOne({ _id: userId });
const orders = await msq.collection('orders')
.find({ userId }).toArray();
return { user, orders };
}
// 添加缓存(零侵入)
const cached = withCache(getUserProfile, {
ttl: 300000, // 5分钟
cache: msq.getCache()
});
// 使用
await cached('user123'); // 首次:查询数据库
await cached('user123'); // 再次:从缓存读取 ⚡- ✅ 零侵入 - 装饰器模式,不修改原函数
- ✅ 自动序列化 - 支持复杂参数(对象、Date 等)
- ✅ 并发控制 - 防止缓存击穿
- ✅ 双层缓存 - 本地 + Redis,最佳性能
- ✅ 条件缓存 - 基于返回值决定是否缓存
- ✅ 统计监控 - 命中率、调用次数等
- ✅ 命名空间 - 多模块缓存隔离
- ✅ TypeScript - 完整类型支持
性能提升:
- 🚀 复杂业务函数:50000x
- 🚀 外部 API 调用:200000x
- 🚀 复杂计算:100000x
FunctionCache 类管理:
const { FunctionCache } = require('monsqlize');
const fnCache = new FunctionCache(msq, {
namespace: 'myApp',
defaultTTL: 60000
});
// 注册多个函数
fnCache.register('getUserProfile', getUserProfileFn);
fnCache.register('getOrderStats', getOrderStatsFn);
// 执行
await fnCache.execute('getUserProfile', 'user123');
// 失效缓存
await fnCache.invalidate('getUserProfile', 'user123');
// 查看统计
const stats = fnCache.getStats('getUserProfile');
console.log('命中率:', stats.hitRate);参考说明:Function Cache 的完整行为与键生成机制,当前请以 monSQLize-v1 的对应文档和实现为准。
122个操作符(100% MongoDB支持!新增49个函数),让MongoDB聚合查询像写SQL一样简单!
const { expr } = require('monsqlize');
// ❌ MongoDB原生(繁琐)
await users.aggregate([
{
$project: {
fullName: {
$concat: ['$firstName', ' ', '$lastName']
},
age: {
$subtract: [
{ $year: new Date() },
{ $year: '$birthDate' }
]
}
}
}
]);
// ✅ 统一表达式(简洁)
await users.aggregate([
{
$project: {
fullName: expr("CONCAT(firstName, ' ', lastName)"),
age: expr("YEAR(CURRENT_DATE) - YEAR(birthDate)")
}
}
]);- ✅ 67 个操作符 - 覆盖 95% 使用场景
- ✅ 类 SQL 语法 - 易读易写,降低学习成本
- ✅ 上下文感知 - 自动适配
$match/$project/$group - ✅ Lambda 表达式 -
FILTER/MAP完整支持 - ✅ 高性能 - LRU 缓存,>90% 命中率
- ✅ 100% 兼容 - 可与原生语法混用
支持的操作符分类:
- 🔹 条件判断(三元、
SWITCH) - 🔹 数学计算(
ABS、ROUND、POW等) - 🔹 字符串处理(
CONCAT、SPLIT、REPLACE等) - 🔹 数组操作(
FILTER、MAP、SIZE等) - 🔹 日期处理(
YEAR、MONTH、DAY等) - 🔹 类型转换(
TO_INT、TO_STRING等)
更多示例:
// 条件判断 - 三元运算符
expr("score >= 90 ? 'A' : 'B'")
// 多分支条件 - SWITCH
expr("SWITCH(score >= 90, 'A', score >= 80, 'B', score >= 60, 'C', 'F')")
// 字符串处理
expr("UPPER(TRIM(email))")
expr("SPLIT(tags, ',')")
// 数组过滤(Lambda表达式)
expr("FILTER(items, item, item.price > 100)")
// 日期计算
expr("YEAR(createdAt) === 2024 && MONTH(createdAt) === 12")
// 完整聚合查询示例
await orders.aggregate([
{
$project: {
// 价格计算
finalPrice: expr("price * (1 - discount / 100)"),
// 日期提取
year: expr("YEAR(createdAt)"),
month: expr("MONTH(createdAt)"),
// 状态分类
statusLabel: expr("SWITCH(status === 'paid', 'Paid', status === 'pending', 'Pending', 'Cancelled')")
}
},
{
$group: {
_id: { year: '$year', month: '$month' },
totalOrders: expr("COUNT()"),
totalRevenue: expr("SUM(finalPrice)")
}
}
]);参考说明:统一表达式系统和操作符明细,当前请以 monSQLize-v1 的对应文档和实现为准。
- ✅ TTL 过期策略 - 指定缓存时间
- ✅ LRU 淘汰策略 - 自动淘汰旧数据
- ✅ 精准失效 🆕 - 只清除受影响的缓存
- ✅ 自动失效 - 写操作自动清理缓存
- ✅ 并发去重 - 相同查询只执行一次
- ✅ 多层缓存 - 内存 + Redis
- ✅ 命名空间隔离 - 按集合独立管理
| 操作 | 原生驱动 | monSQLize | 提升 |
|---|---|---|---|
| 热点查询 | 50ms | 0.5ms | 100x ⚡ |
| 复杂聚合 | 200ms | 2ms | 100x ⚡ |
| 列表查询 | 30ms | 0.3ms | 100x ⚡ |
// 一行代码启用缓存
const users = await collection.find({ status: 'active' }, { cache: 60000 });// 自动管理事务生命周期
await db.withTransaction(async (tx) => {
// 只读操作会被优化(不加锁,减少 30% 访问)
const user = await users.findOne({ _id: userId }, { session: tx.session });
// 写操作自动加锁
await users.updateOne({ _id: userId }, { $inc: { balance: -100 } }, { session: tx.session });
// 自动提交 or 回滚
});// 定义 Saga(跨服务事务)
msq.defineSaga({
name: 'create-order-with-payment',
steps: [
{
name: 'create-order',
execute: async (ctx) => {
const order = await createOrder(ctx.data);
// ✅ 可以保存字符串、对象、数组等任何类型
ctx.set('order', order); // 保存完整对象
return order;
},
compensate: async (ctx) => {
const order = ctx.get('order');
await cancelOrder(order.id);
}
},
{
name: 'charge-payment',
execute: async (ctx) => {
const charge = await stripe.charges.create({...});
ctx.set('charge', charge); // 保存完整对象
return charge;
},
compensate: async (ctx) => {
const charge = ctx.get('charge');
await stripe.refunds.create({ charge: charge.id });
}
}
]
});
// 执行 Saga(失败自动补偿)
const result = await msq.executeSaga('create-order-with-payment', data);Saga 特性:
- ✅ 跨服务事务协调
- ✅ 失败自动补偿(逆序执行)
- ✅ 支持 Redis 分布式(多进程共享)
- ✅ 无时间限制(突破 60秒限制)
- ✅ 详细日志(完整执行追踪)
说明:当前仓库已恢复最小 Saga orchestrator / runtime façade 闭环;更完整的跨进程共享、长事务恢复与高级编排细节仍以 monSQLize-v1 的对应文档和实现为参考。
实时同步数据到备份库,基于 MongoDB Change Stream
const msq = new MonSQLize({
type: 'mongodb',
config: {
uri: 'mongodb://localhost:27017/main?replicaSet=rs0' // 🔴 必须:Change Stream 需要 Replica Set
},
// 🆕 同步配置
sync: {
enabled: true,
targets: [
{
name: 'backup-main',
uri: 'mongodb://backup:27017/backup',
collections: ['users', 'orders']
}
]
}
});
await msq.connect();
// 正常使用,自动同步
await msq.collection('users').insertOne({ name: 'Alice' });
// ✅ 自动通过 Change Stream 同步到 backup-mainChange Stream 特性:
- ✅ 实时同步(延迟 10-500ms)
- ✅ 断点续传(Resume Token)
- ✅ 多目标支持(多地容灾)
- ✅ 数据过滤和转换
- ✅ 自动重连和健康检查
- ✅ 主库影响 <2%(异步处理)
说明:当前仓库已恢复最小 sync contract / manager / runtime lifecycle;更完整的多目标容灾策略、自动重连细节与旧示例仍以 monSQLize-v1 的对应文档和实现为参考。
// 查询单个文档(需要手动转换 ObjectId)
const { ObjectId } = require('mongodb');
const user = await users.findOne({
_id: new ObjectId(userId)
});
// 批量查询(需要手动构建 $in)
const userList = await users.find({
_id: { $in: ids.map(id => new ObjectId(id)) }
}).toArray();
// Upsert(需要手动设置选项)
await users.updateOne(
{ email: 'alice@example.com' },
{ $set: { name: 'Alice', age: 30 } },
{ upsert: true }
);// 查询单个文档(自动转换)
const user = await users.findOneById(userId);
// 批量查询(一行搞定)
const userList = await users.findByIds(ids);
// Upsert(语义化)
await users.upsertOne(
{ email: 'alice@example.com' },
{ name: 'Alice', age: 30 }
);代码减少 60~80%!
🔥 ObjectId 自动转换 - 告别手动转换
// ❌ 原生驱动 - 每次都要转换
const { ObjectId } = require('mongodb');
await users.findOne({ _id: new ObjectId(userId) });
await users.find({ _id: { $in: ids.map(id => new ObjectId(id)) } }).toArray();
// ✅ monSQLize - 自动识别并转换
await users.findOneById(userId); // 自动转换字符串
await users.findByIds([id1, id2, id3]); // 批量自动转换
await users.findOne({ _id: userId }); // 查询时也自动转换// 多实例部署,Redis 自动同步缓存
const db = new MonSQLize({
cache: {
distributed: {
enabled: true,
redis: redisInstance // 使用 Redis 广播缓存失效
}
}
});
// 实例 A 更新数据
await users.updateOne({ _id: userId }, { $set: { name: 'Bob' } });
// ⚡ 实例 B/C/D 的缓存自动失效// 🔥 解决复杂业务场景的并发问题
// 场景1:库存扣减
await db.withLock(`inventory:${sku}`, async () => {
const product = await inventory.findOne({ sku });
const price = calculatePrice(product, user, coupon); // 复杂计算
if (user.balance < price) throw new Error('余额不足');
await inventory.updateOne({ sku }, { $inc: { stock: -1 } });
await users.updateOne({ userId }, { $inc: { balance: -price } });
await orders.insertOne({ userId, sku, price });
});
// 场景2:定时任务防重(多实例环境)
const lock = await db.tryAcquireLock('cron:daily-report');
if (lock) {
try {
await generateDailyReport(); // 只有一个实例执行
} finally {
await lock.release();
}
}特性:基于 Redis · 自动重试 · TTL 防死锁 · 支持续期 · 降级策略
参考说明:业务级分布式锁的详细行为,当前请以 monSQLize-v1 的对应文档和实现为准。
// 批量插入 10 万条数据
await users.insertBatch(documents, {
batchSize: 1000, // 每批 1000 条
retryTimes: 3, // 失败重试 3 次
onProgress: (stats) => {
console.log(`进度: ${stats.inserted}/${stats.total}`);
}
});性能: 比原生 insertMany 快 10~50 倍 ⚡
// 千万级数据分页(游标分页,性能稳定)
const result = await users.findPage({
query: { status: 'active' },
page: 1000, // 第 1000 页
limit: 20,
totals: {
mode: 'async', // 异步统计总数
ttl: 300000 // 缓存 5 分钟
}
});
console.log(`总计: ${result.totals.total}, 共 ${result.totals.totalPages} 页`);// 🆕 慢查询日志持久化存储(v1.3+)
const msq = new MonSQLize({
type: 'mongodb',
config: { uri: 'mongodb://localhost:27017/mydb' },
slowQueryMs: 500,
slowQueryLog: true // ✅ 零配置启用,自动存储到 admin.slow_query_logs
});
await msq.connect();
// 查询慢查询日志(支持去重聚合)
const logs = await msq.getSlowQueryLogs(
{ collection: 'users' },
{ sort: { count: -1 }, limit: 10 } // 查询高频慢查询Top10
);
// [{ queryHash: 'abc123', count: 2400, avgTimeMs: 520, maxTimeMs: 1200, ... }]
// 自动记录慢查询(原有功能)
// [WARN] Slow query { ns: 'mydb.users', duration: 1200ms, query: {...} }
// 健康检查
const health = await db.health();
// { status: 'ok', uptime: 3600, connections: 10 }
// 性能指标
const stats = await db.getStats();
// { queries: 10000, cacheHits: 9000, hitRate: 0.9 }// 场景:数据库位于防火墙后,无法直接访问
const db = new MonSQLize({
type: 'mongodb',
config: {
// SSH隧道配置
ssh: {
host: 'bastion.example.com', // SSH服务器(跳板机)
port: 22,
username: 'deploy',
password: 'your-password', // ✅ 支持密码认证
// 或使用私钥认证(推荐)
// privateKeyPath: '~/.ssh/id_rsa',
},
// MongoDB连接配置(内网地址,自动从URI解析remoteHost和remotePort)
uri: 'mongodb://user:pass@internal-mongo:27017/mydb'
}
});
await db.connect(); // 自动建立SSH隧道
// 正常使用MongoDB,无需关心隧道细节
const users = db.collection('users');
const data = await users.findOne({});
await db.close(); // 自动关闭SSH隧道特性:
- ✅ 支持密码和私钥认证
- ✅ 自动管理隧道生命周期
- ✅ 完美跨平台(基于ssh2库)
- ✅ 开箱即用,零额外配置
参考说明:SSH 隧道的详细配置与错误处理,当前请以 monSQLize-v1 的对应文档和实现为准。
解决混用 mongoose 和 monSQLize 时的 BSON 版本冲突问题。
// ❌ 问题场景:mongoose (bson@4.x/5.x) + monSQLize (bson@6.x)
const dataFromMongoose = await MongooseModel.findOne({ ... }).lean();
await msq.collection('orders').insertOne(dataFromMongoose);
// 错误:Unsupported BSON version, bson types must be from bson 6.x.x
// ✅ monSQLize v1.1.1+ 自动处理
const dataFromMongoose = await MongooseModel.findOne({ ... }).lean();
await msq.collection('orders').insertOne(dataFromMongoose);
// 成功:自动将旧版本 ObjectId 转换为 bson@6.x特性:
- ✅ 自动检测并转换来自其他 BSON 版本的 ObjectId
- ✅ 递归处理嵌套对象和数组
- ✅ 性能优化:无需转换时零拷贝
- ✅ 错误降级:转换失败不影响其他字段
- ✅ 完全透明:无需修改业务代码
兼容性:
| BSON 版本 | mongoose 版本 | 支持状态 |
|---|---|---|
| bson@4.x | mongoose@5.x | ✅ 完全支持 |
| bson@5.x | mongoose@6.x | ✅ 完全支持 |
| bson@6.x | mongoose@7.x | ✅ 原生支持 |
参考说明:ObjectId 跨版本兼容的详细行为,当前请以 monSQLize-v1 的对应文档和实现为准。
monSQLize 提供了一个轻量级的 Model 层,让你可以像使用 ORM 一样定义数据模型,同时保持 MongoDB 的灵活性。
📦 依赖说明: Model 层基于
schema-dsl库实现 Schema 验证,已随 monsqlize 自动安装。
const { Model } = require('monsqlize');
// 1. 定义 Model(集成 schema-dsl 验证)
Model.define('users', {
enums: {
role: 'admin|user|guest'
},
schema: function(dsl) {
return dsl({
username: 'string:3-32!',
email: 'email!',
role: this.enums.role.default('user'),
age: 'number:1-150'
});
},
options: {
timestamps: true, // 🆕 v1.0.3: 自动管理 createdAt/updatedAt
softDelete: true // 🆕 v1.0.3: 软删除(标记删除,支持恢复)
},
methods: (model) => ({
// 实例方法 - 注入到查询返回的文档对象
instance: {
isAdmin() {
return this.role === 'admin';
}
},
// 静态方法 - 挂载到 Model 实例
static: {
async findByEmail(email) {
return await model.findOne({ email });
}
}
}),
hooks: (model) => ({
// 生命周期钩子
insert: {
before: (ctx, docs) => {
// 自动添加时间戳
return { ...docs, createdAt: new Date() };
}
}
}),
indexes: [
{ key: { username: 1 }, unique: true },
{ key: { email: 1 }, unique: true }
]
});
// 2. 使用 Model
const db = new MonSQLize({ /* ... */ });
await db.connect();
const User = db.model('users');
// 自动 Schema 验证
const user = await User.insertOne({
username: 'john',
email: 'john@example.com',
age: 25
}); // ✅ 验证通过
// 使用实例方法
const admin = await User.findOne({ username: 'admin' });
console.log(admin.isAdmin()); // true
// 使用静态方法
const user = await User.findByEmail('john@example.com');
// 软删除(标记删除,可恢复)
await User.deleteOne({ _id: user._id });
// 查询(自动过滤已删除)
const users = await User.find({}); // 不包含已删除用户
// 查询包含已删除
const allUsers = await User.findWithDeleted({});
// 恢复已删除
await User.restore({ _id: user._id });特性:
- ✅ Schema 验证(集成 schema-dsl)
- ✅ 自定义方法(instance + static)
- ✅ 生命周期钩子(before/after)
- ✅ 索引自动创建
- ✅ 自动时间戳(v1.0.3+)
- ✅ 软删除(v1.0.3+)
- ✅ 乐观锁版本控制(v1.0.3+)
- ✅ 关系定义和 populate(v1.2.0+) 🆕
- ✅ TypeScript 类型支持
轻松处理集合之间的关联关系,支持 one-to-one 和 one-to-many。
// 1. 定义关系
Model.define('users', {
schema: (dsl) => dsl({
username: 'string!',
profileId: 'objectId'
}),
relations: {
// one-to-one: 用户 → 个人资料
profile: {
from: 'profiles', // 集合名
localField: 'profileId', // 本地字段
foreignField: '_id', // 外部字段
single: true // 返回类型
},
// one-to-many: 用户 → 文章列表
posts: {
from: 'posts',
localField: '_id',
foreignField: 'authorId',
single: false // 返回数组
}
}
});
// 2. 使用 populate
const user = await User.findOne({ username: 'john' })
.populate('profile') // 填充 profile
.populate('posts', { // 填充 posts
select: 'title content', // 只选择部分字段
match: { status: 'published' }, // 额外查询条件
sort: { createdAt: -1 }, // 排序
limit: 10 // 限制数量
});返回结果示意:
_id:...username:johnprofileId:...profile:自动填充后的对象,例如包含_id、bio、avatarposts:自动填充后的数组,例如包含title、content等字段
支持的查询方法(全部 6 个):
- ✅
find().populate()- 批量查询 - ✅
findOne().populate()- 单文档查询 - ✅
findByIds().populate()- 批量 ID 查询 - ✅
findOneById().populate()- 单 ID 查询 - ✅
findAndCount().populate()- 带计数查询 - ✅
findPage().populate()- 分页查询
特点:
- ✅ 极简配置(只需 4 个字段)
- ✅ 接近 MongoDB 原生(直接对应
$lookup) - ✅ 批量查询优化(避免 N+1 问题)
- ✅ 支持链式调用
- ✅ 丰富的 populate 选项(select/sort/limit/skip/match)
参考说明:Relations / populate 的详细语义,当前请以 monSQLize-v1 的对应文档和实现为准。
注意:需要安装 schema-dsl 依赖:
npm install schema-dsl在开发模式下,无需重启进程即可更新 Model 定义。
const { Model } = require('monsqlize');
// 注销 Model 定义(返回 boolean)
Model.undefine('users'); // true — 成功注销
Model.undefine('nonexistent'); // false — 不存在时不抛错
// 替换 Model 定义(undefine + define 的组合)
Model.redefine('users', {
schema: (dsl) => dsl({ username: 'string!', email: 'email!' })
});
// 批量热重载(重新加载所有 model 文件)
await msq._loadModels({ reload: true });注意事项:
redefine()若新定义校验失败,旧定义已被移除(不会回滚),调用方需 try/catch- 已实例化的
ModelInstance不受影响,热重载后应通过db.model()重新获取实例
参考说明:Model 热重载与完整 API 说明,当前请以 monSQLize-v1 的对应文档和实现为准。
// 实时监听订单变化
const watcher = orders.watch([
{ $match: { 'fullDocument.status': 'pending' } }
]);
watcher.on('change', (change) => {
console.log('新订单:', change.fullDocument);
// 触发通知、更新统计、失效缓存等
});
// ✅ 自动处理:重连、错误恢复、缓存失效特性: 支持聚合管道过滤 · 断点续传 · 自动失效相关缓存
参考说明:Change Streams 的详细用法与旧示例,当前请以 monSQLize-v1 的对应文档和实现为准。
// 高并发场景:100 个用户同时请求分页
const db = new MonSQLize({
countQueue: {
enabled: true, // 默认启用
concurrency: 8 // 同时最多 8 个 count
}
});
// ✅ 自动队列控制,防止 count 拖垮数据库
const result = await users.findPage({
query: { status: 'active' },
totals: { mode: 'async' } // 自动应用队列
});效果: 数据库 CPU 从 100% → 30% · 其他查询不再超时
参考说明:Count 队列控制的详细行为,当前请以 monSQLize-v1 的对应文档和实现为准。
// jQuery 风格的链式调用
const result = await users
.find()
.filter({ age: { $gte: 18 } })
.sort({ createdAt: -1 })
.limit(10)
.cache(60000)
.exec();
// ✅ 代码更清晰、可读性更强参考说明:链式调用 API 与方法明细,当前请以 monSQLize-v1 的对应文档和实现为准。
// 启用版本控制
Model.define('products', {
schema: (dsl) => dsl({ name: 'string!', stock: 'number!' }),
options: { optimisticLock: true }
});
// 自动版本检查和更新
await Product.updateOne(
{ _id: productId, __v: 1 }, // 要求版本为 1
{ $inc: { stock: -1 }, $inc: { __v: 1 } } // 自动递增版本
);
// ❌ 如果版本不匹配(被其他请求修改),更新失败参考说明:Model 层乐观锁的完整行为,当前请以 monSQLize-v1 的对应文档和实现为准。
// ✅ 支持 import/export
import MonSQLize from 'monsqlize';
const db = new MonSQLize({ /* ... */ });
await db.connect();
// 🎯 TypeScript 消费以当前正式 `index.d.ts` 导出面为准
import type { Collection } from 'monsqlize';参考说明:ESM 支持的详细兼容语义,当前请以 monSQLize-v1 的对应文档和实现为准。
- CPU: Intel i7-9700K
- 内存: 16GB
- 数据库: MongoDB 5.0
- 数据量: 100 万条
| 场景 | 原生驱动 | monSQLize (缓存) | 提升倍数 |
|---|---|---|---|
| 热点查询 (findOne) | 10ms | 0.1ms | 100x ⚡ |
| 列表查询 (find) | 50ms | 0.5ms | 100x ⚡ |
| 复杂聚合 (aggregate) | 200ms | 2ms | 100x ⚡ |
| 批量插入 (10万条) | 30s | 1.2s | 25x ⚡ |
- 电商场景: 85% (商品/用户查询)
- 内容平台: 75% (文章/评论查询)
- 社交应用: 80% (个人资料/动态)
结论: 在真实业务场景中,缓存命中率通常在 70~90%,性能提升 10~100 倍。
当前 README 不再维护逐文件级的 API 文档导航,避免继续指向已删除的本地 docs/、examples/ 资产。若你只需要快速判断 monSQLize 的能力边界,可以先看这份压缩版概览:
- MongoDB 原生兼容面:CRUD、聚合、索引、Explain、事务、Change Streams。
- 性能与缓存:TTL/LRU、多层缓存、并发去重、批量操作、Count 队列、分页优化、慢查询日志。
- 企业能力:多连接池、分布式缓存失效、业务锁、SSH 隧道、Saga、Change Stream 同步。
- 开发体验:Model 层、
schema-dsl验证、Populate / Relations、ObjectId 自动转换、ESM/CommonJS 双模式。 - 长期方向:在保持 MongoDB 兼容语义的前提下,逐步扩展到 MySQL / PostgreSQL 的统一查询接口。
| 特性 | MongoDB 原生 | monSQLize |
|---|---|---|
| API 兼容性 | ✅ 原生 | 🎯 兼容目标以需求文档与最终公开导出矩阵为准;当前重写阶段尚未完成该目标 |
| 智能缓存 | ❌ 需要自己实现 | ✅ 内置 TTL/LRU,开箱即用,10~100 倍提升 |
| 性能 | ⭐⭐⭐ 基准性能 | ⭐⭐⭐⭐⭐ 缓存命中时性能提升 10~100 倍 |
| 事务支持 | ⭐⭐ 需要手动管理 | ⭐⭐⭐⭐⭐ 自动管理生命周期,优化只读操作 |
| 分布式部署 | ❌ 缓存不一致 | ✅ Redis 广播自动同步,保证一致性 |
| 便利方法 | ❌ 需要自己封装 | ✅ findOneById、findByIds、upsertOne 等 |
| 运维监控 | ✅ 慢查询日志、性能统计,开箱即用 | |
| 学习成本 | ⭐⭐⭐ MongoDB 语法 | ⭐ 零学习成本,API 完全一致 |
| 迁移成本 | - | ⭐ 只需修改初始化代码,业务代码不变 |
✅ 适合场景:
- 高并发读取场景(商品详情、用户信息)
- 需要缓存但不想自己实现
- 多实例部署需要缓存一致性
- 希望零学习成本提升性能
- 纯写入应用(缓存作用有限)
- 实时性要求极高(每次必查最新)
- 简单应用,流量不大(原生驱动足够)
// ❌ 原来的代码
const { MongoClient } = require('mongodb');
const client = await MongoClient.connect('mongodb://localhost:27017');
const db = client.db('mydb');
const users = db.collection('users');
// ✅ 迁移后的代码(只需改 3 行)
const MonSQLize = require('monsqlize'); // 1. 引入 monSQLize
const db = new MonSQLize({ // 2. 修改初始化
type: 'mongodb',
config: { uri: 'mongodb://localhost:27017/mydb' },
cache: { enabled: true } // 3. 启用缓存
});
await db.connect();
const users = db.collection('users');
// 🎉 后续所有代码不需要改动,性能提升 10~100 倍!
const user = await users.findOne({ email }); // 完全一样的 API// ✅ 可以混用原生驱动和 monSQLize
const nativeClient = await MongoClient.connect('...');
const monsqlize = new MonSQLize({ cache: { enabled: true } });
// 性能敏感的查询用 monSQLize(启用缓存)
const hotData = await monsqlize.collection('products').find({}, { cache: 60000 });
// 简单查询用原生驱动
const coldData = await nativeClient.db('mydb').collection('logs').find({});当前仓库正在进行 TypeScript 重写。旧 docs/、examples/ 与 v1 时代的历史 test/ 资产已从现行长期资产中移除;当前 docs/** 与 examples/** 是新的 TS 版正式入口,而不是旧目录的原样回滚。
当前建议的参考顺序:
- 本 README:用于快速理解 monSQLize 的定位、适用场景、核心能力与迁移方式。
docs/**、examples/**:用于查看当前 TS 版已正式承接的文档主题与最小示例入口。test/compatibility/**、test/performance/baselines/**、test/validation/**:用于查看当前已恢复的验证资产与 docs/examples 承接映射。monSQLize-v1:用于核对当前docs/**尚未展开的历史 API 语义、详细功能说明和旧示例。- 当前源码与需求产物:用于确认正在进行中的重写边界和最新兼容约束。
| 维度 | 当前口径 | 状态 |
|---|---|---|
| Node.js | >=18.0.0 |
✅ 已在当前工作区验证;Node 20.x / 22.x 实机回归已完成 |
| MongoDB Driver | 当前依赖为 mongodb@^6.21.0 |
✅ 6.x 当前基线 + 7.x 扩展验证已完成;4.x / 5.x 仍未在本轮虚标为已验证 |
| MongoDB Server | 当前 integration 以 mongodb-memory-server replica set 为主 |
✅ 当前 harness 可用;真实 6.x / 7.x 服务矩阵已具备探测/执行入口,但当前主机尚未完成实测 |
| 模块系统 | CommonJS、ESM | ✅ 已由根入口与 compatibility tests 验证 |
当前兼容矩阵清单见 test/compatibility/matrix.json,当前验证说明见 test/compatibility/README.md 与 test/validation/VERIFICATION-PROGRESS.md。
- ✅ 业务级分布式锁
- ✅ 智能缓存系统
- ✅ 事务优化
- ✅ 便利方法
- ✅ 分布式支持
- ✅ Model 层(v1.0.3)- Schema 验证、自定义方法、生命周期钩子
- 🔄 查询分析器
- 🔄 自动索引建议
- 🔄 数据迁移工具
- 🔄 GraphQL 支持
- 🔄 Model 关系(relations)完善
- 🔮 统一 API 支持 MySQL
- 🔮 统一 API 支持 PostgreSQL
- 🔮 完整 ORM 功能
- 🔮 数据同步中间件
我们欢迎所有形式的贡献!
# 克隆仓库
git clone https://github.com/vextjs/monSQLize.git
cd monSQLize
# 安装依赖
npm install
# 当前可执行校验
npm run build
npm run type-check
npm run test:examples
npm run test:compatibility
npm run test:performance
npm test
npm run lint当前仓库已恢复到 P4-D compatibility / performance / validation / docs 收口 级别的
build/type-check/test/verify入口:默认验证链路已包含根入口 smoke、导出兼容、声明式兼容矩阵、test/unit/{expression,management,writes,cache,function-cache,model,lock,transaction,pool,sync,slow-query-log,saga}/**与test/integration/{cache,mongodb,model,transaction,pool,sync,slow-query-log}/**的基础运行时验证;同时新增npm run test:performance作为withCache()热路径与并发去重的回归守卫。若需核对跨版本 / 实机矩阵,请继续参考monSQLize-v1的历史资产与test/validation/VERIFICATION-PROGRESS.md中的待补项。
- 📧 Email: support@monsqlize.dev
- 💬 Issues: GitHub Issues
- 🌟 Star: 如果觉得有用,请给我们一个 Star ⭐
🚀 快速开始 · 🧭 文档现状 · 🐛 报告问题 · ⭐ Star 项目
npm install monsqlizeMade with ❤️ by monSQLize Team