Version
MongoDBWriter
Short description
MongoDBWriter stores, removes, or updates data in the MongoDB database using the Java driver.
MongoDBWriter can manipulate with documents in a MongoDB collection. New documents can be inserted, existing documents can be updated or removed.
| Data output | Input ports | Output ports | Transformation | Transf. required | Java | CTL | Auto-propagated metadata |
|---|---|---|---|---|---|---|---|
database |
1 |
0-2 |
✓ |
✓ |
⨯ |
✓ |
✓ |
Ports
| Port type | Number | Required | Description | Metadata |
|---|---|---|---|---|
Input |
0 |
✓ |
Input data records to be mapped to component attributes. |
any |
Output |
0 |
⨯ |
Results |
any |
1 |
⨯ |
Errors |
any |
Metadata
MongoDBWriter does not propagate metadata.
This component has metadata templates. The templates are described in the documentation of MongoDBReader in the section Metadata.
MongoDBWriter attributes
| Attribute | Req | Description | Possible values |
|---|---|---|---|
Basic |
|||
Connection |
✓ |
The ID of the MongoDB connection to be used. |
|
Collection name |
✓ [1] |
The name of the target collection. |
|
Operation |
The operation to be performed. MongoDBWriter can perform:
|
See the description. |
|
Query |
Selects a subset of documents from a collection. The selection criteria may contain query operators. Ignored by the |
||
New value |
✓ [1] |
Specifies the document to be stored in the database. Ignored by delete operations ( For update operations, New value may contain update operators. |
|
Input mapping |
✓ |
Defines the mapping of input records to component attributes. |
|
Output mapping |
Defines mapping of results to standard output port. |
||
Error mapping |
Defines the mapping of errors to the error output port. |
||
Advanced |
|||
Batch size |
Number of records that can be sent to database in one batch. Bulk write operations may significantly increase performance. However, the whole batch is stored in memory, so increasing Batch size also increases memory requirements. |
bulk write: 100 (default) | basic: 1 (default) |
|
Stop processing on fail |
If |
true (default) | false |
|
Field pattern |
Specifies the format of placeholders that can be used within the Query and New value attributes.
The value of the attribute must contain " During the execution, each placeholder is replaced using a simple string substitution with the value of the respective input field, e.g.
the string " |
@{field} (default) | any string containing " |
|
Details
Operations
There are two types of operations available for this component: bulk write and basic operations. Bulk write operations are supported since driver and DB version 3.2.
| Operation | Description |
|---|---|
Adds the value of the New value attribute as a new document to the target Collection.
If the document does not contain the See also db.collection.insertOne(). |
|
Updates a single document matching the Query, with the values specified in the New value attribute, which must contain update operators. The See also db.collection.updateOne(). |
|
Updates multiple documents matching the Query, with the values specified in the New value attribute, which must contain update operators. The See also db.collection.updateMany(). |
|
Replaces a single document matching the Query. The See also db.collection.replaceOne(). |
|
Removes a single document matching the Query. See also db.collection.deleteOne(). |
|
Removes all documents matching the Query. See also db.collection.deleteMany(). |
|
Parameters for bulk write operations |
|
Upsert |
Only applicable to Generated object IDs for upserted documents will be returned as the |
Ordered |
Executes operations in the order they arrive within every batch. If enabled, the first error causes the following operations in the same batch to be skipped. |
Basic operations |
|
Adds the value of the New value attribute as a new document to the target Collection.
If the document does not contain the See also db.collection.insert(). |
|
Removes objects that match the Query from the Collection. See also db.collection.remove(). |
|
Similar to See also db.collection.save(). |
|
Updates at most one document that matches the Query, with the values specified in the New value attribute which may contain update operators. See also db.collection.update(). |
|
Updates multiple documents matching the Query with the values specified in the New value attribute which must contain update operators. See also db.collection.update() - multi. |
|
If no existing document matches the Query, inserts a new document into the Collection, otherwise performs an update. The New value attribute may contain update operators. See also db.collection.update() - upsert. |
|
Mapping
Editing any of the Input, Output or Error mapping opens the Transform Editor.
Input mapping
The editor allows you to override selected attributes of the component with the values of the input fields.
| Field Name | Attribute | Type | Possible values |
|---|---|---|---|
collection |
Collection |
string |
|
query |
Query |
string |
|
newValue |
Projection |
string |
Output mapping
The editor allows you to map the results and the input data to the output port.
If Output mapping is empty, fields of input record and result record are mapped to output by name.
| Field Name | Type | Description |
|---|---|---|
numAffected |
integer |
The number of affected documents, only set by the |
objectId |
string |
The object ID of the document. Bulk write operations: set by the Basic operations: set by the |
batchNumber |
long |
The sequence number of the current batch, starting from 0. |
deletedCount |
integer |
The number of documents deleted by the current batch. |
insertedCount |
integer |
The number of documents inserted by the current batch. |
matchedCount |
integer |
The number of documents matched by the current batch. |
modifiedCount |
integer |
The number of documents modified by the current batch. |
Error mapping
The editor allows you to map the errors and the input data to the error port.
If Error mapping is empty, fields of input record and result record are mapped to output by name.
| Field Name | Type | Description |
|---|---|---|
errorMessage |
string |
The error message. |
stackTrace |
string |
The stack trace of the error. |
batchNumber |
long |
The sequence number of the current batch, starting from 0. |
deletedCount |
integer |
The number of documents deleted by the current batch. |
insertedCount |
integer |
The number of documents inserted by the current batch. |
matchedCount |
integer |
The number of documents matched by the current batch. |
modifiedCount |
integer |
The number of documents modified by the current batch. |
Error handling in bulk operations
Each input record produces one output record either on the standard, or error output port. A record is sent to the error output port if an error occurs or the operation is skipped. In such a case, see the errorMessage field in Error mapping for details and possible solution.
Notes and limitations
MongoDBWriter does not write maps and lists. It converts maps and lists to string and writes the string.
Format of the date Field Value
A date value is in an ISO-8601 date format.
{
withTZ : { "$date": "2018-11-22T14:25:11.541+02:00" },
millis: { "$date": "2018-11-22T14:25:11.541" },
seconds: { "$date": "2018-11-22T14:25:11" },
dateLocal: { "$date": "2018-11-22" },
dateUTC: { "$date": "2018-11-22+00:00" }
}
Examples
Writing records to MongoDB
Insert records (productID, productName, description) to collection newProducts.
Solution
Create MongoDB Connection to target database.
Set up the following attributes:
| Attribute | Value |
|---|---|
Connection |
MyMongoDBConnection |
Collection name |
newProducts |
Operation |
insertOne |
New value |
{ productID : @{productID}, productName : "@{productName}", description: "@{description}"} |