Page History

...

Name	Default Value	Description
`database`	none	Required. 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 `CamelMongoDbDatabase` header is set.
`collection`	none	Required (Except for getDbStats and command operations). The name of the collection (within the specified database) to which this endpoint will be bound. All operations will be executed against this database unless dynamicity is enabled and the `CamelMongoDbDatabase` header is set.
`collectionIndex`	none	Camel 2.12: An optional single field index or compound index to create when inserting new collections.
`operation`	none	Required for producers. The id of the operation this endpoint will execute. Pick from the following: Query operations: `findById`, `findOneByQuery`, `findAll`, `count` Write operations: `insert`, `save`, `update` Delete operations: `remove` Other operations: `getDbStats`, `getColStats`, `aggregate, command`
`createCollection`	true	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 `false` and the collection doesn't exist, an initialisation exception will be thrown.
`invokeGetLastError`	false (behaviour may be inherited from connections WriteConcern)	Instructs the MongoDB Java driver to invoke `getLastError()` 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 `getLastError()` on the `WriteResult` object returned or by setting the appropriate `WriteConcern`. If the backend operation has not finished yet, the client will block until the result is available. Setting this option to `true` will make the endpoint behave synchronously and return an Exception if the underlying operation failed.
`writeConcern`	none (driver's default)	Set a `WriteConcern` on the operation out of MongoDB's parameterised values. See WriteConcern.valueOf(String).
`writeConcernRef`	none	Sets a custom `WriteConcern` that exists in the Registry. Specify the bean name.
`readPreference`	none	Available as of Camel 2.12.4, 2.13.1 and 2.14.0: Sets a ReadPreference on the connection. Accepted values are those supported by the ReadPreference#valueOf() public API. Currently as of MongoDB-Java-Driver version 2.12.0 the supported values are: `primary`, `primaryPreferred`, `secondary`, `secondaryPreferred` and `nearest`. See also the documentation for more details about this option.
`dynamicity`	false	If set to true, the endpoint will inspect the `CamelMongoDbDatabase` and `CamelMongoDbCollection` 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.
`writeResultAsHeader`	false	Available as of Camel 2.10.3 and 2.11: 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 `CamelMongoWriteResult` header (constant `MongoDbConstants.WRITERESULT`).
`persistentTailTracking`	false	Enables or disables persistent tail tracking for Tailable Cursor consumers. See below for more information.
`persistentId`	none	Required if persistent tail tracking is enabled. The id of this persistent tail tracker, to separate its records from the rest on the tail-tracking collection.
`tailTrackingIncreasingField`	none	Required if persistent tail tracking is enabled. 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 > 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.
`cursorRegenerationDelay`	1000ms	Establishes how long the endpoint will wait to regenerate the cursor after it has been killed by the MongoDB server (normal behaviour).
`tailTrackDb`	same as endpoint's	Database on which the persistent tail tracker will store its runtime information.
`tailTrackCollection`	camelTailTracking	Collection on which the persistent tail tracker will store its runtime information.
`tailTrackField`	lastTrackingValue	Field in which the persistent tail tracker will store the last tracked value.

...

Anchor

	FieldsFilter
	FieldsFilter

Specifying a fields filter

Query operations will, by default, return the matching objects in their entirety (with all their fields). If your documents are large and you only require retrieving a subset of their fields, you can specify a field filter in all query operations, simply by setting the relevant DBObject (or type convertible to DBObject, such as a JSON String, Map, etc.) on the CamelMongoDbFieldsFilter header, constant shortcut: MongoDbConstants.FIELDS_FILTER.

count

Returns the total number of objects in a collection, returning a Long as the OUT message body.
The following example will count the number of records in the "dynamicCollectionName" collection. Notice how dynamicity is enabled, and as a result, the operation will not run against the "notableScientists" collection, but against the "dynamicCollectionName" collection.Here is an example that uses MongoDB's BasicDBObjectBuilder to simplify the creation of DBObjects. It retrieves all fields except _id and boringField:

Code Block

// route: fromfrom("direct:findAllcount").to("mongodb:myDb?database=flightstickets&collection=ticketsflights&operation=findAll")
DBObject fieldFilter = BasicDBObjectBuilder.start().add("_id", 0).add("boringField", 0).get();
Objectcount&dynamicity=true");
Long result = template.requestBodyAndHeader("direct:findAllcount", (Object) null"irrelevantBody", MongoDbConstants.FIELDS_FILTERCOLLECTION, fieldFilter);
"dynamicCollectionName");
assertTrue("Result is not of type Long", result instanceof Long);

From Camel 2.14 onwards you can provide a com.mongodb.DBObject object in the message body as a query, and operation will return the amount of documents matching this criteria.

