Skip to main content

Read MongoDB

Synopsis​

Reads documents from a MongoDB collection.

Description​

This operator retrieves a collection of documents from the specified MongoDB collection. The query criteria, the query projection and sorting criteria can be specified via JSON/BSON documents.

Input​

criteria​

The query criteria which can be used to select only specific documents (a JSON/BSON document). Alternatively, you can specify this document via the criteria parameter. Note that the parameter is only visible if no document is connected to this input port.

projection​

The query projection which can be used to include/exclude specific fields from the results (a JSON/BSON document). Alternatively, you can specify this document via the projection parameter. Note that the parameter is only visible if no document is connected to this input port.

sorting criteria​

The sorting criteria which can be used to sort the returned documents in a specific order (a JSON/BSON document). Alternatively, you can specify this document via the sort document and sorting criteria parameters. Note that the parameter is only visible if no document is connected to this input port.

connection​

This input port expects a Connection object if any. See the parameter connection entry for more information.

Output​

collection​

The documents retrieved from the MongoDB collection.

connection​

This output port delivers the Connection object from the input port. If the input port is not connected the port delivers nothing.

Parameters​

Connection source​

This parameter indicates how the connection should be specified. It gives you two options, predefined and repository. The parameter is not visible if the connection input port is connected.

Connection entry​

This parameter is only available when the connection source parameter is set to repository. This parameter is used to specify a repository location that represents a connection entry. The connection can also be provided using the connection input port.

Mongodb instance​

This parameter is only available when the connection source parameter is set to predefined. The MongoDB instance to be used for storing the documents can be specified here.

Collection​

The MongoDB collection in which the documents are stored.

Criteria​

The query criteria which can be used to select only specific documents (a JSON/BSON document). Alternatively, you can specify this document via the criteria input port.

Projection​

The query projection which can be used to include/exclude specific fields from the results (a JSON/BSON document). Alternatively, you can specify this document via the projection input port.

Sort documents​

If checked, a sorting criteria document can be specified to sort the query results. Alternatively, you can enable this behavior by connection a sorting criteria document to the sorting input port.

Sorting criteria​

The sorting criteria which can be used to sort the returned documents in a specific order (a JSON/BSON document). Alternatively, you can specify this document via the sorting input port.

Limit results​

Whether the number of results should be limited.

Limit​

The number of documents to be queried.

Skip​

The number of documents to be skipped.