mm_mongodb 1.4.2 → 1.4.3

package/README.md

@@ -1,2 +1,231 @@
-# mm_mongodb
- 这是超级美眉mongodb帮助函数模块，用于便捷操作mongodb，使用await方式，可以避免嵌套函数
+# mm_mongodb
+
+这是超级美眉mongodb帮助函数模块，用于便捷操作mongodb，使用await方式，可以避免嵌套函数。
+
+## 功能特点
+
+- 支持异步/await操作，避免回调地狱
+- 简化MongoDB的常用操作
+- 支持数据库连接池
+- 提供缓存操作扩展
+- 支持基本的CRUD操作
+
+## 安装
+
+```bash
+npm install mm_mongodb
+```
+
+## 基础配置
+
+### 默认配置
+
+```javascript
+const config = {
+    // 服务器地址
+    host: "localhost",
+    // 端口号
+    port: 27017,
+    // 数据库名
+    database: "mm",
+    // 用户名
+    user: "admin",
+    // 密码
+    password: "",
+    // 附加选项
+    options: {
+        useNewUrlParser: true,
+        useUnifiedTopology: true
+    }
+}
+```
+
+## 基本使用
+
+### 引入模块
+
+```javascript
+const { MongoDB, mongoDB_admin } = require('mm_mongodb');
+```
+
+### 创建连接
+
+```javascript
+// 方式1：直接实例化
+const mb = new MongoDB("localhost", "mm");
+mb.setConfig();
+await mb.open();
+
+// 方式2：使用管理器（推荐，支持连接池）
+const mb = mongoDB_admin("sys");
+mb.setConfig();
+await mb.open();
+```
+
+## API文档
+
+### 数据库操作
+
+#### open()
+- 说明：连接数据库
+- 返回：Promise对象，连接成功返回true
+
+#### close()
+- 说明：关闭数据库连接
+
+#### setConfig(config)
+- 说明：设置数据库配置
+- 参数：
+  - config: Object|String - 配置对象或配置文件路径
+
+### 表操作
+
+#### addTable(table)
+- 说明：创建数据表
+- 参数：
+  - table: String - 表名
+- 返回：Promise对象
+
+### 数据操作
+
+#### addObj(obj)
+- 说明：添加一条数据
+- 参数：
+  - obj: Object - 要添加的对象
+- 返回：Promise对象
+
+#### addList(list)
+- 说明：批量添加数据
+- 参数：
+  - list: Array - 对象数组
+- 返回：Promise对象
+
+#### del(query)
+- 说明：删除数据
+- 参数：
+  - query: Object - 查询条件
+- 返回：Promise对象
+
+#### set(query, body)
+- 说明：修改数据
+- 参数：
+  - query: Object - 查询条件
+  - body: Object - 修改内容
+- 返回：Promise对象
+
+#### get(query)
+- 说明：查询数据
+- 参数：
+  - query: Object - 查询条件
+- 返回：Promise对象，返回数组
+
+## 使用示例
+
+### 基本CRUD操作
+
+```javascript
+const { MongoDB } = require('mm_mongodb');
+
+async function test() {
+    // 实例化构造函数
+    const mb = new MongoDB("localhost", "mm");
+    mb.setConfig();
+    
+    // 连接数据库
+    await mb.open();
+    
+    try {
+        // 创建数据表
+        await mb.addTable('mm_table');
+        
+        // 添加单条数据
+        let ret = await mb.addObj({
+            name: "张三",
+            age: 21,
+            sex: true
+        });
+        
+        // 批量添加数据
+        ret = await mb.addList([{
+            name: "李四",
+            age: 18,
+            sex: false
+        }, {
+            name: "王五",
+            age: 15,
+            sex: true
+        }]);
+        
+        // 查询数据
+        ret = await mb.get({
+            name: '李四'
+        });
+        
+        // 修改数据
+        ret = await mb.set(
+            { name: '李四' },
+            { age: 20 }
+        );
+        
+        // 删除数据
+        ret = await mb.del({
+            name: '王五'
+        });
+        
+    } catch (e) {
+        console.error(e);
+    }
+    
+    // 关闭连接
+    mb.close();
+}
+```
+
+### 缓存操作扩展
+
+```javascript
+const { Mongodb_cache, mongodb_cache_admin } = require('mm_mongodb/cache');
+
+async function test() {
+    const mb = new Mongodb_cache("localhost", "mm");
+    mb.setConfig();
+    await mb.open();
+    
+    try {
+        // 添加缓存
+        await mb.add("user:1", {
+            name: "张三",
+            age: 21
+        });
+        
+        // 获取缓存
+        const data = await mb.get("user:1");
+        
+        // 设置缓存（带过期时间）
+        await mb.set("temp:1", "临时数据", 3600); // 1小时后过期
+        
+        // 删除缓存
+        await mb.del("user:1");
+        
+    } catch (e) {
+        console.error(e);
+    }
+    
+    mb.close();
+}
+```
+
+## 注意事项
+
+1. 使用前请确保MongoDB服务已启动
+2. 建议使用try-catch处理可能的异常
+3. 操作完成后记得关闭连接
+4. 推荐使用连接池管理器（mongoDB_admin）来创建实例
+
+## 许可证
+
+ISC License
+
+## 作者
+
+qww

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mm_mongodb",
-    "version": "1.4.2",
+    "version": "1.4.3",
     "description": "这是超级美眉mongdb帮助函数模块，用于便捷操作mongdb，使用await方式，可以避免嵌套函数",
     "main": "index.js",
     "scripts": {
@@ -30,7 +30,7 @@
     },
     "homepage": "https://github.com/qiuwenwu/mm_mongodb#readme",
     "dependencies": {
-        "mm_expand": "^1.7.0",
-        "mongodb": "^5.9.1"
+        "mm_expand": "^1.8.3",
+        "mongodb": "^6.15.0"
     }
 }