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:

record, put, sink

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Record Readerput-record-readerController Service API:
RecordReaderFactory
Implementations: AvroReader
ScriptedReader
XMLReader
ExcelReader
ParquetReader
JsonTreeReader
WindowsEventLogReader
YamlTreeReader
ReaderLookup
JsonPathReader
ProtobufReader
CSVReader
CEFReader
SyslogReader
Syslog5424Reader
GrokReader
Specifies the Controller Service to use for reading incoming data
Record Destination Serviceput-record-sinkController Service API:
RecordSinkService
Implementations: SiteToSiteReportingRecordSink
KafkaRecordSink_2_0
PrometheusRecordSink
EmailRecordSink
ScriptedRecordSink
KafkaRecordSink_1_0
UDPEventRecordSink
ZendeskRecordSink
LoggingRecordSink
RecordSinkServiceLookup
AzureEventHubRecordSink
KafkaRecordSink_2_6
DatabaseRecordSink
Specifies the Controller Service to use for writing out the query result records to some destination.
Include Zero Record Resultsput-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.

Relationships:

NameDescription
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
failureA FlowFile is routed to this relationship if the records could not be transmitted and retrying the operation will also fail

Reads Attributes:

None specified.

Writes Attributes:

None specified.

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:

None specified.