RecordSchemaCacheService
Implementation: VolatileSchemaCache
Specifies a Schema Cache to add the Record Schema to so that Record Readers can quickly lookup the schema. | Schema Protocol Version | schema-protocol-version | 1 | | The protocol version to be used for Schema Write Strategies that require a protocol version, such as Hortonworks Schema Registry strategies. Valid protocol versions for Hortonworks Schema Registry are integer values 1, 2, or 3. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
This Property is only considered if the [Schema Write Strategy] Property is set to one of the following values: [HWX Schema Reference Attributes], [HWX Content-Encoded Schema Reference] |
Schema Access Strategy | schema-access-strategy | Inherit Record Schema | - Inherit Record Schema
![The schema used to write records will be the same schema that was given to the Record when the Record was created. The schema used to write records will be the same schema that was given to the Record when the Record was created.](../../../../../html/images/iconInfo.png) - Use 'Schema Name' Property
![The name of the Schema to use is specified by the 'Schema Name' Property. The value of this property is used to lookup the Schema in the configured Schema Registry service. The name of the Schema to use is specified by the 'Schema Name' Property. The value of this property is used to lookup the Schema in the configured Schema Registry service.](../../../../../html/images/iconInfo.png) - Use 'Schema Text' Property
![The text of the Schema itself is specified by the 'Schema Text' Property. The value of this property must be a valid Avro Schema. If Expression Language is used, the value of the 'Schema Text' property must be valid after substituting the expressions. The text of the Schema itself is specified by the 'Schema Text' Property. The value of this property must be a valid Avro Schema. If Expression Language is used, the value of the 'Schema Text' property must be valid after substituting the expressions.](../../../../../html/images/iconInfo.png)
| 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 DatabaseTableSchemaRegistry AvroSchemaRegistry ClouderaSchemaRegistry HortonworksSchemaRegistry AmazonGlueSchemaRegistry | 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: [Use 'Schema Name' Property] |
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". |
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). |
Suppress Null Values | suppress_nulls | Never Suppress | - Never Suppress
![Fields that are missing (present in the schema but not in the record), or that have a value of null, will be written out as a null value Fields that are missing (present in the schema but not in the record), or that have a value of null, will be written out as a null value](../../../../../html/images/iconInfo.png) - Always Suppress
![Fields that are missing (present in the schema but not in the record), or that have a value of null, will not be written out Fields that are missing (present in the schema but not in the record), or that have a value of null, will not be written out](../../../../../html/images/iconInfo.png) - Suppress Missing Values
![When a field has a value of null, it will be written out. However, if a field is defined in the schema and not present in the record, the field will not be written out. When a field has a value of null, it will be written out. However, if a field is defined in the schema and not present in the record, the field will not be written out.](../../../../../html/images/iconInfo.png)
| Specifies how the writer should handle a null field |
Pretty Print XML | pretty_print_xml | false | | Specifies whether or not the XML should be pretty printed |
Omit XML Declaration | omit_xml_declaration | false | | Specifies whether or not to include XML declaration |
Name of Root Tag | root_tag_name | | | Specifies the name of the XML root tag wrapping the record set. This property has to be defined if the writer is supposed to write multiple records in a single FlowFile. |
Name of Record Tag | record_tag_name | | | Specifies the name of the XML record tag wrapping the record fields. If this is not set, the writer will use the record name in the schema. |
Wrap Elements of Arrays | array_wrapping | No Wrapping | - Use Property as Wrapper
![The value of the property "Array Tag Name" will be used as the tag name to wrap elements of an array. The field name of the array field will be used for the tag name of the elements. The value of the property "Array Tag Name" will be used as the tag name to wrap elements of an array. The field name of the array field will be used for the tag name of the elements.](../../../../../html/images/iconInfo.png) - Use Property for Elements
![The value of the property "Array Tag Name" will be used for the tag name of the elements of an array. The field name of the array field will be used as the tag name to wrap elements. The value of the property "Array Tag Name" will be used for the tag name of the elements of an array. The field name of the array field will be used as the tag name to wrap elements.](../../../../../html/images/iconInfo.png) - No Wrapping
![The elements of an array will not be wrapped The elements of an array will not be wrapped](../../../../../html/images/iconInfo.png)
| Specifies how the writer wraps elements of fields of type array |
Array Tag Name | array_tag_name | | | Name of the tag used by property "Wrap Elements of Arrays" to write arrays |
Character Set | Character Set | UTF-8 | | The Character set to use when writing the data to the FlowFile |
State management:
This component does not store state.Restricted:
This component is not restricted.System Resource Considerations:
None specified.