GenerateRecord

GenerateRecord 2.8.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: This processor creates FlowFiles with records having random value for the specified fields. GenerateRecord is useful for testing, configuration, and simulation. It uses one of three methods to define a record schema: (1) a provided Avro Schema Text, (2) a Predefined Schema template such as Person, Order, Event, Sensor, Product, Stock Trade, or Complete Example covering all data types, or (3) user-defined dynamic properties. The processor generates the specified number of records using random data for the fields in the schema.
Tags: fake, generate, random, test
Input Requirement: FORBIDDEN
Supports Sensitive Dynamic Properties: false

Properties

Null Value Percentage
The percent probability (0-100%) that a generated value for any nullable field will be null. Set this property to zero to have no null values, or 100 to have all null values.
Display Name

Null Value Percentage

Description

The percent probability (0-100%) that a generated value for any nullable field will be null. Set this property to zero to have no null values, or 100 to have all null values.

API Name

Null Value Percentage

Default Value

0

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true

Dependencies
- Nullable Fields is set to any of [true]
Nullable Fields
Whether the generated fields will be nullable. Note that this property is ignored if Schema Text is set. Also it only affects the schema of the generated data, not whether any values will be null. If this property is true, see 'Null Value Percentage' to set the probability that any generated field will be null.
Display Name

Nullable Fields

Description

Whether the generated fields will be nullable. Note that this property is ignored if Schema Text is set. Also it only affects the schema of the generated data, not whether any values will be null. If this property is true, see 'Null Value Percentage' to set the probability that any generated field will be null.

API Name

Nullable Fields

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Number of Records
Specifies how many records will be generated for each outgoing FlowFile.

Display Name

Number of Records

Description

Specifies how many records will be generated for each outgoing FlowFile.

API Name

Number of Records

Default Value

100

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Predefined Schema
Select a predefined schema template for quick record generation. Predefined schemas provide ready-to-use templates with multiple fields covering various data types including nested records, arrays, maps, dates, timestamps, etc. Only one of Schema Text, Predefined Schema, or user-defined dynamic properties should be configured. Note: This feature is intended for quick testing purposes only. Predefined schemas may change between NiFi versions.
Display Name

Predefined Schema

Description

Select a predefined schema template for quick record generation. Predefined schemas provide ready-to-use templates with multiple fields covering various data types including nested records, arrays, maps, dates, timestamps, etc. Only one of Schema Text, Predefined Schema, or user-defined dynamic properties should be configured. Note: This feature is intended for quick testing purposes only. Predefined schemas may change between NiFi versions.

API Name

Predefined Schema

Allowable Values
- Person
- Order
- Event
- Sensor
- Product
- Stock Trade
- Complete Example
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Record Writer
Specifies the Controller Service to use for writing out the records

Display Name

Record Writer

Description

Specifies the Controller Service to use for writing out the records

API Name

Record Writer

Service Interface

org.apache.nifi.serialization.RecordSetWriterFactory

Service Implementations

org.apache.nifi.avro.AvroRecordSetWriter

org.apache.nifi.csv.CSVRecordSetWriter

org.apache.nifi.text.FreeFormTextRecordSetWriter

org.apache.nifi.json.JsonRecordSetWriter

org.apache.nifi.lookup.RecordSetWriterLookup

org.apache.nifi.record.script.ScriptedRecordSetWriter

org.apache.nifi.xml.XMLRecordSetWriter

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Schema Text
The text of an Avro-formatted Schema used to generate record data. Only one of Schema Text, Predefined Schema, or user-defined dynamic properties should be configured.

Display Name

Schema Text

Description

The text of an Avro-formatted Schema used to generate record data. Only one of Schema Text, Predefined Schema, or user-defined dynamic properties should be configured.

API Name

Schema Text

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false

Dynamic Properties

Field name in generated record
Custom properties define the generated record schema using configured field names and value data types in absence of the Schema Text property

Name

Field name in generated record

Description

Custom properties define the generated record schema using configured field names and value data types in absence of the Schema Text property

Value

Faker category for generated record values

Expression Language Scope

NONE

Relationships

Name	Description
success	FlowFiles that are successfully created will be routed to this relationship

Writes Attributes

Name	Description
mime.type	Sets the mime.type attribute to the MIME Type specified by the Record Writer
record.count	The number of records in the FlowFile