MongoDB Connector 6.3 Reference - Mule 4

Array of Server Address

Server in which your MongoDB instance is located. You can specify multiple servers.

x

String

Database name to which you want to connect.

x

String

Username to use for authentication.

String

Password to use for authentication. If you do not want to use authentication, the password and the username must both be empty.

String

Name of the replica set to which to connect. Use this field to connect to a MongoDB cluster.

String

Authentication source.

Array of String

List of compressors to enable network compression for communication between the client and a mongod or mongos instance. If you specify multiple compressors, then the order in which you list the compressors matters. The driver uses the first compressor in the list.

Number

Integer that specifies the compression level if using zlib for network compression. 0 means no compression. 1 through 9 are the compression levels, with 1 being the lowest compression level, and 9 being the highest compression level. Higher compression levels take more time to process than lower compression levels.

-1

Number

How long the connector waits before timing out when establishing a connection to the remote service.

30

Enumeration, one of:

Time unit for the Connection Timeout field.

SECONDS

Number

Size of the latency window for selecting among multiple suitable MongoDB instances.

15

Enumeration, one of:

Time unit for the Local Threshold field.

MILLISECONDS

Number

How long to block for server selection before throwing an exception.

30

Enumeration, one of:

Time unit for the Server Selection Timeout field.

SECONDS

Number

Socket timeout. Used for I/O socket read and write operations. Set this field to 0 if you do not want socket read and write operations to time out.

Enumeration, one of:

Time unit for the Socket Timeout field.

SECONDS

Boolean

Enable retryable writes.

false

Enumeration, one of:

Authentication mechanism used for this connection.

Tls

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Number

Minimum size for the connection pool.

Number

Maximum size for the connection pool.

100

Number

Maximum wait queue time for the connection pool.

120

Enumeration, one of:

Time unit for the Max Wait Queue Time field.

SECONDS

Number

Maximum connection lifetime for the connection pool.

Enumeration, one of:

Time unit for the Max Connection Life Time field.

SECONDS

Number

Maximum connection idle time for the connection pool.

Enumeration, one of:

Time unit for the Max Connection Idle Time field.

SECONDS

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

String

URI that describes the hosts to use and their options.

x

Tls

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

String

Name of the configuration to use.

x

String

Collection that is watched to detect the matching documents.

x

String

Field that is queried to detect the objects that match the trigger condition.

x

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the user.

x

String

Password to use for authentication.

x

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the collection.

x

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Target collection.

x

Binary

Query for counting documents. Only documents matching the query are counted. If unspecified, all documents are counted. Values can be {"field1": "value1"} or can contain operators {"field1": {$gte: 1, $lt: 10}}.

String

Level of acknowledgment requested from MongoDB for write operations propagated to the specified number of MongoDB instances. You can specify a number of instances, for example, n>0, or use a value from the list.

Number

Specifies a time limit, in milliseconds, for Write Concern Acknowledgement. The value must be greater than 1.

Enumeration, one of:

Time unit for the Write Concern Timeout field.

SECONDS

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the collection to create.

x

Number

Maximum number of documents the new collection contains.

Number

Maximum size of the new collection.

Enumeration, one of:

Data unit of the Collection Size field.

BYTE

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Binary

Content of the new file. This content is an InputStream.

#[payload]

x

String

Name of the new file.

x

Binary

JSON object that holds information to store.

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the collection in which the index is created.

x

String

Name of the field that is indexed.

x

Enumeration, one of:

Indexing order.

ASC

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the collection to drop.

x

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the database to drop.

x

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the collection.

x

String

Name of the index to drop.

x

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Output directory in which dump files are created.

x

String

Output file name prefix. If unspecified, the database name is used.

Boolean

Point in time backup (requires an oplog).

false

Number

Maximum wait time for the dump.

60

Enumeration, one of:

Time unit for the Operation Timeout field.

SECONDS

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Binary

Command to execute on the database as a document.

#[payload]

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Binary

Query for finding documents. If unspecified, all documents are retrieved. Values can be {"field1": "value1"} or can contain operators {"field1": {$gte: 1, $lt: 10}}.

Binary

Indicates the document used to sort the results. Use [{"yourField":"ASC"}] to sort by ascending, or [{"yourField":"DESC"}] to sort by descending.

Number

Size of the documents of each page to return.

100

Number

Limit of the documents to return.

String

Level of acknowledgment requested from MongoDB for write operations propagated to the specified number of MongoDB instances. You can specify a number of instances, for example, n>0, or use a value from the list.

Number

Specifies a time limit, in milliseconds, for Write Concern Acknowledgement. The value must be greater than 1.

Enumeration, one of:

Time unit for the Write Concern Timeout field.

SECONDS

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Collection name.

x

String

Comma-separated list of fields to return from each document. To return all fields, type a single comma character.

x

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Binary

Query for listing all files. Values can be {"field1": "value1"} or can contain operators {"field1": {$gte: 1, $lt: 10}}.

Binary

