salesforce Say hello to Einstein GPT
Contact Us 1-800-664-9073
  1. Homepage
  2. MongoDB Connector
  3. MongoDB Connector Reference
All Connectors

MongoDB Connector Reference - Mule 4

MongoDB Connector v5.3

Anypoint Connector for MongoDB is a closed-source connector that provides a connection between the Mule runtime and third-party software on a MongoDB server.

Release Notes: MongoDB Connector Release Notes

Configurations

Config

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when it sees fit.

Enable Metadata

Boolean

collectionMetadataSamples: Stores templates to build metadata based on Document parameters union Key (String): Collection Name. List<String>: List of ObjectIDs Documents in specific collection.

true

Collection Metadata samples

Object

Connection Types

Connection
Parameters
Name Type Description Default Value Required

Servers (host:port)

String

A list of MongoDB instance, with the format host:port, separated by commas. Example: 127.0.0.1:27017, 192.168.1.2:27017

localhost:27017

Connections Per Host

Number

The number of connections allowed per host (the pool size, per host).

100

Threads Allowed To Block For Connection Multiplier

Number

Multiplier for connectionsPerHost for # of threads that can block.

5

Max Wait Time

Number

The max wait time for a blocking thread for a connection from the pool in milliseconds.

120000

Connect Timeout

Number

The connection timeout in milliseconds; this is for establishing the socket connections (open). 0 is default and infinite.

30000

Socket Timeout

Number

The socket timeout. 0 is default and infinite.

0

Username

String

The username to use for authentication.

Password

String

The password to use for authentication. If the password is null or whitespaces only, the connector won’t use authentication and username must be empty too.

Database

String

Name of the database.

x

SSL

Boolean

This is for enabling an SSL connection. It is disabled by default.

false

Tls Context

TLS

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.
Connection String
Parameters
Name Type Description Default Value Required

Connection URI

String

x

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Supported Operations

Sources

MongoDB sources (listeners) use Object Store to save watermarks. You might experience limitations that are specific to the Object Store implementation you are using (Object Store for CloudHub deployments or Object Store for on-premises deployments), so configure Object Store to suit your needs.
For more information, see The Different Types of Object Stores Explained.

Operations

Add User

<mongo:add-user>

Adds a new user for this database.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Username

String

Name of the user.

x

Password

String

Password to use for authentication.

x

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Count Documents

<mongo:count-documents>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The target collection.

x

Condition Query

Binary

The optional String query for counting documents. Only documents matching it will be counted. If unspecified, all documents are counted.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Number

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Create Collection

<mongo:create-collection>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The name of the collection to create.

x

Capped

Boolean

If the collection will be capped.

false

Max Objects

Number

The maximum number of documents the new collection is able to contain.

Collection Size

Number

The maximum size of the new collection.

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Create File From Payload

<mongo:create-file-from-payload>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

Binary

The mandatory content of the new gridfs file. It may be a java.io.File, a byte[], or an InputStream.

#[payload]

Filename

String

The mandatory name of new file.

x

Metadata

Binary

The optional String metadata of the new content type.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Create Index

<mongo:create-index>

Creates a new index.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The name of the collection where the index is created.

x

Field Name

String

The name of the field which is indexed.

x

Order

Enumeration, one of:

  • ASC

  • DESC

The indexing order.

ASC

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Drop Collection

<mongo:drop-collection>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The name of the collection to drop.

x

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Drop Database

<mongo:drop-database>

Drop the current database.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Drop Index

<mongo:drop-index>

Drops an existing index.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The name of the collection where the index is.

x

Index Name

String

The name of the index to drop.

x

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Dump

<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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Output Directory

String

Output directory path, if no output directory is provided the default /dump directory is assumed.

dump

Output Name

String

Output file name - if not specified, the database name is used.

Zip

Boolean

Whether to zip the created dump file or not,

false

Oplog

Boolean

Point in time backup (requires an oplog).

false

Threads

Number

Amount of threads to execute the dump.

5

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Execute Command

<mongo:execute-command>

Executes a command on the database.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Command Name

String

The command to execute on the database.

x

Command Value

String

The value for the command

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Execute Generic Command

<mongo:execute-generic-command>

Executes a generic command on the database.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Command

Binary

The generic command to execute on the database.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Exists Collection

<mongo:exists-collection>

Answers if a collection exists given its name.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The name of the collection

#[payload]

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Boolean

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Find Documents

<mongo:find-documents>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The target collection.

x

Condition Query

Binary

The optional String query document. If unspecified, all documents are returned.

#[payload]

Fields

Array of String

Alternative way of passing fields as a literal List.

Num To Skip

Number

Number of documents to skip (offset).

Result Limit

Number

Limit of documents to return.

Sort By

Binary

Indicates the String used to sort the results.

Return Id

Boolean

Boolean that indicates if an ID is return in the response.

true

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Find Files

<mongo:find-files>

Lists all the files that match a query.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Find Query

Binary

A String query.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Find One And Update Document

