Skip to main content

PutRecord

Description​

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).

Tags​

put, record, sink

Properties​

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Record Reader *put-record-readerController Service:
RecordReaderFactory

Implementations:
AvroReader
CEFReader
CSVReader
ExcelReader
GrokReader
JsonPathReader
JsonTreeReader
ReaderLookup
ScriptedReader
Syslog5424Reader
SyslogReader
WindowsEventLogReader
XMLReader
YamlTreeReader
Specifies the Controller Service to use for reading incoming data
Record Destination Service *put-record-sinkController Service:
RecordSinkService

Implementations:
AzureEventHubRecordSink
DatabaseRecordSink
EmailRecordSink
HttpRecordSink
LoggingRecordSink
RecordSinkServiceLookup
ScriptedRecordSink
SlackRecordSink
UDPEventRecordSink
Specifies the Controller Service to use for writing out the query result records to some destination.
Include Zero Record Results *put-record-include-zero-record-resultsfalse
  • true
  • false
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.

Dynamic Properties​

This component does not support dynamic properties.

Relationships​

NameDescription
failureA FlowFile is routed to this relationship if the records could not be transmitted and retrying the operation will also fail
retryThe original FlowFile is routed to this relationship if the records could not be transmitted but attempting the operation again may succeed
successThe original FlowFile will be routed to this relationship if the records were transmitted successfully

Reads Attributes​

This processor does not read attributes.

Writes Attributes​

This processor does not write attributes.

State Management​

This component does not store state.

Restricted​

This component is not restricted.

Input Requirement​

This component requires an incoming relationship.

System Resource Considerations​

This component does not specify system resource considerations.

See Also​