NiFi Ingest 26.3
NiFi Ingest

# getFieldsByRegex

The `getFieldsByRegex` method returns all sub fields where the sub field name or path (relative to this field) matches a regular expression.

## Syntax

    getFieldsByRegex( regex [, recursive [, matchFullPath [, caseSensitive ]]])

## Arguments

Argument | Description
--- | ---
`regex` | (string) The regular expression to match field names or paths against.
`recursive` | (boolean, default `true`) Specifies whether to search recursively. If you set this argument to `false`, the method only returns fields that are direct descendants of this field.
`matchFullPath` | (boolean, default `true`) Specifies whether to match against the path of the sub field (relative to the field the method is called on). If you set this argument to `false`, the regular expression only has to match the field name.
`caseSensitive` | (boolean, default `true`) Specifies whether matching is case-sensitive.

## Returns

(LuaFields) A list of LuaField objects where each LuaField represents a matching field. To map the returned fields to a table, surround the function call with braces as shown in the following example.

## Example

    local fields = { myField:getFieldsByRegex("Prefix_.*", true, false, false) }
    for i, field in ipairs(fields) do
        print field:value()
    end

Copyright 2018-2026 Open Text
Version 26.3 | Last updated July 2026

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery NiFi Ingest 26.3

Topic Title: getFieldsByRegex