101.8. MongoDB 操作 - 生成者端点
101.8.1. 查询操作 复制链接链接已复制到粘贴板!
101.8.1.1. findById 复制链接链接已复制到粘贴板!
此操作仅从其 _id 字段与 IN 消息正文内容匹配的集合中检索一个元素。传入的对象可以是与 Bson
类型等效的任何对象。请参阅 http://bsonspec.org/spec.html 和 http://www.mongodb.org/display/DOCS/Java+Types。
from("direct:findById") .to("mongodb:myDb?database=flights&collection=tickets&operation=findById") .to("mock:resultFindById");
from("direct:findById")
.to("mongodb:myDb?database=flights&collection=tickets&operation=findById")
.to("mock:resultFindById");
请注意,默认的 _id 被 Mongo 视为 和 ObjectId
类型,因此您可能需要正确转换它。
from("direct:findById") .convertBodyTo(ObjectId.class) .to("mongodb:myDb?database=flights&collection=tickets&operation=findById") .to("mock:resultFindById");
from("direct:findById")
.convertBodyTo(ObjectId.class)
.to("mongodb:myDb?database=flights&collection=tickets&operation=findById")
.to("mock:resultFindById");
支持可选参数
此操作支持投射运算符。请参阅 指定字段过滤器(投射)。
101.8.1.2. findOneByQuery 复制链接链接已复制到粘贴板!
从与 MongoDB 查询选择器匹配的集合中检索第一个元素。如果设置了 CamelMongoDbCriteria
标头,则其值将用作查询选择器。如果 CamelMongoDbCriteria
标头为 null,则 IN 消息正文将用作查询选择器。在这两种情况下,查询选择器都应类型为 Bson
,或转换为 Bson
(例如,JSON 字符串或 HashMap
)。如需更多信息,请参阅类型转换。
使用 MongoDB Driver 提供的 过滤器
创建查询选择器。
101.8.1.3. 没有查询选择器的示例(将集合中的第一个文档返回) 复制链接链接已复制到粘贴板!
from("direct:findOneByQuery") .to("mongodb:myDb?database=flights&collection=tickets&operation=findOneByQuery") .to("mock:resultFindOneByQuery");
from("direct:findOneByQuery")
.to("mongodb:myDb?database=flights&collection=tickets&operation=findOneByQuery")
.to("mock:resultFindOneByQuery");
101.8.1.4. 带有查询选择器的示例(在集合中返回第一个匹配文档): 复制链接链接已复制到粘贴板!
from("direct:findOneByQuery") .setHeader(MongoDbConstants.CRITERIA, constant(Filters.eq("name", "Raul Kripalani"))) .to("mongodb:myDb?database=flights&collection=tickets&operation=findOneByQuery") .to("mock:resultFindOneByQuery");
from("direct:findOneByQuery")
.setHeader(MongoDbConstants.CRITERIA, constant(Filters.eq("name", "Raul Kripalani")))
.to("mongodb:myDb?database=flights&collection=tickets&operation=findOneByQuery")
.to("mock:resultFindOneByQuery");
支持可选参数
此操作支持投射运算符和排序子句。请参阅 指定字段过滤器(项目),指定 sort 子句。
101.8.1.5. findAll 复制链接链接已复制到粘贴板!
findAll
操作会返回与查询匹配的所有文档,或全部都不匹配,在这种情况下,集合中包含的所有文档都会被返回。查询对象会被提取 CamelMongoDbCriteria
标头。如果 CamelMongoDbCriteria 标头为空,则查询对象将被提取消息正文,即 Bson
类型,或者转换为 Bson
。它可以是 JSON 字符串或 Hashmap。如需更多信息,请参阅类型转换。
101.8.1.5.1. 没有查询选择器的示例(返回集合中的所有文档) 复制链接链接已复制到粘贴板!
from("direct:findAll") .to("mongodb:myDb?database=flights&collection=tickets&operation=findAll") .to("mock:resultFindAll");
from("direct:findAll")
.to("mongodb:myDb?database=flights&collection=tickets&operation=findAll")
.to("mock:resultFindAll");
101.8.1.5.2. 使用查询选择器的示例(返回集合中的所有匹配文档) 复制链接链接已复制到粘贴板!
from("direct:findAll") .setHeader(MongoDbConstants.CRITERIA, Filters.eq("name", "Raul Kripalani")) .to("mongodb:myDb?database=flights&collection=tickets&operation=findAll") .to("mock:resultFindAll");
from("direct:findAll")
.setHeader(MongoDbConstants.CRITERIA, Filters.eq("name", "Raul Kripalani"))
.to("mongodb:myDb?database=flights&collection=tickets&operation=findAll")
.to("mock:resultFindAll");
通过以下标头支持分页和有效的检索:
标头键 | 快速常数 | 描述(从 MongoDB API 文档中提取) | 预期类型 |
---|---|---|---|
|
| 在光标的开始丢弃指定数量的元素。 | int/Integer |
|
| 限制返回的元素数量。 | int/Integer |
|
| 限制一个批处理中返回的元素数量。光标通常获取一系列结果对象并将其存储在本地。如果 batchSize 为正数,则代表检索的每个对象批处理的大小。可以调整它以优化性能和限制数据传输。如果 batchSize 为负数,它将限制返回的数量,该对象适合最大批处理大小限制(通常为 4MB),并且光标将关闭。例如,如果 batchSize 是 -10,则服务器将返回最多 10 个文档,且尽可能多的文档可能适合 4MB,然后关闭光标。请注意,这个功能与文件的 limit ()不同,文档必须适合最大大小,它会删除发送请求以关闭光标服务器端。即使光标迭代后,批处理大小也可以更改,在这种情况下,设置将应用到下一个批处理检索。 | int/Integer |
|
| 设置 allowDiskUse MongoDB 标记。从 MongoDB Server 4.3.1 开始支持它。将此标头与旧的 MongoDB Server 版本一起使用可能会导致查询失败。 | boolean/Boolean |
101.8.1.5.3. 带有选项 outputType=MongoIterable 和 batch 大小的示例 复制链接链接已复制到粘贴板!
from("direct:findAll") .setHeader(MongoDbConstants.BATCH_SIZE).constant(10) .setHeader(MongoDbConstants.CRITERIA, constant(Filters.eq("name", "Raul Kripalani"))) .to("mongodb:myDb?database=flights&collection=tickets&operation=findAll&outputType=MongoIterable") .to("mock:resultFindAll");
from("direct:findAll")
.setHeader(MongoDbConstants.BATCH_SIZE).constant(10)
.setHeader(MongoDbConstants.CRITERIA, constant(Filters.eq("name", "Raul Kripalani")))
.to("mongodb:myDb?database=flights&collection=tickets&operation=findAll&outputType=MongoIterable")
.to("mock:resultFindAll");
findAll
操作也会返回以下 OUT 标头,以便在使用分页时迭代结果页面:
标头键 | 快速常数 | 描述(从 MongoDB API 文档中提取) | 数据类型 |
---|---|---|---|
|
| 与查询匹配的对象数量。这不会考虑限制/跳过。 | int/Integer |
|
| 与查询匹配的对象数量。这不会考虑限制/跳过。 | int/Integer |
支持可选参数
此操作支持投射运算符和排序子句。请参阅 指定字段过滤器(项目),指定 sort 子句。
101.8.1.6. æ•°é‡� 复制链接链接已复制到粘贴板!
返回集合中对象总数,返回 Long 作为 OUT 消息正文。
以下示例将计算"dynamicCollectionName"集合中的记录数。请注意启用动态性的方式,因此操作不会针对"notableScientists"集合运行,而是针对"dynamicCollectionName"集合运行。
// from("direct:count").to("mongodb:myDb?database=tickets&collection=flights&operation=count&dynamicity=true"); Long result = template.requestBodyAndHeader("direct:count", "irrelevantBody", MongoDbConstants.COLLECTION, "dynamicCollectionName"); assertTrue("Result is not of type Long", result instanceof Long);
// from("direct:count").to("mongodb:myDb?database=tickets&collection=flights&operation=count&dynamicity=true");
Long result = template.requestBodyAndHeader("direct:count", "irrelevantBody", MongoDbConstants.COLLECTION, "dynamicCollectionName");
assertTrue("Result is not of type Long", result instanceof Long);
您可以提供一个查询。查询 对象会被提取 CamelMongoDbCriteria
标头。如果 CamelMongoDbCriteria 标头为 null,则查询对象会被提取消息正文,即它的类型为 Bson
,或者转换为 Bson
。操作将返回与此条件匹配的文档数量。
Document query = ... Long count = template.requestBodyAndHeader("direct:count", query, MongoDbConstants.COLLECTION, "dynamicCollectionName");
Document query = ...
Long count = template.requestBodyAndHeader("direct:count", query, MongoDbConstants.COLLECTION, "dynamicCollectionName");
101.8.1.7. 指定字段过滤器(项目) 复制链接链接已复制到粘贴板!
默认情况下,查询操作将返回整个对象(所有字段)。如果您的文档较大,且您只需要检索其字段的子集,您可以在所有查询操作中指定字段过滤器,只需设置相关的
(或类型转换为 Bson,如 JSON String、Map 等)。Bson
以下是一个示例,它使用 MongoDB 的 Projections
来简化 Bson 的创建。它检索除 _id
和 boringField
以外的所有字段:
// route: from("direct:findAll").to("mongodb:myDb?database=flights&collection=tickets&operation=findAll") Bson fieldProjection = Projection.exclude("_id", "boringField"); Object result = template.requestBodyAndHeader("direct:findAll", ObjectUtils.NULL, MongoDbConstants.FIELDS_PROJECTION, fieldProjection);
// route: from("direct:findAll").to("mongodb:myDb?database=flights&collection=tickets&operation=findAll")
Bson fieldProjection = Projection.exclude("_id", "boringField");
Object result = template.requestBodyAndHeader("direct:findAll", ObjectUtils.NULL, MongoDbConstants.FIELDS_PROJECTION, fieldProjection);
以下是一个示例,它使用 MongoDB 的 Projections
来简化 Bson 的创建。它检索除 _id
和 boringField
以外的所有字段:
// route: from("direct:findAll").to("mongodb:myDb?database=flights&collection=tickets&operation=findAll") Bson fieldProjection = Projection.exclude("_id", "boringField"); Object result = template.requestBodyAndHeader("direct:findAll", ObjectUtils.NULL, MongoDbConstants.FIELDS_PROJECTION, fieldProjection);
// route: from("direct:findAll").to("mongodb:myDb?database=flights&collection=tickets&operation=findAll")
Bson fieldProjection = Projection.exclude("_id", "boringField");
Object result = template.requestBodyAndHeader("direct:findAll", ObjectUtils.NULL, MongoDbConstants.FIELDS_PROJECTION, fieldProjection);
101.8.1.8. 指定 sort 子句 复制链接链接已复制到粘贴板!
通常,根据特定字段的排序,从集合中获取 min/max 记录(使用 MongoDB 的 排序来简化 Bs
on 的创建)。它检索除 _id
和 boringField
以外的所有字段:
// route: from("direct:findAll").to("mongodb:myDb?database=flights&collection=tickets&operation=findAll") Bson sorts = Sorts.descending("_id"); Object result = template.requestBodyAndHeader("direct:findAll", ObjectUtils.NULL, MongoDbConstants.SORT_BY, sorts);
// route: from("direct:findAll").to("mongodb:myDb?database=flights&collection=tickets&operation=findAll")
Bson sorts = Sorts.descending("_id");
Object result = template.requestBodyAndHeader("direct:findAll", ObjectUtils.NULL, MongoDbConstants.SORT_BY, sorts);
在 Camel 路由中,SORT_BY 标头可与 findOneByQuery 操作一起使用,以达到相同的结果。如果还指定了 FIELDS_PROJECTION 标头,则操作将返回可直接传递给另一个组件的单个字段/值对(例如,参数化 MyBatis SELECT 查询)。本例演示了从集合中获取最新的文档,并根据 documentTimestamp
字段将结果减少到单个字段:
101.8.2. 创建/更新操作 复制链接链接已复制到粘贴板!
101.8.2.1. insert 复制链接链接已复制到粘贴板!
将新对象插入到 MongoDB 集合中,从 IN 消息正文获取。键入转换尝试将它转换为 文档或
列表
。
支持两种模式: 单插入和多个插入。对于多个插入,端点将预期任何类型的对象的 List、Array 或 Collections,只要它们是 - 或可以转换为 - 文档
。Example:
from("direct:insert") .to("mongodb:myDb?database=flights&collection=tickets&operation=insert");
from("direct:insert")
.to("mongodb:myDb?database=flights&collection=tickets&operation=insert");
该操作将返回 WriteResult,并根据 WriteConcern
或 invokeGetLastError
选项的值,getLastError ()
将已被调用。如果您希望访问些操作的最终结果,可以通过在 WriteResult
上调用 getLastError()
或 getCachedLastError()
来获取 CommandResult
。然后,您可以通过调用 CommandResult.ok ()
、CommandResult.getErrorMessage ()
和/或 CommandResult.getException ()
来验证结果。
请注意,新对象的 _id
在集合中必须是唯一的。如果没有指定值,MongoDB 将自动为您生成一个。但是,如果您确实指定它且不是唯一的,插入操作将失败(并且要注意,您需要启用 invokeGetLastError 或设置等待写结果的 WriteConcern)。
这并不是组件的一个限制,但它是在 MongoDB 中用于更高吞吐量的效果。如果您使用自定义 _id
,则需要确保在应用程序级别具有唯一性(这也是良好的做法)。
插入记录的 OID 存储在 CamelMongoOid
键下的消息标头中(MongoDbConstants.OID
constant)。存储的值为 org.bson.types.ObjectId
用于单个插入或 java.util.List<org.bson.types.ObjectId>
; (如果插入了多个记录)。
在 MongoDB Java Driver 3.x 中,insertOne 和 insertMany 操作返回 void。Camel insert 操作返回插入的 Document 或 Documents 列表。请注意,每个文档都会被新的 OID 更新(如果需要)。
101.8.2.2. save 复制链接链接已复制到粘贴板!
save 操作等同于 upsert (UPdate, inSERT)操作,其中将更新记录,如果记录不存在,它将被插入,所有都在一个原子操作中。MongoDB 将基于 _id
字段执行匹配。
请注意,如果有更新,对象会被完全替换,不允许使用 MongoDB 的 $modifiers。因此,如果要操作对象(如果已存在),有两个选项:
- 执行查询,首先检索整个对象及其所有字段(可能效率低下),在 Camel 中更改它,然后保存它。
- 使用带有 $modifiers 的 update 操作,这将在服务器端执行更新。您可以启用 upsert 标志,在这种情况下,如果需要一个插入,MongoDB 会将 $modifiers 应用到过滤器查询对象并插入结果。
如果要保存的文档不包含 _id
属性,则操作将是插入的,则创建新的 _id
将放置在 CamelMongoOid
标头中。
例如:
from("direct:insert") .to("mongodb:myDb?database=flights&collection=tickets&operation=save");
from("direct:insert")
.to("mongodb:myDb?database=flights&collection=tickets&operation=save");
// route: from("direct:insert").to("mongodb:myDb?database=flights&collection=tickets&operation=save"); org.bson.Document docForSave = new org.bson.Document(); docForSave.put("key", "value"); Object result = template.requestBody("direct:insert", docForSave);
// route: from("direct:insert").to("mongodb:myDb?database=flights&collection=tickets&operation=save");
org.bson.Document docForSave = new org.bson.Document();
docForSave.put("key", "value");
Object result = template.requestBody("direct:insert", docForSave);
101.8.2.3. update 复制链接链接已复制到粘贴板!
更新集合中的一个或多个记录。需要过滤器查询和更新规则。
您可以使用 MongoDBConstants.CRITERIA 标头定义为 Bson
,并将更新规则定义为 Body 中的 Bson
。
在功能丰富的
后更新,使用 MongoDBConstants.CRITERIA 标头来定义过滤器,作为 Bson
在进行更新前查询 mongodb,您应该注意到在聚合过程中将其从生成的 camel 交换中删除,然后应用 mongodb 更新。如果在聚合和/或将 camel Exchange 发送到 mongodb producer 端点前,在聚合和/或重新定义 MongoDBConstants.CRITERIA 标头的过程中没有删除此标头,则在更新 mongodb 时可能会最终使用无效的 camel Exchange payload。
第二种方法 Require a List<Bson> 作为 IN message body (包括正好 2 个元素):
- 元素 1 (index 0) navigator filter query determine 确定哪些对象会受到影响,与典型的查询对象相同
- 元素 2 (index 1) package update rules TOKEN 如何更新匹配的对象。支持 MongoDB 中的所有 修饰符操作。
Multiupdates
默认只会更新 1 个对象,即使多个对象与过滤器查询匹配。要指示 MongoDB 更新 所有匹配 记录,请将 CamelMongoDbMultiUpdate
IN 消息标头设置为 true
。
将返回一个带有键 CamelMongoDbRecordsAffected
的标头(Affected) (MongoDbConstants.RECORDS_AFFECTED
constant),带有更新的记录数(从 WriteResult.getN ()
)。
支持以下 IN message 标头:
标头键 | 快速常数 | 描述(从 MongoDB API 文档中提取) | 预期类型 |
---|---|---|---|
|
| 如果更新应该应用到匹配的所有对象。See http://www.mongodb.org/display/DOCS/Atomic+Operations | boolean/Boolean |
|
| 如果数据库应创建元素(如果它不存在) | boolean/Boolean |
例如,以下命令将 "scientist" 字段的值设置为 "Darwin" 字段来更新其 filterField 字段等于 true 的所有记录:
// route: from("direct:update").to("mongodb:myDb?database=science&collection=notableScientists&operation=update"); String updateObj = "[{\"filterField\": true}, {\"$set\", {\"scientist\", \"Darwin\"}}]"; Object result = template.requestBodyAndHeader("direct:update", updateObj, MongoDbConstants.MULTIUPDATE, true);
// route: from("direct:update").to("mongodb:myDb?database=science&collection=notableScientists&operation=update");
String updateObj = "[{\"filterField\": true}, {\"$set\", {\"scientist\", \"Darwin\"}}]";
Object result = template.requestBodyAndHeader("direct:update", updateObj, MongoDbConstants.MULTIUPDATE, true);
101.8.3. 删除操作 复制链接链接已复制到粘贴板!
101.8.3.1. remove 复制链接链接已复制到粘贴板!
从集合中删除匹配的记录。IN 消息正文将充当删除过滤器查询,并且应该是 DBObject
类型的类型或可转换的类型。
以下示例将删除其字段 'conditionField' 等于 true 的所有对象,在科学数据库中,ableScientists 集合:
// route: from("direct:remove").to("mongodb:myDb?database=science&collection=notableScientists&operation=remove"); Bson conditionField = Filters.eq("conditionField", true); Object result = template.requestBody("direct:remove", conditionField);
// route: from("direct:remove").to("mongodb:myDb?database=science&collection=notableScientists&operation=remove");
Bson conditionField = Filters.eq("conditionField", true);
Object result = template.requestBody("direct:remove", conditionField);
返回一个带有键 CamelMongoDbRecordsAffected
的标头 (MongoDbConstants.RECORDS_AFFECTED
constant) with type int
, 包括删除记录的数量 (从 WriteResult.getN()
复制)。
101.8.4. 批量写操作 复制链接链接已复制到粘贴板!
101.8.4.1. bulkWrite 复制链接链接已复制到粘贴板!
批量执行带有控件的写入操作,以便执行顺序。需要一个 List<WriteModel<Document
>> 作为 IN 消息正文,其中包含用于插入、更新和删除操作的命令。
以下示例将插入一个新的科学家 "Pierre Curie",更新 id 为 "5" 的记录,将 "scientist" 项的值设置为 "Marie Curie" 并删除 id 为 "3" 的记录 :
默认情况下,操作会按顺序执行,并在第一个写入错误时中断操作,而不会处理列表中任何剩余的写操作。要指示 MongoDB 继续处理列表中剩余的写操作,请将 CamelMongoDbBulkOrdered
IN message 标头设置为 false
。未排序的操作并行执行,无法保证此行为。
标头键 | 快速常数 | 描述(从 MongoDB API 文档中提取) | 预期类型 |
---|---|---|---|
|
| 执行有序或未排序的操作执行。默认值为 true。 | boolean/Boolean |
101.8.5. 其他操作 复制链接链接已复制到粘贴板!
101.8.5.1. 聚合 复制链接链接已复制到粘贴板!
使用正文中包含的给定管道执行聚合。聚合可能是长时间和重度的操作。请谨慎使用。
支持以下 IN message 标头:
标头键 | 快速常数 | 描述(从 MongoDB API 文档中提取) | 预期类型 |
---|---|---|---|
|
| 设置每个批处理要返回的文档数量。 | int/Integer |
|
| 启用聚合管道阶段,将数据写入临时文件。 | boolean/Boolean |
默认情况下,返回所有结果的列表。根据结果的大小,这可能会对内存进行重量。更安全的替代方案是设置 outputType=MongoIterable。下一个处理器将在消息正文中看到一个不可取的,允许它逐一完成结果。因此,设置批处理大小并返回可使其可以有效地检索和处理结果。
例如:
请注意,调用 .split (body ())
足以逐一发送条目,但仍会首先将所有条目加载到内存中。因此,需要调用 .streaming ()
来通过批处理将数据加载到内存中。
101.8.5.2. getDbStats 复制链接链接已复制到粘贴板!
等同于在 MongoDB shell 中运行 db.stats ()
命令,该命令显示有关数据库的有用统计图。
例如:
使用示例:
// from("direct:getDbStats").to("mongodb:myDb?database=flights&collection=tickets&operation=getDbStats"); Object result = template.requestBody("direct:getDbStats", "irrelevantBody"); assertTrue("Result is not of type Document", result instanceof Document);
// from("direct:getDbStats").to("mongodb:myDb?database=flights&collection=tickets&operation=getDbStats");
Object result = template.requestBody("direct:getDbStats", "irrelevantBody");
assertTrue("Result is not of type Document", result instanceof Document);
该操作将返回类似于 shell 中显示的数据结构,格式为 OUT 消息正文中的 Document
。
101.8.5.3. getColStats 复制链接链接已复制到粘贴板!
等同于在 MongoDB shell 中运行 db.collection.stats ()
命令,该命令显示有关集合的有用统计图。
例如:
使用示例:
// from("direct:getColStats").to("mongodb:myDb?database=flights&collection=tickets&operation=getColStats"); Object result = template.requestBody("direct:getColStats", "irrelevantBody"); assertTrue("Result is not of type Document", result instanceof Document);
// from("direct:getColStats").to("mongodb:myDb?database=flights&collection=tickets&operation=getColStats");
Object result = template.requestBody("direct:getColStats", "irrelevantBody");
assertTrue("Result is not of type Document", result instanceof Document);
该操作将返回类似于 shell 中显示的数据结构,格式为 OUT 消息正文中的 Document
。
101.8.5.4. 命令 复制链接链接已复制到粘贴板!
在数据库上运行正文作为命令。对于 admin 操作,作为获取主机信息、复制或分片状态。
此操作不使用集合参数。
// route: from("command").to("mongodb:myDb?database=science&operation=command"); DBObject commandBody = new BasicDBObject("hostInfo", "1"); Object result = template.requestBody("direct:command", commandBody);
// route: from("command").to("mongodb:myDb?database=science&operation=command");
DBObject commandBody = new BasicDBObject("hostInfo", "1");
Object result = template.requestBody("direct:command", commandBody);
101.8.6. 动态操作 复制链接链接已复制到粘贴板!
Exchange 可以通过设置 MongoDbConstants.OPERATION_HEADER
常量所定义的 CamelMongoDbOperation
标头来覆盖端点的固定操作。
支持的值由 MongoDbOperation enumeration 决定,并与端点 URI 上的 operation
参数接受的值匹配。
例如:
// from("direct:insert").to("mongodb:myDb?database=flights&collection=tickets&operation=insert"); Object result = template.requestBodyAndHeader("direct:insert", "irrelevantBody", MongoDbConstants.OPERATION_HEADER, "count"); assertTrue("Result is not of type Long", result instanceof Long);
// from("direct:insert").to("mongodb:myDb?database=flights&collection=tickets&operation=insert");
Object result = template.requestBodyAndHeader("direct:insert", "irrelevantBody", MongoDbConstants.OPERATION_HEADER, "count");
assertTrue("Result is not of type Long", result instanceof Long);