svn commit: r880656 [3/3] - in /websites/production/camel/content: cache/main.pageCache camel-2130-release.html component-list-grouped.html mongodb.html

[bu...@apache.org]

Modified: websites/production/camel/content/mongodb.html
==============================================================================
--- websites/production/camel/content/mongodb.html (original)
+++ websites/production/camel/content/mongodb.html Tue Oct  1 12:19:26 2013
@@ -124,7 +124,7 @@ mongodb:connectionBean?database=database
 
 <div class="confluenceTableSmall"></div>
 <div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th><th colspan="1" rowspan="1" class="confluenceTh"> Producer </th><th colspan="1" rowspan="1" class="confluenceTh"> Tailable Cursor Consumer </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>database</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> none </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Required.</b> The name of the database to which this endpoint will be bound. All operations will be executed against this database unless dynamicity is enabled and the&#160;<tt>CamelMongoDbDatabase</tt> header is set. </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" borde
 r="0"> </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>collection</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> none </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Required.</b> The name of the collection (within the specified database) to which this endpoint will be bound.&#160;All operations will be executed against this database unless dynamicity is enabled and the&#160;<tt>CamelMongoDbDatabase</tt> header is set. </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.ap
 ache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>collectionIndex</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> none </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.12:</b> An optional index to create when inserting new collections. </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td><td colspan="1" rowspan="1" class="confluenceTd">&#160;</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>operation</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> none </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Required for producers.</b> The id of the operation this endpoint will execute. Pick from the following:
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th><th colspan="1" rowspan="1" class="confluenceTh"> Producer </th><th colspan="1" rowspan="1" class="confluenceTh"> Tailable Cursor Consumer </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>database</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> none </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Required.</b> The name of the database to which this endpoint will be bound. All operations will be executed against this database unless dynamicity is enabled and the&#160;<tt>CamelMongoDbDatabase</tt> header is set. </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" borde
 r="0"> </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>collection</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> none </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Required.</b> The name of the collection (within the specified database) to which this endpoint will be bound.&#160;All operations will be executed against this database unless dynamicity is enabled and the&#160;<tt>CamelMongoDbDatabase</tt> header is set. </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.ap
 ache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>collectionIndex</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> none </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.12:</b> An optional <a shape="rect" class="external-link" href="http://docs.mongodb.org/manual/core/index-single/" rel="nofollow">single field index</a> or <a shape="rect" class="external-link" href="http://docs.mongodb.org/manual/core/index-compound/" rel="nofollow">compound field index</a> to create when inserting new collections. </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td><td colspan="1" rowspan="1" class="confluenceTd">&#160;</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>operation</tt>
  </td><td colspan="1" rowspan="1" class="confluenceTd"> none </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Required for producers.</b> The id of the operation this endpoint will execute. Pick from the following:
 <ul><li>Query operations: <tt>findById</tt>, <tt>findOneByQuery</tt>, <tt>findAll</tt>, <tt>count</tt></li><li>Write operations: <tt>insert</tt>, <tt>save</tt>, <tt>update</tt></li><li>Delete operations: <tt>remove</tt></li><li>Other operations: <tt>getDbStats</tt>, <tt>getColStats</tt>, <tt>aggregate</tt></li></ul>
 </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td><td colspan="1" rowspan="1" class="confluenceTd">&#160;</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>createCollection</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> true </td><td colspan="1" rowspan="1" class="confluenceTd"> Determines whether the collection will be automatically created in the MongoDB database during endpoint initialisation if it doesn't exist already. If this option is <tt>false</tt> and the collection doesn't exist, an initialisation exception will be thrown. </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td><td colspan="1" rowspan="1" class="confluenceTd">&
 #160;</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>invokeGetLastError</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> false (behaviour may be inherited from connections WriteConcern) </td><td colspan="1" rowspan="1" class="confluenceTd"> Instructs the MongoDB Java driver to invoke <tt>getLastError()</tt> after every call. Default behaviour in version 2.7.2 of the MongoDB Java driver is that only network errors will cause the operation to fail, because the actual operation is executed asynchronously in the MongoDB server without holding up the client - to increase performance. The client can obtain the real result of the operation by explicitly invoking <tt>getLastError()</tt> on the <tt>WriteResult</tt> object returned or by setting the appropriate <tt>WriteConcern</tt>. If the backend operation has not finished yet, the client will block until the result is available. Setting this option to <tt>true</tt> will make the endpoint behave synchronously 
 and return an Exception if the underlying operation failed. </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td><td colspan="1" rowspan="1" class="confluenceTd">&#160;</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>writeConcern</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> none (driver's default) </td><td colspan="1" rowspan="1" class="confluenceTd"> Set a <tt>WriteConcern</tt> on the operation out of MongoDB's parameterised values. See <a shape="rect" class="external-link" href="http://api.mongodb.org/java/current/com/mongodb/WriteConcern.html#valueOf(java.lang.String)" rel="nofollow">WriteConcern.valueOf(String)</a>. </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height=
 "16" width="16" alt="" border="0"> </td><td colspan="1" rowspan="1" class="confluenceTd">&#160;</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>writeConcernRef</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> none </td><td colspan="1" rowspan="1" class="confluenceTd"> Sets a custom <tt>WriteConcern</tt> that exists in the Registry. Specify the bean name. </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td><td colspan="1" rowspan="1" class="confluenceTd">&#160;</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>readPreference</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> none </td><td colspan="1" rowspan="1" class="confluenceTd"> Sets a <tt>ReadPreference</tt> on the connection. Accepted values: the name of any inner subclass of <a shape="rect" class="external-link"
  href="http://api.mongodb.org/java/current/com/mongodb/ReadPreference.html" rel="nofollow">ReadPreference</a>. For example: <tt>PrimaryReadPreference</tt>, <tt>SecondaryReadPreference</tt>, <tt>TaggedReadPreference</tt>. </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td><td colspan="1" rowspan="1" class="confluenceTd">&#160;</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>dynamicity</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="1" class="confluenceTd"> If set to true, the endpoint will inspect the <tt>CamelMongoDbDatabase</tt> and <tt>CamelMongoDbCollection</tt> headers of the incoming message, and if any of them exists, the target collection and/or database will be overridden for that particular operation. Set to false by default to avoid triggering the
  lookup on every Exchange if the feature is not desired. </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td><td colspan="1" rowspan="1" class="confluenceTd">&#160;</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>writeResultAsHeader</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Available as of Camel 2.10.3 and 2.11:</b> In write operations (save, update, insert, etc.), instead of replacing the body with the WriteResult object returned by MongoDB, keep the input body untouched and place the WriteResult in the <tt>CamelMongoWriteResult</tt> header (constant <tt>MongoDbConstants.WRITERESULT</tt>). </td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/ima
 ges/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td><td colspan="1" rowspan="1" class="confluenceTd">&#160;</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>persistentTailTracking</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="1" class="confluenceTd"> Enables or disables persistent tail tracking for Tailable Cursor consumers. See below for more information. </td><td colspan="1" rowspan="1" class="confluenceTd">&#160;</td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>persistentId</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> none </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Required if persistent tail tracking is enabled.</b> The id of this per
 sistent tail tracker, to separate its records from the rest on the tail-tracking collection. </td><td colspan="1" rowspan="1" class="confluenceTd">&#160;</td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>tailTrackingIncreasingField</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> none </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Required if persistent tail tracking is enabled.</b> Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated. The cursor will be (re)created with a query of type: tailTrackIncreasingField &gt; lastValue (where lastValue is possibly recovered from persistent tail tracking). Can be of type Integer, Date, String, etc. NOTE: No 
 support for dot notation at the current time, so the field should be at the top level of the document. </td><td colspan="1" rowspan="1" class="confluenceTd">&#160;</td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>cursorRegenerationDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> 1000ms </td><td colspan="1" rowspan="1" class="confluenceTd"> Establishes how long the endpoint will wait to regenerate the cursor after it has been killed by the MongoDB server (normal behaviour). </td><td colspan="1" rowspan="1" class="confluenceTd">&#160;</td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td><
 /tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>tailTrackDb</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> same as endpoint's </td><td colspan="1" rowspan="1" class="confluenceTd"> Database on which the persistent tail tracker will store its runtime information. </td><td colspan="1" rowspan="1" class="confluenceTd">&#160;</td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>tailTrackCollection</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> camelTailTracking </td><td colspan="1" rowspan="1" class="confluenceTd"> Collection on which the persistent tail tracker will store its runtime information. </td><td colspan="1" rowspan="1" class="confluenceTd">&#160;</td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle
 " class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>tailTrackField</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> lastTrackingValue </td><td colspan="1" rowspan="1" class="confluenceTd"> Field in which the persistent tail tracker will store the last tracked value. </td><td colspan="1" rowspan="1" class="confluenceTd">&#160;</td><td colspan="1" rowspan="1" class="confluenceTd"> <img align="middle" class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" alt="" border="0"> </td></tr></tbody></table>
 </div>