JsonRecordSetWriter

JsonRecordSetWriter 2.0.0

Bundle: org.apache.nifi | nifi-record-serialization-services-nar
Description: Writes the results of a RecordSet as either a JSON Array or one JSON object per line. If using Array output, then even if the RecordSet consists of a single row, it will be written as an array with a single element. If using One Line Per Object output, the JSON objects cannot be pretty-printed.
Tags: json, record, recordset, resultset, row, serialize, writer
Input Requirement
Supports Sensitive Dynamic Properties: false

Properties

Allow Scientific Notation
Specifies whether or not scientific notation should be used when writing numbers
Display Name

Allow Scientific Notation

Description

Specifies whether or not scientific notation should be used when writing numbers

API Name

Allow Scientific Notation

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Compression Format
The compression format to use. Valid values are: GZIP, BZIP2, ZSTD, XZ-LZMA2, LZMA, Snappy, and Snappy Framed
Display Name

Compression Format

Description

The compression format to use. Valid values are: GZIP, BZIP2, ZSTD, XZ-LZMA2, LZMA, Snappy, and Snappy Framed

API Name

compression-format

Default Value

none

Allowable Values
- none
- gzip
- bzip2
- xz-lzma2
- snappy
- snappy framed
- zstd
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Compression Level
The compression level to use; this is valid only when using GZIP compression. A lower value results in faster processing but less compression; a value of 0 indicates no compression but simply archiving
Display Name

Compression Level

Description

The compression level to use; this is valid only when using GZIP compression. A lower value results in faster processing but less compression; a value of 0 indicates no compression but simply archiving

API Name

compression-level

Default Value

1

Allowable Values
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Compression Format is set to any of [gzip]
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).

Display Name

Date Format

Description

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).

API Name

Date Format

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Output Grouping
Specifies how the writer should output the JSON records (as an array or one object per line, e.g.) Note that if 'One Line Per Object' is selected, then Pretty Print JSON must be false.
Display Name

Output Grouping

Description

Specifies how the writer should output the JSON records (as an array or one object per line, e.g.) Note that if 'One Line Per Object' is selected, then Pretty Print JSON must be false.

API Name

output-grouping

Default Value

output-array

Allowable Values
- Array
- One Line Per Object
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Pretty Print JSON
Specifies whether or not the JSON should be pretty printed
Display Name

Pretty Print JSON

Description

Specifies whether or not the JSON should be pretty printed

API Name

Pretty Print JSON

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Schema Reference Writer
Service implementation responsible for writing FlowFile attributes or content header with Schema reference information
Display Name

Schema Reference Writer

Description

Service implementation responsible for writing FlowFile attributes or content header with Schema reference information

API Name

Schema Reference Writer

Service Interface

org.apache.nifi.schemaregistry.services.SchemaReferenceWriter

Service Implementations

org.apache.nifi.confluent.schemaregistry.ConfluentEncodedSchemaReferenceWriter

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Schema Write Strategy is set to any of [schema-reference-writer]
Schema Write Strategy
Specifies how the schema for a Record should be added to the data.
Display Name

Schema Write Strategy

Description

Specifies how the schema for a Record should be added to the data.

API Name

Schema Write Strategy

Default Value

no-schema

Allowable Values
- Do Not Write Schema
- Set 'schema.name' Attribute
- Set 'avro.schema' Attribute
- Schema Reference Writer
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Schema Access Strategy
Specifies how to obtain the schema that is to be used for interpreting the data.
Display Name

Schema Access Strategy

Description

Specifies how to obtain the schema that is to be used for interpreting the data.

API Name

schema-access-strategy

Default Value

inherit-record-schema

Allowable Values
- Inherit Record Schema
- Use 'Schema Name' Property
- Use 'Schema Text' Property
Expression Language Scope

Not Supported

Sensitive

false

Required

true
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.
Display Name

Schema Branch

Description

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.

API Name

schema-branch

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-name]
Schema Cache
Specifies a Schema Cache to add the Record Schema to so that Record Readers can quickly lookup the schema.

Display Name

Schema Cache

Description

Specifies a Schema Cache to add the Record Schema to so that Record Readers can quickly lookup the schema.

API Name

schema-cache

Service Interface

org.apache.nifi.serialization.RecordSchemaCacheService

Service Implementations

org.apache.nifi.schema.inference.VolatileSchemaCache

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Schema Name
Specifies the name of the schema to lookup in the Schema Registry property
Display Name

Schema Name

Description

Specifies the name of the schema to lookup in the Schema Registry property

API Name

schema-name

Default Value

${schema.name}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-name]
Schema Reference Reader
Service implementation responsible for reading FlowFile attributes or content to determine the Schema Reference Identifier
Display Name

Schema Reference Reader

Description

Service implementation responsible for reading FlowFile attributes or content to determine the Schema Reference Identifier

API Name

schema-reference-reader

Service Interface

org.apache.nifi.schemaregistry.services.SchemaReferenceReader

Service Implementations

org.apache.nifi.confluent.schemaregistry.ConfluentEncodedSchemaReferenceReader

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Schema Access Strategy is set to any of [schema-reference-reader]
Schema Registry
Specifies the Controller Service to use for the Schema Registry
Display Name

Schema Registry

Description

Specifies the Controller Service to use for the Schema Registry

API Name

schema-registry

Service Interface

org.apache.nifi.schemaregistry.services.SchemaRegistry

Service Implementations

org.apache.nifi.aws.schemaregistry.AmazonGlueSchemaRegistry

org.apache.nifi.apicurio.schemaregistry.ApicurioSchemaRegistry

org.apache.nifi.schemaregistry.services.AvroSchemaRegistry

org.apache.nifi.confluent.schemaregistry.ConfluentSchemaRegistry

org.apache.nifi.db.schemaregistry.DatabaseTableSchemaRegistry

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-reference-reader, schema-name]
Schema Text
The text of an Avro-formatted Schema
Display Name

Schema Text

Description

The text of an Avro-formatted Schema

API Name

schema-text

Default Value

${avro.schema}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-text-property]
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.
Display Name

Schema Version

Description

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.

API Name

schema-version

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-name]
Suppress Null Values
Specifies how the writer should handle a null field
Display Name

Suppress Null Values

Description

Specifies how the writer should handle a null field

API Name

suppress-nulls

Default Value

never-suppress

Allowable Values
- Never Suppress
- Always Suppress
- Suppress Missing Values
Expression Language Scope

Not Supported

Sensitive

false

Required

true
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).

Display Name

Time Format

Description

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).

API Name

Time Format

Expression Language Scope

Not Supported

Sensitive

false

Required

false
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).

Display Name

Timestamp Format

Description

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).

API Name

Timestamp Format

Expression Language Scope

Not Supported

Sensitive

false

Required

false