| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutRecord</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;">PutRecord</h1><h2>Description: </h2><p>The PutRecord processor uses a specified RecordReader to input (possibly multiple) records from an incoming flow file, and sends them to a destination specified by a Record Destination Service (i.e. record sink).</p><h3>Tags: </h3><p>record, put, sink</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.</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"><strong>Record Reader</strong></td><td>put-record-reader</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordReaderFactory<br/><strong>Implementations: </strong><a href="../../../nifi-record-serialization-services-nar/1.19.0/org.apache.nifi.cef.CEFReader/index.html">CEFReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.0/org.apache.nifi.syslog.Syslog5424Reader/index.html">Syslog5424Reader</a><br/><a href="../../../nifi-scripting-nar/1.19.0/org.apache.nifi.record.script.ScriptedReader/index.html">ScriptedReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.0/org.apache.nifi.syslog.SyslogReader/index.html">SyslogReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.0/org.apache.nifi.csv.CSVReader/index.html">CSVReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.0/org.apache.nifi.grok.GrokReader/index.html">GrokReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.0/org.apache.nifi.json.JsonTreeReader/index.html">JsonTreeReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.0/org.apache.nifi.xml.XMLReader/index.html">XMLReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.0/org.apache.nifi.avro.AvroReader/index.html">AvroReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.0/org.apache.nifi.lookup.ReaderLookup/index.html">ReaderLookup</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.0/org.apache.nifi.windowsevent.WindowsEventLogReader/index.html">WindowsEventLogReader</a><br/><a href="../../../nifi-parquet-nar/1.19.0/org.apache.nifi.parquet.ParquetReader/index.html">ParquetReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.0/org.apache.nifi.json.JsonPathReader/index.html">JsonPathReader</a></td><td id="description">Specifies the Controller Service to use for reading incoming data</td></tr><tr><td id="name"><strong>Record Destination Service</strong></td><td>put-record-sink</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordSinkService<br/><strong>Implementations: </strong><a href="../../../nifi-azure-nar/1.19.0/org.apache.nifi.services.azure.eventhub.AzureEventHubRecordSink/index.html">AzureEventHubRecordSink</a><br/><a href="../../../nifi-kafka-2-0-nar/1.19.0/org.apache.nifi.record.sink.kafka.KafkaRecordSink_2_0/index.html">KafkaRecordSink_2_0</a><br/><a href="../../../nifi-prometheus-nar/1.19.0/org.apache.nifi.reporting.prometheus.PrometheusRecordSink/index.html">PrometheusRecordSink</a><br/><a href="../../../nifi-site-to-site-reporting-nar/1.19.0/org.apache.nifi.reporting.sink.SiteToSiteReportingRecordSink/index.html">SiteToSiteReportingRecordSink</a><br/><a href="../../../nifi-record-sink-service-nar/1.19.0/org.apache.nifi.record.sink.LoggingRecordSink/index.html">LoggingRecordSink</a><br/><a href="../../../nifi-record-sink-service-nar/1.19.0/org.apache.nifi.record.sink.event.UDPEventRecordSink/index.html">UDPEventRecordSink</a><br/><a href="../../../nifi-scripting-nar/1.19.0/org.apache.nifi.record.sink.script.ScriptedRecordSink/index.html">ScriptedRecordSink</a><br/><a href="../../../nifi-record-sink-service-nar/1.19.0/org.apache.nifi.record.sink.EmailRecordSink/index.html">EmailRecordSink</a><br/><a href="../../../nifi-dbcp-service-nar/1.19.0/org.apache.nifi.record.sink.db.DatabaseRecordSink/index.html">DatabaseRecordSink</a><br/><a href="../../../nifi-kafka-1-0-nar/1.19.0/org.apache.nifi.record.sink.kafka.KafkaRecordSink_1_0/index.html">KafkaRecordSink_1_0</a><br/><a href="../../../nifi-record-sink-service-nar/1.19.0/org.apache.nifi.record.sink.lookup.RecordSinkServiceLookup/index.html">RecordSinkServiceLookup</a><br/><a href="../../../nifi-kafka-2-6-nar/1.19.0/org.apache.nifi.record.sink.kafka.KafkaRecordSink_2_6/index.html">KafkaRecordSink_2_6</a></td><td id="description">Specifies the Controller Service to use for writing out the query result records to some destination.</td></tr><tr><td id="name"><strong>Include Zero Record Results</strong></td><td>put-record-include-zero-record-results</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If no records are read from the incoming FlowFile, this property specifies whether or not an empty record set will be transmitted. The original FlowFile will still be routed to success, but if no transmission occurs, no provenance SEND event will be generated.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>The original FlowFile is routed to this relationship if the records could not be transmitted but attempting the operation again may succeed</td></tr><tr><td>success</td><td>The original FlowFile will be routed to this relationship if the records were transmitted successfully</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if the records could not be transmitted and retrying the operation will also fail</td></tr></table><h3>Reads Attributes: </h3>None specified.<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> |