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-5409 Added additional documentation for DeleteMongo.

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

This closes #2879
This commit is contained in:
Mike Thomsen 2018-07-11 12:12:57 -04:00 committed by Matthew Burgess
parent 46ce7aaa32
commit d139b28564
1 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -0,0 +1,41 @@
<!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>DeleteMongo</title>
<link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<h2>Description:</h2>
<p>
This processor deletes from Mongo using a user-provided query that is provided in the body of a flowfile. It must
be a valid JSON document. The user has the option of deleting a single document or all documents that match the
criteria. That behavior can be configured using the related configuration property. In addition, the processor
can be configured to regard a failure to delete any documents as an error event, which would send the flowfile
with the query to the failure relationship.
</p>
<h3>Example Query</h3>
<pre>
{
"username": "john.smith",
"recipient": "jane.doe"
}
</pre>
</body>
</html>