批量写入操作
概述
考虑这样一种情况:您想要将一个文档插入到一个集合中,更新多个其他文档,然后删除一个文档。 如果使用单独的方法,则每个操作都需要调用自己的数据库。 本指南向您展示如何使用批量写入操作在单个数据库调用中执行多个写入操作。
样本数据
本指南中的示例使用 Atlas 样本数据集中的 sample_restaurants.restaurants
集合。要了解如何创建免费的 MongoDB Atlas 集群并加载样本数据集,请参阅 PyMongo 入门教程。
定义写入操作
对于要执行的每个写入操作,请创建以下操作类之一的实例:
InsertOne
UpdateOne
UpdateMany
ReplaceOne
DeleteOne
DeleteMany
然后,将这些实例的列表传递给bulk_write()
方法。
以下部分介绍如何创建和使用上述类的实例。
插入操作
要执行插入操作,请创建InsertOne
的实例并指定要插入的文档。
以下示例创建了一个InsertOne
实例:
operation = pymongo.InsertOne( { "name": "Mongo's Deli", "cuisine": "Sandwiches", "borough": "Manhattan", "restaurant_id": "1234" } )
要插入多个文档,请为每个文档创建一个InsertOne
实例。
更新操作
要更新文档,请创建UpdateOne
的实例并传入以下参数:
查询筛选器,用于指定匹配集合中文档的条件
要执行的更新操作。有关更新操作的更多信息,请参阅 MongoDB Server 手册中的字段更新操作符指南。
UpdateOne
更新与查询筛选器匹配的第一个文档。
以下示例创建了一个UpdateOne
实例:
operation = pymongo.UpdateOne( { "name": "Mongo's Deli" }, { "$set": { "cuisine": "Sandwiches and Salads" }}, )
要更新多个文档,请创建UpdateMany
的实例并传入相同的参数。 UpdateMany
会更新与查询筛选器匹配的所有文档。
以下示例创建了一个UpdateMany
实例:
operation = pymongo.UpdateMany( { "name": "Mongo's Deli" }, { "$set": { "cuisine": "Sandwiches and Salads" }}, )
替换操作
替换操作会删除指定文档的所有字段和值,然后替换为新的字段和值。 要执行替换操作,请创建ReplaceOne
的实例,并向其传递查询筛选器以及要在匹配文档中存储的字段和值。
以下示例创建了一个ReplaceOne
实例:
operation = pymongo.ReplaceOne( { "restaurant_id": "1234" }, { "name": "Mongo's Pizza", "cuisine": "Pizza", "borough": "Brooklyn", "restaurant_id": "5678" } )
要替换多个文档,必须为每个文档创建一个ReplaceOne
实例。
删除操作
要删除文档,请创建DeleteOne
的实例并传入查询筛选器,指定要删除的文档。 DeleteOne
仅删除与查询筛选器匹配的第一个文档。
以下示例创建了一个DeleteOne
实例:
operation = pymongo.DeleteOne({ "restaurant_id": "5678" })
要删除多个文档,请创建DeleteMany
的实例并传入查询筛选器,指定要删除的文档。 DeleteMany
将删除与查询筛选器匹配的所有文档。
以下示例创建了一个DeleteMany
实例:
operation = pymongo.DeleteMany({ "name": "Mongo's Deli" })
调用bulk_write()
方法
为要执行的每个操作定义类实例后,将这些实例的列表传递给bulk_write()
方法。默认情况下,该方法按照列表中定义的顺序运行操作。
以下示例使用bulk_write()
方法执行多个写入操作:
operations = [ pymongo.InsertOne( { "name": "Mongo's Deli", "cuisine": "Sandwiches", "borough": "Manhattan", "restaurant_id": "1234" } ), pymongo.InsertOne( { "name": "Mongo's Deli", "cuisine": "Sandwiches", "borough": "Brooklyn", "restaurant_id": "5678" } ), pymongo.UpdateMany( { "name": "Mongo's Deli" }, { "$set": { "cuisine": "Sandwiches and Salads" }}, ), pymongo.DeleteOne( { "restaurant_id": "1234" } ) ] results = restaurants.bulk_write(operations) print(results)
BulkWriteResult({'writeErrors': [], 'writeConcernErrors': [], 'nInserted': 2, 'nUpserted': 0, 'nMatched': 2, 'nModified': 2, 'nRemoved': 1, 'upserted': []}, acknowledged=True)
如果任何写入操作失败,PyMongo 都会引发BulkWriteError
并且不会执行任何进一步的操作。 BulkWriteError
提供了一个details
属性,其中包括失败的操作以及有关异常的详细信息。
注意
当 PyMongo 运行批量操作时,它会使用运行该操作的集合的write_concern
。无论执行顺序如何,驱动程序在尝试所有操作后都会报告所有写关注错误。
自定义批量写入操作
bulk_write()
方法可以选择接受其他参数,这些参数表示可用于配置批量写入操作的选项。 如果不指定任何其他选项,驱动程序不会自定义批量写入操作。
属性 | 说明 |
---|---|
ordered | 如果为 True ,则驱动程序按规定的顺序执行写入操作。如果发生错误,则不会尝试其余操作。如果为 False ,则驱动程序以任意顺序执行操作并尝试执行所有操作。默认值为 True 。 |
bypass_document_validation | 指定操作是否绕过文档级验证。 有关更多信息,请参阅 MongoDB Server 手册中的模式验证。 默认值为 False 。 |
session | ClientSession 的实例。有关更多信息,请参阅 API 文档 。 |
comment | 要附加到操作的注释。 有关更多信息,请参阅 MongoDB Server 手册中的删除命令字段指南。 |
let | 参数名称和值的映射。 值必须是常量或不引用文档字段的闭合表达式。 有关更多信息,请参阅 MongoDB Server 手册中的let 语句。 |
以下示例调用上一示例中的bulk_write()
方法,并将ordered
选项设置为False
:
results = restaurants.bulk_write(operations, ordered=False)
如果无序批量写入中的任何写入操作失败,PyMongo 仅在尝试所有操作后才会报告错误。
注意
无序批量操作不保证执行顺序。 为了优化运行时间,顺序可以与您列出的方式不同。
返回值
bulk_write()
方法返回一个BulkWriteResult
对象。 BulkWriteResult
对象包含以下属性:
属性 | 说明 |
---|---|
acknowledged | 指示服务器是否确认了写入操作。 |
bulk_api_result | 服务器返回的原始批量 API 结果。 |
deleted_count | 已删除的文档数量(如有)。 |
inserted_count | 插入的文档数量(如有)。 |
matched_count | 与更新匹配的文档数量(如果适用)。 |
modified_count | 已修改文档的数量(如有)。 |
upserted_count | 已更新或插入的文档数量(如有)。 |
upserted_ids | 操作索引到已更新或已插入文档的 _id 的映射(如果适用)。 |
更多信息
要了解如何执行单个写入操作,请参阅以下指南:
API 文档
要进一步了解本指南所讨论的任何方法或类型,请参阅以下 API 文档: