org.mule.modules

mule-module-mongo

config

Namespace	http://www.mulesoft.org/schema/mule/mongo
Schema Location	http://www.mulesoft.org/schema/mule/mongo/current/mule-mongo.xsd (View Schema)
Schema Version	2.0
Minimum Mule Version	3.3

Module Overview

MongoDB is an open source, high-performance, schema-free, document-oriented database that manages collections of BSON documents.

Summary

Configuration
<mongo:config> Configure an instance of this module

Transformers
<mongo:bson-list-to-json> Convert a BasicBSONList into Json.
<mongo:db-object-to-map> Convert a DBObject into Map.
<mongo:dbobject-to-json> Convert DBObject to Json.
<mongo:json-to-dbobject> Convert JSON to DBObject.
<mongo:mongo-collection-to-json> Convert a BasicBSONList into Json.

Message Processors
<mongo:add-user> Adds a new user for this db
<mongo:count-objects> Counts the number of objects that match the given query.
<mongo:count-objects-using-query-map> Counts the number of objects that match the given query.
<mongo:create-collection> Creates a new collection.
<mongo:create-file-from-payload> Creates a new GridFSFile in the database, saving the given content, filename, contentType, and extraData, and answers it.
<mongo:create-index> Creates a new index
<mongo:drop-collection> Deletes a collection and all the objects it contains.
<mongo:drop-database> Drop the current database
<mongo:drop-index> Drops an existing index
<mongo:dump> Executes a dump of the database to the specified output directory.
<mongo:execute-command> Executes a command on the database
<mongo:exists-collection> Answers if a collection exists given its name
<mongo:find-files> Lists all the files that match the given query
<mongo:find-files-using-query-map> Lists all the files that match the given query
<mongo:find-objects> Finds all objects that match a given query.
<mongo:find-objects-using-query-map> Finds all objects that match a given query.
<mongo:find-one-file> Answers the first file that matches the given query.
<mongo:find-one-file-using-query-map> Answers the first file that matches the given query.
<mongo:find-one-object> Finds the first object that matches a given query.
<mongo:find-one-object-using-query-map> Finds the first object that matches a given query.
<mongo:get-file-content> Answers an inputstream to the contents of the first file that matches the given query.
<mongo:get-file-content-using-query-map> Answers an inputstream to the contents of the first file that matches the given queryAttributes.
<mongo:incremental-dump> Executes an incremental dump of the database
<mongo:insert-object> Inserts an object in a collection, setting its id if necessary.
<mongo:insert-object-from-map> Inserts an object in a collection, setting its id if necessary.
<mongo:list-collections> Lists names of collections available at this database
<mongo:list-files> Lists all the files that match the given query, sorting them by filename.
<mongo:list-files-using-query-map> Lists all the files that match the given query, sorting them by filename.
<mongo:list-indices> List existent indices in a collection
<mongo:map-reduce-objects> Transforms a collection into a collection of aggregated groups, by applying a supplied element-mapping function to each element, that transforms each one into a key-value pair, grouping the resulting pairs by key, and finally reducing values in each group applying a suppling 'reduce' function.
<mongo:remove-files> Removes all the files that match the given query.
<mongo:remove-files-using-query-map> Removes all the files that match the given query.
<mongo:remove-objects> Removes all the objects that match the a given optional query.
<mongo:remove-using-query-map> Removes all the objects that match the a given optional query.
<mongo:restore> Takes the output from the dump and restores it.
<mongo:save-object> Inserts or updates an object based on its object _id.
<mongo:save-object-from-map> Inserts or updates an object based on its object _id.
<mongo:update-objects> Updates objects that matches the given query.
<mongo:update-objects-by-function> Update objects using a mongo function
<mongo:update-objects-by-function-using-map> Update objects using a mongo function
<mongo:update-objects-using-map> Updates objects that matches the given query.
<mongo:update-objects-using-query-map> Updates objects that matches the given query.

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:mongo="http://www.mulesoft.org/schema/mule/mongo"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/mongo
               http://www.mulesoft.org/schema/mule/mongo/current/mule-mongo.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necessary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
Type	Name	Default Value	Description	Java Type	MIME Type	Encoding
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
xs:boolean	autoConnectRetry		Optional. This controls whether the system retries automatically on connection errors.
xs:int	connectTimeout	30000	Optional. The connection timeout in milliseconds; this is for establishing the socket connections (open).
xs:int	connectionsPerHost		Optional. The number of connections allowed per host (the pool size, per host)
xs:boolean	fsync		Optional. Sets the fsync value of WriteConcern for the connection.
xs:string	host	localhost	Optional. The host of the Mongo server, it can also be a list of comma separated hosts for replicas
xs:int	maxWaitTime		Optional. The max wait time for a blocking thread for a connection from the pool in ms.
xs:int	port	27017	Optional. The port of the Mongo server
xs:boolean	safe		Optional. If the driver sends a getLastError command after every update to ensure it succeeded.
xs:boolean	slaveOk		Optional. Specifies if the driver is allowed to read from secondaries or slaves.
xs:int	socketTimeout		Optional. The socket timeout.
xs:int	threadsAllowedToBlockForConnectionMultiplier		Optional. Multiplier for connectionsPerHost for # of threads that can block
xs:int	w		Optional. If set, the w value of WriteConcern for the connection is set to this.
xs:int	wtimeout		Optional. If set, the wtimeout value of WriteConcern for the connection is set to this.

Connection Pool

This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.

Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.

The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:

    <mongo:connection-pooling-profile maxActive="10" maxIdle="10"
                             exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>

The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.

Connection Attributes
Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
username		The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Reconnection Strategies

Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:

The type of exception
Number and frequency of reconnection attempts
The notifications generated, and more

With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.

Configuration

A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.

    <mongo:config>
         <reconnect count="5" frequency="1000"/>
    </mongo:config>

Reconnect Attributes
Name	Default Value	Description
frequency	2000	Optional. How often (in ms) to reconnect
count	2	Optional. How many reconnection attempts to make

For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.

Message Processors

<mongo:add-user>

Adds a new user for this db

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
newUsername		Name of the user	String	/	UTF-8
newPassword		Password that will be used for authentication	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

<mongo:count-objects>

Counts the number of objects that match the given query. If no query is passed, returns the number of elements in the collection

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The target collection	String	/	UTF-8
query	#[payload]	Optional. The optional DBObject query for counting objects. Only objects matching it will be counted. If unspecified, all objects are counted.	DBObject	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Returns

Return Type	Description
long	the amount of objects that matches the query

<mongo:count-objects-using-query-map>

Counts the number of objects that match the given query. If no query is passed, returns the number of elements in the collection

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The target collection	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<mongo:query-attributes>		Optional. The optional query for counting objects. Only objects matching it will be counted. If unspecified, all objects are counted.	Map<String, Object>

Returns

Return Type	Description
long	the amount of objects that matches the query

<mongo:create-collection>

Creates a new collection. If the collection already exists, a MongoException will be thrown.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The name of the collection to create	String	/	UTF-8
capped	false	Optional. If the collection will be capped	boolean	/
maxObjects		Optional. The maximum number of documents the new collection is able to contain	Integer	/
size		Optional. The maximum size of the new collection	Integer	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

<mongo:create-file-from-payload>

Creates a new GridFSFile in the database, saving the given content, filename, contentType, and extraData, and answers it.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payload		The mandatory content of the new gridfs file. It may be a java.io.File, a byte[] or an InputStream.	Object	/
filename		The mandatory name of new file.	String	/	UTF-8
contentType		Optional. The optional content type of the new file	String	/	UTF-8
metadata		Optional. The optional DBObject metadata of the new content type	DBObject	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Returns

Return Type	Description
DBObject	the new GridFSFile DBObject

Exception Payloads

Payload Class	Description
IOException	IOException

<mongo:create-index>

Creates a new index

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The name of the collection where the index will be created	String	/	UTF-8
field		The name of the field which will be indexed	String	/	UTF-8
order	ASC	Optional. The indexing order	IndexOrder	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

<mongo:drop-collection>

Deletes a collection and all the objects it contains. If the collection does not exist, does nothing.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The name of the collection to drop	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

<mongo:drop-database>

Drop the current database

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

<mongo:drop-index>

Drops an existing index

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The name of the collection where the index is	String	/	UTF-8
index		The name of the index to drop	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

<mongo:dump>

Executes a dump of the database to the specified output directory. If no output directory is provided then the default /dump directory is used.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
outputDirectory	dump	Optional. Output directory path, if no output directory is provided the default /dump directory is assumed	String	/	UTF-8
outputName		Optional. Output file name, if it's not specified the database name is used	String	/	UTF-8
zip	false	Optional. Whether to zip the created dump file or not	boolean	/
oplog	false	Optional. Point in time backup (requires an oplog)	boolean	/
threads	5	Optional. Amount of threads to execute the dump	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	if an error occurs during the dump

