You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by ze...@apache.org on 2018/08/30 04:16:22 UTC

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

Repository: nifi
Updated Branches:
  refs/heads/master 860663ae3 -> c755ed932


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

This closes #2881

Signed-off-by: zenfenan <ze...@apache.org>


Project: http://git-wip-us.apache.org/repos/asf/nifi/repo
Commit: http://git-wip-us.apache.org/repos/asf/nifi/commit/c755ed93
Tree: http://git-wip-us.apache.org/repos/asf/nifi/tree/c755ed93
Diff: http://git-wip-us.apache.org/repos/asf/nifi/diff/c755ed93

Branch: refs/heads/master
Commit: c755ed9322c7362a99524e5a816f5b1407c291c4
Parents: 860663a
Author: Mike Thomsen <mi...@gmail.com>
Authored: Wed Jul 11 14:51:51 2018 -0400
Committer: zenfenan <si...@gmail.com>
Committed: Thu Aug 30 09:43:44 2018 +0530

----------------------------------------------------------------------
 .../org/apache/nifi/processors/mongodb/PutMongoRecord.java     | 6 +++++-
 .../additionalDetails.html                                     | 2 +-
 2 files changed, 6 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/nifi/blob/c755ed93/nifi-nar-bundles/nifi-mongodb-bundle/nifi-mongodb-processors/src/main/java/org/apache/nifi/processors/mongodb/PutMongoRecord.java
----------------------------------------------------------------------
diff --git a/nifi-nar-bundles/nifi-mongodb-bundle/nifi-mongodb-processors/src/main/java/org/apache/nifi/processors/mongodb/PutMongoRecord.java b/nifi-nar-bundles/nifi-mongodb-bundle/nifi-mongodb-processors/src/main/java/org/apache/nifi/processors/mongodb/PutMongoRecord.java
index cfe19e9..d3698bb 100644
--- a/nifi-nar-bundles/nifi-mongodb-bundle/nifi-mongodb-processors/src/main/java/org/apache/nifi/processors/mongodb/PutMongoRecord.java
+++ b/nifi-nar-bundles/nifi-mongodb-bundle/nifi-mongodb-processors/src/main/java/org/apache/nifi/processors/mongodb/PutMongoRecord.java
@@ -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();

http://git-wip-us.apache.org/repos/asf/nifi/blob/c755ed93/nifi-nar-bundles/nifi-mongodb-bundle/nifi-mongodb-processors/src/main/resources/docs/org.apache.nifi.processors.mongodb.RunMongoAggregation/additionalDetails.html
----------------------------------------------------------------------
diff --git a/nifi-nar-bundles/nifi-mongodb-bundle/nifi-mongodb-processors/src/main/resources/docs/org.apache.nifi.processors.mongodb.RunMongoAggregation/additionalDetails.html b/nifi-nar-bundles/nifi-mongodb-bundle/nifi-mongodb-processors/src/main/resources/docs/org.apache.nifi.processors.mongodb.RunMongoAggregation/additionalDetails.html
index 451de6f..0774c78 100644
--- a/nifi-nar-bundles/nifi-mongodb-bundle/nifi-mongodb-processors/src/main/resources/docs/org.apache.nifi.processors.mongodb.RunMongoAggregation/additionalDetails.html
+++ b/nifi-nar-bundles/nifi-mongodb-bundle/nifi-mongodb-processors/src/main/resources/docs/org.apache.nifi.processors.mongodb.RunMongoAggregation/additionalDetails.html
@@ -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>