Code Block
DBObject query = ... Long count = template.requestBodyAndHeader("direct:count", query, MongoDbConstants.COLLECTION, "dynamicCollectionName");

Specifying a fields filter

Query operations will, by default, return the matching objects in their entirety (with all their fields). If your documents are large and you only require retrieving a subset of their fields, you can specify a field filter in all query operations, simply by setting the relevant DBObject (or type convertible to DBObject, such as a JSON String, Map, etc.) on the CamelMongoDbFieldsFilter header, constant shortcut: MongoDbConstants.FIELDS_FILTER.

Here is an example that uses MongoDB's BasicDBObjectBuilder to simplify the creation of DBObjects. It retrieves all fields except _id and boringField:

Code Block

// 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);

Create/update Create/update operations

insert

Inserts an new object into the MongoDB collection, taken from the IN message body. Type conversion is attempted to turn it into DBObject or a List.
Two modes are supported: single insert and multiple insert. For multiple insert, the endpoint will expect a List, Array or Collections of objects of any type, as long as they are - or can be converted to - DBObject. All objects are inserted at once. The endpoint will intelligently decide which backend operation to invoke (single or multiple insert) depending on the input.

...

A header with key CamelMongoDbRecordsAffected is returned (MongoDbConstants.RECORDS_AFFECTED constant) with type int, containing the number of records deleted (copied from WriteResult.getN()).

Other operations

count

Returns the total number of objects in a collection, returning a Long as the OUT message body.
The following example will count the number of records in the "dynamicCollectionName" collection. Notice how dynamicity is enabled, and as a result, the operation will not run against the "notableScientists" collection, but against the "dynamicCollectionName" collection.

aggregate

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.

Code Block

// route: from("direct:countaggregate").to("mongodb:myDb?database=ticketsscience&collection=flightsnotableScientists&operation=count&dynamicity=trueaggregate");
Long result = template.requestBodyAndHeader("direct:count", "irrelevantBody", MongoDbConstants.COLLECTION, "dynamicCollectionName");
assertTrue("Result is not of type Long", result instanceof Long);

From Camel 2.14 onwards you can provide a com.mongodb.DBObject object in the message body as a query, and operation will return the amount of documents matching this criteria.

Code Block

DBObject query = ...
Long count = template.requestBodyAndHeader("direct:count", query, MongoDbConstants.COLLECTION, "dynamicCollectionName");
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");

getDbStats

Equivalent of running the db.stats() command in the MongoDB shell, which displays useful statistic figures about the database.
For example:

...

Code Block

> db.camelTest.stats();
{
	"ns" : "test.camelTest",
	"count" : 100,
	"size" : 5792,
	"avgObjSize" : 57.92,
	"storageSize" : 20480,
	"numExtents" : 2,
	"nindexes" : 1,
	"lastExtentSize" : 16384,
	"paddingFactor" : 1,
	"flags" : 1,
	"sizetotalIndexSize" : 57928176,
	"avgObjSizeindexSizes" : 57.92,{
		"storageSize_id_" : 204808176
	},
	"numExtentsok" : 2,
	"nindexes" : 1,
	"lastExtentSize" : 16384,
	"paddingFactor" : 1,
	"flags" : 1,
	"totalIndexSize" : 8176,
	"indexSizes" : {
		"_id_" : 8176
	},
	"ok" : 1
}

Usage example:

1
}

Usage example:

Code Block

// 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);

The operation will return a data structure similar to the one displayed in the shell, in the form of a DBObject in the OUT message body.

command

Available as of Camel 2.15

Run the body as a command on database. Usefull for admin operation as getting host informations, replication or sharding status.

Collection parameter is not use for this operation.

Code Block

// route: from("command

Code Block

// from("direct:getColStats").to("mongodb:myDb?database=flightsscience&collection=tickets&operation=getColStatscommand");
ObjectDBObject resultcommandBody = template.requestBodynew BasicDBObject("direct:getColStatshostInfo", "irrelevantBody1");
assertTrue("Result is not of type DBObject", result instanceof DBObject);

...

Object result = template.requestBody("direct:command", commandBody);

Dynamic operations

An Exchange can override the endpoint's fixed operation by setting the CamelMongoDbOperation header, defined by the MongoDbConstants.OPERATION_HEADER constant.
The values supported are determined by the MongoDbOperation enumeration and match the accepted values for the operation parameter on the endpoint URI.

...

Child pages

Versions Compared

Old Version 48

New Version 49

Key

Specifying a fields filter

count

Specifying a fields filter

Create/update Create/update operations

insert

Other operations

count

aggregate

Available as of Camel 2.14

getDbStats

command

Dynamic operations