Enables you to sort the result list. A file is sorted by file ID or upload date.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Binary

Mandatory file ID.

#[payload]

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the collection in which to insert the given document.

x

Binary

Document to insert.

#[payload]

String

Level of acknowledgment requested from MongoDB for write operations propagated to the specified number of MongoDB instances. You can specify a number of instances, for example, n>0, or use a value from the list.

Number

Specifies a time limit, in milliseconds, for Write Concern Acknowledgement. The value must be greater than 1.

Enumeration, one of:

Time unit for the Write Concern Timeout field.

SECONDS

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the collection in which to insert the given document.

x

Binary

List of the documents to insert.

#[payload]

Boolean

Indicates whether the list of documents are executed in order. If set to true and an error occurs during the processing of one of the write operations, MongoDB returns without processing any remaining write operations in the list.

false

String

Level of acknowledgment requested from MongoDB for write operations propagated to the specified number of MongoDB instances. You can specify a number of instances, for example, n>0, or use a value from the list.

Number

Specifies a time limit, in milliseconds, for Write Concern Acknowledgement. The value must be greater than 1.

Enumeration, one of:

Time unit for the Write Concern Timeout field.

SECONDS

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the collection.

x

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the collection to map and reduce.

x

String

JavaScript-encoded mapping function.

x

String

JavaScript-encoded reducing function.

x

String

Name of the output collection to which to write the results. This replaces an existing collection, if any exists. This field is mandatory if the resulting objects are larger than 16 MB. If Output Collection is unspecified, the computation is performed in-memory and is not persisted.

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Collection for which to remove elements.

x

Binary

Query for detecting the elements to delete. Values can be {"field1": "value1"} or can contain operators {"field1": {$gte: 1, $lt: 10}}.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Binary

ID of the file to delete.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Input path of the dump files. This path must be a directory.

x

Boolean

Indicates whether to drop existing collections before performing the restore.

false

Boolean

Replay oplog used for point-in-time restore.

false

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the collection to restore.

x

Binary

InputStream that points to the dump file. It can be a .bson file or a zip file.

#[payload]

Boolean

Indicates whether to drop existing collections before performing the restore.

false

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the collection to update.

x

Binary

Query for detecting the element to update. Values can be {"field1": "value1"} or can contain operators {"field1": {$gte: 1, $lt: 10}}.

Binary

Object to replace the document that matches the query.

#[payload]

Boolean

Indicates whether only the first document matching the query is updated.

false

Boolean

If set to true, creates a new document when no document matches the query criteria. The default value is false, which does not insert a new document when no match is found.

false

String

Level of acknowledgment requested from MongoDB for write operations propagated to the specified number of MongoDB instances. You can specify a number of instances, for example, n>0, or use a value from the list.

Number

Specifies a time limit, in milliseconds, for Write Concern Acknowledgement. The value must be greater than 1.

Enumeration, one of:

Time unit for the Write Concern Timeout field.

SECONDS

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Retry strategy in case of connectivity errors.

Any

Exception.

Any

ID.

String

Message.

Binary

Payload.

String

Status code.

Boolean

Indicates success.

Any

ID.

Array of Bulk Item

Array of items.

Boolean

Indicates success.

String

Path to the CRL file.

String

URL of the OCSP responder.

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Enumeration, one of:

Time unit for the Max Idle Time field.

String

Field name.

String

Name of the index.

Enumeration, one of:

Order of the index.

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

String

Type of keystore.

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

String

Password used to protect the private key.

String

Password used to protect the keystore.

String

Encryption algorithm that the keystore uses.

Object

Name value.

x

Number

How often to attempt to reconnect, in milliseconds.

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Number

How many reconnection attempts the Mule app can make.

Number

How often to attempt to reconnect, in milliseconds.

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

Reconnection strategy to use.

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

String

One or more expressions that determine if a message is redelivered. This property can be set only if the Use Secure Hash field is false.

ObjectStore

Configures the object store that stores the redelivery counter for each message.

Number

Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Enumeration, one of:

Unit for the In Memory Size field.

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

Enumeration, one of:

Unit for the In Memory Size field.

Number

Amount of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the Buffer Size Increment attribute, with an upper limit of Max In Memory Size. Default value is 100 instances.

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower means that the buffer must not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Number

Maximum amount of memory to use. If more than that is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to 0 means no limit.

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Enumeration, one of:

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

String

Host to which you want to connect.

x

Number

Port of the host to which you want to connect.

27017

Boolean

Which elements to verify in the certificate chain:

Boolean

How to check certificate validity:

Boolean

Whether to use the secondary method to check certificate validity:

Boolean

What to do if the revocation server can’t be reached or is busy:

String

Comma-separated list of protocols enabled for this context.

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Configures the TLS truststore.

Key Store

Configures the TLS keystore.

Configures a revocation checking mechanism.

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

String

Password used to protect the truststore.

String

Type of truststore.

String

Encryption algorithm that the truststore uses.

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.