Description and usage of SplitRecord processor:

Splits up an input FlowFile that is in a record-oriented data format into multiple smaller FlowFiles

Tags:

split, generic, schema, json, csv, avro, log, logs, freeform, text

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, and whether a property supports the Expression Language Guide.

Name

Default Value

Allowable Values

Description

Record Reader

Controller Service API: 


RecordReaderFactory

Implementations: 


JsonPathReader


CSVReader


ScriptedReader


AvroReader


GrokReader


JsonTreeReader


XMLReader


Syslog5424Reader


SyslogReader


Specifies the Controller Service to use for reading incoming data

Record Writer

Controller Service API: 


RecordSetWriterFactory

Implementations: 

FreeFormTextRecordSetWriter


CSVRecordSetWriter


JsonRecordSetWriter


ScriptedRecordSetWriter


AvroRecordSetWriter


XMLRecordSetWriter

Specifies the Controller Service to use for writing out the records

Records Per Split

Specifies how many records should be written to each 'split' or 'segment' FlowFile

Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)


Relationships:

Name

Description

failure If a FlowFile cannot be transformed from the configured input format to the configured output format, the unchanged FlowFile will be routed to this relationship.
splits The individual 'segments' of the original FlowFile will be routed to this relationship.
original Upon successfully splitting an input FlowFile, the original FlowFile will be sent to this relationship.

Reads Attributes:

None specified.

Writes Attributes:

Name

Description

mime.type Sets the mime.type attribute to the MIME Type specified by the Record Writer for the FlowFiles routed to the 'splits' Relationship.
record.count The number of records in the FlowFile. This is added to FlowFiles that are routed to the 'splits' Relationship.
fragment.identifier All split FlowFiles produced from the same parent FlowFile will have the same randomly generated UUID added for this attribute
fragment.index A one-up number that indicates the ordering of the split FlowFiles that were created from a single parent FlowFile
fragment.count The number of split FlowFiles generated from the parent FlowFile
segment.original.filename The filename of the parent FlowFile

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.