| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DeleteMongo</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">DeleteMongo</h1><h2>Description: </h2><p>Executes a delete query against a MongoDB collection. The query is provided in the body of the flowfile and the user can select whether it will delete one or many documents that match it.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>delete, mongo, mongodb</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name">Client Service</td><td>mongo-client-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>MongoDBClientService<br/><strong>Implementation: </strong><a href="../../../nifi-mongodb-services-nar/1.19.1/org.apache.nifi.mongodb.MongoDBControllerService/index.html">MongoDBControllerService</a></td><td id="description">If configured, this property will use the assigned client service for connection pooling.</td></tr><tr><td id="name">Mongo URI</td><td>Mongo URI</td><td></td><td id="allowable-values"></td><td id="description">MongoURI, typically of the form: mongodb://host1[:port1][,host2[:port2],...]<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Mongo Database Name</strong></td><td>Mongo Database Name</td><td></td><td id="allowable-values"></td><td id="description">The name of the database to use<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Mongo Collection Name</strong></td><td>Mongo Collection Name</td><td></td><td id="allowable-values"></td><td id="description">The name of the collection to use<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">SSL Context Service</td><td>ssl-context-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.19.1/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.19.1/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections.</td></tr><tr><td id="name">Client Auth</td><td>ssl-client-auth</td><td id="default-value">REQUIRED</td><td id="allowable-values"><ul><li>WANT</li><li>REQUIRED</li><li>NONE</li></ul></td><td id="description">Client authentication policy when connecting to secure (TLS/SSL) cluster. Possible values are REQUIRED, WANT, NONE. This property is only used when an SSL Context has been defined and enabled.</td></tr><tr><td id="name">Delete Mode</td><td>delete-mongo-delete-mode</td><td id="default-value">Delete One</td><td id="allowable-values"><ul><li>Delete One <img src="../../../../../html/images/iconInfo.png" alt="Delete only the first document that matches the query." title="Delete only the first document that matches the query."></img></li><li>Delete Many <img src="../../../../../html/images/iconInfo.png" alt="Delete every document that matches the query." title="Delete every document that matches the query."></img></li><li>Use 'mongodb.delete.mode' attribute <img src="../../../../../html/images/iconInfo.png" alt="Read the 'mongodb.delete.mode attribute and use that mode. Acceptable values are 'many' and 'one.'" title="Read the 'mongodb.delete.mode attribute and use that mode. Acceptable values are 'many' and 'one.'"></img></li></ul></td><td id="description">Choose between deleting one document by query or many documents by query.</td></tr><tr><td id="name">Fail When Nothing Is Deleted</td><td>delete-mongo-fail-on-no-delete</td><td id="default-value">True</td><td id="allowable-values"><ul><li>True <img src="../../../../../html/images/iconInfo.png" alt="Fail when no documents are deleted." title="Fail when no documents are deleted."></img></li><li>False <img src="../../../../../html/images/iconInfo.png" alt="Do not fail when nothing is deleted." title="Do not fail when nothing is deleted."></img></li></ul></td><td id="description">Determines whether to send the flowfile to the success or failure relationship if nothing is successfully deleted.</td></tr><tr><td id="name"><strong>Write Concern</strong></td><td>Write Concern</td><td id="default-value">ACKNOWLEDGED</td><td id="allowable-values"><ul><li>ACKNOWLEDGED</li><li>UNACKNOWLEDGED</li><li>FSYNCED</li><li>JOURNALED</li><li>REPLICA_ACKNOWLEDGED</li><li>MAJORITY</li><li>W1</li><li>W2</li><li>W3</li></ul></td><td id="description">The write concern to use</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are written to MongoDB are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be written to MongoDB are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mongodb.delete.mode</td><td>Configurable parameter for controlling delete mode on a per-flowfile basis. The process must be configured to use this option. Acceptable values are 'one' and 'many.'</td></tr></table><h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> |