RecordReaderFactory
Implementations: JsonPathReader
XMLReader
AvroReader
ReaderLookup
WindowsEventLogReader
Syslog5424Reader
JsonTreeReader
CEFReader
ScriptedReader
SyslogReader
CSVReader
ParquetReader
GrokReader
Specifies the Controller Service to use for reading incoming data | Record Writer | record-writer | | Controller Service API: RecordSetWriterFactory Implementations: ScriptedRecordSetWriter XMLRecordSetWriter JsonRecordSetWriter AvroRecordSetWriter CSVRecordSetWriter ParquetRecordSetWriter FreeFormTextRecordSetWriter RecordSetWriterLookup | Specifies the Controller Service to use for writing out the records |
Lookup Service | lookup-service | | Controller Service API: LookupService Implementations: SimpleKeyValueLookupService ScriptedLookupService CouchbaseKeyValueLookupService CSVRecordLookupService CouchbaseRecordLookupService SimpleScriptedLookupService ElasticSearchStringLookupService SimpleDatabaseLookupService RestLookupService PropertiesFileLookupService DatabaseRecordLookupService HBase_2_RecordLookupService SimpleCsvFileLookupService DistributedMapCacheLookupService HBase_1_1_2_RecordLookupService KuduLookupService IPLookupService XMLFileLookupService MongoDBLookupService HBase_1_1_2_ListLookupService ElasticSearchLookupService | The Lookup Service to use in order to lookup a value in each Record |
Result RecordPath | result-record-path | | | A RecordPath that points to the field whose value should be updated with whatever value is returned from the Lookup Service. If not specified, the value that is returned from the Lookup Service will be ignored, except for determining whether the FlowFile should be routed to the 'matched' or 'unmatched' Relationship. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Routing Strategy | routing-strategy | Route to 'success' | - Route to 'success'
 - Route to 'matched' or 'unmatched'

| Specifies how to route records after a Lookup has completed |
Record Result Contents | result-contents | Insert Entire Record | - Insert Entire Record
 - Insert Record Fields

| When a result is obtained that contains a Record, this property determines whether the Record itself is inserted at the configured path or if the contents of the Record (i.e., the sub-fields) will be inserted at the configured path. |
Record Update Strategy | record-update-strategy | Use Property | - Replace Existing Values
 - Use Property

| This property defines the strategy to use when updating the record with the value returned by the Lookup Service. |
Cache Size | record-path-lookup-miss-result-cache-size | 0 | | Specifies how many lookup values/records should be cached.Setting this property to zero means no caching will be done and the table will be queried for each lookup value in each record. If the lookup table changes often or the most recent data must be retrieved, do not use the cache. Supports Expression Language: true (will be evaluated using variable registry only) |
Dynamic Properties:
Supports Sensitive Dynamic Properties: No
Dynamic Properties allow the user to specify both the name and value of a property.
Name | Value | Description |
---|
Value To Lookup | Valid Record Path | A RecordPath that points to the field whose value will be looked up in the configured Lookup Service Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Relationships:
Name | Description |
---|
success | All records will be sent to this Relationship if configured to do so, unless a failure occurs |
failure | If a FlowFile cannot be enriched, the unchanged FlowFile will be routed 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 |
record.count | The number of records in the 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.See Also:
ConvertRecord, SplitRecord, SimpleKeyValueLookupService, IPLookupService, DatabaseRecordLookupService