<mongo:find-one-and-update-document>

Finds and updates the first document that matches a given query. When returnNew = true, returns the updated document instead of the original document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The target collection.

x

Find Query

Binary

The String query that the returned object matches.

Content To Update

Binary

The String mandatory object that replaces that one which matches the query.

x

Fields

Array of String

Alternative way of passing fields as a literal list.

Return New Document

Boolean

Flag to specify if the returning org.bson.Document should be the updated document instead of the original. Defaults to false, returning the document before modifications

false

Sort By

Binary

Indicates the String used to sort the results.

Remove

Boolean

Removes the specified in the query field. Defaults to false

false

Upsert

Boolean

Whether the database should create the element if it does not exist

false

Bypass Document Validation

Boolean

Lets you update documents that do not meet the validation requirements. Defaults to false.

false

Return Id

Boolean

Boolean that indicates if an ID is return in the response.

false

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Find One Document

<mongo:find-one-document>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The target collection.

x

Find Query

Binary

The mandatory String query document that the returned object matches.

#[payload]

Fields

Array of String

Alternative way of passing fields as a literal list.

Fail On Not Found

Boolean

Flag to specify if an exception is thrown when no object is found. For backward compatibility the default value is true.

true

Return Id

Boolean

Boolean that indicates if an ID is return in the response.

true

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Find One File

<mongo:find-one-file>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Find Query

Binary

The String mandatory query.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Get File Content

<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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Id

Mule BSON Object ID

The MuleBsonObjectId of the file to be deleted.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Incremental Dump

<mongo:incremental-dump>

Executes an incremental dump of the database.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Output Directory

String

Output directory path, if no output directory is provided the default /dump directory is assumed.

dump

Incremental Timestamp File

String

File that keeps track of the last timestamp processed, if no file is provided one is created on the output directory.

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Insert Document

<mongo:insert-document>

Inserts a document in a collection, setting its ID if necessary.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The name of the collection where to insert the given document.

x

Document

Binary

A String instance.

#[payload]

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Insert Documents

<mongo:insert-documents>

Inserts a list of documents in a collection, setting its ID if necessary.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The name of the collection where to insert the given document.

x

Documents

Binary

A java.util.List of String.

#[payload]

Write Ordered

Boolean

Indicates if the list of write operations is ordered or unordered. By default, if an error occurs during the processing of one of the write operations, MongoDB returns without processing any remaining write operations in the list. Returns a new BsonDocumentWrapper(this, codecRegistry.get(Document.class)); value.

true

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

List Collections

<mongo:list-collections>

Lists names of collections available in this database.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

List Files

<mongo:list-files>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Find Query

Binary

The String optional query.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

List Indices

<mongo:list-indices>

List existent indices in a collection.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The name of the collection.

x

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Map Reduce Objects

<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; consult the MongoDB documentation for writing them.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The name of the collection to map and reduce.

x

Mapping Function

String

A JavaScript encoded mapping function.

x

Reduce Function

String

A JavaScript encoded reducing function.

x

Output Collection

String

The name of the output collection to write the results, replacing the previous collection if it exists, which is mandatory when results may be larger than 16 MB. If outputCollection is not specified, the computation is performed in-memory and not persisted.

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Remove Documents

<mongo:remove-documents>

Removes all the documents that match a given optional query. If a query is not specified, all documents are removed.

This is normally less performant than dropping the collection, and creating the collection and its indices again.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The collection whose elements you want to remove.

x

Find Query

Binary

The optional String query object. Documents that match it are removed.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Remove Files

<mongo:remove-files>

Removes the file that matches the given file ID. If no file ID is specified, all files are removed.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Id

Mule BSON Object ID

The MuleBsonObjectId of the file to be deleted.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Restore

<mongo:restore>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Input Path

String

Input path to the dump files, it can be a directory, a zip file, or just a BSON file.

dump

Drop Collection

Boolean

Whether to drop existing collections before a restore.

false

Oplog Replay

Boolean

Replay oplog for point-in-time restore.

false

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Save Document

<mongo:save-document>

Inserts or updates a document based on its object ID.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The collection where to insert the object

x

Document

Binary

The mandatory String document to insert.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Update Documents

<mongo:update-documents>

Updates documents that matches the given query. If query is not specified, all documents are retrieved. If parameter Multiple Update is set to false, only the first document matching the query is updated. Otherwise, all the documents matching the query are updated.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The name of the collection to update

x

Find Query

Binary

The String query object used to detect the element to update.

Content To Update

Binary

The mandatory String object that replaces the one that matches the query.

x

Multiple Update

Boolean

If all or just the first document matching the query will be updated.

true

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Update Documents By Function

<mongo:update-documents-by-function>

Update documents using a Mongo function. If a query is not specified, all documents are retrieved.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The name of the collection to update.

x

Function

String

The function used to execute the update.

x

Find Query

Binary

The String query document used to detect the element to update.

Content To Update

Binary

The mandatory String document that replaces the one that matches the query.

x

Upsert

