You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2018/03/05 07:05:24 UTC
[camel] 02/02: CAMEL-12316 : update documentation for allowDiskUse
option
This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
commit c5b2689486783ea1422ebd23d939191ca24dfe29
Author: Farès Hassak <fa...@gmail.com>
AuthorDate: Sat Mar 3 20:17:31 2018 +0100
CAMEL-12316 : update documentation for allowDiskUse option
---
components/camel-mongodb/src/main/docs/mongodb-component.adoc | 9 ++++++---
components/camel-mongodb3/src/main/docs/mongodb3-component.adoc | 9 ++++++---
2 files changed, 12 insertions(+), 6 deletions(-)
diff --git a/components/camel-mongodb/src/main/docs/mongodb-component.adoc b/components/camel-mongodb/src/main/docs/mongodb-component.adoc
index dbbff25..e3dd18c 100644
--- a/components/camel-mongodb/src/main/docs/mongodb-component.adoc
+++ b/components/camel-mongodb/src/main/docs/mongodb-component.adoc
@@ -528,9 +528,9 @@ containing the number of records deleted (copied from
*Available as of Camel 2.14*
Perform a aggregation with the given pipeline contained in the
-body. *Aggregations could be long and heavy operations. Use with care.*
+body.
+*Aggregations could be long and heavy operations. Use with care.*
-
[source,java]
----------------------------------------------------------------------------------------------------------------------------------------------------------------------
@@ -541,15 +541,18 @@ from("direct:aggregate")
.to("mock:resultAggregate");
----------------------------------------------------------------------------------------------------------------------------------------------------------------------
-Efficient retrieval is supported via outputType=DBCursor and the following header :
+Supports the following IN message headers:
[width="100%",cols="10%,10%,10%,70%",options="header",]
|=======================================================================
|Header key |Quick constant |Description (extracted from MongoDB API doc) |Expected type
|`CamelMongoDbBatchSize` |`MongoDbConstants.BATCH_SIZE` | Sets the number of documents to return per batch. |int/Integer
+|`CamelMongoDbAllowDiskUse` |`MongoDbConstants.ALLOW_DISK_USE` | Enable aggregation pipeline stages to write data to temporary files. |boolean/Boolean
|=======================================================================
+Efficient retrieval is supported via outputType=DBCursor.
+
You can also "stream" the documents returned from the server into your route by including outputType=DBCursor (Camel 2.21+) as an endpoint option
which may prove simpler than setting the above headers. This hands your Exchange the DBCursor from the Mongo driver, just as if you were executing
the aggregate() within the Mongo shell, allowing your route to iterate over the results. By default and without this option, this component will load
diff --git a/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc b/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc
index aef5bf0..3351340 100644
--- a/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc
+++ b/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc
@@ -574,9 +574,9 @@ containing the number of records deleted (copied from
===== aggregate
Perform a aggregation with the given pipeline contained in the
-body. *Aggregations could be long and heavy operations. Use with care.*
+body.
+*Aggregations could be long and heavy operations. Use with care.*
-
[source,java]
----------------------------------------------------------------------------------------------------------------------------------------------------------------------
@@ -590,15 +590,18 @@ from("direct:aggregate")
----------------------------------------------------------------------------------------------------------------------------------------------------------------------
-Efficient retrieval is supported via outputType=MongoIterable and the following header :
+Supports the following IN message headers:
[width="100%",cols="10%,10%,10%,70%",options="header",]
|=======================================================================
|Header key |Quick constant |Description (extracted from MongoDB API doc) |Expected type
|`CamelMongoDbBatchSize` |`MongoDbConstants.BATCH_SIZE` | Sets the number of documents to return per batch. |int/Integer
+|`CamelMongoDbAllowDiskUse` |`MongoDbConstants.ALLOW_DISK_USE` | Enable aggregation pipeline stages to write data to temporary files. |boolean/Boolean
|=======================================================================
+Efficient retrieval is supported via outputType=MongoIterable.
+
You can also "stream" the documents returned from the server into your route by including outputType=DBCursor (Camel 2.21+) as an endpoint option
which may prove simpler than setting the above headers. This hands your Exchange the DBCursor from the Mongo driver, just as if you were executing
the aggregate() within the Mongo shell, allowing your route to iterate over the results. By default and without this option, this component will load
--
To stop receiving notification emails like this one, please contact
acosentino@apache.org.