📚 API 参考索引

📚 核心概念

文档说明
mongodb-native-vs-extensions.mdMongoDB 原生 vs monSQLize 扩展功能对比
connection.md连接管理和配置
multi-pool.md🎉 企业级多连接池管理 - 读写分离、负载均衡、故障转移(v1.0.8+)🆕
pool-chain-api.md🆕 链式池/库访问 API - pool() / use() / scopedCollection() / scopedModel()(v1.3.0+)
objectid-auto-convert.mdObjectId 自动转换 - 简化 ObjectId 处理(v1.3.0+)🆕
model.mdModel 层 - Schema 验证、自定义方法、生命周期钩子(v1.0.3+)
populate.mdPopulate API - 关联查询(6个方法支持,业界领先)(v1.0.6+)🆕
relations.mdRelations API - 关系定义(hasOne/hasMany/belongsTo)(v1.0.6+)🆕
hooks.mdHooks API - 生命周期钩子(insert/update/delete/find)(v1.0.6+)🆕
model/relations.mdRelations 和 Populate - 关系定义和关联数据填充(v1.2.0+)🆕
model/nested-populate.md嵌套 Populate - 多层关系填充(v1.2.0+)🆕
ssh-tunnel.mdSSH隧道 - 安全连接内网数据库(v1.3+)
error-codes.md错误码参考 - 完整的错误码定义和处理指南
cache.md缓存系统(LRU + TTL)
function-cache.md🎉 函数缓存 - 为任意异步函数添加缓存能力(v1.1.4+)🆕
transaction.md事务管理(自动重试、缓存锁)
saga-transaction.md🎉 Saga 分布式事务 - 跨服务事务补偿机制(v1.0.8+)🆕
saga-advanced.mdSaga 高级特性与实现原理 - 深入解析补偿机制、分布式存储
sync-backup.md🎉 Change Stream 数据同步 - 实时备份到多个数据库(v1.0.8+)🆕
business-lock.md业务级分布式锁

| transaction-optimizations.md | 事务优化策略 | | distributed-deployment.md | 分布式部署指南(多实例缓存一致性)⭐ | | events.md | 事件系统 |


🔍 查询操作(Query Operations)

文档方法说明
find.mdfind()查询多个文档
findOne.mdfindOne()查询单个文档
find-one-by-id.mdfindOneById()通过 _id 查询单个文档(便利方法)⭐
find-by-ids.mdfindByIds()批量通过 _id 查询多个文档(便利方法)⭐
findPage.mdfindPage()游标分页查询
count.mdcount()统计文档数量
distinct.mddistinct()去重查询
watch.mdwatch()实时监听数据变更(Change Streams)⭐

✏️ 写入操作(Write Operations)

插入操作

文档方法说明
insert-one.mdinsertOne()插入单个文档
insert-many.mdinsertMany()批量插入文档(10-50x 性能提升)
insertBatch.mdinsertBatch()大批量插入(分批+重试)
write-operations.md所有插入方法插入操作完整指南

更新操作

文档方法说明
update-operations.md所有更新方法更新操作完整指南
upsert-guide.mdUpsert 操作指南不存在就插入,存在则更新 - 完整指南 ⭐
update-one.mdupdateOne()更新单个文档
update-many.mdupdateMany()批量更新文档
update-aggregation.md🎉 Update 聚合管道 - 字段间计算、条件赋值(v1.0.8+)🆕
updateBatch.mdupdateBatch()大批量更新(分批+重试)⭐
replace-one.mdreplaceOne()完整替换文档
find-one-and-update.mdfindOneAndUpdate()原子更新并返回
find-one-and-replace.mdfindOneAndReplace()原子替换并返回

便利方法(Convenience Methods)

文档方法说明
upsert-one.mdupsertOne()存在则更新,不存在则插入 ⭐
increment-one.mdincrementOne()原子递增/递减字段值 ⭐

删除操作

文档方法说明
delete-one.mddeleteOne()删除单个文档
delete-many.mddeleteMany()批量删除文档
deleteBatch.mddeleteBatch()大批量删除(分批+重试)⭐
find-one-and-delete.mdfindOneAndDelete()原子删除并返回

📊 聚合操作(Aggregation Operations)

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

🔗 高级功能

文档说明
chaining-api.md链式调用 API
chaining-methods.md链式调用方法详解
explain.md查询计划分析
bookmarks.md分页书签管理

🛠️ 工具与配置

文档说明
utilities.md工具函数
collection-management.md集合管理
readPreference.md读偏好设置
count-queue.mdCount 队列控制(高并发优化)⭐
distributed-deployment.md分布式部署配置

🔧 兼容性与测试

文档说明
mongodb-driver-compatibility.mdDriver 版本兼容性详解
findOneAnd-return-value-unified.mdfindOneAnd* 返回值统一说明

| esm-support.md | ES Module (import) 支持 ✨ |


📖 按功能分类

CRUD 操作

Create (创建):

Read (读取):

Update (更新):

Delete (删除):

高级查询

性能与缓存


🚀 快速开始路径

新用户推荐阅读顺序:

  1. connection.md - 了解如何连接数据库
  2. find.md - 学习基础查询
  3. insert-one.md / insert-many.md - 学习插入数据
  4. update-one.md / update-many.md - 学习更新数据
  5. delete-one.md / delete-many.md - 学习删除数据
  6. cache.md - 了解缓存机制
  7. transaction.md - 学习事务管理
  8. distributed-deployment.md - 多实例部署(生产环境必读)

文档总数: 85个
最后更新: 2025-01-06 新增:

  • ✨ esm-support.md - ES Module (import) 支持
  • ✨ findOneAnd-return-value-unified.md - 返回值统一说明