avro-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Shannon Carey (JIRA)" <j...@apache.org>
Subject [jira] [Created] (AVRO-1843) Clarify importance of writer's schema in documentation
Date Tue, 10 May 2016 19:24:12 GMT
Shannon Carey created AVRO-1843:

             Summary: Clarify importance of writer's schema in documentation
                 Key: AVRO-1843
                 URL: https://issues.apache.org/jira/browse/AVRO-1843
             Project: Avro
          Issue Type: Improvement
          Components: doc
            Reporter: Shannon Carey
            Priority: Minor

I'll be submitting a PR with some improvements to the Java Getting Started page as well as
the Specification which make it clearer that Avro must read all data with the writer's schema
before converting it into the reader's schema and why, and explaining that's why the schema
should be available next to serialized data. Currently, it's arguably too easy to misinterpret
Avro as only requiring a single, reader's schema in order to read data while still following
the resolution rules which make Avro seem similar to JSON (resolution by field name). For
example, the Java API examples only appear to involve one schema, hiding the fact that it
reads in the writer's schema implicitly. Also, the ability to serialize to JSON (where field
names and some type info is present) makes this misconception easy to believe.

This message was sent by Atlassian JIRA

View raw message