Repository: nifi Updated Branches: refs/heads/master d139b2856 -> c3cad2b38
NIFI-5410 Added additional documentation for GetMongo. Signed-off-by: Matthew Burgess <[email protected]> This closes #2880 Project: http://git-wip-us.apache.org/repos/asf/nifi/repo Commit: http://git-wip-us.apache.org/repos/asf/nifi/commit/c3cad2b3 Tree: http://git-wip-us.apache.org/repos/asf/nifi/tree/c3cad2b3 Diff: http://git-wip-us.apache.org/repos/asf/nifi/diff/c3cad2b3 Branch: refs/heads/master Commit: c3cad2b38b5bdef2a0a63a880dcdceec7419938f Parents: d139b28 Author: Mike Thomsen <[email protected]> Authored: Wed Jul 11 14:45:33 2018 -0400 Committer: Matthew Burgess <[email protected]> Committed: Mon Jul 23 08:55:36 2018 -0400 ---------------------------------------------------------------------- .../additionalDetails.html | 59 ++++++++++++++++++++ 1 file changed, 59 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/nifi/blob/c3cad2b3/nifi-nar-bundles/nifi-mongodb-bundle/nifi-mongodb-processors/src/main/resources/docs/org.apache.nifi.processors.mongodb.GetMongo/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-mongodb-bundle/nifi-mongodb-processors/src/main/resources/docs/org.apache.nifi.processors.mongodb.GetMongo/additionalDetails.html b/nifi-nar-bundles/nifi-mongodb-bundle/nifi-mongodb-processors/src/main/resources/docs/org.apache.nifi.processors.mongodb.GetMongo/additionalDetails.html new file mode 100644 index 0000000..d6b476d --- /dev/null +++ b/nifi-nar-bundles/nifi-mongodb-bundle/nifi-mongodb-processors/src/main/resources/docs/org.apache.nifi.processors.mongodb.GetMongo/additionalDetails.html @@ -0,0 +1,59 @@ +<!DOCTYPE html> +<html lang="en"> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<head> + <meta charset="utf-8" /> + <title>GetMongo</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> +</head> + +<body> +<!-- Processor Documentation ================================================== --> +<h2>Description:</h2> +<p> + This processor runs queries against a MongoDB instance or cluster and writes the results to a flowfile. It allows + input, but can run standalone as well. +</p> +<h2>Specifying the Query</h2> +<p> + The query can be specified in one of three ways: +</p> +<ul> + <li>Query configuration property.</li> + <li>Query Attribute configuration property.</li> + <li>FlowFile content.</li> +</ul> +<p> + If a value is specified in either of the configuration properties, it will not look in the FlowFile content for a + query. +</p> +<h2>Limiting/Shaping Results</h2> +<p> + The following options for limiting/shaping results are available: +</p> +<ul> + <li>Limit - limit the number of results. This should not be confused with the "batch size" option which is a + setting for the underlying MongoDB driver to tell it how many items to retrieve in each poll of the server.</li> + <li>Sort - sort the result set. Requires a JSON document like <em>{ "someDate": -1 }</em></li> + <li>Projection - control which fields to return. Exampe, which would remove <em>_id</em>: <em>{ "_id": 0 }</em></li> +</ul> +<h2>Misc Options</h2> +<p> + Results Per FlowFile, if set, creates a JSON array out of a batch of results and writes the result to the output. + Pretty Print, if enabled, will format the JSON data to be easy read by a human (ex. proper indentation of fields). +</p> +</body> +</html> \ No newline at end of file
