Modifies the contents of a FlowFile that contains Record-oriented data (i.e. data that can be read via a RecordReader and written by a RecordWriter) by removing selected fields. This Processor requires that at least one user-defined Property be added. The name of the property is ignored by the processor, but could be a meaningful identifier for the user. The value of the property should indicate a RecordPath that determines the field to be removed. The processor executes the removal in the order in which these properties are added to the processor. Set the "Record Writer" to "Inherit Record Schema" in order to use the updated Record Schema modified when removing Fields.
update, record, generic, schema, json, csv, avro, freeform, text, remove, delete
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 Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Record Reader | record-reader | Controller Service API: RecordReaderFactory Implementations: GrokReader JsonTreeReader WindowsEventLogReader ReaderLookup ParquetReader CSVReader Syslog5424Reader ExcelReader CEFReader XMLReader ScriptedReader SyslogReader JsonPathReader AvroReader YamlTreeReader | Specifies the Controller Service to use for reading incoming data | |
| Record Writer | record-writer | Controller Service API: RecordSetWriterFactory Implementations: FreeFormTextRecordSetWriter CSVRecordSetWriter ParquetRecordSetWriter RecordSetWriterLookup ScriptedRecordSetWriter XMLRecordSetWriter JsonRecordSetWriter AvroRecordSetWriter | Specifies the Controller Service to use for writing out the records |
Supports Sensitive Dynamic Properties: No
Dynamic Properties allow the user to specify both the name and value of a property.
| Name | Value | Description |
|---|---|---|
| (Ignored) | A RecordPath to the field to be removed. | Allows users to specify fields to remove that match the RecordPath. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Name | Description |
|---|---|
| success | FlowFiles that are successfully transformed will be routed to this relationship |
| 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 |
| Name | Description |
|---|---|
| record.error.message | This attribute provides on failure the error message encountered by the Reader or Writer. |