Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.RestLookupService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.RestLookupService/index.html?rev=1873052&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.RestLookupService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.RestLookupService/index.html Thu Jan 23 03:48:17 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>RestLookupService</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;">RestLookupService</h1><h2>Description: </h2><p>Use a REST service to look up values.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>rest, lookup, json, xml, http</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, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning t hat its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL for the REST endpoint. Expression language is evaluated against the lookup key/value pairs, not flowfile attributes.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Record Reader</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordReaderFactory<br/><strong>Implementations: </strong><a href="../../../nifi-parquet-nar/1.11.0/org.apache.nifi.parquet.ParquetReader/index.html">ParquetR eader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.json.JsonTreeReader/index.html">JsonTreeReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.syslog.SyslogReader/index.html">SyslogReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.csv.CSVReader/index.html">CSVReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.avro.AvroReader/index.html">AvroReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.syslog.Syslog5424Reader/index.html">Syslog5424Reader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.grok.GrokReader/index.html">GrokReader</a><br/><a href="../../../nifi-scripting-nar/1.11.0/org.apache.nifi.record.script.ScriptedReader/index.html">ScriptedReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apac he.nifi.xml.XMLReader/index.html">XMLReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.json.JsonPathReader/index.html">JsonPathReader</a></td><td id="description">The record reader to use for loading the payload and handling it as a record set.</td></tr><tr><td id="name">Record Path</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">An optional record path that can be used to define where in a record to get the real data to merge into the record set to be enriched. See documentation for examples of when this might be useful.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.0/org.apache.nifi.ssl.St andardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.11.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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">Proxy Configuration Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>ProxyConfigurationService<br/><strong>Implementation: </strong><a href="../../../nifi-proxy-configuration-nar/1.11.0/org.apache.nifi.proxy.StandardProxyConfigurationService/index.html">StandardProxyConfigurationService</a></td><td id="description">Specifies the Proxy Configuration Controller Service to proxy network requests. If set, it supersedes proxy settings configured per component. Supported proxies: HTTP + AuthN, SOCKS</td></tr><tr><td id="name">Basic Authentication Usernam e</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The username to be used by the client to authenticate against the Remote URL. Cannot include control characters (0-31), ':', or DEL (127).<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Basic Authentication Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password to be used by the client to authenticate against the Remote URL.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Use Digest Authentication</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether to communicate with the website using Digest Authentication. 'Basic Authentication Username' and 'Basic Authen tication Password' are used for authentication.</td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">5 secs</td><td id="allowable-values"></td><td id="description">Max wait time for connection to remote service.</td></tr><tr><td id="name"><strong>Read Timeout</strong></td><td id="default-value">15 secs</td><td id="allowable-values"></td><td id="description">Max wait time for response from remote service.</td></tr></table><h3>Dynamic Properties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">*</td><td id="value">*</td><td>All dynamic properties are added as HTTP headers with the name as the header name and the value as the header value.<br/><strong>Supports Expression Language: false</strong></td></tr></table></p><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.SimpleCsvFileLookupService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.SimpleCsvFileLookupService/index.html?rev=1873052&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.SimpleCsvFileLookupService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.SimpleCsvFileLookupService/index.html Thu Jan 23 03:48:17 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SimpleCsvFileLookupService</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;">SimpleCsvFileLookupService</h1><h2>Description: </h2><p>A reloadable CSV file-based lookup service</p><h3>Tags: </h3><p>lookup, cache, enrich, join, csv, reloadable, key, value</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>Name</th><th>Default Value</th><th>A llowable Values</th><th>Description</th></tr><tr><td id="name"><strong>CSV File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A CSV file.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>CSV Format</strong></td><td id="default-value">Default</td><td id="allowable-values"><ul><li>Excel</li><li>MySQL</li><li>TDF</li><li>PostgreSQLCsv</li><li>InformixUnloadCsv</li><li>Oracle</li><li>Default</li><li>RFC4180</li><li>InformixUnload</li><li>PostgreSQLText</li></ul></td><td id="description">Specifies which "format" the CSV data is in, or specifies if custom formatting should be used.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The Character Encoding that is used to decode the CSV file.<br/><strong>Supports Expression Language: true (will be evaluated usi ng variable registry only)</strong></td></tr><tr><td id="name"><strong>Lookup Key Column</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Lookup key column.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Lookup Value Column</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Lookup value column.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Ignore Duplicates</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Ignore duplicate keys for records in the CSV file.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None s pecified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.SimpleKeyValueLookupService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.SimpleKeyValueLookupService/index.html?rev=1873052&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.SimpleKeyValueLookupService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.SimpleKeyValueLookupService/index.html Thu Jan 23 03:48:17 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SimpleKeyValueLookupService</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;">SimpleKeyValueLookupService</h1><h2>Description: </h2><p>Allows users to add key/value pairs as User-defined Properties. Each property that is added can be looked up by Property Name. The coordinates that are passed to the lookup must contain the key 'key'.</p><h3>Tags: </h3><p>lookup, enrich, key, value</p><h3>Properties: </h3><p>This component has no required or optional properties.</p><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.XMLFileLookupService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.XMLFileLookupService/index.html?rev=1873052&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.XMLFileLookupService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.XMLFileLookupService/index.html Thu Jan 23 03:48:17 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>XMLFileLookupService</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;">XMLFileLookupService</h1><h2>Description: </h2><p>A reloadable XML file-based lookup service. This service uses Apache Commons Configuration. Example XML configuration file and how to access specific configuration can be found at http://commons.apache.org/proper/commons-configuration/userguide/howto_hierarchical.html. External entity processing is disabled.</p><h3>Tags: </h3><p>lookup, cache, enrich, join, xml, reloadable, key, value</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 consider ed 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>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Configuration File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A configuration file<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.db.DatabaseRecordLookupService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.db.DatabaseRecordLookupService/index.html?rev=1873052&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.db.DatabaseRecordLookupService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.db.DatabaseRecordLookupService/index.html Thu Jan 23 03:48:17 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DatabaseRecordLookupService</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;">DatabaseRecordLookupService</h1><h2>Description: </h2><p>A relational-database-based lookup service. When the lookup key is found in the database, the specified columns (or all if Lookup Value Columns are not specified) are returned as a Record. Only one row will be returned for each lookup, duplicate database entries are ignored.</p><h3>Tags: </h3><p>lookup, cache, enrich, join, rdbms, database, reloadable, key, value, record</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 consider ed 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>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Database Connection Pooling Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>DBCPService<br/><strong>Implementations: </strong><a href="../../../nifi-hive-nar/1.11.0/org.apache.nifi.dbcp.hive.HiveConnectionPool/index.html">HiveConnectionPool</a><br/><a href="../../../nifi-dbcp-service-nar/1.11.0/org.apache.nifi.dbcp.DBCPConnectionPool/index.html">DBCPConnectionPool</a><br/><a href="../../../nifi-dbcp-service-nar/1.11.0/org.apache.nifi.dbcp.DBCPConnectionPoolLookup/index.html">DBCPConnectionPoolLookup</a></td><td id="description">The Controller Service that is used to obtain connection to data base</td></tr><tr><td id="name"><strong>Table Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the database table to be queried. Note that this may be case-sensitive depending on the database.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Lookup Key Column</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The column in the table that will serve as the lookup key. This is the column that will be matched against the property specified in the lookup processor. Note that this may be case-sensitive depending on the database.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Lookup Value Columns</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-delimite d list of columns in the table that will be returned when the lookup key matches. Note that this may be case-sensitive depending on the database.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Cache Size</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Specifies how many lookup values/records should be cached. The cache is shared for all tables and keeps a map of lookup values to records. Setting this property to zero means no caching will be done and the table will be queried for each lookup value in each record. If the lookup table changes often or the most recent data must be retrieved, do not use the cache.</td></tr><tr><td id="name"><strong>Clear Cache on Enabled</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether to clear the cache wh en this service is enabled. If the Cache Size is zero then this property is ignored. Clearing the cache when the service is enabled ensures that the service will first go to the database to get the most recent data.</td></tr><tr><td id="name">Cache Expiration</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Time interval to clear all cache entries. If the Cache Size is zero then this property is ignored.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.db.SimpleDatabaseLookupService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.db.SimpleDatabaseLookupService/index.html?rev=1873052&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.db.SimpleDatabaseLookupService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.db.SimpleDatabaseLookupService/index.html Thu Jan 23 03:48:17 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SimpleDatabaseLookupService</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;">SimpleDatabaseLookupService</h1><h2>Description: </h2><p>A relational-database-based lookup service. When the lookup key is found in the database, the specified lookup value column is returned. Only one value will be returned for each lookup, duplicate database entries are ignored.</p><h3>Tags: </h3><p>lookup, cache, enrich, join, rdbms, database, reloadable, key, value</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>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Database Connection Pooling Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>DBCPService<br/><strong>Implementations: </strong><a href="../../../nifi-hive-nar/1.11.0/org.apache.nifi.dbcp.hive.HiveConnectionPool/index.html">HiveConnectionPool</a><br/><a href="../../../nifi-dbcp-service-nar/1.11.0/org.apache.nifi.dbcp.DBCPConnectionPool/index.html">DBCPConnectionPool</a><br/><a href="../../../nifi-dbcp-service-nar/1.11.0/org.apache.nifi.dbcp.DBCPConnectionPoolLookup/index.html">DBCPConnectionPoolLookup</a></td><td id="description">The Controller Service that is used to obtain connection to database</td></tr><tr><td id="name"><strong>Table Name</strong ></td><td id="default-value"></td><td id="allowable-values"></td><td >id="description">The name of the database table to be queried. Note that this >may be case-sensitive depending on the database.<br/><strong>Supports >Expression Language: true (will be evaluated using flow file attributes and >variable registry)</strong></td></tr><tr><td id="name"><strong>Lookup Key >Column</strong></td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">The column in the table that >will serve as the lookup key. This is the column that will be matched against >the property specified in the lookup processor. Note that this may be >case-sensitive depending on the database.<br/><strong>Supports Expression >Language: true (will be evaluated using variable registry >only)</strong></td></tr><tr><td id="name"><strong>Lookup Value >Column</strong></td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">The column whose value will >be returned when the Lookup va lue is matched<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Cache Size</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Specifies how many lookup values/records should be cached. The cache is shared for all tables and keeps a map of lookup values to records. Setting this property to zero means no caching will be done and the table will be queried for each lookup value in each record. If the lookup table changes often or the most recent data must be retrieved, do not use the cache.</td></tr><tr><td id="name"><strong>Clear Cache on Enabled</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether to clear the cache when this service is enabled. If the Cache Size is zero then this property is ignored. Clearing the cache when the service is enabled ensures that the se rvice will first go to the database to get the most recent data.</td></tr><tr><td id="name">Cache Expiration</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Time interval to clear all cache entries. If the Cache Size is zero then this property is ignored.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.maxmind.IPLookupService/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.maxmind.IPLookupService/additionalDetails.html?rev=1873052&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.maxmind.IPLookupService/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.maxmind.IPLookupService/additionalDetails.html Thu Jan 23 03:48:17 2020 @@ -0,0 +1,179 @@ +<!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>IPLookupService</title> + + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <p> + The IPLookupService is powered by a MaxMind database and can return several different types of enrichment information + about a given IP address. Below is the schema of the Record that is returned by this service (in Avro Schema format). + The schema is for a single record that consists of several fields: <code>geo</code>, <code>isp</code>, + <code>domainName</code>, <code>connectionType</code>, and <code>anonymousIp</code>. Each of these fields is nullable + and will be populated only if the IP address that is searched for has the relevant information in the MaxMind database + and if the Controller Service is configured to return such information. Because each of the fields requires a separate + lookup in the database, it is advisable to retrieve only those fields that are of value. + </p> + +<code> +<pre> +{ + "name": "enrichmentRecord", + "namespace": "nifi", + "type": "record", + "fields": [ + { + "name": "geo", + "type": ["null", { + "name": "cityGeo", + "type": "record", + "fields": [ + { "name": "city", "type": ["null", "string"] }, + { "name": "accuracy", "type": ["null", "int"], "doc": "The radius, in kilometers, around the given location, where the IP address is believed to be" }, + { "name": "metroCode", "type": ["null", "int"] }, + { "name": "timeZone", "type": ["null", "string"] }, + { "name": "latitude", "type": ["null", "double"] }, + { "name": "longitude", "type": ["null", "double"] }, + { "name": "country", "type": ["null", { + "type": "record", + "name": "country", + "fields": [ + { "name": "name", "type": "string" }, + { "name": "isoCode", "type": "string" } + ] + }] }, + { "name": "subdivisions", "type": { + "type": "array", + "items": { + "type": "record", + "name": "subdivision", + "fields": [ + { "name": "name", "type": "string" }, + { "name": "isoCode", "type": "string" } + ] + } + } + }, + { "name": "continent", "type": ["null", "string"] }, + { "name": "postalCode", "type": ["null", "string"] } + ] + }] + }, + { + "name": "isp", + "type": ["null", { + "name": "ispEnrich", + "type": "record", + "fields": [ + { "name": "name", "type": ["null", "string"] }, + { "name": "organization", "type": ["null", "string"] }, + { "name": "asn", "type": ["null", "int"] }, + { "name": "asnOrganization", "type": ["null", "string"] } + ] + }] + }, + { + "name": "domainName", + "type": ["null", "string"] + }, + { + "name": "connectionType", + "type": ["null", "string"], + "doc": "One of 'Dialup', 'Cable/DSL', 'Corporate', 'Cellular'" + }, + { + "name": "anonymousIp", + "type": ["null", { + "name": "anonymousIpType", + "type": "record", + "fields": [ + { "name": "anonymous", "type": "boolean" }, + { "name": "anonymousVpn", "type": "boolean" }, + { "name": "hostingProvider", "type": "boolean" }, + { "name": "publicProxy", "type": "boolean" }, + { "name": "torExitNode", "type": "boolean" } + ] + }] + } + ] +} +</pre> +</code> + + + <p> + While this schema is fairly complex, it is a single record with 5 fields. This makes it quite easy to update + an existing schema to allow for this record, by adding a new field to an existing schema and pasting in the schema + above as the type. + </p> + + <p> + For example, suppose that we have an existing schema that is as simple as: + </p> + +<pre> +<code> +<span style="color: #808080;"> +{ + "name": "ipRecord", + "namespace": "nifi", + "type": "record", + "fields": [ + { "name": "ip", "type": "string" } + ] +} +</span> +</code> +</pre> + + <p> + Now, let's suppose that we want to add a new field named <code>enrichment</code> to the above schema. + Further, let's say that we want the new <code>enrichment</code> field to be nullable. + We can do so by copying and pasting our enrichment schema from above thus: + </p> + +<pre> +<code> +<span style="color: #808080;"> +{ + "name": "ipRecord", + "namespace": "nifi", + "type": "record", + "fields": [ + { "name": "ip", "type": "string" },</span><span style="color: #191970;"> + { "name": "enrichment", "type": ["null", +</span> + + <span style="color: #000000"><Paste Enrichment Schema Here></span> + +<span style="color: #191970;"> + ]</span><span style="color: #808080;"> + } + ] +} +</span> +</code> +</pre> + + + + + </body> +</html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.maxmind.IPLookupService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.maxmind.IPLookupService/index.html?rev=1873052&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.maxmind.IPLookupService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.0/org.apache.nifi.lookup.maxmind.IPLookupService/index.html Thu Jan 23 03:48:17 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>IPLookupService</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;">IPLookupService</h1><h2>Description: </h2><p>A lookup service that provides several types of enrichment information for IP addresses. The service is configured by providing a MaxMind Database file and specifying which types of enrichment should be provided for an IP Address or Hostname. Each type of enrichment is a separate lookup, so configuring the service to provide all of the available enrichment data may be slower than returning only a portion of the available enrichments. In order to use this service, a lookup must be performed using key of 'ip' and a value that is a valid IP address or ho stname. View the Usage of this component and choose to view Additional Details for more information, such as the Schema that pertains to the information that is returned.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>lookup, enrich, ip, geo, ipgeo, maxmind, isp, domain, cellular, anonymous, tor</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>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>MaxMind Database File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to Maxmind IP Enrichment Database File<br/><strong>Suppo rts Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Lookup Geo Enrichment</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not information about the geographic information, such as cities, corresponding to the IP address should be returned</td></tr><tr><td id="name"><strong>Lookup ISP</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not information about the Information Service Provider corresponding to the IP address should be returned</td></tr><tr><td id="name"><strong>Lookup Domain Name</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not information about the Domain Name corresponding to the IP add ress should be returned. If true, the lookup will contain second-level domain information, such as foo.com but will not contain bar.foo.com</td></tr><tr><td id="name"><strong>Lookup Connection Type</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not information about the Connection Type corresponding to the IP address should be returned. If true, the lookup will contain a 'connectionType' field that (if populated) will contain a value of 'Dialup', 'Cable/DSL', 'Corporate', or 'Cellular'</td></tr><tr><td id="name"><strong>Lookup Anonymous IP Information</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not information about whether or not the IP address belongs to an anonymous network should be returned.</td></tr></table><h3>State management: </h3>This component does not stor e state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lumberjack-nar/1.11.0/org.apache.nifi.processors.lumberjack.ListenLumberjack/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lumberjack-nar/1.11.0/org.apache.nifi.processors.lumberjack.ListenLumberjack/index.html?rev=1873052&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lumberjack-nar/1.11.0/org.apache.nifi.processors.lumberjack.ListenLumberjack/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lumberjack-nar/1.11.0/org.apache.nifi.processors.lumberjack.ListenLumberjack/index.html Thu Jan 23 03:48:17 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ListenLumberjack</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;">ListenLumberjack</h1><h2>Description: </h2><p>This processor is deprecated and may be removed in the near future. Listens for Lumberjack messages being sent to a given port over TCP. Each message will be acknowledged after successfully writing the message to a FlowFile. Each FlowFile will contain data portion of one or more Lumberjack frames. In the case where the Lumberjack frames contain syslog messages, the output of this processor can be sent to a ParseSyslog processor for further processing. </p><h3>Tags: </h3><p>listen, lumberjack, tcp, logs</p><h3>Properties: </h3><p>In the list below, t he 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>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name">Local Network Interface</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of a local network interface to be used to restrict listening to a specific LAN.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port to listen on for communication.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Receive Buffer Size</strong></td><td id="default-value">65507 B</td><td id="allowable-values"></td><td id="description">The size of each buffer used to receive messages. Adjust this value appropriately based on the expected size of the incoming messages.</td></tr><tr><td id="name"><strong>Max Size of Message Queue</strong></td><td id="default-value">10000</td><td id="allowable-values"></td><td id="description">The maximum size of the internal queue used to buffer messages being transferred from the underlying channel to the processor. Setting this value higher allows more messages to be buffered in memory during surges of incoming messages, but increases the total memory used by the processor.</td></tr><tr><td id="name"><strong>Max Size of Socket Buffer</strong></td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">The maximum size of the socket buffer that should be used. This is a suggestion to the Operating System to indicate how big the socket buffer should be. If this value is set too low, the buffer may fill up before the data can be read, and incoming data will be dropped.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the received data.</td></tr><tr><td id="name"><strong>Max Batch Size</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The maximum number of messages to add to a single FlowFile. If multiple messages are available, they will be concatenated along with the <Message Delimiter> up to this configured maximum number of messages</td></tr><tr><td id="name"><strong>Batching Message Delimiter</strong></td><td id="default-value">\n</td><td id="allowable-values"></td><td id="description">Specifies the delimiter to place between messages when multiple messages are bundled together (see < Max Batch Size> property).</td></tr><tr><td id="name"><strong>Max Number of TCP Connections</strong></td><td id="default-value">2</td><td id="allowable-values"></td><td id="description">The maximum number of concurrent TCP connections to accept.</td></tr><tr><td id="name"><strong>SSL Context Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RestrictedSSLContextService<br/><strong>Implementation: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context. If this property is set, messages will be received over a secure connection. Note that as Lumberjack client requirestwo-way SSL authentication, the controller MUST have a truststore and a keystore to workproperly.</td></tr></table><h3>Relationships: </h3><table i d="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Messages received successfully will be sent out this relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>lumberjack.sender</td><td>The sending host of the messages.</td></tr><tr><td>lumberjack.port</td><td>The sending port the messages were received over.</td></tr><tr><td>lumberjack.sequencenumber</td><td>The sequence number of the message. Only included if <Batch Size> is 1.</td></tr><tr><td>lumberjack.*</td><td>The keys and respective values as sent by the lumberjack producer. Only included if <Batch Size> is 1.</td></tr><tr><td>mime.type</td><td>The mime.type of the content which is text/plain</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This c omponent does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../../../nifi-standard-nar/1.11.0/org.apache.nifi.processors.standard.ParseSyslog/index.html">ParseSyslog</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.11.0/org.apache.nifi.metrics.reporting.reporter.service.GraphiteMetricReporterService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.11.0/org.apache.nifi.metrics.reporting.reporter.service.GraphiteMetricReporterService/index.html?rev=1873052&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.11.0/org.apache.nifi.metrics.reporting.reporter.service.GraphiteMetricReporterService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.11.0/org.apache.nifi.metrics.reporting.reporter.service.GraphiteMetricReporterService/index.html Thu Jan 23 03:48:17 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GraphiteMetricReporterService</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;">GraphiteMetricReporterService</h1><h2>Description: </h2><p>A controller service that provides metric reporters for graphite. Used by MetricsReportingTask.</p><h3>Tags: </h3><p>metrics, reporting, graphite</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>Name< /th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Host</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The hostname of the carbon listener<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port on which carbon listens<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Charset</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The charset used by the graphite server</td></tr><tr><td id="name"><strong>Metric Name Prefix</strong></td><td id="default-value">nifi</td><td id="allowable-values"></td><td id="description">A prefix that will be used for all metric names sent by reporters provided by this service.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.11.0/org.apache.nifi.metrics.reporting.task.MetricsReportingTask/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.11.0/org.apache.nifi.metrics.reporting.task.MetricsReportingTask/index.html?rev=1873052&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.11.0/org.apache.nifi.metrics.reporting.task.MetricsReportingTask/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.11.0/org.apache.nifi.metrics.reporting.task.MetricsReportingTask/index.html Thu Jan 23 03:48:17 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>MetricsReportingTask</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;">MetricsReportingTask</h1><h2>Description: </h2><p>This reporting task reports a set of metrics regarding the JVM and the NiFi instanceto a reporter. The reporter is provided by a MetricReporterService. It can be optionally used for a specificprocess group if a property with the group id is provided.</p><h3>Tags: </h3><p>metrics, reporting</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>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Metric Reporter Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>MetricReporterService<br/><strong>Implementation: </strong><a href="../org.apache.nifi.metrics.reporting.reporter.service.GraphiteMetricReporterService/index.html">GraphiteMetricReporterService</a></td><td id="description">The service that provides a reporter for the gathered metrics</td></tr><tr><td id="name">Process Group ID</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The id of the process group to report. If not specified, metrics of the root process groupare reported.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr> </table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.DeleteMongo/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.DeleteMongo/additionalDetails.html?rev=1873052&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.DeleteMongo/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.DeleteMongo/additionalDetails.html Thu Jan 23 03:48:17 2020 @@ -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> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.DeleteMongo/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.DeleteMongo/index.html?rev=1873052&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.DeleteMongo/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.DeleteMongo/index.html Thu Jan 23 03:48:17 2020 @@ -0,0 +1 @@ +<!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>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name">Client Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>MongoDBClientService<br/><strong>Implementation: </strong><a href="../../../nifi-mongodb-services-nar/1.11.0/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 id="default-value"></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 Na me</strong></td><td id="default-value"></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 id="default-value"></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 id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.11.0/org.apache.nifi.ssl.Standard RestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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 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 id="default-value">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 quer y." 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 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 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></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> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.GetMongo/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.GetMongo/additionalDetails.html?rev=1873052&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.GetMongo/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.GetMongo/additionalDetails.html Thu Jan 23 03:48:17 2020 @@ -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 Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.GetMongo/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.GetMongo/index.html?rev=1873052&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.GetMongo/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.GetMongo/index.html Thu Jan 23 03:48:17 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetMongo</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;">GetMongo</h1><h2>Description: </h2><p>Creates FlowFiles from documents in MongoDB loaded by a user-specified query.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>mongodb, read, get</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>Name</th>< th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name">Client Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>MongoDBClientService<br/><strong>Implementation: </strong><a href="../../../nifi-mongodb-services-nar/1.11.0/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 id="default-value"></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 id="default-value"></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 id="default-value"></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 id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.11.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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 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"><strong>JSON Type</strong></td><td id="default-value">Extended</td><td id="allowable-values"><ul><li>Extended JSON <img src="../../../../../html/images/iconInfo.png" alt="Use MongoDB's "extended JSON". This is the JSON generated with toJson() on a MongoDB Document from the Java driver" title="Use MongoDB's "extended JSON". This is the JSON generated with toJson() on a MongoDB Document from the Java driver"></img></li><li>Standard JSON <img src="../../../../../html/images/iconInfo.png" alt ="Generate a JSON document that conforms to typical JSON conventions instead of Mongo-specific conventions." title="Generate a JSON document that conforms to typical JSON conventions instead of Mongo-specific conventions."></img></li></ul></td><td id="description">By default, MongoDB's Java driver returns "extended JSON". Some of the features of this variant of JSON may cause problems for other JSON parsers that expect only standard JSON types and conventions. This configuration setting controls whether to use extended JSON or provide a clean view that conforms to standard JSON.</td></tr><tr><td id="name"><strong>Pretty Print Results JSON</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>True</li><li>False</li></ul></td><td id="description">Choose whether or not to pretty print the JSON from the results of the query. Choosing 'True' can greatly increase the space requirements on disk depending on the complexity of the JSON document</td></tr><tr><td id=" name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the document data.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Query</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The selection criteria to do the lookup. If the field is left blank, it will look for input from an incoming connection from another processor to provide the query as a valid JSON document inside of the FlowFile's body. If this field is left blank and a timer is enabled instead of an incoming connection, that will result in a full collection fetch using a "{}" query.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Query Output Attribute</td><td id="default-value"></td><t d id="allowable-values"></td><td id="description">If set, the query will be written to a specified attribute on the output flowfiles.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Projection</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fields to be returned from the documents in the result set; must be a valid BSON document<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Sort</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fields by which to sort; must be a valid BSON document<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Limit</td><td id="default-value"></td><td id="allowable-values"></td>< td id="description">The maximum number of elements to return<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Batch Size</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The number of elements to be returned from the server in one batch<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Results Per FlowFile</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">How many results to put into a FlowFile at once. The whole body will be treated as a JSON array of results.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Date Format</td><td id="default-value">yyyy-MM-dd'T'HH:mm:ss'Z'</td><td id="allowable-values"></td><td id ="description">The date format string to use for formatting Date fields that are returned from Mongo. It is only applied when the JSON output format is set to Standard JSON. Full documentation for format characters can be found here: https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html<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 id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.11.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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 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">Send Empty Result</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If a query executes successfully, but returns no results, send an empty JSON document signifying no result.</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 have the results of a successful query execution go here.</td></tr><tr><td>failure</td><td>All input FlowFiles that are part of a failed query execution go here.</td></tr><tr><td>original</td><td>All input FlowFiles that are part of a successful query execution go here.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mongo.database.name</td><td>The database where the results came from.</td></tr><tr><td>mongo.collection.name</td><td>The collection where the results came from.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component allows an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.GetMongoRecord/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.GetMongoRecord/additionalDetails.html?rev=1873052&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.GetMongoRecord/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.GetMongoRecord/additionalDetails.html Thu Jan 23 03:48:17 2020 @@ -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>GetMongoRecord</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. It is a record-aware version of the <em>GetMongo</em> processor. +</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 Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.GetMongoRecord/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.GetMongoRecord/index.html?rev=1873052&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.GetMongoRecord/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.11.0/org.apache.nifi.processors.mongodb.GetMongoRecord/index.html Thu Jan 23 03:48:17 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetMongoRecord</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;">GetMongoRecord</h1><h2>Description: </h2><p>A record-based version of GetMongo that uses the Record writers to write the MongoDB result set.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>mongo, mongodb, get, fetch, record, json</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 Langu age</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name">Client Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>MongoDBClientService<br/><strong>Implementation: </strong><a href="../../../nifi-mongodb-services-nar/1.11.0/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"><strong>Record Writer</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordSetWriterFactory<br/><strong>Implementations: </strong><a href="../../../nifi-parquet-nar/1.11.0/org.apache.nifi.parquet.ParquetRecordSetWriter/index.html">ParquetRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.11.0/org.apache.nifi.record. script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.xml.XMLRecordSetWriter/index.html">XMLRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a></td><td id="description">The record writer to use to write the result sets.</td></tr><tr><td id="name"><strong>Mongo Database Name</strong></td><td id="default-value"></td><td id="allowable-v alues"></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 id="default-value"></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"><strong>Schema Name</strong></td><td id="default-value">${schema.name}</td><td id="allowable-values"></td><td id="description">The name of the schema in the configured schema registry to use for the query results.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Query Output Attribute</td><td id="default-value"></td><td id="allowable-values"></td><td id="description ">If set, the query will be written to a specified attribute on the output flowfiles.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Query</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The selection criteria to do the lookup. If the field is left blank, it will look for input from an incoming connection from another processor to provide the query as a valid JSON document inside of the FlowFile's body. If this field is left blank and a timer is enabled instead of an incoming connection, that will result in a full collection fetch using a "{}" query.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Projection</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fields to be returned from the documents in the result set; must be a valid BSON document<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Sort</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fields by which to sort; must be a valid BSON document<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Limit</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The maximum number of elements to return<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Batch Size</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The number of elements to be returned from the server in one batch<br/><strong>Supports Expression Language: true (will be ev aluated using flow file attributes and variable registry)</strong></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 have the results of a successful query execution go here.</td></tr><tr><td>failure</td><td>All input FlowFiles that are part of a failed query execution go here.</td></tr><tr><td>original</td><td>All input FlowFiles that are part of a successful query execution go here.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mongo.database.name</td><td>The database where the results came from.</td></tr><tr><td>mongo.collection.name</td><td>The collection where the results came from.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component al lows an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file
