https://github.com/leboncoin/avrocado
Avrocado is a convenience library to handle Avro in Golang
https://github.com/leboncoin/avrocado
avro go golib leboncoin
Last synced: about 1 year ago
JSON representation
Avrocado is a convenience library to handle Avro in Golang
- Host: GitHub
- URL: https://github.com/leboncoin/avrocado
- Owner: leboncoin
- License: mit
- Created: 2018-03-08T15:30:50.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-01-19T00:15:25.000Z (over 1 year ago)
- Last Synced: 2025-03-29T04:02:14.049Z (over 1 year ago)
- Topics: avro, go, golib, leboncoin
- Language: Go
- Homepage:
- Size: 224 KB
- Stars: 27
- Watchers: 11
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/leboncoin/avrocado)
# Avrocado
Avrocado is a convenience library to handle Avro in golang, built on top of [linkedin/goavro](https://github.com/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](https://github.com/confluentinc/schema-registry) client.
* A codec registry which handles marshalling/unmarshalling schemas from the schema-registry.
## Getting Started
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](example_test.go).
## Installing
Just run `go get github.com/leboncoin/avrocado`.
## Examples
See the test files for examples on how to use the library.
## Running tests
Just run `go test` at the root directory of this repository.