JsonTreeReader
Description
Parses JSON into individual Record objects. While the reader expects each record to be well-formed JSON, the content of a FlowFile may consist of many records, each as a well-formed JSON array or JSON object with optional whitespace between them, such as the common 'JSON-per-line' format. If an array is encountered, each element in that array will be treated as a separate record. If the schema that is configured contains a field that is not present in the JSON, a null value will be used. If the JSON contains a field that is not present in the schema, that field will be skipped. See the Usage of the Controller Service for more information and examples.
Tags
json, parser, reader, record, tree
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Schema Access Strategy * | schema-access-strategy | Infer Schema |
| Specifies how to obtain the schema that is to be used for interpreting the data. |
| Schema Registry | schema-registry | Controller Service: SchemaRegistry Implementations: AmazonGlueSchemaRegistry ApicurioSchemaRegistry AvroSchemaRegistry ConfluentSchemaRegistry | Specifies the Controller Service to use for the Schema Registry This property is only considered if:
| |
| Schema Name | schema-name | ${schema.name} | Specifies the name of the schema to lookup in the Schema Registry property Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| |
| Schema Version | schema-version | Specifies the version of the schema to lookup in the Schema Registry. If not specified then the latest version of the schema will be retrieved. Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Schema Branch | schema-branch | Specifies the name of the branch to use when looking up the schema in the Schema Registry property. If the chosen Schema Registry does not support branching, this value will be ignored. Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Schema Text | schema-text | ${avro.schema} | The text of an Avro-formatted Schema Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| |
| Schema Reference Reader * | schema-reference-reader | Controller Service: SchemaReferenceReader Implementations: ConfluentEncodedSchemaReferenceReader | Service implementation responsible for reading FlowFile attributes or content to determine the Schema Reference Identifier This property is only considered if:
| |
| Schema Inference Cache | schema-inference-cache | Controller Service: RecordSchemaCacheService Implementations: VolatileSchemaCache | Specifies a Schema Cache to use when inferring the schema. If not populated, the schema will be inferred each time. However, if a cache is specified, the cache will first be consulted and if the applicable schema can be found, it will be used instead of inferring the schema. This property is only considered if:
| |
| Starting Field Strategy * | starting-field-strategy | Root Node |
| Start processing from the root node or from a specified nested node. |
| Starting Field Name | starting-field-name | Skips forward to the given nested JSON field (array or object) to begin processing. This property is only considered if:
| ||
| Schema Application Strategy * | schema-application-strategy | Selected Part |
| Specifies whether the schema is defined for the whole JSON or for the selected part starting from "Starting Field Name". This property is only considered if:
|
| Max String Length * | Max String Length | 20 MB | The maximum allowed length of a string value when parsing the JSON document | |
| Allow Comments * | Allow Comments | false |
| Whether to allow comments when parsing the JSON document |
| Date Format | Date Format | Specifies the format to use when reading/writing Date fields. If not specified, Date fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java java.time.format.DateTimeFormatter format (for example, MM/dd/yyyy for a two-digit month, followed by a two-digit day, followed by a four-digit year, all separated by '/' characters, as in 01/01/2017). | ||
| Time Format | Time Format | Specifies the format to use when reading/writing Time fields. If not specified, Time fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java java.time.format.DateTimeFormatter format (for example, HH:mm:ss for a two-digit hour in 24-hour format, followed by a two-digit minute, followed by a two-digit second, all separated by ':' characters, as in 18:04:15). | ||
| Timestamp Format | Timestamp Format | Specifies the format to use when reading/writing Timestamp fields. If not specified, Timestamp fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java java.time.format.DateTimeFormatter format (for example, MM/dd/yyyy HH:mm:ss for a two-digit month, followed by a two-digit day, followed by a four-digit year, all separated by '/' characters; and then followed by a two-digit hour in 24-hour format, followed by a two-digit minute, followed by a two-digit second, all separated by ':' characters, as in 01/01/2017 18:04:15). |
State Management
This component does not store state.
Restricted
This component is not restricted.
System Resource Considerations
This component does not specify system resource considerations.