红帽全球峰会228.6. MongoDB operations - producer 端点
228.6.1. 查询操作
228.6.1.1. findById
此操作仅从与 IN 消息正文的内容匹配的集合中检索一个元素。传入的对象可以是任何相当于 BSON 类型的对象。请参阅 http://bsonspec.org//specification[http://bsonspec.org//specification] 和 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");支持可选参数。此操作支持指定字段过滤器。请参阅 指定可选参数。
228.6.1.2. findOneByQuery
使用此操作只从与 MongoDB 查询匹配的集合中检索一个元素。查询对象从 IN 消息正文中提取，即 它应该是 DBObject 类型，或者可转换为 DBObject。它可以是 JSON 字符串或 Hashmap。如需更多信息，请参阅 #Type 转换。
无查询的示例（返回集合的任何对象）：
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");带有查询的示例（返回一个匹配结果）：
from("direct:findOneByQuery")
.setBody().constant("{ \"name\": \"Raul Kripalani\" }")
.to("mongodb:myDb?database=flights&collection=tickets&operation=findOneByQuery")
.to("mock:resultFindOneByQuery");
from("direct:findOneByQuery")
.setBody().constant("{ \"name\": \"Raul Kripalani\" }")
.to("mongodb:myDb?database=flights&collection=tickets&operation=findOneByQuery")
.to("mock:resultFindOneByQuery");支持可选参数。此操作支持指定字段过滤器和/或 sort 子句。请参阅 指定可选参数。
228.6.1.3. findAll
findAll 操作会返回与查询匹配的所有文档，或者根本没有返回集合中包含的所有文档。查询对象从 IN 消息正文中提取，即 它应该是 DBObject 类型，或者可转换为 DBObject。它可以是 JSON 字符串或 Hashmap。如需更多信息，请参阅 #Type 转换。
无查询的示例（重新返回集合中的所有对象）：
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");带有查询的示例（返回所有匹配结果）：
from("direct:findAll")
.setBody().constant("{ \"name\": \"Raul Kripalani\" }")
.to("mongodb:myDb?database=flights&collection=tickets&operation=findAll")
.to("mock:resultFindAll");
from("direct:findAll")
.setBody().constant("{ \"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 |
您还可以通过包含 outputType=DBCursor (Camel 2.16+)作为端点选项，它比设置上述标头来"流"文档到您的路由。这让您的 Exchange Cursor 从 Mongo 驱动程序执行，就像您在 Mongo shell 中执行 findAll （）时一样，您的路由可以迭代结果。默认情况下，如果没有这个选项，此组件将从驱动程序的光标中将文档加载到列表，并返回到您的路由 - 这可能会导致大量内存对象。请记住，在 DBCursor 时，不会要求提供匹配的文档数量 - 详情请查看 MongoDB 文档站点。
带有选项 outputType=DBCursor 和 batch size 的示例：
from("direct:findAll")
.setHeader(MongoDbConstants.BATCH_SIZE).constant(10)
.setBody().constant("{ \"name\": \"Raul Kripalani\" }")
.to("mongodb:myDb?database=flights&collection=tickets&operation=findAll&outputType=DBCursor")
.to("mock:resultFindAll");
from("direct:findAll")
.setHeader(MongoDbConstants.BATCH_SIZE).constant(10)
.setBody().constant("{ \"name\": \"Raul Kripalani\" }")
.to("mongodb:myDb?database=flights&collection=tickets&operation=findAll&outputType=DBCursor")
.to("mock:resultFindAll");
findAll 操作还会返回以下 OUT 标头，以便在使用分页时迭代结果页面：
| 标头键 | 快速常量 | 描述（从 MongoDB API 文档中提取） | 数据类型 |
|---|---|---|---|
|
|
| 与查询匹配的对象数量。这不会考虑 limit/skip。 | int/Integer |
|
|
| 与查询匹配的对象数量。这不会考虑 limit/skip。 | int/Integer |
支持可选参数。此操作支持指定字段过滤器和/或 sort 子句。请参阅 指定可选参数。
228.6.1.4. 数�
返回集合中对象总数，返回 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);
从 Camel 2.14 开始，您可以在消息正文中提供一个 com.mongodb.DBObject 对象作为查询，操作将返回与此条件匹配的文档数量。
DBObject query = ...
Long count = template.requestBodyAndHeader("direct:count", query, MongoDbConstants.COLLECTION, "dynamicCollectionName");
DBObject query = ...
Long count = template.requestBodyAndHeader("direct:count", query, MongoDbConstants.COLLECTION, "dynamicCollectionName");228.6.1.5. 指定字段过滤器（项目）
默认情况下，查询操作将在其整个中返回匹配的对象（及其所有字段）。如果您的文档较大，且您只需要检索其字段的子集，您可以在所有查询操作中指定字段过滤器，只需设置相关的 DBObject （或类型可转换为 DBObject，如 JSON String、映射等）在 CamelMongoDbFieldsFilter 标头、恒定快捷方式： MongoDbConstants.FIELDS_FILTER。
以下是一个示例，它使用 MongoDB 的 BasicDBObjectBuilder 来简化 DBObjects 的创建：它检索除 _id 和 boringField 以外的所有字段：
// route: from("direct:findAll").to("mongodb:myDb?database=flights&collection=tickets&operation=findAll")
DBObject fieldFilter = BasicDBObjectBuilder.start().add("_id", 0).add("boringField", 0).get();
Object result = template.requestBodyAndHeader("direct:findAll", (Object) null, MongoDbConstants.FIELDS_FILTER, fieldFilter);
// route: from("direct:findAll").to("mongodb:myDb?database=flights&collection=tickets&operation=findAll")
DBObject fieldFilter = BasicDBObjectBuilder.start().add("_id", 0).add("boringField", 0).get();
Object result = template.requestBodyAndHeader("direct:findAll", (Object) null, MongoDbConstants.FIELDS_FILTER, fieldFilter);228.6.1.6. 指定 sort 子句
通常需要根据特定字段排序从集合中获取 min/max 记录。在 Mongo 中，该操作使用类似如下的语法来执行：
db.collection.find().sort({_id: -1}).limit(1)
// or
db.collection.findOne({$query:{},$orderby:{_id:-1}})
db.collection.find().sort({_id: -1}).limit(1)
// or
db.collection.findOne({$query:{},$orderby:{_id:-1}})
在 Camel 路由中，SORT_BY 标头可用于 findOneByQuery 操作，以实现相同的结果。如果还指定了 FIELDS_FILTER 标头，则操作将返回单个字段/值对，它可以直接传递给另一个组件（例如，参数ized MyBatis SELECT 查询）。本例演示了如何根据 documentTimestamp 字段从集合中获取临时最新的文档，并将结果减少到单个字段：
228.6.2. 创建/更新操作
228.6.2.1. insert
将新对象插入到 MongoDB 集合中，从 IN 消息正文获取。试图将类型转换转换为 DBObject 或 列表。
支持两种模式：单一插入和多个插入。对于多个插入，端点将预期任何类型的对象列表、数组或集合，只要它们是 - 或可以转换为 - DBObject。所有对象都会一次性插入。根据输入，端点将智能决定调用哪些后端操作（单个或多个插入）。
例如：
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 （） and/or CommandResult.getException （） 来验证结果。
请注意，新对象的 _id 在集合中必须是唯一的。如果没有指定值，MongoDB 将自动为您生成一个值。但是，如果您确实指定了它，则插入操作将失败（对于 Camel 需要注意，您需要启用 invokeGetLastError 或设置等待写结果的 WriteConcern）。
这并不是组件的限制，而是在 MongoDB 中的工作方式以获得更高的吞吐量。如果您使用自定义 _id，您预期在应用程序级别确保是唯一的（这也是很好的做法）。
由于 Camel 2.15: 插入记录的 OID (s)存储在 CamelMongoOid 键下的消息标头中(MongoDbConstants.OID constant)。存储的值为 org.bson.types.ObjectId，用于单个插入或 java.util.List<org.bson.types.ObjectId> （如果插入多个记录）。
228.6.2.2. save
save 操作等同于 upsert (UPdate，inSERT)操作，其中将更新记录，如果不存在，它将被插入一个原子操作。MongoDB 将根据 _id 字段执行匹配。
请注意，如果更新，对象会被完全被替换，而不允许使用 MongoDB 的 $modifier。因此，如果要操作对象已存在，则有两个选项：
- 执行查询以首先检索整个对象及其所有字段（或者效率不高），在 Camel 中更改它，然后保存它。
- 使用带有 $modifiers 的 update 操作，这将在服务器端执行更新。您可以启用 upsert 标志，在这种情况下，如果需要插入，MongoDB 会将 $modifiers 应用到过滤器查询对象并插入结果。
例如：
from("direct:insert")
.to("mongodb:myDb?database=flights&collection=tickets&operation=save");
from("direct:insert")
.to("mongodb:myDb?database=flights&collection=tickets&operation=save");228.6.2.3. update
更新集合上的一个或多个记录。需要 List<DBObject> 作为包含完全 2 个元素的 IN 消息正文：
- 元素 1 (index 0) jpeg 过滤器查询 TOKEN 确定受影响的对象，与典型的查询对象相同
- 元素 2 (index 1) TOKEN 更新规则 jpeg 如何更新匹配的对象。支持 MongoDB 中的所有 修饰符操作。
多更新 .默认情况下，MongoDB 只会更新 1 个对象，即使多个对象与过滤器查询匹配。要指示 MongoDB 更新 所有匹配 记录，请将 CamelMongoDbMultiUpdate IN 消息标头设置为 true。
将返回一个带有键 CamelMongoDbRecordsAffected 的标头(MongoDbConstants.RECORDS_AFFECTED constant)，其记录数量已更新（从 WriteResult.getN （））。
支持以下 IN 消息标头：
| 标头键 | 快速常量 | 描述（从 MongoDB API 文档中提取） | 预期类型 |
|---|---|---|---|
|
|
| 如果更新应该应用到所有匹配的对象。请参阅 http://www.mongodb.org/display/DOCS/Atomic+Operations | 布尔值/布尔值 |
|
|
| 如果数据库应该创建元素（如果不存在） | 布尔值/布尔值 |
例如，以下命令将 "scientist" 字段的值设置为 "Darwin" 来更新其 filterField 字段等于 true 的所有记录：
// route: from("direct:update").to("mongodb:myDb?database=science&collection=notableScientists&operation=update");
DBObject filterField = new BasicDBObject("filterField", true);
DBObject updateObj = new BasicDBObject("$set", new BasicDBObject("scientist", "Darwin"));
Object result = template.requestBodyAndHeader("direct:update", new Object[] {filterField, updateObj}, MongoDbConstants.MULTIUPDATE, true);
// route: from("direct:update").to("mongodb:myDb?database=science&collection=notableScientists&operation=update");
DBObject filterField = new BasicDBObject("filterField", true);
DBObject updateObj = new BasicDBObject("$set", new BasicDBObject("scientist", "Darwin"));
Object result = template.requestBodyAndHeader("direct:update", new Object[] {filterField, updateObj}, MongoDbConstants.MULTIUPDATE, true);228.6.3. 删除操作
228.6.3.1. remove
从集合中删除匹配的记录。IN 消息正文将充当删除过滤器查询，它预期为 DBObject 类型或可转换的类型。
以下示例将删除在 Science 数据库, notableScientists 集合中，其字段 'conditionField' 等于 true 的所有对象：
// route: from("direct:remove").to("mongodb:myDb?database=science&collection=notableScientists&operation=remove");
DBObject conditionField = new BasicDBObject("conditionField", true);
Object result = template.requestBody("direct:remove", conditionField);
// route: from("direct:remove").to("mongodb:myDb?database=science&collection=notableScientists&operation=remove");
DBObject conditionField = new BasicDBObject("conditionField", true);
Object result = template.requestBody("direct:remove", conditionField);
返回一个带有键 CamelMongoDbRecordsAffected 的标头 (MongoDbConstants.RECORDS_AFFECTED constant) with type int, 包括删除记录的数量 (从 WriteResult.getN() 复制)。
228.6.4. 批量写操作
228.6.4.1. bulkWrite
从 Camel 2.21 开始提供
批量执行写入操作，并控制执行顺序。需要 List<WriteModel<DBObject > 作为 IN 消息正文，其中包含用于插入、更新和删除操作的命令。
以下示例将插入一个新的科学家 "Pierre Curie"，更新 id 为 "5" 的记录，将 "scientist" 项的值设置为 "Marie Curie" 并删除 id 为 "3" 的记录 :
默认情况下，操作会按顺序执行，并在第一个写入错误上中断，而不处理列表中任何剩余的写入操作。要指示 MongoDB 继续处理列表中剩余的写入操作，请将 CamelMongoDbBulkOrdered IN 消息标头设置为 false。未排序的操作是并行执行的，无法保证此行为。
| 标头键 | 快速常量 | 描述（从 MongoDB API 文档中提取） | 预期类型 |
|---|---|---|---|
|
|
| 执行有序或未排序的操作执行。默认值为 true。 | 布尔值/布尔值 |
228.6.5. 其他操作
228.6.5.1. 聚合
从 Camel 2.14 开始提供
使用正文中包含的给定管道执行聚合。聚合可能非常长且繁重的操作。请谨慎使用。
// route: from("direct:aggregate").to("mongodb:myDb?database=science&collection=notableScientists&operation=aggregate");
from("direct:aggregate")
.setBody().constant("[{ $match : {$or : [{\"scientist\" : \"Darwin\"},{\"scientist\" : \"Einstein\"}]}},{ $group: { _id: \"$scientist\", count: { $sum: 1 }} } ]")
.to("mongodb:myDb?database=science&collection=notableScientists&operation=aggregate")
.to("mock:resultAggregate");
// route: from("direct:aggregate").to("mongodb:myDb?database=science&collection=notableScientists&operation=aggregate");
from("direct:aggregate")
.setBody().constant("[{ $match : {$or : [{\"scientist\" : \"Darwin\"},{\"scientist\" : \"Einstein\"}]}},{ $group: { _id: \"$scientist\", count: { $sum: 1 }} } ]")
.to("mongodb:myDb?database=science&collection=notableScientists&operation=aggregate")
.to("mock:resultAggregate");支持以下 IN 消息标头：
| 标头键 | 快速常量 | 描述（从 MongoDB API 文档中提取） | 预期类型 |
|---|---|---|---|
|
|
| 设置每个批处理要返回的文档数量。 | int/Integer |
|
|
| 启用聚合管道阶段，将数据写入临时文件。 | 布尔值/布尔值 |
通过 outputType=DBCursor 支持有效的检索。
您还可以通过包含 outputType=DBCursor (Camel 2.21+)作为端点选项，它比设置上述标头来"流"文档到您的路由。这您的交换来自 Mongo 驱动程序的 Exchange DBCursor 就像您在 Mongo shell 中执行 aggregate （）一样，您的路由可以迭代结果。默认情况下，如果没有这个选项，此组件将从驱动程序的光标中将文档加载到列表，并返回到您的路由 - 这可能会导致大量内存对象。请记住，在 DBCursor 时，不会要求提供匹配的文档数量 - 详情请查看 MongoDB 文档站点。
带有选项 outputType=DBCursor 和 batch size 的示例：
228.6.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 DBObject", result instanceof DBObject);
// 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 DBObject", result instanceof DBObject);
该操作将返回与 shell 中显示的数据结构，格式为 OUT 消息正文中的 DBObject。
228.6.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 DBObject", result instanceof DBObject);
// 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 DBObject", result instanceof DBObject);
该操作将返回与 shell 中显示的数据结构，格式为 OUT 消息正文中的 DBObject。
228.6.5.4. 命令
从 Camel 2.15 开始提供
作为命令在数据库上运行正文。Usefull for admin 操作作为获取主机信息、复制或分片状态。
这个操作不使用 collection 参数。
// 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);228.6.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);
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}