Apache/nifi
1
0
Fork 0
mirror of https://github.com/apache/nifi.git synced 2025-02-09 03:25:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

NIFI-5410 Added additional documentation for GetMongo.

Browse Source 
Signed-off-by: Matthew Burgess <mattyb149@apache.org>

This closes #2880
This commit is contained in:
Mike Thomsen 2018-07-11 14:45:33 -04:00 committed by Matthew Burgess
parent d139b28564
commit c3cad2b38b
1 changed files with 59 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
nifi-nar-bundles/nifi-mongodb-bundle/nifi-mongodb-processors/src/main/resources/docs/org.apache.nifi.processors.mongodb.GetMongo/additionalDetails.html Normal file
View File

@ -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>