NIFI-5413 Added additional documentation for PutMongoRecord and fixed a typo in RunMongoAggregation's documentation.

This closes #2881

Signed-off-by: zenfenan <zenfenan@apache.org>
This commit is contained in:
Mike Thomsen 2018-07-11 14:51:51 -04:00 committed by zenfenan
parent 860663ae3e
commit c755ed9322
2 changed files with 6 additions and 2 deletions

View File

@ -51,7 +51,11 @@ import java.util.Set;
@EventDriven
@Tags({"mongodb", "insert", "record", "put"})
@InputRequirement(InputRequirement.Requirement.INPUT_REQUIRED)
@CapabilityDescription("Bulk ingest documents into MongoDB using a configured record reader.")
@CapabilityDescription("This processor is a record-aware processor for inserting data into MongoDB. It uses a configured record reader and " +
"schema to read an incoming record set from the body of a flowfile and then inserts batches of those records into " +
"a configured MongoDB collection. This processor does not support updates, deletes or upserts. The number of documents to insert at a time is controlled " +
"by the \"Insert Batch Size\" configuration property. This value should be set to a reasonable size to ensure " +
"that MongoDB is not overloaded with too many inserts at once.")
public class PutMongoRecord extends AbstractMongoProcessor {
static final Relationship REL_SUCCESS = new Relationship.Builder().name("success")
.description("All FlowFiles that are written to MongoDB are routed to this relationship").build();

View File

@ -24,7 +24,7 @@
<!-- Processor Documentation ================================================== -->
<h2>Description:</h2>
<p>
This Processors runs a MongoDB aggregation query based on user-defined settings. The
This processor runs a MongoDB aggregation query based on user-defined settings. The
following is an example of such a query (and what the expected input looks like):
</p>
<pre>