📚 API 参考索引

📚 核心概念

文档说明
原生 API 对比MongoDB 原生 vs monSQLize 扩展功能对比
连接配置连接管理和配置
多连接池管理🎉 企业级多连接池管理 - 读写分离、负载均衡、故障转移(v1.0.8+)🆕
链式池/库访问🆕 链式池/库访问 API - pool() / use() / scopedCollection() / scopedModel()(v1.3.0+)
ObjectId 自动转换ObjectId 自动转换 - 简化 ObjectId 处理(v1.3.0+)🆕
Model 层Model 层 - Schema 验证、自定义方法、生命周期钩子(v1.0.3+)
Populate APIPopulate API - 关联查询(6个方法支持,业界领先)(v1.0.6+)🆕
Relations APIRelations API - 关系定义(hasOne/hasMany/belongsTo)(v1.0.6+)🆕
Hooks APIHooks API - 生命周期钩子(insert/update/delete/find)(v1.0.6+)🆕
Relations 与 PopulateRelations 和 Populate - 关系定义和关联数据填充(v1.2.0+)🆕
嵌套 Populate嵌套 Populate - 多层关系填充(v1.2.0+)🆕
SSH 隧道SSH隧道 - 安全连接内网数据库(v1.3+)
错误码参考错误码参考 - 完整的错误码定义和处理指南
缓存系统缓存系统(LRU + TTL)
函数缓存🎉 函数缓存 - 为任意异步函数添加缓存能力(v1.1.4+)🆕
事务管理事务管理(自动重试、缓存锁)
Saga 分布式事务🎉 Saga 分布式事务 - 跨服务事务补偿机制(v1.0.8+)🆕
Saga 高级特性Saga 高级特性与实现原理 - 深入解析补偿机制、分布式存储
Change Stream 同步🎉 Change Stream 数据同步 - 实时备份到多个数据库(v1.0.8+)🆕
业务级分布式锁业务级分布式锁
事务优化策略事务优化策略
分布式部署分布式部署指南(多实例缓存一致性)⭐
事件系统事件系统

🔍 查询操作(Query Operations)

文档方法说明
查询多个文档find()查询多个文档
查询单个文档findOne()查询单个文档
按 id 查询单个文档findOneById()通过 _id 查询单个文档(便利方法)⭐
按 ids 批量查询findByIds()批量通过 _id 查询多个文档(便利方法)⭐
分页查询findPage()游标分页查询
统计文档数量count()统计文档数量
去重查询distinct()去重查询
监听数据变更watch()实时监听数据变更(Change Streams)⭐

✏️ 写入操作(Write Operations)

插入操作

文档方法说明
插入单个文档insertOne()插入单个文档
批量插入文档insertMany()批量插入文档(10-50x 性能提升)
大批量插入insertBatch()大批量插入(分批+重试)
写入操作指南所有插入方法插入操作完整指南

更新操作

文档方法说明
更新操作指南所有更新方法更新操作完整指南
Upsert 操作指南Upsert 操作指南不存在就插入,存在则更新 - 完整指南 ⭐
更新单个文档updateOne()更新单个文档
批量更新文档updateMany()批量更新文档
Update 聚合管道🎉 Update 聚合管道 - 字段间计算、条件赋值(v1.0.8+)🆕
大批量更新updateBatch()大批量更新(分批+重试)⭐
完整替换文档replaceOne()完整替换文档
查询并更新findOneAndUpdate()原子更新并返回
查询并替换findOneAndReplace()原子替换并返回

便利方法(Convenience Methods)

文档方法说明
Upsert 单个文档upsertOne()存在则更新,不存在则插入 ⭐
递增/递减字段incrementOne()原子递增/递减字段值 ⭐

删除操作

文档方法说明
删除单个文档deleteOne()删除单个文档
批量删除文档deleteMany()批量删除文档
大批量删除deleteBatch()大批量删除(分批+重试)⭐
查询并删除findOneAndDelete()原子删除并返回

📊 聚合操作(Aggregation Operations)

文档方法说明
聚合管道查询aggregate()聚合管道查询

🔗 高级功能

文档说明
链式调用 API链式调用 API
链式调用方法详解链式调用方法详解
查询计划分析查询计划分析
分页书签管理分页书签管理

🛠️ 工具与配置

文档说明
工具函数工具函数
集合管理集合管理
读偏好设置读偏好设置
Count 队列控制Count 队列控制(高并发优化)⭐
分布式部署配置分布式部署配置

🔧 兼容性与测试

文档说明
MongoDB Driver 兼容性Driver 版本兼容性详解
findOneAnd 返回值findOneAnd* 返回值统一说明

| ES Module 支持 | ES Module (import) 支持 ✨ |


📖 按功能分类

CRUD 操作

Create (创建):

Read (读取):

Update (更新):

Delete (删除):

高级查询

性能与缓存


🧭 入口、示例与站点页面

文档说明
文档目录索引docs 目录索引
文档站首页文档站首页
API 参考索引当前 API 参考索引
入门指南入门指南
示例索引示例索引
常见配方常见配方
能力索引能力索引

🗂️ 管理、索引与表达式

文档说明
管理 API管理 API
数据库操作数据库操作
创建单个索引创建单个索引
批量创建索引批量创建索引
删除索引删除索引
列出索引列出索引
查询并计数查询并计数
表达式函数表达式函数
快速 upsert快速 upsert

🧩 运行时、部署与治理

文档说明
运行时架构运行时架构
支持矩阵支持矩阵
路线图边界路线图边界
文件依赖治理文件依赖治理
能力可追溯性能力可追溯性
发布前检查发布前检查
验证入口验证入口
验证说明验证说明

🔎 ObjectId、缓存与排障

文档说明
ObjectId 转换范围ObjectId 转换范围
ObjectId 跨版本说明ObjectId 跨版本说明
ObjectId 跨版本 FAQObjectId 跨版本 FAQ
ObjectId 日志优化ObjectId 日志优化
缓存与函数缓存对比缓存与函数缓存对比
cache-hub 迁移cache-hub 迁移
慢查询日志慢查询日志
故障恢复示例故障恢复示例
多连接池健康检查多连接池健康检查
分布式部署速查分布式部署速查
Relations 快速开始Relations 快速开始

🚀 快速开始路径

新用户推荐阅读顺序:

  1. 连接配置 - 了解如何连接数据库
  2. 查询多个文档 - 学习基础查询
  3. 插入单个文档 / 批量插入文档 - 学习插入数据
  4. 更新单个文档 / 批量更新文档 - 学习更新数据
  5. 删除单个文档 / 批量删除文档 - 学习删除数据
  6. 缓存系统 - 了解缓存机制
  7. 事务管理 - 学习事务管理
  8. 分布式部署 - 多实例部署(生产环境必读)

文档总数: 97 个 索引覆盖: 97/97(含当前索引页) 最后更新: 2026-06-10 新增: