avro-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Bridger Howell (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (AVRO-2019) Improve documentation for logical type annotations in IDL
Date Fri, 15 Sep 2017 16:22:00 GMT

    [ https://issues.apache.org/jira/browse/AVRO-2019?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16168107#comment-16168107
] 

Bridger Howell commented on AVRO-2019:
--------------------------------------

Clarification on my previous comment: I do think this documentation update is a good idea;
I was just trying to say that IDL logical types don't necessarily need to be treated internally
as a feature separate from the generic metadata facility of IDL annotations.

In order to break {{@logicalType}} annotations in IDL you'd probably either be changing the
avro spec for logical types, or changing the way that annotations in IDL are processed, either
of which is a breaking change already.
On the other hand, if you try to retain the way {{@logicalType}} maps to a logical type separately
from the way annotations are mapped, that could in many cases make IDL annotations harder
to understand by complicating the mechanism.

> Improve documentation for logical type annotations in IDL
> ---------------------------------------------------------
>
>                 Key: AVRO-2019
>                 URL: https://issues.apache.org/jira/browse/AVRO-2019
>             Project: Avro
>          Issue Type: Improvement
>          Components: doc, logical types
>            Reporter: Andrew Rosca
>            Assignee: Andrew Rosca
>            Priority: Minor
>         Attachments: AVRO-2019.patch
>
>
> The IDL documentation lacks information for how annotations can be specified for logical
types, like in the following example:
> {code}
> protocol test {
>     record test {
>         @logicalType("timestamp-millis")
>         long time;
>     }
> }
> {code}



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

Mime
View raw message