This processor creates FlowFiles with records having random value for the specified fields. GenerateRecord is useful for testing, configuration, and simulation. It uses either user-defined properties to define a record schema or a provided schema and generates the specified number of records using random data for the fields in the schema.
test, random, generate, fake
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 |
|---|---|---|---|---|
| Record Writer | record-writer | Controller Service API: RecordSetWriterFactory Implementations: FreeFormTextRecordSetWriter CSVRecordSetWriter ParquetRecordSetWriter RecordSetWriterLookup ScriptedRecordSetWriter XMLRecordSetWriter JsonRecordSetWriter AvroRecordSetWriter | Specifies the Controller Service to use for writing out the records | |
| Number of Records | number-of-records | 100 | Specifies how many records will be generated for each outgoing FlowFile. Supports Expression Language: true (will be evaluated using variable registry only) | |
| Nullable Fields | nullable-fields | true |
| 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. |
| Null Value Percentage | null-percentage | 0 | 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. Supports Expression Language: true (will be evaluated using variable registry only) This Property is only considered if the [Nullable Fields] Property has a value of "true". | |
| Schema Text | schema-text | The text of an Avro-formatted Schema used to generate record data. If this property is set, any user-defined properties are ignored. Supports Expression Language: true (will be evaluated using variable registry only) |
Supports Sensitive Dynamic Properties: No
Dynamic Properties allow the user to specify both the name and value of a property.
| Name | Value | Description |
|---|---|---|
| Field name in generated record | Faker category for generated record values | Custom properties define the generated record schema using configured field names and value data types in absence of the Schema Text property Supports Expression Language: false |
| Name | Description |
|---|---|
| success | FlowFiles that are successfully created will be routed to this relationship |
| 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 |