Avrocado is a convenience library to handle Avro in golang, built on top of linkedin/goavro. It is split into three parts:
- Avro marshalling/unmarshalling using structure fields annotations inspired by the JSON standard library.
- A confluentinc/schema-registry client.
- A codec registry which handles marshalling/unmarshalling schemas from the schema-registry.
You can start using the library after installing by importing it in your go code. You need to annotate the types you want to marshal with the avro tag. Finally you will have to instantiate a codec with the corresponding Avro schema:
import "github.com/leboncoin/avrocado"
import (
"fmt"
)
type Someone struct {
Name string `avro:"name"`
Age int32 `avro:"age"`
}
func ExampleCodec() {
val := Someone{"MyName", 3}
var decoded Someone
schema := `{
"type": "record",
"name": "Someone",
"fields": [
{
"name": "name",
"type": "string"
}, {
"name": "age",
"type": "int"
}
]
}`
codec, err := NewCodec(schema)
if err != nil {
panic(fmt.Sprintf("wrong schema: %s", err))
}
avro, err := codec.Marshal(&val)
if err != nil {
panic(fmt.Sprintf("unable to serialize to avro: %s", err))
}
err = codec.Unmarshal(avro, &decoded)
if err != nil {
panic(fmt.Sprintf("unable to deserialize from avro: %s", err))
}
}
The example can also be found here.
Just run go get github.com/leboncoin/avrocado.
See the test files for examples on how to use the library.
Just run go test at the root directory of this repository.