使用 Apifox 轻松操作 MongoDB 数据库

 MongoDB 是一种面向文档的非关系型数据库管理系统,采用 BSON(Binary JSON)格式存储数据。

不同于传统的关系型数据库,MongoDB 不使用表(table)的概念,而是使用集合(collection)来组织文档(document),文档是 MongoDB 中的一个基本单位,类似于关系型数据库中的一行记录,一个文档由键值对(字段和值)组成,并使用 BSON 格式表示,每个文档都有一个特殊的字段  _id 来唯一标识它。

以下是一个简单的例子,假设我们要创建一个存储用户信息的集合 users,每个用户有姓名、年龄和电子邮件字段。在 MongoDB 中,这可以表示为以下的 BSON 文档:

{
"_id": ObjectId("6566f7c68c8e613fce1b75bc"),
"name":"张三",
"age": 30,
"email": "[email protected]"
}

请注意,上述的 ObjectId 是 MongoDB 自动生成的文档标识符。在实际应用中,你可以让 MongoDB 自动生成 _id,也可以自己定义一个唯一的值。 

Apifox 为 MongoDB 数据库提供了基本的可视化操作,例如上述的 BSON 文档,在 Apifox 中通过 _id 查询这个文档时,你不需要写入类似 

db.users.findOne({  _id: new  ObjectId("6566f...") }); 

这样的命令,只需要在「查询条件」中使用 JSON 撰写相应的内容即可,通过  _id 查询文档时写入的 JSON 如下所示:

{  
"_id": "6566f7c68c8e613fce1b75bc"
}

Apifox 会自动处理唯一标识 _id 中的 ObjectId()。

图片

操作数据库时,如果基本的「操作类型」无法满足你的需求,你也可以直接运行数据库命令,以执行更高级的操作。

需要注意的是,这里提到的「数据库命令」并不是指像 db.collection.findOne() 这样的方法调用,而是一个特定格式的 JSON 数据。

例如上面的 BSON 文档,如果要使用数据库命令来查询其值,在将操作类型选择为「运行数据库命令」后,其查询的 JSON 数据可以写为:

{
"find": "users",
"filter": {
"_id": "6566f7c68c8e613fce1b75bc"
}
}
  • “find”: 操作类型,指定为 “find”。

  • “users”: 要查询的集合名称,你需要将其替换为实际的集合名称。

  • “filter”: 查询过滤器,指定为一个包含查询条件的对象。

图片

简单来讲,Apifox 提供了两种方式来操作 MongoDB 数据库,一种是基本的可视化操作(包含增删改查),另一种是更高级的数据库命令操作。两种方式在修改 MongoDB 数据库时都是通过提交 JSON 格式文件来达到目的

下文通过一个具体的例子来讲述如何在 Apifox 中操作 MongoDB 数据库。

连接 MongoDB 数据库

假设在数据库中存在一个名为 users 的集合,并在集合中有相应的 BSON 文档。

{
"name":"张三",
"age": 30,
"email": "[email protected]"
},
{
"name":"李四",
"age": 30,
"email": "[email protected]"
},
"name":"王五",
"age": 22,
"email": "[email protected]"
}

图片

要在 Apifox 中操作 MongoDB 数据库,需在「前置/后置操作」中选择「数据库操作」,然后在「数据库连接」中选择已有的数据库连接,填入相关的操作名称、集合名、查询条件等,最后将「控制台打印结果」按钮开启。

图片

如果没有「数据库连接」,可以新建一个进行配置,数据库类型选择 MongoDB,并填入数据库地址、端口等。

图片

相关选项中的信息都填写完毕,就可以尝试连接,点击「发送」按钮,如果控制台中输出了相应的内容,说明连接成功。

图片

操作 MongoDB 数据库

对 MongoDB 数据库进行操作时,可以通过基本的可视化操作(根据操作类型写入相关 JSON)、也可以使用数据库命令,下面根据上文的 users 集合列举一些常用的增删改查操作。

1 查询单个文档(findOne)

需求: 根据 _id 查询单个文档。

实现: 在「数据库操作」中,选择操作类型为「查询单个文档」,查询条件中输入的 JSON 数据为:

{
"_id": "6566f7c68c8e613fce1b75bc"
}

如果通过「数据库命令」的方式,那么上面的查询条件可等价为如下的 JSON:

{
"find": "users",
"filter": {
"_id": "6566f7c68c8e613fce1b75bc"
}

图片

2 查询多个文档(find)

需求: 查询 age 为 30 的所有文档。

实现: 操作类型选择「查询多个文档」,查询条件中输入的 JSON 数据为:

{
"age":30
}

如果通过「数据库命令」的方式,那么上面的查询条件可等价为如下的 JSON:

{
"find": "users",
"filter":
"age": 30
}

图片

3 插入单个文档(insertOne)

需求: 插入单个文档到数据库。

实现: 操作类型选择为「插入单个文档」,文档中输入的 JSON 数据为:

{
"name":"lili",
"age":20,
"email": "[email protected]"
}

如果通过「数据库命令」的方式,那么上面插入的文档可等价为如下的 JSON:

{
"insert": "users",
"documents
"name": "lili",
"age": 20,
"email": "[email protected]"
}

这里注意几点:

  • insert 键表示执行插入操作的命令名称。
  • documents 键对应一个数组,包括了一个或多个你想插入的文档。

图片

4 插入多个文档(insertMany)

需求: 插入多个文档到数据库。

实现: 操作类型选择为「插入多个文档」,文档中输入的 JSON 数据为:

[
 {
"name":"wangwang",
"age":20,
"email": "[email protected]"
},

{
"name":"zhangzhang",
"age":30,
"email":"[email protected]"
 }
]

如果通过「数据库命令」的方式,那么上面插入的文档可等价为如下的 JSON:

{  "insert": "users", 
"documents": [  
{   
"name":"wangwang",   
"age":20,   
"email":"[email protected]"  
}, 
{     
"name":"zhangzhang",  
"age":30,    
"email":"[email protected]" 
} 
]
}

图片

5 更新单个文档(updateOne)

需求: 将数据库集合中某个文档进行更新。

实现: 操作类型选择为「更新单个文档」,文档中输入的 JSON 数据为:

  1. 填写查询条件:
{  
 "_id":"656718d724d1ffab1ee34e09"
 }
  1. 填写更新内容:
 { 
 "name":"小张",    "age":35
 }

如果通过「数据库命令」的方式,那么上面更新的文档可等价为如下的 JSON:

    { 
    "update": "users", 
    "updates": [  
    {    
    "q": { "_id": "656718d724d1ffab1ee34e09" },  
    "u": { "$set": { "name":"小张","age": 35 } }, 
    "upsert": false    } 
    ]
    }

这里的字段说明如下:

1. "update" 键表示要在哪个集合上进行更新操作;

2. "updates" 数组包含一个或多个更新操作,每个更新操作是一个对象,包含以下键:

  • "q"(查询)是用于匹配文档的查询条件。

  • "u"(更新)是用于执行的更新操作。"$set" 运算符用于更新指定字段的值。

  • "upsert" 选项确定在找不到匹配的文档时是否进行插入。如果设为 true,则在找不到匹配的文档时将插入一个新的文档。如果设为 false(或省略),在找不到匹配的文档时不执行任何操作。

图片

6 更新多个文档(updateMany)

需求: 将文档中年龄为 20 的更改为年龄为 30 的。

实现: 操作类型选择为「更新多个文档」,文档中输入的 JSON 数据为:

  1. 查询条件:
    {  
    "age": 20
    }
  1. 更新内容:
{  
"age":35
}

如果通过「数据库命令」的方式,那么上面更新的文档可等价为如下的 JSON:

    { 
    "update": "users",
    "updates": [ 
    {
    "q": { "age": 20 }, 
    "u": { "$set": { "age": 35 } },  
    "upsert": false   
    } 
    ]
    }

7 删除单个文档(deleteOne)

需求: 根据  _id 来删除单个文档。

实现: 操作类型选择「删除单个文档」,查询条件中输入的 JSON 数据为:

{
"_id": "6567176024d1ffab1ee34e06"
}

如果通过「数据库命令」的方式,那么上面的查询条件可等价为如下的 JSON:

   {
    "delete": "users", 
    "deletes": [  
    {    
    "q": { "_id": "6567176024d1ffab1ee34e06" },
    "limit": 1   
    } 
    ]
    }

这里的字段说明如下:

  • "delete": 指定了要在哪个集合上执行删除命令;
  • "deletes": 是一个数组,包含了一组删除操作。由于我们只删除一个文档,数组中只有一项删除请求;

对于每个删除请求:

  • "q": 表示查询条件(Query),用于匹配要删除的文档;

  • "limit": 指定要删除的文档数量,1 表示只删除一个匹配的文档,deleteOne 对应的是 limit 设置为 1。

image.png

8 删除多个文档(deleteMany)

需求: 根据  _id 来删除多个文档。

实现: 操作类型选择「删除多个文档」,查询条件中输入的 JSON 数据为:

    { 
    "_id": [
    "656718d724d1ffab1ee34e08",   
    "656718d724d1ffab1ee34e09" 
    ]
    }

如果通过「数据库命令」的方式,那么上面的查询条件可等价为如下的 JSON:

    {
    "delete":
    "users", 
    "deletes": [ 
    {  
    "q": { "_id": "65683575d0c31d6a9321c69a" }, 
    "limit": 0  
    },  
    {    
    "q": { "_id": "65683575d0c31d6a9321c69b" },  
    "limit": 0 
    }
    ]
    }

将 "limit" 设置为 0,表示删除所有匹配的文档,deleteMany 命令对应的是 "limit" 设置为 0。

本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
THE END
分享
二维码
< <上一篇
下一篇>>