Avro
  1. Avro
  2. AVRO-1477

Add Documentation For Serialization and Deserialization With Bytes

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 1.7.6
    • Fix Version/s: None
    • Component/s: doc
    • Labels:
      None

      Description

      Sometimes you need to serialize and deserialize an object to and from a byte array. This is true if you're using HBase or for unit tests. The docs don't cover this subject and the patch adds this information.

      1. bytesserde.diff
        2 kB
        Jesse Anderson
      2. AVRO-1477.3.cwiki.txt
        2 kB
        Jesse Anderson
      3. AVRO-1477.2.cwiki.txt
        2 kB
        Sean Busbey

        Activity

        Hide
        Sean Busbey added a comment -

        Thanks Doug!

        Show
        Sean Busbey added a comment - Thanks Doug!
        Show
        Jesse Anderson added a comment - Added to the Wiki in the FAQ at https://cwiki.apache.org/confluence/display/AVRO/FAQ#FAQ-HowcanIserializedirectlyto/fromabytearray?
        Hide
        Doug Cutting added a comment -

        I think you should both now have permission to edit the Avro wiki.

        Show
        Doug Cutting added a comment - I think you should both now have permission to edit the Avro wiki.
        Hide
        Doug Cutting added a comment -

        We can give anyone who needs it wiki write access. I'll try to get it for both Jesse & Sean.

        Ref: INFRA-7441

        Show
        Doug Cutting added a comment - We can give anyone who needs it wiki write access. I'll try to get it for both Jesse & Sean. Ref: INFRA-7441
        Hide
        Jesse Anderson added a comment -

        New patch that mentions object reuse.

        Show
        Jesse Anderson added a comment - New patch that mentions object reuse.
        Hide
        Sean Busbey added a comment -

        Unfortunately, I also don't have edit privileges on the wiki.

        Here's a proposed edit of your submission as confluence wiki markup. I added some wording about how Avro data needs a schema (since this is pretty strongly stated in the specification).

        How's this look? I'm a little concerned that the warning isn't strong enough and the examples will be used out of context.

        Show
        Sean Busbey added a comment - Unfortunately, I also don't have edit privileges on the wiki. Here's a proposed edit of your submission as confluence wiki markup. I added some wording about how Avro data needs a schema (since this is pretty strongly stated in the specification). How's this look? I'm a little concerned that the warning isn't strong enough and the examples will be used out of context.
        Hide
        Jesse Anderson added a comment -

        That's fine as long as there's something Googleable and reviewed. I don't have Wiki edit access unless you want to make the change.

        Show
        Jesse Anderson added a comment - That's fine as long as there's something Googleable and reviewed. I don't have Wiki edit access unless you want to make the change.
        Hide
        Sean Busbey added a comment -

        Hey Jesse, the getting started guide is pretty focused right now on Avro basics and only has separate sections to show code generation options (with the Specific and Generic APIs). This third section reads as a little bolted on, especially since it only covers the Specific API.

        Maybe this would make a better addition as a FAQ entry?

        Show
        Sean Busbey added a comment - Hey Jesse, the getting started guide is pretty focused right now on Avro basics and only has separate sections to show code generation options (with the Specific and Generic APIs). This third section reads as a little bolted on, especially since it only covers the Specific API. Maybe this would make a better addition as a FAQ entry ?
        Hide
        Jesse Anderson added a comment -

        Documentation Patch

        Show
        Jesse Anderson added a comment - Documentation Patch

          People

          • Assignee:
            Jesse Anderson
            Reporter:
            Jesse Anderson
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development