<mongo:execute-command>

Executes a command on the database

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
commandName		The command to execute on the database	String	/	UTF-8
commandValue		Optional. The value for the command	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Returns

Return Type	Description
DBObject	The result of the command

<mongo:exists-collection>

Answers if a collection exists given its name

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The name of the collection	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Returns

Return Type	Description
boolean	if the collection exists

<mongo:find-files>

Lists all the files that match the given query

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
query	#[payload]	Optional. A DBObject query the optional query	DBObject	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Returns

Return Type	Description
Iterable<DBObject>	a DBObject files iterable

<mongo:find-files-using-query-map>

Lists all the files that match the given query

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<mongo:query-attributes>		Optional. The optional query attributes	Map<String, Object>

Returns

Return Type	Description
Iterable<DBObject>	a DBObject files iterable

<mongo:find-objects>

Finds all objects that match a given query. If no query is specified, all objects of the collection are retrieved. If no fields object is specified, all fields are retrieved.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The target collection	String	/	UTF-8
query		Optional. The optional DBObject query object. If unspecified, all documents are returned.	DBObject	/
numToSkip		Optional. Number of objects skip (offset)	Integer	/
limit		Optional. Limit of objects to return	Integer	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<mongo:fields>		Optional. Alternative way of passing fields as a literal List	List<String>

Returns

Return Type	Description
Iterable<DBObject>	an iterable of DBObject

<mongo:find-objects-using-query-map>

Finds all objects that match a given query. If no query is specified, all objects of the collection are retrieved. If no fields object is specified, all fields are retrieved.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The target collection	String	/	UTF-8
numToSkip		Optional. Number of objects skip (offset)	Integer	/
limit		Optional. Limit of objects to return	Integer	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<mongo:query-attributes>		Optional. The optional query object. If unspecified, all documents are returned.	Map<String, Object>
<mongo:fields>		Optional. Alternative way of passing fields as a literal List	List<String>

Returns

Return Type	Description
Iterable<DBObject>	an iterable of DBObject

<mongo:find-one-file>

Answers the first file that matches the given query. If no object matches it, a MongoException is thrown.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
query		The DBObject mandatory query	DBObject	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Returns

Return Type	Description
DBObject	a DBObject

<mongo:find-one-file-using-query-map>

Answers the first file that matches the given query. If no object matches it, a MongoException is thrown.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<mongo:query-attributes>		The mandatory query	Map<String, Object>

Returns

Return Type	Description
DBObject	a DBObject

<mongo:find-one-object>

Finds the first object that matches a given query. Throws a MongoException if no one matches the given query

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The target collection	String	/	UTF-8
query	#[payload]	Optional. The mandatory DBObject query object that the returned object matches.	DBObject	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<mongo:fields>		Optional. Alternative way of passing fields as a literal List	List<String>

Returns

Return Type	Description
DBObject	a non-null DBObject that matches the query.

<mongo:find-one-object-using-query-map>

Finds the first object that matches a given query. Throws a MongoException if no one matches the given query

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The target collection	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<mongo:query-attributes>		The mandatory query object that the returned object matches.	Map<String, Object>
<mongo:fields>		Optional. Alternative way of passing fields as a literal List	List<String>

Returns

Return Type	Description
DBObject	a non-null DBObject that matches the query.

<mongo:get-file-content>

Answers an inputstream to the contents of the first file that matches the given query. If no object matches it, a MongoException is thrown.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
query	#[payload]	Optional. The DBObject mandatory query	DBObject	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Returns

Return Type	Description
InputStream	an InputStream to the file contents

<mongo:get-file-content-using-query-map>

Answers an inputstream to the contents of the first file that matches the given queryAttributes. If no object matches it, a MongoException is thrown.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<mongo:query-attributes>		The mandatory query attributes	Map<String, Object>

Returns

Return Type	Description
InputStream	an InputStream to the file contents

<mongo:incremental-dump>

Executes an incremental dump of the database

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
outputDirectory	dump	Optional. Output directory path, if no output directory is provided the default /dump directory is assumed	String	/	UTF-8
incrementalTimestampFile		Optional. File that keeps track of the last timestamp processed, if no file is provided one is created on the output directory	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	if an error occurs during the incremental dump

<mongo:insert-object>

Inserts an object in a collection, setting its id if necessary.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The name of the collection where to insert the given object	String	/	UTF-8
dbObject	#[payload]	Optional. A DBObject instance.	DBObject	/
writeConcern	DATABASE_DEFAULT	Optional. The optional write concern of insertion	WriteConcern	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Returns

