Description:
Parses JSON records and evaluates user-defined JSON Path's against each JSON object. 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. User-defined properties define the fields that should be extracted from the JSON in order to form the fields of a Record. Any JSON field that is not extracted via a JSONPath will not be returned in the JSON Records.
Additional Details...
Tags:
json, jsonpath, record, reader, parser
Properties:
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, 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
|
-
Use 'Schema Name' Property
-
Use 'Schema Text' Property
-
HWX Schema Reference Attributes
-
HWX Content-Encoded Schema Reference
-
Confluent Content-Encoded Schema Reference
-
Infer Schema
|
Specifies how to obtain the schema that is to be used for interpreting the data.
|
|
Schema Registry
|
schema-registry
|
|
Controller Service API:
SchemaRegistry
Implementations:
ConfluentSchemaRegistry
AmazonGlueSchemaRegistry
HortonworksSchemaRegistry
DatabaseTableSchemaRegistry
AvroSchemaRegistry
|
Specifies the Controller Service to use for the Schema Registry
This Property is only considered if
the [Schema Access Strategy] Property is set to one of the following values: [Confluent Content-Encoded Schema Reference], [Use 'Schema Name' Property], [HWX Schema Reference Attributes], [HWX Content-Encoded Schema Reference]
|
|
Schema Name
|
schema-name
|
${schema.name}
|
|
Specifies the name of the schema to lookup in the Schema Registry property
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
This Property is only considered if
the [Schema Access Strategy] Property has a value of "Use 'Schema Name' Property".
|
|
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: true (will be evaluated using flow file attributes and variable registry)
This Property is only considered if
the [Schema Access Strategy] Property has a value of "Use 'Schema Name' Property".
|
|
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: true (will be evaluated using flow file attributes and variable registry)
This Property is only considered if
the [Schema Access Strategy] Property has a value of "Use 'Schema Name' Property".
|
|
Schema Text
|
schema-text
|
${avro.schema}
|
|
The text of an Avro-formatted Schema
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
This Property is only considered if
the [Schema Access Strategy] Property has a value of "Use 'Schema Text' Property".
|
|
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 Simple Date 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 Simple Date 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 Simple Date 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).
|
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
|
|
The field name for the record.
|
A JSONPath Expression that will be evaluated against each JSON record. The result of the JSONPath will be the value of the field whose name is the same as the property name.
|
User-defined properties identify how to extract specific fields from a JSON object in order to create a Record
Supports Expression Language: false
|
State management:
This component does not store state.
Restricted:
This component is not restricted.
System Resource Considerations:
None specified.
See Also:
JsonTreeReader
