Avro Support(3.0)
This page describes the Avro support for Ultra Format Definition Language (UFDL). This functionality enables you to compile Avro definitions, to encode data into, and from the Avro format. A schema in Avro is represented in JSON. You can implement non-protocol data issues in an Analysis agent.
Overview
Avro parsing in UFDL is managed by applying the avro_block
construct.
avro_block {
<avro json schema>
};
The output from an Avro encoder represents a single Avro record, not a complete Avro data file. To de-serialize these records using a third-party tool, add the correct Avro header to the records based on the description of Avro provided in the link below.
The full description of the Avro language can be found at: https://avro.apache.org/docs/current/spec.html.
The Avro Types
The Avro JSON schema can be defined with any of the following types:
Note!
There are limitations to the implementation of the following elements. Refer to the section below, Limitations, for further information.
Primitive Type | Notes |
---|---|
| Implemented as type |
| Value must be |
| 32-bit signed |
| 64-bit signed |
| Single precision (32-bit) IEEE 754 floating-point number |
| Double precision (64-bit) IEEE 754 floating-point number |
| Sequence of 8-bit unsigned bytes |
| Unicode character sequence |
Complex Type | Notes |
---|---|
| Supports the attributes: The |
| Supports the attributes: |
| Supports the attribute: |
| Supports the attribute: |
| Implemented as a record with all types set to optional. If two values are set, both are encoded. If no values are set, none are encoded. To specify a union value, you must use |
| Supports the attributes: |
Note!
Use the doc
attribute to add a comment.
Limitations
The following limitations apply for the Avro support in Usage Engine:
Line and Column are not fully implemented.
No string values are permitted in APL for the
enum
type.Encoding the Avro object container file is not supported.
aliases
are not fully supported.default
is not fully supported.Cross references to other Ultra definitions are not supported.
array of arrays
is not correctly implemented. For example,array of array of x
is implemented witharray of y
, wherey
is a record with onevalue
field. Thisvalue
field is anarray of x
.map of x
is implemented via anarray of y
, wherey
is a record with two fields:key
andvalue
, wherevalue
isx
.
Avro Format Example
To encode an Arvo data file, a format definition is included in the Ultra avro_block
block in the Ultra format.
Example - The xml_schema Ultra Code Block
avro_block {
{
"namespace": "example.avro",
"type": "record",
"name": "User3",
"fields": [
{"name": "name", "type": {
"name": "FullName2",
"type": "record",
"fields": [
{"name": "firstName", "type": "string"},
{"name": "lastName", "type": "string"}
]
}
},
{"name": "favorite_number", "type": ["int", "null"]},
{"name": "favorite_color", "type": ["string", "null"]},
{"name": "favorite_fotball_team", "type": {
"name": "teams",
"type": "enum",
"namespace": "example.avro.teams",
"symbols": ["Djurgården", "Hammarby", "Malmö", "Göteborg"]
}
},
{"name": "ipAddresses", "type": {
"type": "array",
"items": [
{
"name": "ipv4Address",
"type": "fixed",
"size": 4
},
{
"name": "ipv6Address",
"type": "fixed",
"size": 16
}
]
}
},
{"name": "favoriteFoodList", "type": {
"name": "favoriteFood",
"type": "record",
"fields": [
{"name": "dish", "type": "string"},
{"name": "next", "type": ["null", "favoriteFood"]}
]
}
},
{"name": "salary", "type": "long"},
{"name": "myFixed", "type": { "name": "myfixed", "type":"fixed", "size": 4 }},
{"name": "myFloat", "type": "float"},
{"name": "myDouble", "type": "double"},
{"name": "rootUsers", "type": {
"type": "map",
"values": {
"name": "RootUsers",
"type": "record",
"fields": [
{"name": "rootUser", "type": "string"},
{"name": "privileges", "type": "int"}
]
}
}
},
{"name": "maps", "type": {
"type": "array",
"items": {
"type": "map",
"values": {
"name": "Map2",
"type": "record",
"fields": [
{"name": "favoriteUser", "type": "string"},
{"name": "favoriteNumber", "type": "int"}
]
}
}
}
}
]
}
};