Return Type	Description
String	the id that was just insterted

<mongo:insert-object-from-map>

Inserts an object in a collection, setting its id if necessary.

A shallow conversion into DBObject is performed - that is, no conversion is performed to its values.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The name of the collection where to insert the given object	String	/	UTF-8
writeConcern	DATABASE_DEFAULT	Optional. The optional write concern of insertion	WriteConcern	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<mongo:element-attributes>		Optional. Alternative way of specifying the element as a literal Map inside a Mule Flow	Map<String, Object>

Returns

Return Type	Description
String	the id that was just insterted

<mongo:list-collections>

Lists names of collections available at this database

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Returns

Return Type	Description
Collection<String>	the list of names of collections available at this database

<mongo:list-files>

Lists all the files that match the given query, sorting them by filename. If no query is specified, all files are listed.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
query	#[payload]	Optional. The DBObject optional query	DBObject	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Returns

Return Type	Description
Iterable<DBObject>	an iterable of DBObject

<mongo:list-files-using-query-map>

Lists all the files that match the given query, sorting them by filename. If no query is specified, all files are listed.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<mongo:query-attributes>		Optional. The optional query	Map<String, Object>

Returns

Return Type	Description
Iterable<DBObject>	an iterable of DBObject

<mongo:list-indices>

List existent indices in a collection

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The name of the collection	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Returns

Return Type	Description
Collection<DBObject>	a collection of DBObject with indices information

<mongo:map-reduce-objects>

Transforms a collection into a collection of aggregated groups, by applying a supplied element-mapping function to each element, that transforms each one into a key-value pair, grouping the resulting pairs by key, and finally reducing values in each group applying a suppling 'reduce' function.

Each supplied function is coded in JavaScript.

Note that the correct way of writing those functions may not be obvious; please consult MongoDB documentation for writing them.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The name of the collection to map and reduce	String	/	UTF-8
mapFunction		A JavaScript encoded mapping function	String	/	UTF-8
reduceFunction		A JavaScript encoded reducing function	String	/	UTF-8
outputCollection		Optional. The name of the output collection to write the results, replacing previous collection if existed, mandatory when results may be larger than 16MB. If outputCollection is unspecified, the computation is performed in-memory and not persisted.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Returns

Return Type	Description
Iterable<DBObject>	an iterable that retrieves the resulting collection of DBObject

<mongo:remove-files>

Removes all the files that match the given query. If no query is specified, all files are removed

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
query	#[payload]	Optional. The DBObject optional query	DBObject	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

<mongo:remove-files-using-query-map>

Removes all the files that match the given query. If no query is specified, all files are removed

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<mongo:query-attributes>		Optional. The optional query	Map<String, Object>

<mongo:remove-objects>

Removes all the objects that match the a given optional query. If query is not specified, all objects are removed. However, please notice that this is normally less performant that dropping the collection and creating it and its indices again

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The collection whose elements will be removed	String	/	UTF-8
query	#[payload]	Optional. The optional DBObject query object. Objects that match it will be removed.	DBObject	/
writeConcern	DATABASE_DEFAULT	Optional. The write concern used to remove the object	WriteConcern	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

<mongo:remove-using-query-map>

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The collection whose elements will be removed	String	/	UTF-8
writeConcern	DATABASE_DEFAULT	Optional. The write concern used to remove the object	WriteConcern	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<mongo:query-attributes>		The query object. Objects that match it will be removed.	Map<String, Object>

<mongo:restore>

Takes the output from the dump and restores it. Indexes will be created on a restore. It only does inserts with the data to restore, if existing data is there, it will not be replaced.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
inputPath	dump	Optional. Input path to the dump files, it can be a directory, a zip file or just a bson file	String	/	UTF-8
drop	false	Optional. Whether to drop existing collections before restore	boolean	/
oplogReplay	false	Optional. Replay oplog for point-in-time restore	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	if an error occurs during restore of the database

<mongo:save-object>

Inserts or updates an object based on its object _id.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The collection where to insert the object	String	/	UTF-8
element	#[payload]	Optional. The mandatory DBObject object to insert.	DBObject	/
writeConcern	DATABASE_DEFAULT	Optional. The write concern used to persist the object	WriteConcern	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

<mongo:save-object-from-map>

