How to define avro schema for complex json document?

Question

I have a JSON document that I would like to convert to Avro and need a schema to be specified for that purpose. Here is the JSON document for which I would like to define the avro schema:

{
 "uid": 29153333,
 "somefield": "somevalue",
 "options": [
   {
     "item1_lvl2": "a",
     "item2_lvl2": [
       {
         "item1_lvl3": "x1",
         "item2_lvl3": "y1"
       },
       {
         "item1_lvl3": "x2",
         "item2_lvl3": "y2"
       }
     ]
   }
 ]
}

I'm able to define the schema for the non-complex types but not for the complex "options" field:

{
  "namespace" : "my.com.ns",
  "type" :  "record",
  "fields" : [
     {"name": "uid", "type": "int"},
     {"name": "somefield", "type": "string"}
     {"name": "options", "type": .....}
  ]
}

Thanks for the help!

score 26 · Accepted Answer · edited May 23 '17 at 11:47

You need to use Avro complex types, specifically arrays and records. And then nest these together:

{
  "namespace" : "my.com.ns",
  "name": "myrecord",
  "type" :  "record",
  "fields" : [
     {"name": "uid", "type": "int"},
     {"name": "somefield", "type": "string"},
     {"name": "options", "type": {
        "type": "array",
        "items": {
            "type": "record",
            "name": "lvl2_record",
            "fields": [
                {"name": "item1_lvl2", "type": "string"},
                {"name": "item2_lvl2", "type": {
                    "type": "array",
                    "items": {
                        "type": "record",
                        "name": "lvl3_record",
                        "fields": [
                            {"name": "item1_lvl3", "type": "string"},
                            {"name": "item2_lvl3", "type": "string"}
                        ]
                    }
                }}
            ]
        }
     }}
  ]
}

Also, to improve readiblity, you can split the schema into multiple files.

> in correct order On one level of nesting, Avro doesn't care about field ordering. The fields are accessed by name during deserialization, based on the schema the reader knows. — DandyDev, Jan 27 '15 at 22:18
By "in correct order" I meant in corresponding hierarchical order. I removed that misleading phrase. — Marcel Krcah, Jan 27 '15 at 22:23

score 12 · Answer 2 · answered Mar 13 '18 at 17:22

12

This online tool (http://avro4s-ui.landoop.com/) is very practical, you can generate the AVRO schema by a given valid json.

answered Mar 13 '18 at 17:22

panchicore

11,451
12
74
100

2

This is fantastic. I had a rather complex JSON format I needed an avro schema for to convert into parquet, and this tool did the trick. – alaskanloops Jan 16 '20 at 19:55

How to define avro schema for complex json document?

2 Answers2

Linked