Boolean

If the database should create the element if it does not exist.

false

Multiple Update

Boolean

If all or just the first document matching the query will be updated.

true

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Update Documents By Functions

<mongo:update-documents-by-functions>

Update documents using one or more Mongo functions. If a query is not specified, all documents are retrieved. If there are duplicated operators, only the last one executes.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The name of the collection to update.

x

Find Query

Binary

The String query document used to detect the element to update

Functions

Binary

The String of functions used to execute the update. For example: <$set,{"key":123}>

x

Upsert

Boolean

Whether the database should create the element if it does not exist.

false

Multiple Update

Boolean

If all or just the first document matching the query will be updated.

true

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • MONGO:BULK_WRITE

  • MONGO:CLIENT_EXCEPTION

  • MONGO:COMMAND_ERROR

  • MONGO:CONNECTIVITY

  • MONGO:CURSOR_NOT_FOUND

  • MONGO:DUPLICATE_KEY

  • MONGO:EXECUTION_TIMEOUT

  • MONGO:ILLEGAL_ARGUMENT

  • MONGO:INCOMPATIBLE_DRIVER

  • MONGO:INTERNAL_EXCEPTION

  • MONGO:INTERRUPTED

  • MONGO:INVALID_CREDENTIALS

  • MONGO:IO_EXCEPTION

  • MONGO:MAPPING_EXCEPTION

  • MONGO:MONGO_GRID_FS

  • MONGO:MongoExecution

  • MONGO:NODE_IS_RECOVERING

  • MONGO:NOT_PRIMARY

  • MONGO:QUERY_ERROR

  • MONGO:RETRY_EXHAUSTED

  • MONGO:SECURITY

  • MONGO:SERVER_ERROR

  • MONGO:SOCKET

  • MONGO:SOCKET_CLOSED

  • MONGO:SOCKET_OPEN

  • MONGO:SOCKET_READ_ERROR

  • MONGO:SOCKET_READ_TIMEOUT

  • MONGO:SOCKET_WRITE_ERROR

  • MONGO:TIMEOUT

  • MONGO:UNKNOWN

  • MONGO:WAIT_QUEUE_FULL

  • MONGO:WRITE

  • MONGO:WRITE_CONCERN

Sources

Deleted Object

<mongo:deleted-object-trigger>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The collection to watch to detect the matching documents.

x

Field Name

String

The field to query to detect the objects that match the trigger condition. For New Objects trigger, if it is empty, the _id field is used.

Since

String

Specify an initial value from when to start querying objects. If this field is empty, this operation retrieves the selected objects from the time the Mule app is started. For most objects types, the Object#toString() representation is sufficient. For Date objects, use the Date#getTime() representation.

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers polling.

x

Streaming Strategy

Configure to use repeatable streams.

Redelivery Policy

Redelivery Policy

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

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Modified Object

<mongo:modified-object-trigger>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The collection to watch to detect the matching documents.

x

Field Name

String

The field to query to detect the objects that match the trigger condition. For New Objects trigger, if it is empty, the _id field is used.

Since

String

Specify an initial value from when to start querying objects. If this field is empty, this operation retrieves the selected objects from the time the Mule app is started. For most objects types, the Object#toString() representation is sufficient. For Date objects, use the Date#getTime() representation.

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Streaming Strategy

Configure to use repeatable streams.

Redelivery Policy

Redelivery Policy

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

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

New Object

<mongo:new-object-trigger>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection Name

String

The collection to watch to detect the matching documents.

x

Field Name

String

The field to query to detect the objects that match the trigger condition. For New Objects trigger, if it is empty the _id field to use.

Since

String

Specify an initial value from when to start querying objects. If this field is empty, this operation retrieves the selected objects from the time the Mule app is started. For most objects types, the Object#toString() representation is sufficient. For Date objects use the Date#getTime() representation.

Primary Node Only

Boolean

Whether to execute this source only on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers polling.

x

Streaming Strategy

Configure to use repeatable streams.

Redelivery Policy

Redelivery Policy

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

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Types

TLS

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Trust Store

Key Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

The location that resolves relative to the current classpath and file system (if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations are performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location that resolves relative to the current classpath and file system (if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file is used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server cannot be reached or is busy.

Custom OCSP Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

CRL File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Count

Number

How many reconnection attempts to make.

blocking

Boolean

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

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

blocking

Boolean

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

true

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory to allocate 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 bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

By how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

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.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed.

Repeatable File Store Stream

Field Type Description Default Value Required

Max In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed, then it starts to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed.

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering a process-failed message.

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Object Store

Object Store

The object store where the redelivery counter for each message is going to be stored.

Mule BSON Object ID

Field Type Description Default Value Required

Value

Mongo ID Object

Mongo ID Object

Field Type Description Default Value Required

Counter

Number

Date

String

Machine Identifier

Number

Process Identifier

Number

Time

Number

Time Second

Number

Timestamp

Number

See Also

MuleSoft Help Center

View on GitHub