Inserts or updates an object based on its object _id.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The collection where to insert the object	String	/	UTF-8
writeConcern	DATABASE_DEFAULT	Optional. The write concern used to persist the object	WriteConcern	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<mongo:element-attributes>		The mandatory object to insert.	Map<String, Object>

<mongo:update-objects>

Updates objects that matches the given query. If parameter multi is set to false, only the first document matching it will be updated. Otherwise, all the documents matching it will be updated.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The name of the collection to update	String	/	UTF-8
query		The DBObject query object used to detect the element to update.	DBObject	/
element	#[payload]	Optional. The DBObject mandatory object that will replace that one which matches the query.	DBObject	/
upsert	false	Optional. If the database should create the element if it does not exist	boolean	/
multi	true	Optional. If all or just the first object matching the query will be updated	boolean	/
writeConcern	DATABASE_DEFAULT	Optional. The write concern used to update	WriteConcern	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

<mongo:update-objects-by-function>

Update objects using a mongo function

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The name of the collection to update	String	/	UTF-8
function		The function used to execute the update	String	/	UTF-8
query		The DBObject query object used to detect the element to update.	DBObject	/
element		The DBObject mandatory object that will replace that one which matches the query.	DBObject	/
upsert	false	Optional. If the database should create the element if it does not exist	boolean	/
multi	true	Optional. If all or just the first object matching the query will be updated	boolean	/
writeConcern	DATABASE_DEFAULT	Optional. The write concern used to update	WriteConcern	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

<mongo:update-objects-by-function-using-map>

Update objects using a mongo function

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The name of the collection to update	String	/	UTF-8
function		The function used to execute the update	String	/	UTF-8
upsert	false	Optional. If the database should create the element if it does not exist	boolean	/
multi	true	Optional. If all or just the first object matching the query will be updated	boolean	/
writeConcern	DATABASE_DEFAULT	Optional. The write concern used to update	WriteConcern	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<mongo:query-attributes>		The query object used to detect the element to update.	Map<String, Object>
<mongo:element-attributes>		The mandatory object that will replace that one which matches the query.	Map<String, Object>

<mongo:update-objects-using-map>

Updates objects that matches the given query. If parameter multi is set to false, only the first document matching it will be updated. Otherwise, all the documents matching it will be updated.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The name of the collection to update	String	/	UTF-8
upsert	false	Optional. If the database should create the element if it does not exist	boolean	/
multi	true	Optional. If all or just the first object matching the query will be updated	boolean	/
writeConcern	DATABASE_DEFAULT	Optional. The write concern used to update	WriteConcern	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<mongo:query-attributes>		The query object used to detect the element to update.	Map<String, Object>
<mongo:element-attributes>		The mandatory object that will replace that one which matches the query.	Map<String, Object>

<mongo:update-objects-using-query-map>

Updates objects that matches the given query. If parameter multi is set to false, only the first document matching it will be updated. Otherwise, all the documents matching it will be updated.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
collection		The name of the collection to update	String	/	UTF-8
element		The DBObject mandatory object that will replace that one which matches the query.	DBObject	/
upsert	false	Optional. If the database should create the element if it does not exist	boolean	/
multi	true	Optional. If all or just the first object matching the query will be updated	boolean	/
writeConcern	DATABASE_DEFAULT	Optional. The write concern used to update	WriteConcern	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<mongo:query-attributes>		The query object used to detect the element to update.	Map<String, Object>

Message Sources

Transformers

<mongo:bson-list-to-json>

Convert a BasicBSONList into Json.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
input		The input for this transformer	BasicBSONList	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Returns

Return Type	Description
String	the converted string representation

<mongo:db-object-to-map>

Convert a DBObject into Map.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
input		The input for this transformer	DBObject	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Returns

Return Type	Description
Map	the converted Map representation

<mongo:dbobject-to-json>

Convert DBObject to Json.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
input		The input for this transformer	DBObject	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Returns

Return Type	Description
String	the converted string representation

<mongo:json-to-dbobject>

Convert JSON to DBObject.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
input		The input for this transformer	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Returns

Return Type	Description
DBObject	the converted DBObject

<mongo:mongo-collection-to-json>

Convert a BasicBSONList into Json.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
input		The input for this transformer	MongoCollection	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The username to use for authentication. NOTE: Please use a dummy user if you have disabled Mongo authentication	String	/	UTF-8
password		Optional. The password to use for authentication. NOTE: Please use a dummy password if you have disabled Mongo authentication	String	/	UTF-8
database	test	Optional. Name of the database	String	/	UTF-8

Returns

Return Type	Description
String	the converted string representation