Uploaded image for project: 'Apache NiFi'
  1. Apache NiFi
  2. NIFI-7572

Add a ScriptedTransformRecord processor

    XMLWordPrintableJSON

    Details

    • Type: New Feature
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.12.0
    • Component/s: Extensions
    • Labels:
      None

      Description

      NiFi has started to put a heavier emphasis on Record-oriented processors, as they provide many benefits including better performance and a better UX over their purely byte-oriented counterparts. It is common to see users wanting to transform a Record in some very specific way, but NiFi doesn't make this as easy as it should. There are methods using ExecuteScript, InvokedScriptedProcessor, ScriptedRecordWriter, and ScriptedRecordReader for instance.

      But each of these requires that the Script writer understand a lot about NiFi and how to expose properties, create Property Descriptors, etc. and for fairly simple transformation we end up with scripts where the logic takes fewer lines of code than the boilerplate.

      We should expose a Processor that allows a user to write a script that takes a Record and transforms that Record in some way. The processor should be configured with the following:

      • Record Reader (required)
      • Record Writer (required)
      • Script Language (required)
      • Script Body or Script File (one and only one of these required)

      The script should implement a single method along the lines of:

      Record transform(Record input) throws Exception; 

      If the script returns null, the input Record should be dropped. Otherwise, whatever Record is returned should be written to the Record Writer.

      The processor should have two relationships: "success" and "failure."

      The script should not be allowed to expose any properties or define any relationships. The point is to keep the script focused purely on processing the record itself.

      It's not entirely clear to me how easy the Record API works with some of the scripting languages. The Record object does expose a method named toMap() that returns a Map<String, Object> containing the underlying key/value pairs. However, the values in that Map may themselves be Records. It might make sense to expose a new method toNormalizedMap() or something along those lines that would return a Map<String, Object> where the values have been recursively normalized, in much the same way that we do for JoltTransformRecord. This would perhaps allow for cleaner syntax, but I'm not a scripting expert so I can't say for sure whether such a method is necessary.

        Attachments

          Activity

            People

            • Assignee:
              markap14 Mark Payne
              Reporter:
              markap14 Mark Payne
            • Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0h
                0h
                Logged:
                Time Spent - 4.5h
                4.5h